类 FSWatermark 继承关系图:
构造函数 | |
| (float) | - getHeight |
| 获取当前水印的原始高度。 更多... | |
| (float) | - getWidth |
| 获取当前水印的原始宽度。 更多... | |
| (id) | - initWithDocument:bitmap:settings: |
| 从指定位图构造。 更多... | |
| (id) | - initWithDocument:image:frame_index:settings: |
| 从指定图像构造。 更多... | |
| (id) | - initWithDocument:page:settings: |
| 从指定页面构造。 更多... | |
| (id) | - initWithDocument:text:properties:settings: |
| 从指定文本内容构造。 更多... | |
| (id) | - initWithOther: |
| 带另一个水印对象的构造函数。 更多... | |
| (BOOL) | - insertToPage: |
| 将当前水印插入PDF页面。 更多... | |
| (BOOL) | - isEmpty |
| 检查当前对象是否为空。 更多... | |
详细描述
此类主要用于构造具有指定参数的水印，然后将其插入到PDF页面中。 水印对象可以从文本、位图或图像以及PDF页面构造。
函数文档
◆ getHeight()
| - (float) getHeight |
获取当前水印的原始高度。
水印的原始尺寸基于无缩放和无旋转。
- 返回
- 水印高度。
◆ getWidth()
| - (float) getWidth |
获取当前水印的原始宽度。
水印的原始尺寸基于无缩放和无旋转。
- 返回
- 水印宽度。
◆ initWithDocument:bitmap:settings:()
| - (id) initWithDocument: | (FSPDFDoc*) | document | |
| bitmap: | (FSBitmap*) | bitmap | |
| settings: | (FSWatermarkSettings*) | settings | |
从指定位图构造。
- 参数
-
[in] document 有效的PDF文档对象，构造的水印将用于此对象。
[in] bitmap 用作水印内容的有效位图对象。
[in] settings 水印设置，包含布局设置。
◆ initWithDocument:image:frame_index:settings:()
| - (id) initWithDocument: | (FSPDFDoc*) | document | |
| image: | (FSImage*) | image | |
| frame_index: | (int) | frame_index | |
| settings: | (FSWatermarkSettings*) | settings | |
从指定图像构造。
- 参数
-
[in] document 有效的PDF文档对象，构造的水印将用于此对象。
[in] image 有效的图像对象。此图像的一帧将用作 水印的内容。因此，此图像应至少包含一帧， 且图像类型不应为FSImageUnknown。
[in] frame_index 帧索引，指定图像的哪一帧将用于水印。 有效范围：从0到(count-1)。count由 FSImage::getFrameCount函数返回。
[in] settings 水印设置，包含布局设置。
◆ initWithDocument:page:settings:()
| - (id) initWithDocument: | (FSPDFDoc*) | document | |
| page: | (FSPDFPage*) | page | |
| settings: | (FSWatermarkSettings*) | settings | |
从指定页面构造。
- 参数
-
[in] document 有效的PDF文档对象，构造的水印将用于此对象。
[in] page 有效的PDF页面，其内容将用作水印的内容。
[in] settings 水印设置，包含布局设置。
◆ initWithDocument:text:properties:settings:()
| - (id) initWithDocument: | (FSPDFDoc*) | document | |
| text: | (NSString *) | text | |
| properties: | (FSWatermarkTextProperties*) | properties | |
| settings: | (FSWatermarkSettings*) | settings | |
从指定文本内容构造。
- 参数
-
[in] document 有效的PDF文档对象，构造的水印将用于此对象。
[in] text 文本字符串。这将用作水印的内容。 不应为空字符串。
[in] properties 水印的文本属性。
[in] settings 水印设置，包含布局设置。
◆ initWithOther:()
| - (id) initWithOther: | (FSWatermark*) | other |
带另一个水印对象的构造函数。
- 参数
-
[in] other 另一个水印对象。
◆ insertToPage:()
| - (BOOL) insertToPage: | (FSPDFPage*) | page |
将当前水印插入PDF页面。
如果当前水印被视为页面内容（这由构造当前水印时FSWatermarkSettings 的flags指定）， Foxit PDF SDK在水印成功插入后默认会为输入的PDF页面生成内容。在这种情况下， 如果用户希望在此函数成功调用后正确渲染PDF页面，建议用户在渲染前 调用FSPDFPage::startParse:pause:is_reparse:函数，参数is_reparse为YES； 否则，页面内容可能无法按预期渲染。
- 参数
-
[in] page 要插入当前水印的PDF页面。此页面应属于与当前水印所属的同一文档。 且页面应已被解析。
- 返回
- YES表示成功，NO表示失败。
◆ isEmpty()
| - (BOOL) isEmpty |
检查当前对象是否为空。
当当前对象为空时，表示当前对象无用。
- 返回
- YES表示当前对象为空，NO表示不为空。
