Foxit PDF SDK

Public 成员函数 | Public 属性 | 静态 Public 属性 | 所有成员列表
FSDK::BorderInfo类 参考

## Public 成员函数
| constructor ()
| 构造函数。
| constructor (width, style, intensity, dash_phase, dashes)
| 带参数的构造函数。 更多...
| Set (width, style, intensity, dash_phase, dashes)
| 设置值。 更多...

## Public 属性
| cloud_intensity
| 云形效果的强度。 更多...
| dash_phase
| 虚线相位。 更多...
| dashes
| 表示虚线模式的虚线数组。 更多...
| style
| 边框样式。请参阅从 FSDK.BorderInfo.e_Solid 开始的值， 这应该是这些值之一。请同时查看这些值的注释以获取更多详细信息。
| width
| 边框宽度，以点为单位。 更多...

## 静态 Public 属性
static | e_Beveled
| 边框样式：斜面。 更多...
static | e_Cloudy
| 边框样式：云形。 更多...
static | e_Dashed
| 边框样式：虚线。 更多...
static | e_Inset
| 边框样式：嵌入。 更多...
static | e_Solid
| Enumeration for PDF annotation border style. 更多...
static | e_UnderLine
| 边框样式：下划线。 更多...

## 详细描述

此类表示注释边框信息。

## 成员函数说明

## ◆ constructor()

FSDK::BorderInfo::constructor | ( | width | ,
|  | style | ,
|  | intensity | ,
|  | dash_phase | ,
|  | dashes |
| ) |  |

带参数的构造函数。

参数

  [in] | width | 边框宽度，以点为单位。这应该是一个非负值。 如果此值为0，则不绘制边框。
  [in] | style | 边框样式。请参阅从 FSDK.BorderInfo.e_Solid 开始的值， 这应该是这些值之一。
  [in] | intensity | 云形效果的强度。仅在参数 style 为 FSDK.BorderInfo.e_Cloudy 时有用。有效值范围：0到2。 0表示没有云形边框效果。 如果值低于0，它将具有与值0相同的效果。 如果值高于2，它将具有与值2相同的效果。
  [in] | dash_phase | 虚线相位。仅在参数 style 为 FSDK.BorderInfo.e_Dashed 时有用。
  [in] | dashes | 表示虚线模式的虚线数组。此数组中每个元素的值 不应为负值。仅在 style 为 FSDK.BorderInfo.e_Dashed 时有用。

## ◆ Set()

FSDK::BorderInfo::Set | ( | width | ,
|  | style | ,
|  | intensity | ,
|  | dash_phase | ,
|  | dashes |
| ) |  |

设置值。

参数

  [in] | width | 边框宽度，以点为单位。这应该是一个非负值。 如果此值为0，则不绘制边框。
  [in] | style | 边框样式。请参阅从 FSDK.BorderInfo.e_Solid 开始的值， 这应该是这些值之一。
  [in] | intensity | 云形效果的强度。仅在参数 style 为 FSDK.BorderInfo.e_Cloudy 时有用。有效值范围：0到2。 0表示没有云形边框效果。 如果值低于0，它将具有与值0相同的效果。 如果值高于2，它将具有与值2相同的效果。
  [in] | dash_phase | 虚线相位。仅在参数 style 为 FSDK.BorderInfo.e_Dashed 时有用。
  [in] | dashes | 表示虚线模式的虚线数组。此数组中每个元素的值 不应为负值。仅在 style 为 FSDK.BorderInfo.e_Dashed 时有用。

返回
  无。

## 类成员变量说明

## ◆ cloud_intensity

FSDK::BorderInfo::cloud_intensity

云形效果的强度。

仅当当前对象的 style 为 FSDK.BorderInfo.e_Cloudy 时， 这对自由文本、正方形、圆形和多边形注释有用。
建议值范围：0到2。0表示没有云形边框效果。
对于其余值，它们的效果将是：

- 如果值低于0，它将具有与值0相同的效果。
- 如果值高于2，它将具有与值2相同的效果。

## ◆ dash_phase

FSDK::BorderInfo::dash_phase

虚线相位。

仅当当前对象的 style 为 FSDK.BorderInfo.e_Dashed 时有用。

## ◆ dashes

FSDK::BorderInfo::dashes

表示虚线模式的虚线数组。

仅当当前对象的 style 为 FSDK.BorderInfo.e_Dashed 时有用。
此数组中元素的值不应为负值。

## ◆ e_Beveled

FSDK::BorderInfo::e_Beveled
| static

边框样式：斜面。

目前，Foxit PDF SDK不支持此边框样式的注释外观。 如果将此样式设置给任何注释，Foxit PDF SDK将在内部默认更改为 FSDK.BorderInfo.e_Solid。

## ◆ e_Cloudy

FSDK::BorderInfo::e_Cloudy
| static

边框样式：云形。

仅对自由文本、正方形、圆形和多边形注释有用。 如果设置给其他类型的注释，Foxit PDF SDK将在内部默认更改为 FSDK.BorderInfo.e_Solid。

## ◆ e_Dashed

FSDK::BorderInfo::e_Dashed
| static

边框样式：虚线。

仅对链接、自由文本、直线、正方形、圆形、多边形、折线和屏幕注释有用。 如果设置给其他类型的注释，Foxit PDF SDK将在内部默认更改为 FSDK.BorderInfo.e_Solid。

## ◆ e_Inset

FSDK::BorderInfo::e_Inset
| static

边框样式：嵌入。

目前，Foxit PDF SDK不支持此边框样式的注释外观。 如果将此样式设置给任何注释，Foxit PDF SDK将在内部默认更改为 FSDK.BorderInfo.e_Solid。

## ◆ e_Solid

FSDK::BorderInfo::e_Solid
| static

Enumeration for PDF annotation border style.

Values of this enumeration should be used alone.

边框样式：实线

## ◆ e_UnderLine

FSDK::BorderInfo::e_UnderLine
| static

边框样式：下划线。

仅对链接注释有用。如果设置给其他类型的注释，Foxit PDF SDK将在内部默认更改为 FSDK.BorderInfo.e_Solid。

## ◆ width

FSDK::BorderInfo::width

边框宽度，以点为单位。

此值不应为负值。如果此值为0，则不绘制边框。