|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetFlags () |
| Get flags to indicate which properties of default appearance are meaningful. More... | |
| def | GetFont () |
| Get a font for default appearance. More... | |
| def | GetText_color () |
| Get text color for default appearance. More... | |
| def | GetText_size () |
| Get text size for default appearance. More... | |
| def | Set (flags, font, text_size, text_color) |
| Set value. More... | |
| def | SetFlags (value) |
| Set flags to indicate which properties of default appearance are meaningful. More... | |
| def | SetFont (value) |
| Set a font for default appearance. More... | |
| def | SetText_color (value) |
| Set text color for default appearance. More... | |
| def | SetText_size (value) |
| Set text size for default appearance. More... | |
This class represents default appearance data, which is used for free text annotation and form.
| fsdk.DefaultAppearance.GetFlags | ( | ) |
Get flags to indicate which properties of default appearance are meaningful.
Please refer to values starting from fsdk.DefaultAppearanceE_FlagFont and this can be one or a combination of these values. 0 means no property of default appearance is meaningful.
| fsdk.DefaultAppearance.GetFont | ( | ) |
Get a font for default appearance.
| fsdk.DefaultAppearance.GetText_color | ( | ) |
Get text color for default appearance.
| fsdk.DefaultAppearance.GetText_size | ( | ) |
Get 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.
| def 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.DefaultAppearanceE_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.DefaultAppearanceE_FlagFont . |
| [in] | text_size | Font size for default appearance when parameter flags includes fsdk.DefaultAppearanceE_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.SetFlags | ( | value | ) |
Set flags to indicate which properties of default appearance are meaningful.
Please refer to values starting from fsdk.DefaultAppearanceE_FlagFont and this can be one or a combination of these values. 0 means no property of default appearance is meaningful.
| [in] | value | Flags to indicate which properties of default appearance are meaningful. |
| fsdk.DefaultAppearance.SetFont | ( | value | ) |
Set a font for default appearance.
| [in] | value | A font for default appearance. It should be a valid font object when it is useful. |
| fsdk.DefaultAppearance.SetText_color | ( | value | ) |
Set text color for default appearance.
| [in] | value | Text color for default appearance. Format: 0xRRGGBB. |
| fsdk.DefaultAppearance.SetText_size | ( | value | ) |
Set 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.
| [in] | value | Text size for default appearance. |