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

Inherits SystemIDisposable.

Public Types

enum  DictionaryValueType {
  DictionaryValueType.e_DictionaryValueTypeArray = 0, DictionaryValueType.e_DictionaryValueTypeBoolean = 1, DictionaryValueType.e_DictionaryValueTypeDictionary = 2, DictionaryValueType.e_DictionaryValueTypeFixedPoint = 3,
  DictionaryValueType.e_DictionaryValueTypeInt = 4, DictionaryValueType.e_DictionaryValueTypeName = 5, DictionaryValueType.e_DictionaryValueTypeString = 6, DictionaryValueType.e_DictionaryValueTypeDocClass = 7,
  DictionaryValueType.e_DictionaryValueTypeAttributeObject = 8, DictionaryValueType.e_DictionaryValueTypeAttributeClassesRoot = 9, DictionaryValueType.e_DictionaryValueTypeDocumentClassesRoot = 10, DictionaryValueType.e_DictionaryValueTypeAttributeObjectsRoot = 11
}
 Enumeration for dictionary value type. More...
 
enum  TreeItemStatus { TreeItemStatus.e_TreeItemStatusNormal = 0, TreeItemStatus.e_TreeItemStatusAdd = 1, TreeItemStatus.e_TreeItemStatusDelete = 2, TreeItemStatus.e_TreeItemStatusChange = 3 }
 Enumeration for the edit status of a dictionary tree item. More...
 

Public Member Functions

 AccessibilityDictionaryTreeItemData ()
 Constructor.
 
 AccessibilityDictionaryTreeItemData (string item_name, string item_id, string key, string value, AccessibilityDictionaryTreeItemData.DictionaryValueType value_type, AccessibilityDictionaryTreeItemData.TreeItemStatus status)
 Constructor, with parameters. More...
 
 AccessibilityDictionaryTreeItemData (AccessibilityDictionaryTreeItemData other)
 Constructor, with another accessibility dictionary tree item data object. More...
 
void Set (string item_name, string item_id, string key, string value, AccessibilityDictionaryTreeItemData.DictionaryValueType value_type, AccessibilityDictionaryTreeItemData.TreeItemStatus status)
 Set value. More...
 

Properties

string item_id [get, set]
 The item ID.
 
string item_name [get, set]
 The item name.
 
string key [get, set]
 The dictionary key.
 
AccessibilityDictionaryTreeItemData.TreeItemStatus status [get, set]
 The edit status of the tree item. Please refer to values starting from foxit.addon.accessibility.AccessibilityDictionaryTreeItemData.TreeItemStatus.e_TreeItemStatusNormal and this should be one of these values.
 
string value [get, set]
 The dictionary value.
 
AccessibilityDictionaryTreeItemData.DictionaryValueType value_type [get, set]
 The dictionary value type. Please refer to values starting from foxit.addon.accessibility.AccessibilityDictionaryTreeItemData.DictionaryValueType.e_DictionaryValueTypeArray and this should be one of these values.
 

Detailed Description

This class represents accessibility dictionary tree item data.

Member Enumeration Documentation

◆ DictionaryValueType

Enumeration for dictionary value type.

Values of this enumeration should be used alone.

Enumerator
e_DictionaryValueTypeArray 

Dictionary value type: array.

e_DictionaryValueTypeBoolean 

Dictionary value type: boolean.

e_DictionaryValueTypeDictionary 

Dictionary value type: dictionary/object.

e_DictionaryValueTypeFixedPoint 

Dictionary value type: fixed point number.

e_DictionaryValueTypeInt 

Dictionary value type: integer.

e_DictionaryValueTypeName 

Dictionary value type: name object.

e_DictionaryValueTypeString 

Dictionary value type: string object.

e_DictionaryValueTypeDocClass 

Dictionary value type: document class.

e_DictionaryValueTypeAttributeObject 

Dictionary value type: attribute object.

e_DictionaryValueTypeAttributeClassesRoot 

Dictionary value type: attribute classes root.

e_DictionaryValueTypeDocumentClassesRoot 

Dictionary value type: document classes root.

e_DictionaryValueTypeAttributeObjectsRoot 

Dictionary value type: attribute objects root.

◆ TreeItemStatus

Enumeration for the edit status of a dictionary tree item.

Values of this enumeration should be used alone.

Enumerator
e_TreeItemStatusNormal 

Edit status: normal, the item is unchanged.

e_TreeItemStatusAdd 

Edit status: added, the item is newly added.

e_TreeItemStatusDelete 

Edit status: deleted, the item is marked as deleted.

e_TreeItemStatusChange 

Edit status: changed, the item value has been modified.

Constructor & Destructor Documentation

◆ AccessibilityDictionaryTreeItemData() [1/2]

foxit.addon.accessibility.AccessibilityDictionaryTreeItemData.AccessibilityDictionaryTreeItemData ( string  item_name,
string  item_id,
string  key,
string  value,
AccessibilityDictionaryTreeItemData.DictionaryValueType  value_type,
AccessibilityDictionaryTreeItemData.TreeItemStatus  status 
)
inline

Constructor, with parameters.

Parameters
[in]item_nameThe item name.
[in]item_idThe item ID.
[in]keyThe dictionary key.
[in]valueThe dictionary value.
[in]value_typeThe dictionary value type.
[in]statusThe status.

◆ AccessibilityDictionaryTreeItemData() [2/2]

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

Constructor, with another accessibility dictionary tree item data object.

Parameters
[in]otherAnother accessibility dictionary tree item data object.

Member Function Documentation

◆ Set()

void foxit.addon.accessibility.AccessibilityDictionaryTreeItemData.Set ( string  item_name,
string  item_id,
string  key,
string  value,
AccessibilityDictionaryTreeItemData.DictionaryValueType  value_type,
AccessibilityDictionaryTreeItemData.TreeItemStatus  status 
)
inline

Set value.

Parameters
[in]item_nameThe item name.
[in]item_idThe item ID.
[in]keyThe dictionary key.
[in]valueThe dictionary value.
[in]value_typeThe dictionary value type.
[in]statusThe status.
Returns
None.