Foxit PDF SDK
fsdk.AccessibilityCheckOptions Class Reference

Public Member Functions

def GetCheck_rule_array ()
 Get the array of rules to check. More...
 
def GetPage_range ()
 Get the page range to be adjusted, if is empty represents all pages. More...
 
def Set (check_rule_array, page_range)
 Set value.
More...
 
def SetCheck_rule_array (value)
 Set the array of rules to check. More...
 
def SetPage_range (value)
 Set the page range to be adjusted, if is empty represents all pages. More...
 

Detailed Description

This class represents accessibility check options.

Member Function Documentation

◆ GetCheck_rule_array()

fsdk.AccessibilityCheckOptions.GetCheck_rule_array ( )

Get the array of rules to check.

Returns
The array of rules to check. Please refer to values starting from fsdk.AccessibilityCheckOptionsE_CheckValidateRuleTypeDocPermission . You can provide a single rule or multiple rules in the array,and the array can contain one or multiple rule values.

◆ GetPage_range()

fsdk.AccessibilityCheckOptions.GetPage_range ( )

Get the page range to be adjusted, if is empty represents all pages.

Returns
The page range to be adjusted, if is empty represents all pages.

◆ Set()

def fsdk.AccessibilityCheckOptions.Set (   check_rule_array,
  page_range 
)

Set value.

Parameters
[in]check_rule_arrayThe array of rules to check. Please refer to values starting from fsdk.AccessibilityCheckOptionsE_CheckValidateRuleTypeDocPermission . You can provide a single rule or multiple rules in the array, and the array should contain at least one valid rule value.
[in]page_rangeThe page range to be adjusted, if is empty represents all pages.
Returns
None.

◆ SetCheck_rule_array()

fsdk.AccessibilityCheckOptions.SetCheck_rule_array (   value)

Set the array of rules to check.

Parameters
[in]valueThe array of rules to check. Please refer to values starting from fsdk.AccessibilityCheckOptionsE_CheckValidateRuleTypeDocPermission . You can provide a single rule or multiple rules in the array,and the array can contain one or multiple rule values.
Returns
None.

◆ SetPage_range()

fsdk.AccessibilityCheckOptions.SetPage_range (   value)

Set the page range to be adjusted, if is empty represents all pages.

Parameters
[in]valueThe page range to be adjusted, if is empty represents all pages.
Returns
None.