Foxit PDF SDK
fsdk.HiddenInfoSettingData Class Reference

Configuration settings for removing hidden or sensitive data from a PDF document. More...

Public Member Functions

def GetEnable_remove_bookmark ()
 Get a boolean value indicating whether to remove bookmarks. More...
 
def GetEnable_remove_comment ()
 Get a boolean value indicating whether to remove comments and annotations. More...
 
def GetEnable_remove_content ()
 Get a boolean value indicating whether to remove invisible or obscured content. More...
 
def GetEnable_remove_fileattachment ()
 Get a boolean value indicating whether to remove embedded file attachments. More...
 
def GetEnable_remove_form_fields ()
 Get a boolean value indicating whether to remove interactive form fields. More...
 
def GetEnable_remove_hidden_layer ()
 Get a boolean value indicating whether to remove hidden layers (Optional Content Groups). More...
 
def GetEnable_remove_hidden_text ()
 Get a boolean value indicating whether to remove hidden text. More...
 
def GetEnable_remove_link ()
 Get a boolean value indicating whether to remove hyperlink annotations. More...
 
def GetEnable_remove_metadata ()
 Get a boolean value indicating whether to remove document metadata. More...
 
def GetEnable_remove_overlaping ()
 Get a boolean value indicating whether to remove overlapping objects. More...
 
def GetEnable_remove_searchIndex ()
 Get a boolean value indicating whether to remove the search index. More...
 
def SetEnable_remove_bookmark (value)
 Set a boolean value indicating whether to remove bookmarks. More...
 
def SetEnable_remove_comment (value)
 Set a boolean value indicating whether to remove comments and annotations. More...
 
def SetEnable_remove_content (value)
 Set a boolean value indicating whether to remove invisible or obscured content. More...
 
def SetEnable_remove_fileattachment (value)
 Set a boolean value indicating whether to remove embedded file attachments. More...
 
def SetEnable_remove_form_fields (value)
 Set a boolean value indicating whether to remove interactive form fields. More...
 
def SetEnable_remove_hidden_layer (value)
 Set a boolean value indicating whether to remove hidden layers (Optional Content Groups). More...
 
def SetEnable_remove_hidden_text (value)
 Set a boolean value indicating whether to remove hidden text. More...
 
def SetEnable_remove_link (value)
 Set a boolean value indicating whether to remove hyperlink annotations. More...
 
def SetEnable_remove_metadata (value)
 Set a boolean value indicating whether to remove document metadata. More...
 
def SetEnable_remove_overlaping (value)
 Set a boolean value indicating whether to remove overlapping objects. More...
 
def SetEnable_remove_searchIndex (value)
 Set a boolean value indicating whether to remove the search index. More...
 

Detailed Description

Configuration settings for removing hidden or sensitive data from a PDF document.

Member Function Documentation

◆ GetEnable_remove_bookmark()

fsdk.HiddenInfoSettingData.GetEnable_remove_bookmark ( )

Get a boolean value indicating whether to remove bookmarks.

Bookmarks are document outlines that may reveal document structure or private section names.

Returns
A boolean value indicating whether to remove bookmarks.

◆ GetEnable_remove_comment()

fsdk.HiddenInfoSettingData.GetEnable_remove_comment ( )

Get a boolean value indicating whether to remove comments and annotations.

Comments may contain personal notes, editorial feedback, or private data.

Returns
A boolean value indicating whether to remove comments and annotations.

◆ GetEnable_remove_content()

fsdk.HiddenInfoSettingData.GetEnable_remove_content ( )

Get a boolean value indicating whether to remove invisible or obscured content.

Includes content fully covered by other elements or outside the visible page area.

Returns
A boolean value indicating whether to remove invisible or obscured content.

◆ GetEnable_remove_fileattachment()

fsdk.HiddenInfoSettingData.GetEnable_remove_fileattachment ( )

Get a boolean value indicating whether to remove embedded file attachments.

File attachments may contain hidden or unrelated external content embedded in the PDF.

Returns
A boolean value indicating whether to remove embedded file attachments.

◆ GetEnable_remove_form_fields()

fsdk.HiddenInfoSettingData.GetEnable_remove_form_fields ( )

Get a boolean value indicating whether to remove interactive form fields.

Form fields such as text boxes and checkboxes may store sensitive user input.

Returns
A boolean value indicating whether to remove interactive form fields.

◆ GetEnable_remove_hidden_layer()

fsdk.HiddenInfoSettingData.GetEnable_remove_hidden_layer ( )

Get a boolean value indicating whether to remove hidden layers (Optional Content Groups).

Hidden layers can contain text or graphics not visible in normal viewing mode.

Returns
A boolean value indicating whether to remove hidden layers (Optional Content Groups).

◆ GetEnable_remove_hidden_text()

fsdk.HiddenInfoSettingData.GetEnable_remove_hidden_text ( )

Get a boolean value indicating whether to remove hidden text.

Hidden text may be visually invisible but still accessible through text extraction.

Returns
A boolean value indicating whether to remove hidden text.

◆ GetEnable_remove_link()

fsdk.HiddenInfoSettingData.GetEnable_remove_link ( )

Get a boolean value indicating whether to remove hyperlink annotations.

Links may lead to external sites or reference internal sensitive sections.

Returns
A boolean value indicating whether to remove hyperlink annotations.

◆ GetEnable_remove_metadata()

fsdk.HiddenInfoSettingData.GetEnable_remove_metadata ( )

Get a boolean value indicating whether to remove document metadata.

Metadata may contain title, author, keywords, and other hidden descriptive information.

Returns
A boolean value indicating whether to remove document metadata.

◆ GetEnable_remove_overlaping()

fsdk.HiddenInfoSettingData.GetEnable_remove_overlaping ( )

Get a boolean value indicating whether to remove overlapping objects.

Overlapping elements can be used to obscure sensitive content or create misleading visuals.

Returns
A boolean value indicating whether to remove overlapping objects.

◆ GetEnable_remove_searchIndex()

fsdk.HiddenInfoSettingData.GetEnable_remove_searchIndex ( )

Get a boolean value indicating whether to remove the search index.

Search indexes speed up full-text search but may retain hidden or outdated content.

Returns
A boolean value indicating whether to remove the search index.

◆ SetEnable_remove_bookmark()

fsdk.HiddenInfoSettingData.SetEnable_remove_bookmark (   value)

Set a boolean value indicating whether to remove bookmarks.

Bookmarks are document outlines that may reveal document structure or private section names.

Parameters
[in]valueA boolean value indicating whether to remove bookmarks.
Returns
None.

◆ SetEnable_remove_comment()

fsdk.HiddenInfoSettingData.SetEnable_remove_comment (   value)

Set a boolean value indicating whether to remove comments and annotations.

Comments may contain personal notes, editorial feedback, or private data.

Parameters
[in]valueA boolean value indicating whether to remove comments and annotations.
Returns
None.

◆ SetEnable_remove_content()

fsdk.HiddenInfoSettingData.SetEnable_remove_content (   value)

Set a boolean value indicating whether to remove invisible or obscured content.

Includes content fully covered by other elements or outside the visible page area.

Parameters
[in]valueA boolean value indicating whether to remove invisible or obscured content.
Returns
None.

◆ SetEnable_remove_fileattachment()

fsdk.HiddenInfoSettingData.SetEnable_remove_fileattachment (   value)

Set a boolean value indicating whether to remove embedded file attachments.

File attachments may contain hidden or unrelated external content embedded in the PDF.

Parameters
[in]valueA boolean value indicating whether to remove embedded file attachments.
Returns
None.

◆ SetEnable_remove_form_fields()

fsdk.HiddenInfoSettingData.SetEnable_remove_form_fields (   value)

Set a boolean value indicating whether to remove interactive form fields.

Form fields such as text boxes and checkboxes may store sensitive user input.

Parameters
[in]valueA boolean value indicating whether to remove interactive form fields.
Returns
None.

◆ SetEnable_remove_hidden_layer()

fsdk.HiddenInfoSettingData.SetEnable_remove_hidden_layer (   value)

Set a boolean value indicating whether to remove hidden layers (Optional Content Groups).

Hidden layers can contain text or graphics not visible in normal viewing mode.

Parameters
[in]valueA boolean value indicating whether to remove hidden layers (Optional Content Groups).
Returns
None.

◆ SetEnable_remove_hidden_text()

fsdk.HiddenInfoSettingData.SetEnable_remove_hidden_text (   value)

Set a boolean value indicating whether to remove hidden text.

Hidden text may be visually invisible but still accessible through text extraction.

Parameters
[in]valueA boolean value indicating whether to remove hidden text.
Returns
None.

◆ SetEnable_remove_link()

fsdk.HiddenInfoSettingData.SetEnable_remove_link (   value)

Set a boolean value indicating whether to remove hyperlink annotations.

Links may lead to external sites or reference internal sensitive sections.

Parameters
[in]valueA boolean value indicating whether to remove hyperlink annotations.
Returns
None.

◆ SetEnable_remove_metadata()

fsdk.HiddenInfoSettingData.SetEnable_remove_metadata (   value)

Set a boolean value indicating whether to remove document metadata.

Metadata may contain title, author, keywords, and other hidden descriptive information.

Parameters
[in]valueA boolean value indicating whether to remove document metadata.
Returns
None.

◆ SetEnable_remove_overlaping()

fsdk.HiddenInfoSettingData.SetEnable_remove_overlaping (   value)

Set a boolean value indicating whether to remove overlapping objects.

Overlapping elements can be used to obscure sensitive content or create misleading visuals.

Parameters
[in]valueA boolean value indicating whether to remove overlapping objects.
Returns
None.

◆ SetEnable_remove_searchIndex()

fsdk.HiddenInfoSettingData.SetEnable_remove_searchIndex (   value)

Set a boolean value indicating whether to remove the search index.

Search indexes speed up full-text search but may retain hidden or outdated content.

Parameters
[in]valueA boolean value indicating whether to remove the search index.
Returns
None.