|
Foxit PDF SDK
|
Public Member Functions | |
| constructor (flags, font, text_size, text_color) | |
| Constructor, with parameters. More... | |
| constructor () | |
| Constructor. | |
| Set (flags, font, text_size, text_color) | |
| Set value. More... | |
Public Attributes | |
| flags | |
| Flags to indicate which properties of default appearance are meaningful. More... | |
| font | |
| A font for default appearance. It should be a valid font object when it is useful. More... | |
| text_color | |
| Text color for default appearance. Format: 0xRRGGBB. More... | |
| text_size | |
| Text size for default appearance. More... | |
Static Public Attributes | |
| static | e_FlagFont |
| Enumeration for default appearance flags. More... | |
| static | e_FlagFontSize |
| Indicates property text size of FSDK.DefaultAppearance is meaningful. | |
| static | e_FlagTextColor |
| Indicates property text color of FSDK.DefaultAppearance is meaningful. | |
This class represents default appearance data, which is used for free text annotation and form.
| FSDK.DefaultAppearance.constructor | ( | flags | , |
| font | , | ||
| text_size | , | ||
| text_color | |||
| ) |
Constructor, with parameters.
| [in] | flags | Flags to indicate which properties of default appearance are meaningful. Please refer to values starting from FSDK.DefaultAppearance.e_FlagFont and this can be one or a combination of these values. |
| [in] | font | A valid font object for default appearance when parameter flags includes FSDK.DefaultAppearance.e_FlagFont. |
| [in] | text_size | Font size for default appearance when parameter flags includes FSDK.DefaultAppearance.e_FlagFontSize. Usually it should be above 0. For some objects, the size 0 has special meaning. Please refer to the comment of functions which are used to set default appearance data to other object. |
| [in] | text_color | Text color for default appearance. Format: 0xRRGGBB. |
| FSDK.DefaultAppearance.Set | ( | flags | , |
| font | , | ||
| text_size | , | ||
| text_color | |||
| ) |
Set value.
| [in] | flags | Flags to indicate which properties of default appearance are meaningful. Please refer to values starting from FSDK.DefaultAppearance.e_FlagFont and this can be one or a combination of these values. |
| [in] | font | A font for default appearance. Please ensure this is a valid font object when parameter flags includes FSDK.DefaultAppearance.e_FlagFont. |
| [in] | text_size | Font size for default appearance when parameter flags includes FSDK.DefaultAppearance.e_FlagFontSize. Usually it should be above 0. For some objects, the size 0 has special meaning. Please refer to the comment of functions which are used to set default appearance data to other object. |
| [in] | text_color | Text color for default appearance. Format: 0xRRGGBB. |
|
static |
Enumeration for default appearance flags.
Values of this enumeration can be used alone or in combination.Indicates property font of FSDK.DefaultAppearance is meaningful.
| FSDK.DefaultAppearance.flags |
Flags to indicate which properties of default appearance are meaningful.
Please refer to values starting from FSDK.DefaultAppearance.e_FlagFont and this can be one or a combination of these values. 0 means no property of default appearance is meaningful.
| FSDK.DefaultAppearance.font |
A font for default appearance. It should be a valid font object when it is useful.
| FSDK.DefaultAppearance.text_color |
Text color for default appearance. Format: 0xRRGGBB.
| FSDK.DefaultAppearance.text_size |
Text size for default appearance.
Usually it should be above 0 when it is useful. For some objects, the size 0 has special meaning. Please refer to the comment of functions which are used to set default appearance data to other object.