Foxit PDF SDK
foxit::pdf::TiledWatermarkSettings Class Reference

Inherits Object.

Public Types

enum  Flags {
  e_FlagAsPageContents = 0x0000, e_FlagAsAnnot = 0x0001, e_FlagOnTop = 0x0002, e_FlagNoPrint = 0x0004,
  e_FlagInvisible = 0x0008
}
 Enumeration for tiled watermark setting flags. More...
 

Public Member Functions

 TiledWatermarkSettings ()
 Constructor and set the default value. More...
 
 TiledWatermarkSettings (const TiledWatermarkSettings &settings)
 Constructor, with another tiled watermark settings object. More...
 
 TiledWatermarkSettings (float row_space, float col_space, float rotation, int opacity, int scale, uint32 flags)
 Constructor, with parameters. More...
 
TiledWatermarkSettingsoperator= (const TiledWatermarkSettings &settings)
 Assign operator. More...
 
void Set (float row_space, float col_space, float rotation, int opacity, int scale, uint32 flags)
 Set value. More...
 

Public Attributes

float col_space
 The column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
 
uint32 flags
 Watermark flags. More...
 
int opacity
 Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
 
float rotation
 Rotation angle in degrees.
 
float row_space
 The row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
 
int scale
 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.

Member Enumeration Documentation

◆ Flags

Enumeration for tiled watermark setting flags.

Values of this enumeration can be used alone or in combination.

Enumerator
e_FlagAsPageContents 

If set, the watermark will be a part of page content when inserted to a PDF page.

e_FlagAsAnnot 

If set, the watermark will be an annotation when inserted to a PDF page, and the watermark will be show above other content.

e_FlagOnTop 

If set, show watermark above other page content.

e_FlagNoPrint 

If set, do not print a watermark.

e_FlagInvisible 

If set, do not display a watermark.

Constructor & Destructor Documentation

◆ TiledWatermarkSettings() [1/3]

foxit::pdf::TiledWatermarkSettings::TiledWatermarkSettings ( float  row_space,
float  col_space,
float  rotation,
int  opacity,
int  scale,
uint32  flags 
)
inlineexplicit

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

◆ 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 ( const TiledWatermarkSettings settings)
inline

Constructor, with another tiled watermark settings object.

Parameters
[in]settingsAnother tiled watermark settings object.

Member Function Documentation

◆ operator=()

TiledWatermarkSettings& foxit::pdf::TiledWatermarkSettings::operator= ( const TiledWatermarkSettings settings)
inline

Assign operator.

Parameters
[in]settingsAnother tiled watermark settings object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ Set()

void foxit::pdf::TiledWatermarkSettings::Set ( float  row_space,
float  col_space,
float  rotation,
int  opacity,
int  scale,
uint32  flags 
)
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.
[in]flagsWatermark flags. Please refer to values starting from TiledWatermarkSettings::e_FlagAsPageContents and this can be one or a combination of these values. Default value: TiledWatermarkSettings::e_FlagAsPageContents.
Returns
None.

Member Data Documentation

◆ flags

uint32 foxit::pdf::TiledWatermarkSettings::flags

Watermark flags.

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