foxit.pdf.annots.DefaultAppearance Class Reference

Inherits SystemIDisposable.

Public Types

enum  Flags { Flags.e_FlagFont = 0x0001, Flags.e_FlagTextColor = 0x0002, Flags.e_FlagFontSize = 0x0004 }
 Enumeration for default appearance flags.
More...
 

Public Member Functions

 DefaultAppearance (int flags, Font font, float text_size, int text_color)
 Constructor, with parameters. More...
 
 DefaultAppearance ()
 Constructor.

 
 DefaultAppearance (DefaultAppearance default_appearance)
 Constructor, with another DefaultAppearance object. More...
 
void Set (int flags, Font font, float text_size, int text_color)
 Set value. More...
 

Detailed Description

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

Member Enumeration Documentation

◆ Flags

Enumeration for default appearance flags.

Values of this enumeration can be used alone or in combination.

Enumerator
e_FlagFont 

Indicates property pdf::DefaultAppearance::GetFont is meaningful.

e_FlagTextColor 

Indicates property pdf::DefaultAppearance::text_color is meaningful.

e_FlagFontSize 

Indicates property pdf::DefaultAppearance::text_size is meaningful.

Constructor & Destructor Documentation

◆ DefaultAppearance() [1/2]

foxit.pdf.annots.DefaultAppearance.DefaultAppearance ( int  flags,
Font  font,
float  text_size,
int  text_color 
)
inline

Constructor, with parameters.

Parameters
flagsFlags to indicate which properties of DefaultAppearance are meaningful. Please refer to e_FlagXXX values and this can be one or a combination of these values.
fontA valid Font object for default appearance when parameter flags includes e_FlagFont.
text_sizeFont size for default appearance. Please ensure this is above 0 when parameter flags includes e_FlagFontSize.
text_colorText color for default appearance. Format: 0xRRGGBB.

◆ DefaultAppearance() [2/2]

foxit.pdf.annots.DefaultAppearance.DefaultAppearance ( DefaultAppearance  default_appearance)
inline

Constructor, with another DefaultAppearance object.

Parameters
default_appearanceAnother DefaultAppearance object.

Member Function Documentation

◆ Set()

void foxit.pdf.annots.DefaultAppearance.Set ( int  flags,
Font  font,
float  text_size,
int  text_color 
)
inline

Set value.

Parameters
flagsFlags to indicate which properties of DefaultAppearance are meaningful. Please refer to e_FlagXXX values and this can be one or a combination of these values.
fontFont for default appearance. Please ensure this is a valid Font object when parameter flags includes e_FlagFont.
text_sizeText size for default appearance. Please ensure this is above 0 when parameter flags includes e_FlagFontSize.
text_colorText color for default appearance. Format: 0xRRGGBB.
Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.