Foxit PDF SDK
 All Classes Namespaces Functions Enumerations Enumerator Properties Pages
foxit.pdf.WatermarkTextProperties Class Reference

Inherits SystemIDisposable.

Public Types

enum  FontStyle { FontStyle.e_FontStyleNormal = 0, FontStyle.e_FontStyleUnderline = 1 }
 Enumeration for watermark font style. More...
 

Public Member Functions

 WatermarkTextProperties (Font font, float font_size, int color, WatermarkTextProperties.FontStyle style, float line_space, Alignment alignment)
 Constructor, with parameters. More...
 
 WatermarkTextProperties ()
 Constructor.
 
 WatermarkTextProperties (WatermarkTextProperties properties)
 Constructor, with another watermark text properties object. More...
 
void Set (Font font, float font_size, int color, WatermarkTextProperties.FontStyle style, float line_space, Alignment alignment)
 Set value. More...
 

Properties

Alignment alignment [get, set]
 Text horizontal alignment. More...
 
int color [get, set]
 Text color. Format: 0xRRGGBB.
 
Font font [get, set]
 A font object used for the text.
 
float font_size [get, set]
 Font size in points.
 
WatermarkTextProperties.FontStyle font_style [get, set]
 Font style. More...
 
float line_space [get, set]
 Space between vertical center of lines, in line heights. More...
 

Detailed Description

This class represents the watermark text settings used to construct a watermark object from text.

Member Enumeration Documentation

Enumeration for watermark font style.

Values of this enumeration should be used alone.

Enumerator
e_FontStyleNormal 

Watermark font style: normal.

e_FontStyleUnderline 

Watermark font style: with underline.

Constructor & Destructor Documentation

foxit.pdf.WatermarkTextProperties.WatermarkTextProperties ( Font  font,
float  font_size,
int  color,
WatermarkTextProperties.FontStyle  style,
float  line_space,
Alignment  alignment 
)
inline

Constructor, with parameters.

Parameters
[in]fontA valid font object used for the text.
[in]font_sizeFont size in points.
[in]colorText color. Format: 0xRRGGBB.
[in]styleFont style. It should be one of the following values:
[in]line_spaceSpace between vertical center of lines, in line heights. This value specifies the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark.
[in]alignmentText horizontal alignment. It should be one of the following values:
foxit.pdf.WatermarkTextProperties.WatermarkTextProperties ( WatermarkTextProperties  properties)
inline

Constructor, with another watermark text properties object.

Parameters
[in]propertiesAnother watermark text properties object.

Member Function Documentation

void foxit.pdf.WatermarkTextProperties.Set ( Font  font,
float  font_size,
int  color,
WatermarkTextProperties.FontStyle  style,
float  line_space,
Alignment  alignment 
)
inline

Set value.

Parameters
[in]fontA valid font object used for the text.
[in]font_sizeFont size in points.
[in]colorText color. Format: 0xRRGGBB.
[in]styleFont style. It should be one of the following values:
[in]line_spaceSpace between vertical center of lines, in line heights. This value specifies the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark.
[in]alignmentText horizontal alignment. It should be one of the following values:
Returns
None.

Property Documentation

Alignment foxit.pdf.WatermarkTextProperties.alignment
getset

Text horizontal alignment.

It should be one of the following macro definitions:

WatermarkTextProperties.FontStyle foxit.pdf.WatermarkTextProperties.font_style
getset
float foxit.pdf.WatermarkTextProperties.line_space
getset

Space between vertical center of lines, in line heights.

This value is used to specify the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark.