Foxit PDF SDK  9.1
FSTiledWatermarkSettings Class Reference
Inheritance diagram for FSTiledWatermarkSettings:

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 Constructor and set the default value.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithRow_space:col_space:rotation:opacity:scale:flags:
 Constructor, with parameters.
More...
 
(id) - initWithSettings:
 Constructor, with another tiled watermark settings object.
More...
 
(void) - set:col_space:rotation:opacity:scale:flags:
 Set value.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

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

Detailed Description

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

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

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.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

◆ initWithRow_space:col_space:rotation:opacity:scale:flags:

- (id) initWithRow_space: (float)  row_space
col_space: (float)  col_space
rotation: (float)  rotation
opacity: (int)  opacity
scale: (int)  scale
flags: (unsigned int)  flags 

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 FSTiledWatermarkSettingsFlagAsPageContents and this can be one or a combination of these values. Default value: FSTiledWatermarkSettingsFlagAsPageContents.

◆ initWithSettings:

- (id) initWithSettings: (FSTiledWatermarkSettings*)  settings

Constructor, with another tiled watermark settings object.

Parameters
[in]settingsAnother tiled watermark settings object.

◆ set:col_space:rotation:opacity:scale:flags:

- (void) set: (float)  row_space
col_space: (float)  col_space
rotation: (float)  rotation
opacity: (int)  opacity
scale: (int)  scale
flags: (unsigned int)  flags 

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 FSTiledWatermarkSettingsFlagAsPageContents and this can be one or a combination of these values. Default value: FSTiledWatermarkSettingsFlagAsPageContents.
Returns
None.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ col_space

- (float) col_space
readwritenonatomicassign

The column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.

◆ flags

- (unsigned int) flags
readwritenonatomicassign

Watermark flags.

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

◆ opacity

- (int) opacity
readwritenonatomicassign

Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.

◆ rotation

- (float) rotation
readwritenonatomicassign

Rotation angle in degrees.

◆ row_space

- (float) row_space
readwritenonatomicassign

The row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.

◆ scale

- (int) scale
readwritenonatomicassign

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.