Foxit PDF SDK
|
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. | |
This class represents the watermark settings used to construct a watermark object from any supported resource.
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.
[in] | position | Watermark position. Please refer to values starting from FoxitPDFSDKPython3.e_PosTopLeft and this should be one of these values. |
[in] | offset_x | Horizontal offset, in points. |
[in] | offset_y | Vertical offset, in points. |
[in] | flags | Watermark flags. Please refer to values starting from FoxitPDFSDKPython3.WatermarkSettings.e_FlagASPageContents and this can be one or a combination of these values. |
[in] | scale_x | Horizontal scale coefficient. It should be greater than 0.001f. |
[in] | scale_y | Vertical scale coefficient. It should be greater than 0.001f. |
[in] | rotation | Rotation angle in degrees. It should be greater than 0.001f. |
[in] | opacity | Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque. |
[in] | settings | Another watermark settings object. |
def FoxitPDFSDKPython3.WatermarkSettings.Set | ( | position, | |
offset_x, | |||
offset_y, | |||
flags, | |||
scale_x, | |||
scale_y, | |||
rotation, | |||
opacity | |||
) |
Set value.
[in] | position | Watermark position. Please refer to values starting from FoxitPDFSDKPython3.e_PosTopLeft and this should be one of these values. |
[in] | offset_x | Horizontal offset, in points. |
[in] | offset_y | Vertical offset, in points. |
[in] | flags | Watermark flags. Please refer to values starting from FoxitPDFSDKPython3.WatermarkSettings.e_FlagASPageContents and this can be one or a combination of these values. |
[in] | scale_x | Horizontal scale coefficient. It should be greater than 0.001f. |
[in] | scale_y | Vertical scale coefficient. It should be greater than 0.001f. |
[in] | rotation | Rotation angle in degrees. It should be greater than 0.001f. |
[in] | opacity | Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque. |
|
static |
Watermark flags.
Please refer to values starting from FoxitPDFSDKPython3.WatermarkSettings.e_FlagASPageContents and this can be one or a combination of these values.
|
static |
Watermark position.
Please refer to values starting from FoxitPDFSDKPython3.e_PosTopLeft and this should be one of these values.