Foxit PDF SDK
fsdk.TiledWatermarkSettings Class Reference

Public Member Functions

def GetCol_space ()
 Get the column spacing for multiple lines of tiled watermark. More...
 
def GetFlags ()
 Get watermark flags. More...
 
def GetOpacity ()
 Get opacity in percents. More...
 
def GetRotation ()
 Get rotation angle in degrees. More...
 
def GetRow_space ()
 Get the row spacing for multiple lines of tiled watermark. More...
 
def GetScale ()
 Get the image or page scale in percents. More...
 
def Set (row_space, col_space, rotation, opacity, scale, flags)
 Set value.
More...
 
def SetCol_space (value)
 Set the column spacing for multiple lines of tiled watermark. More...
 
def SetFlags (value)
 Set watermark flags. More...
 
def SetOpacity (value)
 Set opacity in percents. More...
 
def SetRotation (value)
 Set rotation angle in degrees. More...
 
def SetRow_space (value)
 Set the row spacing for multiple lines of tiled watermark. More...
 
def SetScale (value)
 Set the image or page scale in percents. More...
 

Detailed Description

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

Member Function Documentation

◆ GetCol_space()

fsdk.TiledWatermarkSettings.GetCol_space ( )

Get the column spacing for multiple lines of tiled watermark.

Returns
The column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.

◆ GetFlags()

fsdk.TiledWatermarkSettings.GetFlags ( )

Get watermark flags.

Please refer to values starting from fsdk.TiledWatermarkSettingsE_FlagAsPageContents and this can be one or a combination of these values.
Default value: fsdk.TiledWatermarkSettingsE_FlagAsPageContents .

Returns
Watermark flags.

◆ GetOpacity()

fsdk.TiledWatermarkSettings.GetOpacity ( )

Get opacity in percents.

Returns
Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.

◆ GetRotation()

fsdk.TiledWatermarkSettings.GetRotation ( )

Get rotation angle in degrees.

Returns
Rotation angle in degrees.

◆ GetRow_space()

fsdk.TiledWatermarkSettings.GetRow_space ( )

Get the row spacing for multiple lines of tiled watermark.

Returns
The row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.

◆ GetScale()

fsdk.TiledWatermarkSettings.GetScale ( )

Get the image or page scale in percents.

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

◆ Set()

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

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.
[in]flagsWatermark flags. Please refer to values starting from fsdk.TiledWatermarkSettingsE_FlagAsPageContents and this can be one or a combination of these values. Default value: fsdk.TiledWatermarkSettingsE_FlagAsPageContents .
Returns
None.

◆ SetCol_space()

fsdk.TiledWatermarkSettings.SetCol_space (   value)

Set the column spacing for multiple lines of tiled watermark.

Parameters
[in]valueThe column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
Returns
None.

◆ SetFlags()

fsdk.TiledWatermarkSettings.SetFlags (   value)

Set watermark flags.

Please refer to values starting from fsdk.TiledWatermarkSettingsE_FlagAsPageContents and this can be one or a combination of these values.
Default value: fsdk.TiledWatermarkSettingsE_FlagAsPageContents .

Parameters
[in]valueWatermark flags.
Returns
None.

◆ SetOpacity()

fsdk.TiledWatermarkSettings.SetOpacity (   value)

Set opacity in percents.

Parameters
[in]valueOpacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
Returns
None.

◆ SetRotation()

fsdk.TiledWatermarkSettings.SetRotation (   value)

Set rotation angle in degrees.

Parameters
[in]valueRotation angle in degrees.
Returns
None.

◆ SetRow_space()

fsdk.TiledWatermarkSettings.SetRow_space (   value)

Set the row spacing for multiple lines of tiled watermark.

Parameters
[in]valueThe row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
Returns
None.

◆ SetScale()

fsdk.TiledWatermarkSettings.SetScale (   value)

Set the image or page scale in percents.

Parameters
[in]valueThe 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.
Returns
None.