FSDK.AccessibilityFixer Class Reference

Public Member Functions
	CanFixPermissionRules (check_rule, is_ocr_enabled)
	Check whether permission rules can be fixed. More...
	CanFixRules (check_rule, check_state)
	Check whether specified rules can be fixed. More...
	constructor (pdf_doc)
	Constructor. More...
	FixDocumentBookmark (roles_array)
	Fix document bookmark. More...
	FixDocumentLanguage (lang)
	Fix document language. More...
	FixDocumentPermission ()
	Fix document permission. More...
	FixDocumentTag ()
	Fix document tag. More...
	FixDocumentTitle (title, subject, author, keywords)
	Fix document title. More...
	FixDocumentTitleWithExistingTitle ()
	Fix document title with existing title. More...
	FixFigureAltText (detail_data_array)
	Fix figure alternate text. More...
	FixFormFieldDescriptions ()
	Fix form field descriptions. More...
	FixFormFieldTagged ()
	Fix form field tagged. More...
	FixPageTabOrder ()
	Fix page tab order. More...
	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 FSDK.Library.Initialize with a key including "Accessibility" module.

See also

FSDK.Library

Member Function Documentation

CanFixPermissionRules()

FSDK.AccessibilityFixer.CanFixPermissionRules (   check_rule,   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()

FSDK.AccessibilityFixer.CanFixRules (   check_rule,   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.

constructor()

FSDK.AccessibilityFixer.constructor (   pdf_doc )

inline

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

FixDocumentBookmark()

FSDK.AccessibilityFixer.FixDocumentBookmark (   roles_array )

inline

Fix document bookmark.

Parameters

[in]

roles_array

The roles array.

Returns

true means success, while false means not.

FixDocumentLanguage()

FSDK.AccessibilityFixer.FixDocumentLanguage (   lang )

inline

Fix document language.

Parameters

[in]

lang

The language to set.

Returns

true means success, while false means not.

FixDocumentPermission()

FSDK.AccessibilityFixer.FixDocumentPermission ( )

inline

Fix document permission.

Returns

true means success, while false means not.

FixDocumentTag()

FSDK.AccessibilityFixer.FixDocumentTag ( )

inline

Fix document tag.

Returns

true means success, while false means not.

FixDocumentTitle()

FSDK.AccessibilityFixer.FixDocumentTitle (   title,   subject,   author,   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()

FSDK.AccessibilityFixer.FixDocumentTitleWithExistingTitle ( )

inline

Fix document title with existing title.

Returns

The existing title text.

FixFigureAltText()

FSDK.AccessibilityFixer.FixFigureAltText (   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()

FSDK.AccessibilityFixer.FixFormFieldDescriptions ( )

inline

Fix form field descriptions.

Returns

true means success, while false means not.

FixFormFieldTagged()

FSDK.AccessibilityFixer.FixFormFieldTagged ( )

inline

Fix form field tagged.

Returns

true means success, while false means not.

FixPageTabOrder()

FSDK.AccessibilityFixer.FixPageTabOrder ( )

inline

Fix page tab order.

Returns

true means success, while false means not.

IsEmpty()

FSDK.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.