Foxit PDF SDK
|
Public Member Functions | |
def | SchemaField () |
Constructor. | |
def | SchemaField (other) |
Constructor, with another schema field object. More... | |
def | GetDisplayName () |
Get the display name. More... | |
def | GetKeyName () |
Get the key name string. More... | |
def | GetSubtypeName () |
Get the subtype name string. More... | |
def | IsEmpty () |
Check whether current object is empty or not. More... | |
def | IsVisible () |
Check if current field is initially visible in application or not. More... | |
def | SetDisplayName (display_name) |
Set the display name. More... | |
def | SetKeyName (key_name) |
Set the key name string. More... | |
def | SetSubtypeName (subtype_name) |
Set the subtype name string. More... | |
def | SetVisibility (is_visible) |
Set the initial visibility of current field in application. More... | |
Schema field can be used to decide which information of a node is to be shown or hide in application.
def FoxitPDFSDKPython2.SchemaField.SchemaField | ( | other | ) |
Constructor, with another schema field object.
[in] | other | Another PDF portfolio folder object. |
def FoxitPDFSDKPython2.SchemaField.GetDisplayName | ( | ) |
Get the display name.
Display name is used for displaying. This can be different from schema field's key name.
def FoxitPDFSDKPython2.SchemaField.GetKeyName | ( | ) |
Get the key name string.
Each schema field is stored by a unique key name. Schema field's key name can be used:
def FoxitPDFSDKPython2.SchemaField.GetSubtypeName | ( | ) |
Get the subtype name string.
Subtype name can be used to specify some properties of file node and folder node directly:
For other case, subtype name is used to specified the data type of an specified entry in file or folder node dictionary. The key for the entry is specified by current schema field's key name. and the data type is specified by:
def FoxitPDFSDKPython2.SchemaField.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
def FoxitPDFSDKPython2.SchemaField.IsVisible | ( | ) |
Check if current field is initially visible in application or not.
def FoxitPDFSDKPython2.SchemaField.SetDisplayName | ( | display_name | ) |
Set the display name.
Display name is used for displaying. This can be different from schema field's key name.
[in] | display_name | Display name string. This should not be an empty string. |
def FoxitPDFSDKPython2.SchemaField.SetKeyName | ( | key_name | ) |
Set the key name string.
Each schema field is stored by a unique key name. Schema field's key name can be used:
[in] | key_name | New key name string. This should not be an empty string. |
def FoxitPDFSDKPython2.SchemaField.SetSubtypeName | ( | subtype_name | ) |
Set the subtype name string.
Subtype name can be used to specify some properties of file node and folder node directly:
For other case, subtype name is used to specified the data type of an specified entry in file or folder node dictionary. The key for the entry is specified by current schema field's key name. and the data type is specified by:
[in] | subtype_name | Subtype name string. This should not be an empty string. Please refer to "Details" part for more information. |
def FoxitPDFSDKPython2.SchemaField.SetVisibility | ( | is_visible | ) |
Set the initial visibility of current field in application.
[in] | is_visible | true means current field is initially visible in application, while false means current field is initially invisible in application. |