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 WatermarkTextProperties object. More...
 
void Set (Font font, float font_size, int color, WatermarkTextProperties.FontStyle style, float line_space, Alignment alignment)
 Set value. More...
 

Detailed Description

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

Member Enumeration Documentation

◆ FontStyle

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

◆ WatermarkTextProperties() [1/2]

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

Constructor, with parameters.

Parameters
fontA valid Font object used for the text.
font_sizeFont size in points.
colorText color. Format: 0xRRGGBB.
styleFont style. It should be one of the following values:

e_FontStyleNormal
e_FontStyleUnderline

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.
alignmentText horizontal alignment. It should be one of the following values:

e_AlignmentLeft
e_AlignmentCenter
e_AlignmentRight

◆ WatermarkTextProperties() [2/2]

foxit.pdf.WatermarkTextProperties.WatermarkTextProperties ( WatermarkTextProperties  properties)
inline

Constructor, with another WatermarkTextProperties object.

Parameters
propertiesAnother WatermarkTextProperties object.

Member Function Documentation

◆ Set()

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

Set value.

Parameters
fontA valid Font object used for the text.
font_sizeFont size in points.
colorText color. Format: 0xRRGGBB.
styleFont style. It should be one of the following values:

e_FontStyleNormal
e_FontStyleUnderline

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.
alignmentText horizontal alignment. It should be one of the following values:

e_AlignmentLeft
e_AlignmentCenter
e_AlignmentRight

Returns
None.

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