Foxit PDF SDK
fsdk.WatermarkTextProperties Class Reference

Public Member Functions

def GetAlignment ()
 Get text horizontal alignment. More...
 
def GetColor ()
 Get text color. More...
 
def GetFont ()
 Get a font object used for the text. More...
 
def GetFont_size ()
 Get font size in points. More...
 
def GetFont_style ()
 Get font style. More...
 
def GetLine_space ()
 Get space between vertical center of lines, in line heights. More...
 
def Set (font, font_size, color, style, line_space, alignment)
 Set value. More...
 
def SetAlignment (value)
 Set text horizontal alignment. More...
 
def SetColor (value)
 Set text color. More...
 
def SetFont (value)
 Set a font object used for the text. More...
 
def SetFont_size (value)
 Set font size in points. More...
 
def SetFont_style (value)
 Set font style. More...
 
def SetLine_space (value)
 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 Function Documentation

◆ GetAlignment()

fsdk.WatermarkTextProperties.GetAlignment ( )

Get text horizontal alignment.

It should be one of the following macro definitions:

Returns
Text horizontal alignment. The default value is fsdk.E_AlignmentLeft .

◆ GetColor()

fsdk.WatermarkTextProperties.GetColor ( )

Get text color.

Returns
Text color. Format: 0xRRGGBB. The default value is 0x000000.

◆ GetFont()

fsdk.WatermarkTextProperties.GetFont ( )

Get a font object used for the text.

Returns
A font object used for the text.

◆ GetFont_size()

fsdk.WatermarkTextProperties.GetFont_size ( )

Get font size in points.

Returns
Font size in points. The default value is 24.0.

◆ GetFont_style()

fsdk.WatermarkTextProperties.GetFont_style ( )

Get font style.

It should be one of the following values:

Returns
Font style.The default value is fsdk.WatermarkTextPropertiesE_FontStyleNormal .

◆ GetLine_space()

fsdk.WatermarkTextProperties.GetLine_space ( )

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

Returns
Space between vertical center of lines, in line heights. The default value is 1.0.

◆ Set()

def fsdk.WatermarkTextProperties.Set (   font,
  font_size,
  color,
  style,
  line_space,
  alignment 
)

Set value.

The parameters line_space and alignment don't support tiled watermark, and will have no effect after setting.

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.

◆ SetAlignment()

fsdk.WatermarkTextProperties.SetAlignment (   value)

Set text horizontal alignment.

It should be one of the following macro definitions:

Parameters
[in]valueText horizontal alignment. The default value is fsdk.E_AlignmentLeft .
Returns
None.

◆ SetColor()

fsdk.WatermarkTextProperties.SetColor (   value)

Set text color.

Parameters
[in]valueText color. Format: 0xRRGGBB. The default value is 0x000000.
Returns
None.

◆ SetFont()

fsdk.WatermarkTextProperties.SetFont (   value)

Set a font object used for the text.

Parameters
[in]valueA font object used for the text.
Returns
None.

◆ SetFont_size()

fsdk.WatermarkTextProperties.SetFont_size (   value)

Set font size in points.

Parameters
[in]valueFont size in points. The default value is 24.0.
Returns
None.

◆ SetFont_style()

fsdk.WatermarkTextProperties.SetFont_style (   value)

Set font style.

It should be one of the following values:

Parameters
[in]valueFont style.The default value is fsdk.WatermarkTextPropertiesE_FontStyleNormal .
Returns
None.

◆ SetLine_space()

fsdk.WatermarkTextProperties.SetLine_space (   value)

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

Parameters
[in]valueSpace between vertical center of lines, in line heights. The default value is 1.0.
Returns
None.