Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit.pdf.Watermark类 参考
类 foxit.pdf.Watermark 继承关系图:

## Public 成员函数
| Watermark (PDFDoc document, string text, WatermarkTextProperties properties, WatermarkSettings settings)
| 从指定文本内容构造。 更多...
| Watermark (PDFDoc document, Bitmap bitmap, WatermarkSettings settings)
| 从指定位图构造。 更多...
| Watermark (PDFDoc document, Image image, int frame_index, WatermarkSettings settings)
| 从指定图像构造。 更多...
| Watermark (PDFDoc document, PDFPage page, WatermarkSettings settings)
| 从指定页面构造。 更多...
| Watermark (Watermark other)
| 带另一个水印对象的构造函数。 更多...
float | GetHeight ()
| 获取当前水印的原始高度。 更多...
float | GetWidth ()
| 获取当前水印的原始宽度。 更多...
bool | InsertToPage (PDFPage page)
| 将当前水印插入PDF页面。 更多...
bool | IsEmpty ()
| 检查当前对象是否为空。 更多...

## 详细描述

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

## 构造及析构函数说明

## ◆ Watermark() [1/5]

foxit.pdf.Watermark.Watermark | ( | PDFDoc | document,
|  | string | text,
|  | WatermarkTextProperties | properties,
|  | WatermarkSettings | settings
| ) |  |
| inline

从指定文本内容构造。

参数

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

## ◆ Watermark() [2/5]

foxit.pdf.Watermark.Watermark | ( | PDFDoc | document,
|  | Bitmap | bitmap,
|  | WatermarkSettings | settings
| ) |  |
| inline

从指定位图构造。

参数

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

## ◆ Watermark() [3/5]

foxit.pdf.Watermark.Watermark | ( | PDFDoc | document,
|  | Image | image,
|  | int | frame_index,
|  | WatermarkSettings | settings
| ) |  |
| inline

从指定图像构造。

参数

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

## ◆ Watermark() [4/5]

foxit.pdf.Watermark.Watermark | ( | PDFDoc | document,
|  | PDFPage | page,
|  | WatermarkSettings | settings
| ) |  |
| inline

从指定页面构造。

参数

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

## ◆ Watermark() [5/5]

foxit.pdf.Watermark.Watermark | ( | Watermark | other | ) |
| inline

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

参数

  [in] | other | 另一个水印对象。

## 成员函数说明

## ◆ GetHeight()

float foxit.pdf.Watermark.GetHeight | ( |  | ) |
| inline

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

水印的原始尺寸基于无缩放和无旋转。

返回
  水印高度。

## ◆ GetWidth()

float foxit.pdf.Watermark.GetWidth | ( |  | ) |
| inline

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

水印的原始尺寸基于无缩放和无旋转。

返回
  水印宽度。

## ◆ InsertToPage()

bool foxit.pdf.Watermark.InsertToPage | ( | PDFPage | page | ) |
| inline

将当前水印插入PDF页面。

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

参数

  [in] | page | 要插入当前水印的PDF页面。此页面应属于与当前水印所属的同一文档。 且页面应已被解析。

返回
  true表示成功，false表示失败。

## ◆ IsEmpty()

bool foxit.pdf.Watermark.IsEmpty | ( |  | ) |
| inline

检查当前对象是否为空。

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

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