Foxit PDF SDK
fsdk.DefaultAppearance Class Reference

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...
 

Detailed Description

This class represents default appearance data, which is used for free text annotation and form.

Member Function Documentation

◆ GetFlags()

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.

Returns
Flags to indicate which properties of default appearance are meaningful.

◆ GetFont()

fsdk.DefaultAppearance.GetFont ( )

Get a font for default appearance.

Note
Useful only when flags of current object includes fsdk.DefaultAppearanceE_FlagFont .
Returns
A font for default appearance. It should be a valid font object when it is useful.

◆ GetText_color()

fsdk.DefaultAppearance.GetText_color ( )

Get text color for default appearance.

Note
Useful only when flags of current object includes fsdk.DefaultAppearanceE_FlagTextColor .
Returns
Text color for default appearance. Format: 0xRRGGBB.

◆ GetText_size()

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.

Note
Useful only when flags of current object includes fsdk.DefaultAppearanceE_FlagFontSize .
Returns
Text size for default appearance.

◆ Set()

def fsdk.DefaultAppearance.Set (   flags,
  font,
  text_size,
  text_color 
)

Set value.

Parameters
[in]flagsFlags 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]fontA font for default appearance. Please ensure this is a valid font object when parameter flags includes fsdk.DefaultAppearanceE_FlagFont .
[in]text_sizeFont 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_colorText color for default appearance. Format: 0xRRGGBB.
Returns
None.

◆ SetFlags()

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.

Parameters
[in]valueFlags to indicate which properties of default appearance are meaningful.
Returns
None.

◆ SetFont()

fsdk.DefaultAppearance.SetFont (   value)

Set a font for default appearance.

Note
Useful only when flags of current object includes fsdk.DefaultAppearanceE_FlagFont .
Parameters
[in]valueA font for default appearance. It should be a valid font object when it is useful.
Returns
None.

◆ SetText_color()

fsdk.DefaultAppearance.SetText_color (   value)

Set text color for default appearance.

Note
Useful only when flags of current object includes fsdk.DefaultAppearanceE_FlagTextColor .
Parameters
[in]valueText color for default appearance. Format: 0xRRGGBB.
Returns
None.

◆ SetText_size()

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.

Note
Useful only when flags of current object includes fsdk.DefaultAppearanceE_FlagFontSize .
Parameters
[in]valueText size for default appearance.
Returns
None.