Foxit PDF SDK
FoxitPDFSDKPython3.TiledWatermarkSettings Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def TiledWatermarkSettings ()
 Constructor and set the default value.
More...
 
def Set (row_space, col_space, rotation, opacity, scale)
 Set value.
More...
 

Static Public Attributes

 col_space = _swig_property(_fsdk.TiledWatermarkSettings_col_space_get, _fsdk.TiledWatermarkSettings_col_space_set)
 The column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.

 
 opacity = _swig_property(_fsdk.TiledWatermarkSettings_opacity_get, _fsdk.TiledWatermarkSettings_opacity_set)
 Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.

 
 rotation = _swig_property(_fsdk.TiledWatermarkSettings_rotation_get, _fsdk.TiledWatermarkSettings_rotation_set)
 Rotation angle in degrees.

 
 row_space = _swig_property(_fsdk.TiledWatermarkSettings_row_space_get, _fsdk.TiledWatermarkSettings_row_space_set)
 The row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.

 
 scale = _swig_property(_fsdk.TiledWatermarkSettings_scale_get, _fsdk.TiledWatermarkSettings_scale_set)
 The image or page scale in percents. Valid range: from 0 to 100. 0 means not displayed, 100 means the image or page is displayed at its original size. The default value is 100.

 

Detailed Description

This class represents the watermark settings used to construct a tiled watermark from any supported resource.

Constructor & Destructor Documentation

◆ TiledWatermarkSettings()

def FoxitPDFSDKPython3.TiledWatermarkSettings.TiledWatermarkSettings ( )

Constructor and set the default value.

Constructor, with parameters.

Constructor, with another tiled watermark settings object.

By default, the watermark is not rotated and opacity is completely opaque, the row spacing and column spacing defaults to 2.0 inches. If it's an image or page watermark, display the original scale size.

Parameters
[in]settingsAnother tiled watermark settings object.

The parameter scale doesn't support text tiled watermark, and will have no effect after setting.

Parameters
[in]row_spaceThe row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
[in]col_spaceThe column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
[in]rotationRotation angle in degrees.
[in]opacityOpacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
[in]scaleThe image or page scale in percents. Valid range: from 0 to 100. 0 means not displayed, 100 means the image or page is displayed at its original scale size.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython3.TiledWatermarkSettings.Set (   row_space,
  col_space,
  rotation,
  opacity,
  scale 
)

Set value.

The parameter scale doesn't support text tiled watermark, and will have no effect after setting.

Parameters
[in]row_spaceThe row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
[in]col_spaceThe column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
[in]rotationRotation angle in degrees.
[in]opacityOpacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
[in]scaleThe image or page scale in percents. Valid range: from 0 to 100. 0 means not displayed, 100 means the image or page is displayed at its original scale size.
Returns
None.