Foxit PDF SDK
foxit.addon.accessibility.AccessibilityCheckOptions Class Reference

Inherits SystemIDisposable.

Public Types

enum  CheckValidateRuleType {
  CheckValidateRuleType.e_CheckValidateRuleTypeDocPermission = 0x0101, CheckValidateRuleType.e_CheckValidateRuleTypeDocPureImage = 0x0102, CheckValidateRuleType.e_CheckValidateRuleTypeDocTagged = 0x0103, CheckValidateRuleType.e_CheckValidateRuleTypeDocStructTreeOrder = 0x0104,
  CheckValidateRuleType.e_CheckValidateRuleTypeDocLanguageSpecified = 0x0105, CheckValidateRuleType.e_CheckValidateRuleTypeDocTitle = 0x0106, CheckValidateRuleType.e_CheckValidateRuleTypeDocOutlineForLarge = 0x0107, CheckValidateRuleType.e_CheckValidateRuleTypeDocColorContrast = 0x0108,
  CheckValidateRuleType.e_CheckValidateRuleTypePageContentTagged = 0x0109, CheckValidateRuleType.e_CheckValidateRuleTypePageAnnotTagged = 0x010A, CheckValidateRuleType.e_CheckValidateRuleTypePageTabOrder = 0x010B, CheckValidateRuleType.e_CheckValidateRuleTypePageFontEncoding = 0x010C,
  CheckValidateRuleType.e_CheckValidateRuleTypePageMultimediaObjectTagged = 0x010D, CheckValidateRuleType.e_CheckValidateRuleTypePageNoFlickering = 0x010E, CheckValidateRuleType.e_CheckValidateRuleTypePageNoInaccessibleScript = 0x010F, CheckValidateRuleType.e_CheckValidateRuleTypePageNoTimedResponse = 0x0110,
  CheckValidateRuleType.e_CheckValidateRuleTypePageNavigationLinkRepeat = 0x0111, CheckValidateRuleType.e_CheckValidateRuleTypeFormFieldTagged = 0x0112, CheckValidateRuleType.e_CheckValidateRuleTypeFormFieldAltText = 0x0113, CheckValidateRuleType.e_CheckValidateRuleTypeTableRowsUsed = 0x0114,
  CheckValidateRuleType.e_CheckValidateRuleTypeTableThTdUsed = 0x0115, CheckValidateRuleType.e_CheckValidateRuleTypeTableHeadersExist = 0x0116, CheckValidateRuleType.e_CheckValidateRuleTypeTableSpanCorrect = 0x0117, CheckValidateRuleType.e_CheckValidateRuleTypeTableSummary = 0x0118,
  CheckValidateRuleType.e_CheckValidateRuleTypeListItemsUsed = 0x0119, CheckValidateRuleType.e_CheckValidateRuleTypeListLblLbodyUsed = 0x011A, CheckValidateRuleType.e_CheckValidateRuleTypeFigureAltText = 0x011B, CheckValidateRuleType.e_CheckValidateRuleTypeNoNestedAltText = 0x011C,
  CheckValidateRuleType.e_CheckValidateRuleTypeAltTextHasContent = 0x011D, CheckValidateRuleType.e_CheckValidateRuleTypeAltTextHideAnnot = 0x011E, CheckValidateRuleType.e_CheckValidateRuleTypeElementAltText = 0x011F, CheckValidateRuleType.e_CheckValidateRuleTypeHeadingProperNest = 0x0120
}
 Enumeration for check validate rule type. More...
 

Public Member Functions

 AccessibilityCheckOptions ()
 Constructor.
 
 AccessibilityCheckOptions (AccessibilityCheckOptions other)
 Constructor, with another accessibility check options object. More...
 
void Set (UInt32Array check_rule_array, Range page_range)
 Set value. More...
 

Properties

UInt32Array? check_rule_array [get, set]
 The array of rules to check. Please refer to values starting from foxit.addon.accessibility.AccessibilityCheckOptions.CheckValidateRuleType.e_CheckValidateRuleTypeDocPermission . You can provide a single rule or multiple rules in the array,and the array can contain one or multiple rule values.
 
Range? page_range [get, set]
 The page range to be adjusted, if is empty represents all pages.
 

Detailed Description

This class represents accessibility check options.

Member Enumeration Documentation

◆ CheckValidateRuleType

Enumeration for check validate rule type.

Values of this enumeration should be used alone.

Enumerator
e_CheckValidateRuleTypeDocPermission 

Check validate rule type: doc permission.

e_CheckValidateRuleTypeDocPureImage 

Check validate rule type: doc pure image.

e_CheckValidateRuleTypeDocTagged 

Check validate rule type: doc tagged.

e_CheckValidateRuleTypeDocStructTreeOrder 

Check validate rule type: doc struct tree order.

e_CheckValidateRuleTypeDocLanguageSpecified 

Check validate rule type: doc language specified.

e_CheckValidateRuleTypeDocTitle 

Check validate rule type: doc title.

e_CheckValidateRuleTypeDocOutlineForLarge 

Check validate rule type: doc outline for large.

e_CheckValidateRuleTypeDocColorContrast 

Check validate rule type: doc color contrast.

e_CheckValidateRuleTypePageContentTagged 

Check validate rule type: page content tagged.

e_CheckValidateRuleTypePageAnnotTagged 

Check validate rule type: page annot tagged.

e_CheckValidateRuleTypePageTabOrder 

Check validate rule type: page tab order.

e_CheckValidateRuleTypePageFontEncoding 

Check validate rule type: page font encoding.

e_CheckValidateRuleTypePageMultimediaObjectTagged 

Check validate rule type: page multimedia object tagged.

e_CheckValidateRuleTypePageNoFlickering 

Check validate rule type: page no flickering.

e_CheckValidateRuleTypePageNoInaccessibleScript 

Check validate rule type: page no inaccessible script.

e_CheckValidateRuleTypePageNoTimedResponse 

Check validate rule type: page no timed response.

e_CheckValidateRuleTypePageNavigationLinkRepeat 

Check validate rule type: page navigation link repeat.

e_CheckValidateRuleTypeFormFieldTagged 

Check validate rule type: form field tagged.

e_CheckValidateRuleTypeFormFieldAltText 

Check validate rule type: form field alt text.

e_CheckValidateRuleTypeTableRowsUsed 

Check validate rule type: table rows proper used.

e_CheckValidateRuleTypeTableThTdUsed 

Check validate rule type: table TH and TD proper used.

e_CheckValidateRuleTypeTableHeadersExist 

Check validate rule type: table headers exist.

e_CheckValidateRuleTypeTableSpanCorrect 

Check validate rule type: table span correct.

e_CheckValidateRuleTypeTableSummary 

Check validate rule type: table summary.

e_CheckValidateRuleTypeListItemsUsed 

Check validate rule type: list items proper used.

e_CheckValidateRuleTypeListLblLbodyUsed 

Check validate rule type: list label and LBody proper used.

e_CheckValidateRuleTypeFigureAltText 

Check validate rule type: figure alt text.

e_CheckValidateRuleTypeNoNestedAltText 

Check validate rule type: no nested alt text.

e_CheckValidateRuleTypeAltTextHasContent 

Check validate rule type: alt text has content.

e_CheckValidateRuleTypeAltTextHideAnnot 

Check validate rule type: alt text hide annot.

e_CheckValidateRuleTypeElementAltText 

Check validate rule type: element alt text.

e_CheckValidateRuleTypeHeadingProperNest 

Check validate rule type: heading proper nest.

Constructor & Destructor Documentation

◆ AccessibilityCheckOptions()

foxit.addon.accessibility.AccessibilityCheckOptions.AccessibilityCheckOptions ( AccessibilityCheckOptions  other)
inline

Constructor, with another accessibility check options object.

Parameters
[in]otherAnother accessibility check options object.

Member Function Documentation

◆ Set()

void foxit.addon.accessibility.AccessibilityCheckOptions.Set ( UInt32Array  check_rule_array,
Range  page_range 
)
inline

Set value.

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