Foxit PDF SDK
fsdk.AccessibilityCheckResultSubItemData Class Reference

Public Member Functions

def GetDetail_data_array ()
 Get the detail items belonging to this sub-item. More...
 
def GetExplain_url ()
 Get the URL for explanation or guidance related to this sub-item. More...
 
def GetItem_full_name ()
 Get the full descriptive name of this check sub-item. More...
 
def GetItem_name ()
 Get the display name of this check sub-item. More...
 
def GetItem_rule ()
 Get the accessibility rule associated with this sub-item. More...
 
def GetItem_state ()
 Get the check state of this sub-item under the associated rule. More...
 
def Set (item_name, item_full_name, explain_url, item_rule, item_state, detail_data_array)
 Set value.
More...
 
def SetDetail_data_array (value)
 Set the detail items belonging to this sub-item. More...
 
def SetExplain_url (value)
 Set the URL for explanation or guidance related to this sub-item. More...
 
def SetItem_full_name (value)
 Set the full descriptive name of this check sub-item. More...
 
def SetItem_name (value)
 Set the display name of this check sub-item. More...
 
def SetItem_rule (value)
 Set the accessibility rule associated with this sub-item. More...
 
def SetItem_state (value)
 Set the check state of this sub-item under the associated rule. More...
 

Detailed Description

This class represents accessibility check result sub item data.

Member Function Documentation

◆ GetDetail_data_array()

fsdk.AccessibilityCheckResultSubItemData.GetDetail_data_array ( )

Get the detail items belonging to this sub-item.

Returns
The detail items belonging to this sub-item.

◆ GetExplain_url()

fsdk.AccessibilityCheckResultSubItemData.GetExplain_url ( )

Get the URL for explanation or guidance related to this sub-item.

Returns
The URL for explanation or guidance related to this sub-item.

◆ GetItem_full_name()

fsdk.AccessibilityCheckResultSubItemData.GetItem_full_name ( )

Get the full descriptive name of this check sub-item.

Returns
The full descriptive name of this check sub-item.

◆ GetItem_name()

fsdk.AccessibilityCheckResultSubItemData.GetItem_name ( )

Get the display name of this check sub-item.

Returns
The display name of this check sub-item.

◆ GetItem_rule()

fsdk.AccessibilityCheckResultSubItemData.GetItem_rule ( )

Get the accessibility rule associated with this sub-item.

Returns
The accessibility rule associated with this sub-item. Please refer to values starting from fsdk.E_RuleTypeDocPermission and this should be one of these values.

◆ GetItem_state()

fsdk.AccessibilityCheckResultSubItemData.GetItem_state ( )

Get the check state of this sub-item under the associated rule.

Returns
The check state of this sub-item under the associated rule. Please refer to values starting from fsdk.E_CheckStateNone and this should be one of these values.

◆ Set()

def fsdk.AccessibilityCheckResultSubItemData.Set (   item_name,
  item_full_name,
  explain_url,
  item_rule,
  item_state,
  detail_data_array 
)

Set value.

Parameters
[in]item_nameThe display name of this check sub-item.
[in]item_full_nameThe full descriptive name of this check sub-item.
[in]explain_urlThe URL for explanation or guidance related to this sub-item.
[in]item_ruleThe accessibility rule associated with this sub-item.
[in]item_stateThe check state of this sub-item under the associated rule.
[in]detail_data_arrayThe detail items belonging to this sub-item.
Returns
None.

◆ SetDetail_data_array()

fsdk.AccessibilityCheckResultSubItemData.SetDetail_data_array (   value)

Set the detail items belonging to this sub-item.

Parameters
[in]valueThe detail items belonging to this sub-item.
Returns
None.

◆ SetExplain_url()

fsdk.AccessibilityCheckResultSubItemData.SetExplain_url (   value)

Set the URL for explanation or guidance related to this sub-item.

Parameters
[in]valueThe URL for explanation or guidance related to this sub-item.
Returns
None.

◆ SetItem_full_name()

fsdk.AccessibilityCheckResultSubItemData.SetItem_full_name (   value)

Set the full descriptive name of this check sub-item.

Parameters
[in]valueThe full descriptive name of this check sub-item.
Returns
None.

◆ SetItem_name()

fsdk.AccessibilityCheckResultSubItemData.SetItem_name (   value)

Set the display name of this check sub-item.

Parameters
[in]valueThe display name of this check sub-item.
Returns
None.

◆ SetItem_rule()

fsdk.AccessibilityCheckResultSubItemData.SetItem_rule (   value)

Set the accessibility rule associated with this sub-item.

Parameters
[in]valueThe accessibility rule associated with this sub-item. Please refer to values starting from fsdk.E_RuleTypeDocPermission and this should be one of these values.
Returns
None.

◆ SetItem_state()

fsdk.AccessibilityCheckResultSubItemData.SetItem_state (   value)

Set the check state of this sub-item under the associated rule.

Parameters
[in]valueThe check state of this sub-item under the associated rule. Please refer to values starting from fsdk.E_CheckStateNone and this should be one of these values.
Returns
None.