Foxit PDF SDK

构造函数 | 属性 | 所有成员列表
FSWidget类 参考
类 FSWidget 继承关系图:

## 构造函数
(NSString *) | - getAppearanceOnStateName
| 获取注释外观"ON"状态的名称。 更多...
(FSControl *) | - getControl
| 获取关联的表单控件。 更多...
(FSField *) | - getField
| 获取关联的表单字段。 更多...
(FSWidgetLineSpacingStyle) | - getLineSpacing:
| 获取当前小部件的行间距。 更多...
(BOOL) | - hasMKEntry:
| 检查在 MK 字典中是否存在指定的条目。 更多...
(id) | - init
| 构造函数。
(id) | - initWithAnnot:
| 构造函数，使用父类对象。 更多...
(void) | - removeAction
| 移除动作。 更多...
(void) | - removeMKEntry:
| 从 MK 字典中移除指定的条目。 更多...
(void) | - setLineSpacing:line_spacing_value:
| 设置当前小部件的行间距。 更多...
(void) | - setMKDownIconImage:frame_index:
| 设置指定帧索引的图像作为MK字典中的按下图标。 更多...
(void) | - setMKNormalIconImage:frame_index:
| 设置指定帧索引的图像作为 MK 字典中的普通图标。 更多...
(void) | - setMKRolloverIconImage:frame_index:
| 设置指定帧索引的图像作为MK字典中的翻转图标。 更多...
构造函数 继承自 FSAnnot
(BOOL) | - FSMoveWithResetAppearance:is_reset_appearance:
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
(BOOL) | - FSResetApStreamWithIsGenerateNewAppearanceObj:
| 重置外观流。 更多...
(FSPDFStream *) | - getAppearanceStream:appearance_state:
| 获取具有指定类型和状态的注释外观流。 更多...
(FSRectI *) | - getDeviceRect:
| 获取设备坐标系统中的注释矩形。 更多...
(FSPDFDictionary *) | - getDict
| 获取注释的字典对象。 更多...
(FSMatrix2D *) | - getDisplayMatrix:
| 获取显示矩阵，从到 目标设备坐标系统。 更多...
(int) | - getIndex
| 获取当前注释在其所属页面中的索引。 更多...
(FSPDFDictionary *) | - getOptionalContent
| 获取注释可选内容的PDF字典。 更多...
(FSPDFPage *) | - getPage
| 获取相关的PDF页面。 更多...
(FSRectF *) | - getRect
| 获取矩形，以表示。 更多...
(FSAnnotType) | - getType
| 获取当前注释的实际注释类型。 更多...
(BOOL) | - hasProperty:
| 当前注释是否具有指定的注释属性。 更多...
(id) | - initWithPage:annot_dict:
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(BOOL) | - isMarkup
| 检查当前注释是否为标记注释。 更多...
(BOOL) | - move:
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
(BOOL) | - removeProperty:
| 删除指定的注释属性。 更多...
(BOOL) | - resetAppearanceStream
| 重置外观流。 更多...

## 属性
FSAction * | action
| 获取动作。 更多...
NSString * | appearanceState
| 获取注释的外观状态，从外观子字典中选择适用的外观流。
FSAnnotHighlightingMode | highlightingMode
| 获取高亮模式。 更多...
unsigned int | mKBackgroundColor
| 获取 MK 字典中的背景颜色。 更多...
unsigned int | mKBorderColor
| 获取 MK 字典中的边框颜色。 更多...
NSString * | mKDownCaption
| 获取 MK 字典中的向下标题字符串。 更多...
FSBitmap * | mKDownIconBitmap
| 获取MK字典中的按下图标位图。 更多...
FSAnnotMKIconCaptionRelation | mKIconCaptionRelation
| 获取MK字典中图标和标题的关系。 更多...
FSIconFit * | mKIconFit
| 获取MK字典中的图标适合信息。 更多...
NSString * | mKNormalCaption
| 获取 MK 字典中的普通标题字符串。 更多...
FSBitmap * | mKNormalIconBitmap
| 获取 MK 字典中的普通图标位图。 更多...
NSString * | mKRolloverCaption
| 获取 MK 字典中的翻转标题字符串。 更多...
FSBitmap * | mKRolloverIconBitmap
| 获取 MK 字典中的翻转图标位图。 更多...
FSRotation | mKRotation
| 获取 MK 字典中的旋转值。 更多...
属性 继承自 FSAnnot
unsigned int | borderColor
| 获取边框颜色。 更多...
FSBorderInfo * | borderInfo
| 获取边框信息。 更多...
NSString * | content
| 获取内容。
unsigned int | flags
| 获取注释标志。
FSDateTime * | modifiedDateTime
| 获取最后修改日期时间。
NSString * | uniqueID
| 获取唯一ID。

## 详细描述

小部件注释用于表示表单字段的外观。
类 FSWidget 派生自类 FSAnnot ，并且还提供了获取/设置小部件注释属性的函数。 函数 FSWidget::getField 和 FSWidget::getControl 可用于获取关联的表单字段 和表单控件对象。如果小部件注释没有与任何表单字段关联或与 签名字段关联，此小部件仍可以获取/设置属性，但无法重置外观。对于这些情况， FSAnnot::resetAppearanceStream（从 Widget 的父类继承）将直接返回 NO。

参见
  FSAnnot
  FSField
  FSControl

## 函数文档

## ◆ getAppearanceOnStateName()

- (NSString *) getAppearanceOnStateName |  |  |

获取注释外观"ON"状态的名称。

返回
  注释外观"ON"状态的名称。

## ◆ getControl()

- (FSControl *) getControl |  |  |

获取关联的表单控件。

返回
  关联的表单控件对象。

## ◆ getField()

- (FSField *) getField |  |  |

获取关联的表单字段。

返回
  关联的表单字段对象。

## ◆ getLineSpacing:()

- (FSWidgetLineSpacingStyle) getLineSpacing: |  | (float *) | line_spacing_value |

获取当前小部件的行间距。

这仅适用于与包含标志FSFieldFlagTextMultiline的文本字段关联的小部件。 对于其他类型的字段，这将无用。

参数

  [out] | line_spacing_value | 接收行间距精确值的输出参数。

返回
  行间距样式。请参考从FSWidgetLineSpacingSingle开始的值， 这将是这些值中的一个。

## ◆ hasMKEntry:()

- (BOOL) hasMKEntry: |  | (FSAnnotMKEntry) | mk_entry |

检查在 MK 字典中是否存在指定的条目。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。

参数

  [in] | mk_entry | MK 字典中的一个条目。请参考从 FSAnnotMKEntryRotation 开始的值，这应该是这些值中的一个。

返回
  YES 表示指定的条目存在于 MK 字典中，而 NO 表示不存在。

## ◆ initWithAnnot:()

- (id) initWithAnnot: |  | (FSAnnot*) | annot |

构造函数，使用父类对象。

参数

  [in] | annot | 父类对象。

重载 FSAnnot .

## ◆ removeAction()

- (void) removeAction |  |  |

移除动作。

此函数不能用于移除用作附加动作的动作。 如果用户想要移除任何附加动作，请参考类 FSAdditionalAction 了解更多详情。

返回
  无。

## ◆ removeMKEntry:()

- (void) removeMKEntry: |  | (FSAnnotMKEntry) | mk_entry |

从 MK 字典中移除指定的条目。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。

参数

  [in] | mk_entry | MK 字典中的一个条目。请参考从 FSAnnotMKEntryRotation 开始的值，这应该是这些值中的一个。

返回
  无。

## ◆ setLineSpacing:line_spacing_value:()

- (void) setLineSpacing: |  | (FSWidgetLineSpacingStyle) | line_spacing_style
line_spacing_value: |  | (float) | line_spacing_value

设置当前小部件的行间距。

这仅适用于与包含标志FSFieldFlagTextMultiline的文本字段关联的小部件。 对于其他类型的字段，这将无用。

参数

  [in] | line_spacing_style | 要设置给当前小部件的行间距样式。请参考从FSWidgetLineSpacingSingle开始的值， 这应该是这些值中的一个。
  [in] | line_spacing_value | 当参数line_spacing_style为 FSWidgetLineSpacingExactValue时，要设置给当前小部件的行间距精确值。 当此参数有用时，此参数必须是非负值，单位应为"pt"（称为点）。 如果此值为零，行间距的效果将与单倍行间距相同。

返回
  无。

## ◆ setMKDownIconImage:frame_index:()

- (void) setMKDownIconImage: |  | (FSImage*) | image
frame_index: |  | (int) | frame_index

设置指定帧索引的图像作为MK字典中的按下图标。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK字典中的按下图标（或备用图标）用于在鼠标按钮在其活动区域内 按下时显示。这适用于与按钮字段关联的小部件。 对于其他类型的字段，这将无用。

参数

  [in] | image | 图像。其中一帧将被设置为MK字典中的按下图标。 此图像应包含至少一帧，图像类型不应为 FSImageUnknown。
  [in] | frame_index | 帧索引。有效范围：从0到(count-1)。 count由函数FSImage::getFrameCount返回。

## ◆ setMKNormalIconImage:frame_index:()

- (void) setMKNormalIconImage: |  | (FSImage*) | image
frame_index: |  | (int) | frame_index

设置指定帧索引的图像作为 MK 字典中的普通图标。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的普通图标用于在小部件不与用户交互时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

参数

  [in] | image | 图像。其中一帧将被设置为 MK 字典中的普通图标。 此图像应包含至少一帧，且图像类型不应为 FSImageUnknown。
  [in] | frame_index | 帧索引。有效范围：从 0 到（count-1）。 count 由函数 FSImage::getFrameCount 返回。

## ◆ setMKRolloverIconImage:frame_index:()

- (void) setMKRolloverIconImage: |  | (FSImage*) | image
frame_index: |  | (int) | frame_index

设置指定帧索引的图像作为MK字典中的翻转图标。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK字典中的翻转图标用于在用户将光标移动到其活动区域内 但不按下鼠标按钮时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

参数

  [in] | image | 图像。其中一帧将被设置为MK字典中的翻转图标。 此图像应包含至少一帧，图像类型不应为 FSImageUnknown。
  [in] | frame_index | 帧索引。有效范围：从0到(count-1)。 count由函数FSImage::getFrameCount返回。

## 属性说明

## ◆ action

- (FSAction *) action
| read write nonatomic weak

获取动作。

此函数不能用于获取用作附加动作的动作。 如果用户想要获取任何附加动作，请参考类 FSAdditionalAction 了解更多详情。

## ◆ highlightingMode

- (FSAnnotHighlightingMode) highlightingMode
| read write nonatomic assign

获取高亮模式。

高亮模式是当鼠标按钮在其活动区域内按下或保持按下时使用的视觉效果。

## ◆ mKBackgroundColor

- (unsigned int) mKBackgroundColor
| read write nonatomic assign

获取 MK 字典中的背景颜色。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。

## ◆ mKBorderColor

- (unsigned int) mKBorderColor
| read write nonatomic assign

获取 MK 字典中的边框颜色。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。

## ◆ mKDownCaption

- (NSString *) mKDownCaption
| read write nonatomic weak

获取 MK 字典中的向下标题字符串。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的向下标题（或备用标题）用于在鼠标按钮在其活动区域内按下时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

## ◆ mKDownIconBitmap

- (FSBitmap *) mKDownIconBitmap
| read write nonatomic weak

获取MK字典中的按下图标位图。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK字典中的按下图标（或备用图标）用于在鼠标按钮在其活动区域内 按下时显示。这适用于与按钮字段关联的小部件。 对于其他类型的字段，这将无用。

## ◆ mKIconCaptionRelation

- (FSAnnotMKIconCaptionRelation) mKIconCaptionRelation
| read write nonatomic assign

获取MK字典中图标和标题的关系。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 标题和图标的关系位置指定小部件注释标题文本相对于其图标的位置。 这适用于与按钮字段关联的小部件。对于其他类型的字段， 这将无用。

## ◆ mKIconFit

- (FSIconFit *) mKIconFit
| read write nonatomic weak

获取MK字典中的图标适合信息。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 图标适合信息指定如何在注释矩形内显示小部件注释的图标。 如果存在，图标适合信息适用于注释的所有图标。 这适用于与按钮字段关联的小部件。对于其他类型的字段， 这将无用。

## ◆ mKNormalCaption

- (NSString *) mKNormalCaption
| read write nonatomic weak

获取 MK 字典中的普通标题字符串。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的普通标题用于在小部件不与用户交互时显示。 这适用于与按钮字段、复选框字段或单选按钮字段关联的小部件。 对于其他类型的字段，这将无用。

## ◆ mKNormalIconBitmap

- (FSBitmap *) mKNormalIconBitmap
| read write nonatomic weak

获取 MK 字典中的普通图标位图。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的普通图标用于在小部件不与用户交互时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

## ◆ mKRolloverCaption

- (NSString *) mKRolloverCaption
| read write nonatomic weak

获取 MK 字典中的翻转标题字符串。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的翻转标题用于在用户将光标移动到其活动区域内 但不按下鼠标按钮时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段， 这将无用。

## ◆ mKRolloverIconBitmap

- (FSBitmap *) mKRolloverIconBitmap
| read write nonatomic weak

获取 MK 字典中的翻转图标位图。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的翻转图标用于在用户将光标移动到其活动区域内 但不按下鼠标按钮时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

## ◆ mKRotation

- (FSRotation) mKRotation
| read write nonatomic assign

获取 MK 字典中的旋转值。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的旋转指定了小部件注释相对于页面逆时针旋转的度数。