Instance Methods | |
| (BOOL) | - canFixPermissionRules:is_ocr_enabled: |
| Check whether permission rules can be fixed. More... | |
| (BOOL) | - canFixRules:check_state: |
| Check whether specified rules can be fixed. More... | |
| (BOOL) | - fixDocumentBookmark: |
| Fix document bookmark. More... | |
| (BOOL) | - fixDocumentLanguage: |
| Fix document language. More... | |
| (BOOL) | - fixDocumentPermission |
| Fix document permission. More... | |
| (BOOL) | - fixDocumentTag |
| Fix document tag. More... | |
| (BOOL) | - fixDocumentTitle:subject:author:keywords: |
| Fix document title. More... | |
| (NSString *) | - fixDocumentTitleWithExistingTitle |
| Fix document title with existing title. More... | |
| (BOOL) | - fixFigureAltText: |
| 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... | |
| (id) | - initWithOther: |
| Constructor, with another fixer object. More... | |
| (id) | - initWithPdf_doc: |
| Constructor. 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 FSLibrary::initialize:key: with a key including "Accessibility" module.
- See also
- FSLibrary
Method Documentation
◆ canFixPermissionRules:is_ocr_enabled:()
| - (BOOL) canFixPermissionRules: | (FSRuleType) | check_rule | |
| is_ocr_enabled: | (BOOL) | is_ocr_enabled | |
Check whether permission rules can be fixed.
- Parameters
-
[in] check_rule The check rule type.
[in] is_ocr_enabled Whether OCR is enabled.
- Returns
- YES means permission rules can be fixed, while NO means not.
◆ canFixRules:check_state:()
| - (BOOL) canFixRules: | (FSRuleType) | check_rule | |
| check_state: | (FSCheckState) | check_state | |
Check whether specified rules can be fixed.
- Parameters
-
[in] check_rule The check rule type.
[in] check_state The check state.
- Returns
- YES means the rules can be fixed, while NO means not.
◆ fixDocumentBookmark:()
| - (BOOL) fixDocumentBookmark: | (NSArray<NSString *> *) | roles_array |
Fix document bookmark.
- Parameters
-
[in] roles_array The roles array.
- Returns
- YES means success, while NO means not.
◆ fixDocumentLanguage:()
| - (BOOL) fixDocumentLanguage: | (NSString *) | lang |
Fix document language.
- Parameters
-
[in] lang The language to set.
- Returns
- YES means success, while NO means not.
◆ fixDocumentPermission()
| - (BOOL) fixDocumentPermission |
Fix document permission.
- Returns
- YES means success, while NO means not.
◆ fixDocumentTag()
| - (BOOL) fixDocumentTag |
Fix document tag.
- Returns
- YES means success, while NO means not.
◆ fixDocumentTitle:subject:author:keywords:()
| - (BOOL) fixDocumentTitle: | (NSString *) | title | |
| subject: | (NSString *) | subject | |
| author: | (NSString *) | author | |
| keywords: | (NSString *) | keywords | |
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
- YES means success, while NO means not.
◆ fixDocumentTitleWithExistingTitle()
| - (NSString *) fixDocumentTitleWithExistingTitle |
Fix document title with existing title.
- Returns
- The existing title text.
◆ fixFigureAltText:()
| - (BOOL) fixFigureAltText: | (FSAccessibilityCheckResultDetailDataArray*) | detail_data_array |
Fix figure alternate text.
- Parameters
-
[in] detail_data_array The check result detail data array.
- Returns
- YES means success, while NO means not.
◆ fixFormFieldDescriptions()
| - (BOOL) fixFormFieldDescriptions |
Fix form field descriptions.
- Returns
- YES means success, while NO means not.
◆ fixFormFieldTagged()
| - (BOOL) fixFormFieldTagged |
Fix form field tagged.
- Returns
- YES means success, while NO means not.
◆ fixPageTabOrder()
| - (BOOL) fixPageTabOrder |
Fix page tab order.
- Returns
- YES means success, while NO means not.
◆ initWithOther:()
| - (id) initWithOther: | (FSAccessibilityFixer*) | other |
Constructor, with another fixer object.
- Parameters
-
[in] other Another fixer object.
◆ initWithPdf_doc:()
| - (id) initWithPdf_doc: | (FSPDFDoc*) | pdf_doc |
Constructor.
- Parameters
-
[in] pdf_doc A valid PDF document object.
◆ isEmpty()
| - (BOOL) isEmpty |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- Returns
- YES means current object is empty, while NO means not.
