foxit.addon.accessibility.AccessibilityFixer Class Reference

Inheritance diagram for foxit.addon.accessibility.AccessibilityFixer:

Public Member Functions
	AccessibilityFixer (PDFDoc pdf_doc)
	Constructor. More...
	AccessibilityFixer (AccessibilityFixer other)
	Constructor, with another fixer object. More...
bool	CanFixPermissionRules (RuleType check_rule, bool is_ocr_enabled)
	Check whether permission rules can be fixed. More...
bool	CanFixRules (RuleType check_rule, CheckState check_state)
	Check whether specified rules can be fixed. More...
bool	FixDocumentBookmark (WStringArray roles_array)
	Fix document bookmark. More...
bool	FixDocumentLanguage (string lang)
	Fix document language. More...
bool	FixDocumentPermission ()
	Fix document permission. More...
bool	FixDocumentTag ()
	Fix document tag. More...
bool	FixDocumentTitle (string title, string subject, string author, string keywords)
	Fix document title. More...
string	FixDocumentTitleWithExistingTitle ()
	Fix document title with existing title. More...
bool	FixFigureAltText (AccessibilityCheckResultDetailDataArray detail_data_array)
	Fix figure alternate text. More...
bool	FixFormFieldDescriptions ()
	Fix form field descriptions. More...
bool	FixFormFieldTagged ()
	Fix form field tagged. More...
bool	FixPageTabOrder ()
	Fix page tab order. More...
bool	IsEmpty ()
	Check whether current object is empty or not. More...

Detailed Description

This class represents an accessibility fixer for a PDF document: query whether rules are fixable and apply automatic fixes (document language / title / bookmark / permission / tag, page tab order, figure alternate text, form field tagging and descriptions). Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function common.Library.Initialize with a key including "Accessibility" module.

See also

foxit.common.Library

Constructor & Destructor Documentation

AccessibilityFixer() [1/2]

foxit.addon.accessibility.AccessibilityFixer.AccessibilityFixer ( PDFDoc  pdf_doc )

inline

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

AccessibilityFixer() [2/2]

foxit.addon.accessibility.AccessibilityFixer.AccessibilityFixer ( AccessibilityFixer  other )

inline

Constructor, with another fixer object.

Parameters

[in]

other

Another fixer object.

Member Function Documentation

CanFixPermissionRules()

bool foxit.addon.accessibility.AccessibilityFixer.CanFixPermissionRules ( RuleType  check_rule, bool  is_ocr_enabled  )

inline

Check whether permission rules can be fixed.

Parameters

[in]	check_rule	The check rule type.
[in]	is_ocr_enabled	Whether OCR is enabled.

Returns

true means permission rules can be fixed, while false means not.

CanFixRules()

bool foxit.addon.accessibility.AccessibilityFixer.CanFixRules ( RuleType  check_rule, CheckState  check_state  )

inline

Check whether specified rules can be fixed.

Parameters

[in]	check_rule	The check rule type.
[in]	check_state	The check state.

Returns

true means the rules can be fixed, while false means not.

FixDocumentBookmark()

bool foxit.addon.accessibility.AccessibilityFixer.FixDocumentBookmark ( WStringArray  roles_array )

inline

Fix document bookmark.

Parameters

[in]

roles_array

The roles array.

Returns

true means success, while false means not.

FixDocumentLanguage()

bool foxit.addon.accessibility.AccessibilityFixer.FixDocumentLanguage ( string  lang )

inline

Fix document language.

Parameters

[in]

lang

The language to set.

Returns

true means success, while false means not.

FixDocumentPermission()

bool foxit.addon.accessibility.AccessibilityFixer.FixDocumentPermission ( )

inline

Fix document permission.

Returns

true means success, while false means not.

FixDocumentTag()

bool foxit.addon.accessibility.AccessibilityFixer.FixDocumentTag ( )

inline

Fix document tag.

Returns

true means success, while false means not.

FixDocumentTitle()

bool foxit.addon.accessibility.AccessibilityFixer.FixDocumentTitle ( string  title, string  subject, string  author, string  keywords  )

inline

Fix document title.

Parameters

[in]	title	The title to set.
[in]	subject	The subject to set.
[in]	author	The author to set.
[in]	keywords	The keywords to set.

Returns

true means success, while false means not.

FixDocumentTitleWithExistingTitle()

string foxit.addon.accessibility.AccessibilityFixer.FixDocumentTitleWithExistingTitle ( )

inline

Fix document title with existing title.

Returns

The existing title text.

FixFigureAltText()

bool foxit.addon.accessibility.AccessibilityFixer.FixFigureAltText ( AccessibilityCheckResultDetailDataArray  detail_data_array )

inline

Fix figure alternate text.

Parameters

[in]

detail_data_array

The check result detail data array.

Returns

true means success, while false means not.

FixFormFieldDescriptions()

bool foxit.addon.accessibility.AccessibilityFixer.FixFormFieldDescriptions ( )

inline

Fix form field descriptions.

Returns

true means success, while false means not.

FixFormFieldTagged()

bool foxit.addon.accessibility.AccessibilityFixer.FixFormFieldTagged ( )

inline

Fix form field tagged.

Returns

true means success, while false means not.

FixPageTabOrder()

bool foxit.addon.accessibility.AccessibilityFixer.FixPageTabOrder ( )

inline

Fix page tab order.

Returns

true means success, while false means not.

IsEmpty()

bool foxit.addon.accessibility.AccessibilityFixer.IsEmpty ( )

inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns

true means current object is empty, while false means not.