foxit.pdf.WatermarkSettings类 参考

继承自 SystemIDisposable .

Public 类型
enum	Flags {   Flags.e_FlagASPageContents = 0x0000, Flags.e_FlagASAnnot = 0x0001, Flags.e_FlagOnTop = 0x0002, Flags.e_FlagNoPrint = 0x0004,   Flags.e_FlagInvisible = 0x0008, Flags.e_FlagShareImageStream = 0x0010, Flags.e_FlagShareTextStream = 0x0020, Flags.e_FlagSharePageStream = 0x0040 }
	水印设置标志的枚举。 更多...

Public 成员函数
	WatermarkSettings (Position position, float offset_x, float offset_y, int flags, float scale_x, float scale_y, float rotation, int opacity, bool is_offset_centered, float relative_scale_to_page)
	带参数的构造函数。 更多...
	WatermarkSettings ()
	构造函数。
	WatermarkSettings (WatermarkSettings settings)
	带另一个水印设置对象的构造函数。 更多...
void	Set (Position position, float offset_x, float offset_y, int flags, float scale_x, float scale_y, float rotation, int opacity, bool is_offset_centered, float relative_scale_to_page)
	设置值。 更多...

属性
int	flags [get, set]
	水印标志。 更多...
bool	is_offset_centered [get, set]
	如果为 true，则 position 无效，偏移量以水印中心为基准。 如果为 false，则偏移量相对于指定 position 计算。
float	offset_x [get, set]
	水平偏移量，以点为单位。
float	offset_y [get, set]
	垂直偏移量，以点为单位。
int	opacity [get, set]
	不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。
Position	position [get, set]
	水印位置。 更多...
float	rotation [get, set]
	旋转角度，以度为单位。
float	scale_x [get, set]
	水平缩放系数。应大于0.001f。
float	scale_y [get, set]
	垂直缩放系数。应大于0.001f。

详细描述

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

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

成员枚举类型说明

Flags

enum foxit.pdf.WatermarkSettings.Flags

strong

水印设置标志的枚举。

此枚举的值可以单独使用或组合使用。 有关表单XObject的更多详情，请参考<PDF Reference 1.7>中的第4.9节"Form XObjects"。

枚举值
e_FlagASPageContents	如果设置，水印将在插入PDF页面时成为页面内容的一部分。
e_FlagASAnnot	如果设置，水印将在插入PDF页面时成为注释。
e_FlagOnTop	如果设置，在其他页面内容之上显示水印。
e_FlagNoPrint	如果设置，不打印水印。
e_FlagInvisible	如果设置，不显示水印。
e_FlagShareImageStream	如果设置，如果这些水印使用相同的图像或位图，水印将共享一个图像流。
e_FlagShareTextStream	如果设置，如果这些水印使用相同的文本和文本相关属性，水印将共享一个表单XObject。
e_FlagSharePageStream	如果设置，如果这些水印使用相同的页面对象，水印将共享一个表单XObject。

构造及析构函数说明

WatermarkSettings() [1/2]

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

inline

带参数的构造函数。

参数

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

WatermarkSettings() [2/2]

foxit.pdf.WatermarkSettings.WatermarkSettings ( WatermarkSettings  settings )

inline

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

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

参数

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

成员函数说明

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, bool  is_offset_centered, float  relative_scale_to_page  )

inline

设置值。

参数

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

返回

无。

属性说明

flags

int foxit.pdf.WatermarkSettings.flags

getset

水印标志。

请参考从 foxit.pdf.WatermarkSettings.Flags.e_FlagASPageContents 开始的值， 这可以是这些值中的一个或它们的组合。

position

Position foxit.pdf.WatermarkSettings.position

getset

水印位置。

请参考从 foxit.common.Position.e_PosTopLeft 开始的值，这应该是这些值中的一个。