Foxit PDF SDK
FoxitPDFSDKPython3.WatermarkSettings Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def WatermarkSettings (position, offset_x, offset_y, flags, scale_x, scale_y, rotation, opacity)
 Constructor, with parameters. More...
 
def Set (position, offset_x, offset_y, flags, scale_x, scale_y, rotation, opacity)
 Set value. More...
 

Static Public Attributes

 e_FlagASAnnot = _fsdk.WatermarkSettings_e_FlagASAnnot
 If set, the watermark will be an annotation when inserted to a PDF page.
 
 e_FlagASPageContents = _fsdk.WatermarkSettings_e_FlagASPageContents
 If set, the watermark will be a part of page content when inserted to a PDF page.
 
 e_FlagInvisible = _fsdk.WatermarkSettings_e_FlagInvisible
 If set, do not display a watermark.
 
 e_FlagNoPrint = _fsdk.WatermarkSettings_e_FlagNoPrint
 If set, do not print a watermark.
 
 e_FlagOnTop = _fsdk.WatermarkSettings_e_FlagOnTop
 If set, show watermark above other page content.
 
 e_FlagShareImageStream = _fsdk.WatermarkSettings_e_FlagShareImageStream
 If set, watermarks will share one image stream if these watermarks use the same image or bitmap.
 
 e_FlagSharePageStream = _fsdk.WatermarkSettings_e_FlagSharePageStream
 If set, watermarks will share one form xobject if these watermarks use the same page object.
 
 e_FlagShareTextStream = _fsdk.WatermarkSettings_e_FlagShareTextStream
 If set, watermarks will share one form xobject if these watermarks use the same text and text's related properties.
 
 flags = _swig_property(_fsdk.WatermarkSettings_flags_get, _fsdk.WatermarkSettings_flags_set)
 Watermark flags. More...
 
 offset_x = _swig_property(_fsdk.WatermarkSettings_offset_x_get, _fsdk.WatermarkSettings_offset_x_set)
 Horizontal offset, in points.
 
 offset_y = _swig_property(_fsdk.WatermarkSettings_offset_y_get, _fsdk.WatermarkSettings_offset_y_set)
 Vertical offset, in points.
 
 opacity = _swig_property(_fsdk.WatermarkSettings_opacity_get, _fsdk.WatermarkSettings_opacity_set)
 Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
 
 position = _swig_property(_fsdk.WatermarkSettings_position_get, _fsdk.WatermarkSettings_position_set)
 Watermark position. More...
 
 rotation = _swig_property(_fsdk.WatermarkSettings_rotation_get, _fsdk.WatermarkSettings_rotation_set)
 Rotation angle in degrees.
 
 scale_x = _swig_property(_fsdk.WatermarkSettings_scale_x_get, _fsdk.WatermarkSettings_scale_x_set)
 Horizontal scale coefficient. It should be greater than 0.001f.
 
 scale_y = _swig_property(_fsdk.WatermarkSettings_scale_y_get, _fsdk.WatermarkSettings_scale_y_set)
 Vertical scale coefficient. It should be greater than 0.001f.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ WatermarkSettings()

def FoxitPDFSDKPython3.WatermarkSettings.WatermarkSettings (   position,
  offset_x,
  offset_y,
  flags,
  scale_x,
  scale_y,
  rotation,
  opacity 
)

Constructor, with parameters.

Constructor, with another watermark settings object.

Constructor.

Parameters
[in]positionWatermark position. Please refer to values starting from FoxitPDFSDKPython3.e_PosTopLeft and this should be one of these values.
[in]offset_xHorizontal offset, in points.
[in]offset_yVertical offset, in points.
[in]flagsWatermark flags. Please refer to values starting from FoxitPDFSDKPython3.WatermarkSettings.e_FlagASPageContents and this can be one or a combination of these values.
[in]scale_xHorizontal scale coefficient. It should be greater than 0.001f.
[in]scale_yVertical scale coefficient. It should be greater than 0.001f.
[in]rotationRotation angle in degrees. It should be greater than 0.001f.
[in]opacityOpacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
[in]settingsAnother watermark settings object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython3.WatermarkSettings.Set (   position,
  offset_x,
  offset_y,
  flags,
  scale_x,
  scale_y,
  rotation,
  opacity 
)

Set value.

Parameters
[in]positionWatermark position. Please refer to values starting from FoxitPDFSDKPython3.e_PosTopLeft and this should be one of these values.
[in]offset_xHorizontal offset, in points.
[in]offset_yVertical offset, in points.
[in]flagsWatermark flags. Please refer to values starting from FoxitPDFSDKPython3.WatermarkSettings.e_FlagASPageContents and this can be one or a combination of these values.
[in]scale_xHorizontal scale coefficient. It should be greater than 0.001f.
[in]scale_yVertical scale coefficient. It should be greater than 0.001f.
[in]rotationRotation angle in degrees. It should be greater than 0.001f.
[in]opacityOpacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
Returns
None.

Member Data Documentation

◆ flags

FoxitPDFSDKPython3.WatermarkSettings.flags = _swig_property(_fsdk.WatermarkSettings_flags_get, _fsdk.WatermarkSettings_flags_set)
static

Watermark flags.

Please refer to values starting from FoxitPDFSDKPython3.WatermarkSettings.e_FlagASPageContents and this can be one or a combination of these values.

◆ position

FoxitPDFSDKPython3.WatermarkSettings.position = _swig_property(_fsdk.WatermarkSettings_position_get, _fsdk.WatermarkSettings_position_set)
static

Watermark position.

Please refer to values starting from FoxitPDFSDKPython3.e_PosTopLeft and this should be one of these values.