Apryse Node SDK

Class: SanitizeOptions

PDFNet.Sanitizer. SanitizeOptions

new SanitizeOptions( [json])

Options for PDFNet.Sanitizer.SanitizeOptions.
Parameters:
Name Type Argument Description
json string <optional>
 JSON data containing options values for SanitizeOptions (optional).

Methods

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.
Type
boolean

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.
Type
boolean

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.
Type
boolean

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.
Type
boolean

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.
Type
boolean

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.
Type
boolean

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.
Type
boolean

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.
Type
boolean

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.
Type
boolean

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.
Type
boolean

setActions(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:
Name Type Description
value boolean The new value for Actions
Returns:
This object, for call chaining.
Type
PDFNet.Sanitizer.SanitizeOptions

setBookmarks(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:
Name Type Description
value boolean The new value for Bookmarks
Returns:
This object, for call chaining.
Type
PDFNet.Sanitizer.SanitizeOptions

setEmbeddedContent(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:
Name Type Description
value boolean The new value for EmbeddedContent
Returns:
This object, for call chaining.
Type
PDFNet.Sanitizer.SanitizeOptions

setFormData(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:
Name Type Description
value boolean The new value for FormData
Returns:
This object, for call chaining.
Type
PDFNet.Sanitizer.SanitizeOptions

setHiddenLayers(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:
Name Type Description
value boolean The new value for HiddenLayers
Returns:
This object, for call chaining.
Type
PDFNet.Sanitizer.SanitizeOptions

setHiddenText(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:
Name Type Description
value boolean The new value for HiddenText
Returns:
This object, for call chaining.
Type
PDFNet.Sanitizer.SanitizeOptions

setMarkups(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:
Name Type Description
value boolean The new value for Markups
Returns:
This object, for call chaining.
Type
PDFNet.Sanitizer.SanitizeOptions

setMetadata(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:
Name Type Description
value boolean The new value for Metadata
Returns:
This object, for call chaining.
Type
PDFNet.Sanitizer.SanitizeOptions

setOccludedText(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:
Name Type Description
value boolean The new value for OccludedText
Returns:
This object, for call chaining.
Type
PDFNet.Sanitizer.SanitizeOptions

setSearchIndices(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:
Name Type Description
value boolean The new value for SearchIndices
Returns:
This object, for call chaining.
Type
PDFNet.Sanitizer.SanitizeOptions