Foxit PDF SDK
FSDK.AccessibilityCheckOptions Class Reference

Public Member Functions

 constructor ()
 Constructor.
 
 Set (check_rule_array, page_range)
 Set value. More...
 

Public Attributes

 check_rule_array
 The array of rules to check. Please refer to values starting from FSDK.AccessibilityCheckOptions.e_CheckValidateRuleTypeDocPermission. You can provide a single rule or multiple rules in the array, and the array can contain one or multiple rule values.
 
 page_range
 The page range to be adjusted, if is empty represents all pages.
 

Static Public Attributes

static e_CheckValidateRuleTypeAltTextHasContent
 Check validate rule type: alt text has content.
 
static e_CheckValidateRuleTypeAltTextHideAnnot
 Check validate rule type: alt text hide annot.
 
static e_CheckValidateRuleTypeDocColorContrast
 Check validate rule type: doc color contrast.
 
static e_CheckValidateRuleTypeDocLanguageSpecified
 Check validate rule type: doc language specified.
 
static e_CheckValidateRuleTypeDocOutlineForLarge
 Check validate rule type: doc outline for large.
 
static e_CheckValidateRuleTypeDocPermission
 Enumeration for check validate rule type. More...
 
static e_CheckValidateRuleTypeDocPureImage
 Check validate rule type: doc pure image.
 
static e_CheckValidateRuleTypeDocStructTreeOrder
 Check validate rule type: doc struct tree order.
 
static e_CheckValidateRuleTypeDocTagged
 Check validate rule type: doc tagged.
 
static e_CheckValidateRuleTypeDocTitle
 Check validate rule type: doc title.
 
static e_CheckValidateRuleTypeElementAltText
 Check validate rule type: element alt text.
 
static e_CheckValidateRuleTypeFigureAltText
 Check validate rule type: figure alt text.
 
static e_CheckValidateRuleTypeFormFieldAltText
 Check validate rule type: form field alt text.
 
static e_CheckValidateRuleTypeFormFieldTagged
 Check validate rule type: form field tagged.
 
static e_CheckValidateRuleTypeHeadingProperNest
 Check validate rule type: heading proper nest.
 
static e_CheckValidateRuleTypeListItemsUsed
 Check validate rule type: list items proper used.
 
static e_CheckValidateRuleTypeListLblLbodyUsed
 Check validate rule type: list label and LBody proper used.
 
static e_CheckValidateRuleTypeNoNestedAltText
 Check validate rule type: no nested alt text.
 
static e_CheckValidateRuleTypePageAnnotTagged
 Check validate rule type: page annot tagged.
 
static e_CheckValidateRuleTypePageContentTagged
 Check validate rule type: page content tagged.
 
static e_CheckValidateRuleTypePageFontEncoding
 Check validate rule type: page font encoding.
 
static e_CheckValidateRuleTypePageMultimediaObjectTagged
 Check validate rule type: page multimedia object tagged.
 
static e_CheckValidateRuleTypePageNavigationLinkRepeat
 Check validate rule type: page navigation link repeat.
 
static e_CheckValidateRuleTypePageNoFlickering
 Check validate rule type: page no flickering.
 
static e_CheckValidateRuleTypePageNoInaccessibleScript
 Check validate rule type: page no inaccessible script.
 
static e_CheckValidateRuleTypePageNoTimedResponse
 Check validate rule type: page no timed response.
 
static e_CheckValidateRuleTypePageTabOrder
 Check validate rule type: page tab order.
 
static e_CheckValidateRuleTypeTableHeadersExist
 Check validate rule type: table headers exist.
 
static e_CheckValidateRuleTypeTableRowsUsed
 Check validate rule type: table rows proper used.
 
static e_CheckValidateRuleTypeTableSpanCorrect
 Check validate rule type: table span correct.
 
static e_CheckValidateRuleTypeTableSummary
 Check validate rule type: table summary.
 
static e_CheckValidateRuleTypeTableThTdUsed
 Check validate rule type: table TH and TD proper used.
 

Detailed Description

This class represents accessibility check options.

Member Function Documentation

◆ Set()

FSDK.AccessibilityCheckOptions.Set (   check_rule_array,
  page_range 
)
inline

Set value.

Parameters
[in]check_rule_arrayThe array of rules to check. Please refer to values starting from FSDK.AccessibilityCheckOptions.e_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.

Member Data Documentation

◆ e_CheckValidateRuleTypeDocPermission

FSDK.AccessibilityCheckOptions.e_CheckValidateRuleTypeDocPermission
static

Enumeration for check validate rule type.

Values of this enumeration should be used alone.Check validate rule type: doc permission.