Foxit PDF SDK
|
Public Member Functions | |
SchemaField () | |
Constructor. | |
SchemaField (const SchemaField &other) | |
Constructor, with another schema field object. More... | |
~SchemaField () | |
Destructor. | |
WString | GetDisplayName () const |
Get the display name. More... | |
String | GetKeyName () const |
Get the key name string. More... | |
String | GetSubtypeName () const |
Get the subtype name string. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | IsVisible () const |
Check if current field is initially visible in application or not. More... | |
bool | operator!= (const SchemaField &other) const |
Not equal operator. More... | |
SchemaField & | operator= (const SchemaField &other) |
Assign operator. More... | |
bool | operator== (const SchemaField &other) const |
Equal operator. More... | |
void | SetDisplayName (const wchar_t *display_name) |
Set the display name. More... | |
void | SetKeyName (const char *key_name) |
Set the key name string. More... | |
void | SetSubtypeName (const char *subtype_name) |
Set the subtype name string. More... | |
void | SetVisibility (bool is_visible) |
Set the initial visibility of current field in application. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
Schema field can be used to decide which information of a node is to be shown or hide in application.
foxit::pdf::portfolio::SchemaField::SchemaField | ( | const SchemaField & | other | ) |
Constructor, with another schema field object.
[in] | other | Another PDF portfolio folder object. |
WString foxit::pdf::portfolio::SchemaField::GetDisplayName | ( | ) | const |
Get the display name.
Display name is used for displaying. This can be different from schema field's key name.
String foxit::pdf::portfolio::SchemaField::GetKeyName | ( | ) | const |
Get the key name string.
Each schema field is stored by a unique key name. Schema field's key name can be used:
String foxit::pdf::portfolio::SchemaField::GetSubtypeName | ( | ) | const |
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:
bool foxit::pdf::portfolio::SchemaField::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::pdf::portfolio::SchemaField::IsVisible | ( | ) | const |
Check if current field is initially visible in application or not.
bool foxit::pdf::portfolio::SchemaField::operator!= | ( | const SchemaField & | other | ) | const |
Not equal operator.
[in] | other | Another schema field object. This function will check if current object is not equal to this one. |
SchemaField& foxit::pdf::portfolio::SchemaField::operator= | ( | const SchemaField & | other | ) |
Assign operator.
[in] | other | Another schema field object, whose value would be assigned to current object |
bool foxit::pdf::portfolio::SchemaField::operator== | ( | const SchemaField & | other | ) | const |
Equal operator.
[in] | other | Another schema field object. This function will check if current object is equal to this one. |
void foxit::pdf::portfolio::SchemaField::SetDisplayName | ( | const wchar_t * | 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. |
void foxit::pdf::portfolio::SchemaField::SetKeyName | ( | const char * | 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. |
void foxit::pdf::portfolio::SchemaField::SetSubtypeName | ( | const char * | 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. |
void foxit::pdf::portfolio::SchemaField::SetVisibility | ( | bool | 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. |