Foxit PDF SDK
FSWatermarkSettings类 参考

继承自 NSObject .

构造函数

(id) - init
 构造函数。

 
(id) - initWithPosition:offset_x:offset_y:flags:scale_x:scale_y:rotation:opacity:is_offset_centered:relative_scale_to_page:
 带参数的构造函数。
更多...
 
(id) - initWithSettings:
 带另一个水印设置对象的构造函数。
更多...
 
(void) - set:offset_x:offset_y:flags:scale_x:scale_y:rotation:opacity:is_offset_centered:relative_scale_to_page:
 设置值。
更多...
 

属性

unsigned int flags
 水印标志。
更多...
 
BOOL is_offset_centered
 如果为 true,则 position 无效,偏移量以水印中心为基准。 如果为 false,则偏移量相对于指定 position 计算。

 
float offset_x
 水平偏移量,以点为单位。

 
float offset_y
 垂直偏移量,以点为单位。

 
int opacity
 不透明度,以百分比为单位。有效范围:从0到100。 0表示完全透明,100表示完全不透明。

 
FSPosition position
 水印位置。
更多...
 
float rotation
 旋转角度,以度为单位。

 
float scale_x
 水平缩放系数。应大于0.001f。

 
float scale_y
 垂直缩放系数。应大于0.001f。

 

详细描述

此类表示用于从任何支持的资源构造水印对象的水印设置。

此类表示和OFD水印相关的位置属性。

函数文档

◆ initWithPosition:offset_x:offset_y:flags:scale_x:scale_y:rotation:opacity:is_offset_centered:relative_scale_to_page:()

- (id) initWithPosition: (FSPosition)  position
offset_x: (float)  offset_x
offset_y: (float)  offset_y
flags: (unsigned int)  flags
scale_x: (float)  scale_x
scale_y: (float)  scale_y
rotation: (float)  rotation
opacity: (int)  opacity
is_offset_centered: (BOOL)  is_offset_centered
relative_scale_to_page: (float)  relative_scale_to_page 

带参数的构造函数。

参数
[in]position水印位置。请参考从 FSPosTopLeft 开始的值, 这应该是这些值中的一个。
[in]offset_x水平偏移量,以点为单位。
[in]offset_y垂直偏移量,以点为单位。
[in]flags水印标志。请参考从 FSWatermarkSettingsFlagASPageContents 开始的值,这可以是这些值中的一个或它们的组合。
[in]scale_x水平缩放系数。应大于0.001f。
[in]scale_y垂直缩放系数。应大于0.001f。
[in]rotation旋转角度,以度为单位。
[in]opacity不透明度,以百分比为单位。有效范围:从0到100。 0表示完全透明,100表示完全不透明
[in]is_offset_centered一个布尔值,用于指示偏移量是否以水印中心为基准。 YES 表示偏移量以水印中心为基准,此时 position 参数会被忽略。 NO 表示不以水印中心为基准,而是按指定位置计算偏移。
[in]relative_scale_to_page与目标页面相对比例。有效范围:0到1(不包含0)。 如果值为0或大于1,则禁用此功能,改用scale_x/scale_y。

◆ initWithSettings:()

- (id) initWithSettings: (FSWatermarkSettings*)  settings

带另一个水印设置对象的构造函数。

构造函数,通过另一个水印位置属性对象。

参数
[in]settings另一个水印设置对象。
[in]settings另一个水印位置属性对象。

◆ set:offset_x:offset_y:flags:scale_x:scale_y:rotation:opacity:is_offset_centered:relative_scale_to_page:()

- (void) set: (FSPosition)  position
offset_x: (float)  offset_x
offset_y: (float)  offset_y
flags: (unsigned int)  flags
scale_x: (float)  scale_x
scale_y: (float)  scale_y
rotation: (float)  rotation
opacity: (int)  opacity
is_offset_centered: (BOOL)  is_offset_centered
relative_scale_to_page: (float)  relative_scale_to_page 

设置值。

参数
[in]position水印位置。请参考从 FSPosTopLeft 开始的值, 这应该是这些值中的一个。
[in]offset_x水平偏移量,以点为单位。
[in]offset_y垂直偏移量,以点为单位。
[in]flags水印标志。请参考从 FSWatermarkSettingsFlagASPageContents 开始的值,这可以是这些值中的一个或它们的组合。
[in]scale_x水平缩放系数。应大于0.001f。
[in]scale_y垂直缩放系数。应大于0.001f。
[in]rotation旋转角度,以度为单位。
[in]opacity不透明度,以百分比为单位。有效范围:从0到100。 0表示完全透明,100表示完全不透明。
[in]is_offset_centered一个布尔值,用于指示偏移量是否以水印中心为基准。 YES 表示偏移量以水印中心为基准,此时 position 参数会被忽略。 NO 表示不以水印中心为基准,而是按指定位置计算偏移。
[in]relative_scale_to_page与目标页面相对比例。有效范围:0到1(不包含0)。 如果值为0或大于1,则禁用此功能,改用scale_x/scale_y。
返回
无。

属性说明

◆ flags

- (unsigned int) flags
readwritenonatomicassign

水印标志。

请参考从 FSWatermarkSettingsFlagASPageContents 开始的值, 这可以是这些值中的一个或它们的组合。

◆ position

- (FSPosition) position
readwritenonatomicassign

水印位置。

请参考从 FSPosTopLeft 开始的值,这应该是这些值中的一个。