public class

SanitizeOptions

extends OptionsBase
java.lang.Object
   ↳ com.pdftron.pdf.OptionsBase
     ↳ com.pdftron.pdf.SanitizeOptions

Summary

Public Constructors
SanitizeOptions()
Constructor.
SanitizeOptions(String json_string)
Constructor.
Public Methods
boolean getActions()
Gets the value Actions from the options object.
boolean getBookmarks()
Gets the value Bookmarks from the options object.
boolean getEmbeddedContent()
Gets the value EmbeddedContent from the options object.
boolean getFormData()
Gets the value FormData from the options object.
boolean getHiddenLayers()
Gets the value HiddenLayers from the options object.
boolean getHiddenText()
Gets the value HiddenText from the options object.
boolean getMarkups()
Gets the value Markups from the options object.
boolean getMetadata()
Gets the value Metadata from the options object.
boolean getOccludedText()
Gets the value OccludedText from the options object.
boolean getSearchIndices()
Gets the value SearchIndices from the options object.
SanitizeOptions setActions(boolean value)
Sets the value for Actions in the options object.
SanitizeOptions setBookmarks(boolean value)
Sets the value for Bookmarks in the options object.
SanitizeOptions setEmbeddedContent(boolean value)
Sets the value for EmbeddedContent in the options object.
SanitizeOptions setFormData(boolean value)
Sets the value for FormData in the options object.
SanitizeOptions setHiddenLayers(boolean value)
Sets the value for HiddenLayers in the options object.
SanitizeOptions setHiddenText(boolean value)
Sets the value for HiddenText in the options object.
SanitizeOptions setMarkups(boolean value)
Sets the value for Markups in the options object.
SanitizeOptions setMetadata(boolean value)
Sets the value for Metadata in the options object.
SanitizeOptions setOccludedText(boolean value)
Sets the value for OccludedText in the options object.
SanitizeOptions setSearchIndices(boolean value)
Sets the value for SearchIndices in the options object.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SanitizeOptions ()

Constructor.

Throws
PDFNetException

public SanitizeOptions (String json_string)

Constructor.

Throws
PDFNetException

Public Methods

public boolean 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.
Throws
PDFNetException

public 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.
Throws
PDFNetException

public 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.
Throws
PDFNetException

public 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.
Throws
PDFNetException

public 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.
Throws
PDFNetException

public 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.
Throws
PDFNetException

public 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.
Throws
PDFNetException

public 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.
Throws
PDFNetException

public 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.
Throws
PDFNetException

public 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.
Throws
PDFNetException

public SanitizeOptions setActions (boolean 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.
Throws
PDFNetException

public SanitizeOptions setBookmarks (boolean 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.
Throws
PDFNetException

public SanitizeOptions setEmbeddedContent (boolean 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.
Throws
PDFNetException

public SanitizeOptions setFormData (boolean 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.
Throws
PDFNetException

public SanitizeOptions setHiddenLayers (boolean 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.
Throws
PDFNetException

public SanitizeOptions setHiddenText (boolean 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.
Throws
PDFNetException

public SanitizeOptions setMarkups (boolean 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.
Throws
PDFNetException

public SanitizeOptions setMetadata (boolean 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.
Throws
PDFNetException

public SanitizeOptions setOccludedText (boolean 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.
Throws
PDFNetException

public SanitizeOptions setSearchIndices (boolean 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.
Throws
PDFNetException