pdftron::PDF::SanitizeOptions Class Reference

#include <SanitizeOptions.h>

Inheritance diagram for pdftron::PDF::SanitizeOptions:

Public Member Functions
	SanitizeOptions ()
	SanitizeOptions (const UString &json)
	~SanitizeOptions ()
bool	GetActions ()
SanitizeOptions &	SetActions (bool value)
bool	GetBookmarks ()
SanitizeOptions &	SetBookmarks (bool value)
bool	GetEmbeddedContent ()
SanitizeOptions &	SetEmbeddedContent (bool value)
bool	GetFormData ()
SanitizeOptions &	SetFormData (bool value)
bool	GetHiddenLayers ()
SanitizeOptions &	SetHiddenLayers (bool value)
bool	GetHiddenText ()
SanitizeOptions &	SetHiddenText (bool value)
bool	GetMarkups ()
SanitizeOptions &	SetMarkups (bool value)
bool	GetMetadata ()
SanitizeOptions &	SetMetadata (bool value)
bool	GetOccludedText ()
SanitizeOptions &	SetOccludedText (bool value)
bool	GetSearchIndices ()
SanitizeOptions &	SetSearchIndices (bool value)
Public Member Functions inherited from pdftron::PDF::OptionsBase
	OptionsBase ()
	OptionsBase (const UString &json)

Additional Inherited Members
Static Public Member Functions inherited from pdftron::PDF::OptionsBase
static SDF::Obj	GetArray (SDF::Obj dict, const char *key)
static void	PutNumber (SDF::Obj dict, const char *key, double num)
static void	PutBool (SDF::Obj dict, const char *key, bool val)
static void	PutText (SDF::Obj dict, const char *key, const UString &text)
static void	PutRect (SDF::Obj dict, const char *key, const Rect &rect)
static void	PushBackNumber (SDF::Obj dict, const char *key, double num)
static void	PushBackBool (SDF::Obj dict, const char *key, bool val)
static void	PushBackText (SDF::Obj dict, const char *key, const UString &text)
static void	PushBackRect (SDF::Obj dict, const char *key, const Rect &rect)
static Rect	RectFromArray (SDF::Obj nums)
static void	InsertRectCollection (SDF::Obj dict, const char *key, const RectCollection &rects, int index)
static Rect	RectFromArray (void *)
static double	ColorPtToNumber (const ColorPt &cp)
static ColorPt	ColorPtFromNumber (double dnum)

Detailed Description

Definition at line 9 of file SanitizeOptions.h.

Constructor & Destructor Documentation

pdftron::PDF::SanitizeOptions::SanitizeOptions

(

)

pdftron::PDF::SanitizeOptions::SanitizeOptions

(

const UString &

json

)

pdftron::PDF::SanitizeOptions::~SanitizeOptions

(

)

Member Function Documentation

bool pdftron::PDF::SanitizeOptions::GetActions

(

)

Gets the value Actions from the options object. Remove any actions such as scripts and links present in the document. By default this option is set to false.

Returns

The current value for Actions.

bool pdftron::PDF::SanitizeOptions::GetBookmarks

(

)

Gets the value Bookmarks from the options object. Remove any bookmarks present in the document. By default this option is set to false.

Returns

The current value for Bookmarks.

bool pdftron::PDF::SanitizeOptions::GetEmbeddedContent

(

)

Gets the value EmbeddedContent from the options object. Remove any embedded content, such as attached files present in the document. By default this option is set to false.

Returns

The current value for EmbeddedContent.

bool pdftron::PDF::SanitizeOptions::GetFormData

(

)

Gets the value FormData from the options object. Flatten any form data present in the document. By default this option is set to false.

Returns

The current value for FormData.

bool pdftron::PDF::SanitizeOptions::GetHiddenLayers

(

)

Gets the value HiddenLayers from the options object. Remove any hidden layers present in the document. By default this option is set to false.

Returns

The current value for HiddenLayers.

bool pdftron::PDF::SanitizeOptions::GetHiddenText

(

)

Gets the value HiddenText from the options object. Remove any hidden text present in the document. By default this option is set to false.

Returns

The current value for HiddenText.

bool pdftron::PDF::SanitizeOptions::GetMarkups

(

)

Gets the value Markups from the options object. Remove any markups and associated comments present in the document. By default this option is set to false.

Returns

The current value for Markups.

bool pdftron::PDF::SanitizeOptions::GetMetadata

(

)

Gets the value Metadata from the options object. Remove any metadata present in the document. By default this option is set to false.

Returns

The current value for Metadata.

bool pdftron::PDF::SanitizeOptions::GetOccludedText

(

)

Gets the value OccludedText from the options object. Remove any text that is occluded within the document (such as clipped by the cropbox or another element). By default this option is set to false.

Returns

The current value for OccludedText.

bool pdftron::PDF::SanitizeOptions::GetSearchIndices

(

)

Gets the value SearchIndices from the options object. Remove any embedded search indices present in the document. By Default this option is set to false.

Returns

The current value for SearchIndices.

SanitizeOptions& pdftron::PDF::SanitizeOptions::SetActions

(

bool

value

)

Sets the value for Actions in the options object. Remove any actions such as scripts and links present in the document. By default this option is set to false.

Parameters

value

The new value for Actions.

Returns

This object, for call chaining.

SanitizeOptions& pdftron::PDF::SanitizeOptions::SetBookmarks

(

bool

value

)

Sets the value for Bookmarks in the options object. Remove any bookmarks present in the document. By default this option is set to false.

Parameters

value

The new value for Bookmarks.

Returns

This object, for call chaining.

SanitizeOptions& pdftron::PDF::SanitizeOptions::SetEmbeddedContent

(

bool

value

)

Sets the value for EmbeddedContent in the options object. Remove any embedded content, such as attached files present in the document. By default this option is set to false.

Parameters

value

The new value for EmbeddedContent.

Returns

This object, for call chaining.

SanitizeOptions& pdftron::PDF::SanitizeOptions::SetFormData

(

bool

value

)

Sets the value for FormData in the options object. Flatten any form data present in the document. By default this option is set to false.

Parameters

value

The new value for FormData.

Returns

This object, for call chaining.

SanitizeOptions& pdftron::PDF::SanitizeOptions::SetHiddenLayers

(

bool

value

)

Sets the value for HiddenLayers in the options object. Remove any hidden layers present in the document. By default this option is set to false.

Parameters

value

The new value for HiddenLayers.

Returns

This object, for call chaining.

SanitizeOptions& pdftron::PDF::SanitizeOptions::SetHiddenText

(

bool

value

)

Sets the value for HiddenText in the options object. Remove any hidden text present in the document. By default this option is set to false.

Parameters

value

The new value for HiddenText.

Returns

This object, for call chaining.

SanitizeOptions& pdftron::PDF::SanitizeOptions::SetMarkups

(

bool

value

)

Sets the value for Markups in the options object. Remove any markups and associated comments present in the document. By default this option is set to false.

Parameters

value

The new value for Markups.

Returns

This object, for call chaining.

SanitizeOptions& pdftron::PDF::SanitizeOptions::SetMetadata

(

bool

value

)

Sets the value for Metadata in the options object. Remove any metadata present in the document. By default this option is set to false.

Parameters

value

The new value for Metadata.

Returns

This object, for call chaining.

SanitizeOptions& pdftron::PDF::SanitizeOptions::SetOccludedText

(

bool

value

)

Sets the value for OccludedText in the options object. Remove any text that is occluded within the document (such as clipped by the cropbox or another element). By default this option is set to false.

Parameters

value

The new value for OccludedText.

Returns

This object, for call chaining.

SanitizeOptions& pdftron::PDF::SanitizeOptions::SetSearchIndices

(

bool

value

)

Sets the value for SearchIndices in the options object. Remove any embedded search indices present in the document. By Default this option is set to false.

Parameters

value

The new value for SearchIndices.

Returns

This object, for call chaining.

---

The documentation for this class was generated from the following file:

• PDF/SanitizeOptions.h