Foxit PDF SDK
foxit.pdf.TiledWatermarkSettings Class Reference

Inherits SystemIDisposable.

Public Member Functions

 TiledWatermarkSettings (float row_space, float col_space, float rotation, int opacity, int scale)
 Constructor, with parameters. More...
 
 TiledWatermarkSettings ()
 Constructor and set the default value. More...
 
 TiledWatermarkSettings (TiledWatermarkSettings settings)
 Constructor, with another tiled watermark settings object. More...
 
void Set (float row_space, float col_space, float rotation, int opacity, int scale)
 Set value. More...
 

Properties

float col_space [get, set]
 The column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
 
int opacity [get, set]
 Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
 
float rotation [get, set]
 Rotation angle in degrees.
 
float row_space [get, set]
 The row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
 
int scale [get, 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() [1/3]

foxit.pdf.TiledWatermarkSettings.TiledWatermarkSettings ( float  row_space,
float  col_space,
float  rotation,
int  opacity,
int  scale 
)
inline

Constructor, with parameters.

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.

◆ TiledWatermarkSettings() [2/3]

foxit.pdf.TiledWatermarkSettings.TiledWatermarkSettings ( )
inline

Constructor and set the default value.

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.

◆ TiledWatermarkSettings() [3/3]

foxit.pdf.TiledWatermarkSettings.TiledWatermarkSettings ( TiledWatermarkSettings  settings)
inline

Constructor, with another tiled watermark settings object.

Parameters
[in]settingsAnother tiled watermark settings object.

Member Function Documentation

◆ Set()

void foxit.pdf.TiledWatermarkSettings.Set ( float  row_space,
float  col_space,
float  rotation,
int  opacity,
int  scale 
)
inline

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.