Foxit PDF SDK
FoxitPDFSDKPython2.WatermarkTextProperties Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def WatermarkTextProperties (font, font_size, color, style, line_space, alignment)
 Constructor, with parameters. More...
 
def Set (font, font_size, color, style, line_space, alignment)
 Set value. More...
 

Static Public Attributes

 alignment = _swig_property(_fsdk.WatermarkTextProperties_alignment_get, _fsdk.WatermarkTextProperties_alignment_set)
 Text horizontal alignment. More...
 
 color = _swig_property(_fsdk.WatermarkTextProperties_color_get, _fsdk.WatermarkTextProperties_color_set)
 Text color. Format: 0xRRGGBB.
 
 e_FontStyleNormal = _fsdk.WatermarkTextProperties_e_FontStyleNormal
 Watermark font style: normal.
 
 e_FontStyleUnderline = _fsdk.WatermarkTextProperties_e_FontStyleUnderline
 Watermark font style: with underline.
 
 font = _swig_property(_fsdk.WatermarkTextProperties_font_get, _fsdk.WatermarkTextProperties_font_set)
 A font object used for the text.
 
 font_size = _swig_property(_fsdk.WatermarkTextProperties_font_size_get, _fsdk.WatermarkTextProperties_font_size_set)
 Font size in points.
 
 font_style = _swig_property(_fsdk.WatermarkTextProperties_font_style_get, _fsdk.WatermarkTextProperties_font_style_set)
 Font style. More...
 
 line_space = _swig_property(_fsdk.WatermarkTextProperties_line_space_get, _fsdk.WatermarkTextProperties_line_space_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.

Constructor & Destructor Documentation

◆ WatermarkTextProperties()

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

Constructor, with parameters.

Constructor, with another watermark text properties object.

Constructor.

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:
[in]propertiesAnother watermark text properties object.

Member Function Documentation

◆ Set()

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

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.

Member Data Documentation

◆ alignment

FoxitPDFSDKPython2.WatermarkTextProperties.alignment = _swig_property(_fsdk.WatermarkTextProperties_alignment_get, _fsdk.WatermarkTextProperties_alignment_set)
static

Text horizontal alignment.

It should be one of the following macro definitions:

◆ font_style

FoxitPDFSDKPython2.WatermarkTextProperties.font_style = _swig_property(_fsdk.WatermarkTextProperties_font_style_get, _fsdk.WatermarkTextProperties_font_style_set)
static

◆ line_space

FoxitPDFSDKPython2.WatermarkTextProperties.line_space = _swig_property(_fsdk.WatermarkTextProperties_line_space_get, _fsdk.WatermarkTextProperties_line_space_set)
static

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.