foxit.pdf.WatermarkSettings Class Reference

Inherits SystemIDisposable.

Public Types

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

Public Member Functions

 WatermarkSettings (Position position, float offset_x, float offset_y, int flags, float scale_x, float scale_y, float rotation, int opacity)
 Constructor, with parameters.
More...
 
 WatermarkSettings ()
 Constructor.

 
 WatermarkSettings (WatermarkSettings settings)
 Constructor, with another WatermarkSettings.

 
void Set (Position position, float offset_x, float offset_y, int flags, float scale_x, float scale_y, float rotation, int opacity)
 Set value.
More...
 

Detailed Description

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

Member Enumeration Documentation

◆ Flags

Enumeration for 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.

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

◆ WatermarkSettings()

foxit.pdf.WatermarkSettings.WatermarkSettings ( Position  position,
float  offset_x,
float  offset_y,
int  flags,
float  scale_x,
float  scale_y,
float  rotation,
int  opacity 
)
inline

Constructor, with parameters.

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

Member Function Documentation

◆ Set()

void foxit.pdf.WatermarkSettings.Set ( Position  position,
float  offset_x,
float  offset_y,
int  flags,
float  scale_x,
float  scale_y,
float  rotation,
int  opacity 
)
inline

Set value.

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

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.