FSDK::Watermark类 参考

Public 成员函数
	constructor (document, bitmap, settings)
	从指定的位图构造函数。 更多...
	constructor (document, image, frame_index, settings)
	从指定的图像构造函数。 更多...
	constructor (document, page, settings)
	从指定的页面构造函数。 更多...
	constructor (document, text, properties, settings)
	从指定的文本内容构造函数。 更多...
	GetHeight ()
	获取当前水印的原始高度。 更多...
	GetWidth ()
	获取当前水印的原始宽度。 更多...
	InsertToPage (page)
	将当前水印插入PDF页面。 更多...
	IsEmpty ()
	检查当前对象是否为空。 更多...

详细描述

此类主要用于使用指定参数构造水印，然后将其插入PDF页面。 水印对象可以从文本、位图或图像和PDF页面构造。

成员函数说明

constructor() [1/4]

FSDK::Watermark::constructor	(	document	,
		bitmap	,
		settings
	)

从指定的位图构造函数。

参数

[in]	document	一个有效的PDF文档对象，构造的水印将用于此文档。
[in]	bitmap	一个有效的位图对象，用作水印的内容。
[in]	settings	水印设置，包含布局设置。

constructor() [2/4]

FSDK::Watermark::constructor	(	document	,
		image	,
		frame_index	,
		settings
	)

从指定的图像构造函数。

参数

[in]	document	一个有效的PDF文档对象，构造的水印将用于此文档。
[in]	image	一个有效的图像对象。此图像的一个帧将用作水印的内容。 因此，此图像应至少包含一帧，且图像类型不应为 FSDK.Image.e_Unknown。
[in]	frame_index	帧索引，用于指定图像的哪一帧将用于水印。 有效范围：从0到（count-1）。count 由函数 FSDK.Image.GetFrameCount 返回。
[in]	settings	水印设置，包含布局设置。

constructor() [3/4]

FSDK::Watermark::constructor	(	document	,
		page	,
		settings
	)

从指定的页面构造函数。

参数

[in]	document	一个有效的PDF文档对象，构造的水印将用于此文档。
[in]	page	一个有效的PDF页面，其内容将用作水印的内容。
[in]	settings	水印设置，包含布局设置。

constructor() [4/4]

FSDK::Watermark::constructor	(	document	,
		text	,
		properties	,
		settings
	)

从指定的文本内容构造函数。

参数

[in]	document	一个有效的PDF文档对象，构造的水印将用于此文档。
[in]	text	一个文本字符串。这将用作水印的内容。 不应为空字符串。
[in]	properties	水印的文本属性。
[in]	settings	水印设置，包含布局设置。

GetHeight()

FSDK::Watermark::GetHeight

(

)

获取当前水印的原始高度。

水印的原始大小是基于无缩放和无旋转的。

返回

水印高度。

GetWidth()

FSDK::Watermark::GetWidth

(

)

获取当前水印的原始宽度。

水印的原始大小是基于无缩放和无旋转的。

返回

水印宽度。

InsertToPage()

FSDK::Watermark::InsertToPage

(

page

)

将当前水印插入PDF页面。

如果当前水印被视为页面内容（由构造当前水印时 FSDK.WatermarkSettings 的 flags 指定）， 在水印成功插入后，Foxit PDF SDK默认将为输入的PDF页面生成内容。在这种情况下，如果用户希望在此函数成功调用后正确渲染PDF页面， 建议用户在渲染之前以参数 is_reparse 为 true 调用函数 FSDK.PDFPage.StartParse； 否则，页面内容可能无法按预期渲染。

参数

[in]

page

一个PDF页面，当前水印将插入其中。此页面应属于与当前水印所属相同的文档。 并且页面应已经被解析。

返回

true 表示成功，而 false 表示失败。

IsEmpty()

FSDK::Watermark::IsEmpty

(

)

检查当前对象是否为空。

当前对象为空时，表示当前对象无用。

返回

true 表示当前对象为空，而 false 表示不为空。