Foxit PDF SDK

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

## Public 类型
enum | LineSpacingStyle { LineSpacingStyle.e_LineSpacingSingle = 0, LineSpacingStyle.e_LineSpacingOneAndHalf = 1, LineSpacingStyle.e_LineSpacingDouble = 2, LineSpacingStyle.e_LineSpacingExactValue = 3, LineSpacingStyle.e_LineSpacingAuto = 4 }
| 行间距样式的枚举。 更多...
Public 类型 继承自 foxit.pdf.annots.Annot
enum | AppearanceType { AppearanceType.e_AppearanceTypeNormal = 0, AppearanceType.e_AppearanceTypeRollover = 1, AppearanceType.e_AppearanceTypeDown = 2 }
| 注释外观类型的枚举。 更多...
enum | Flags { Flags.e_FlagInvisible = 0x0001, Flags.e_FlagHidden = 0x0002, Flags.e_FlagPrint = 0x0004, Flags.e_FlagNoZoom = 0x0008, Flags.e_FlagNoRotate = 0x0010, Flags.e_FlagNoView = 0x0020, Flags.e_FlagReadOnly = 0x0040, Flags.e_FlagLocked = 0x0080, Flags.e_FlagToggleNoView = 0x0100, Flags.e_FlagLockedContents = 0x0200 }
| PDF注释标志的枚举。 更多...
enum | HighlightingMode { HighlightingMode.e_HighlightingNone = 0, HighlightingMode.e_HighlightingInvert = 1, HighlightingMode.e_HighlightingOutline = 2, HighlightingMode.e_HighlightingPush = 3, HighlightingMode.e_HighlightingToggle = 4 }
| PDF注释高亮模式的枚举。 更多...
enum | MKEntry { MKEntry.e_MKEntryRotation = 0, MKEntry.e_MKEntryBorderColor = 1, MKEntry.e_MKEntryBackgroundColor = 2, MKEntry.e_MKEntryNormalCaption = 3, MKEntry.e_MKEntryRolloverCaption = 4, MKEntry.e_MKEntryDownCaption = 5, MKEntry.e_MKEntryNormalIcon = 6, MKEntry.e_MKEntryRolloverIcon = 7, MKEntry.e_MKEntryDownIcon = 8, MKEntry.e_MKEntryIconFit = 9, MKEntry.e_MKEntryIconCaptionRelation = 10 }
| 注释MK字典（外观特征）条目的枚举。 更多...
enum | MKIconCaptionRelation { MKIconCaptionRelation.e_MKRelationNoIcon = 0, MKIconCaptionRelation.e_MKRelationNoCaption = 1, MKIconCaptionRelation.e_MKRelationCaptionBelowIcon = 2, MKIconCaptionRelation.e_MKRelationCaptionAboveIcon = 3, MKIconCaptionRelation.e_MKRelationCaptionRight = 4, MKIconCaptionRelation.e_MKRelationCaptionLeft = 5, MKIconCaptionRelation.e_MKRelationCaptionOvrlayOnIcon = 6 }
| 注释MK字典中图标和标题相对位置的枚举。 更多...
enum | Property { Property.e_PropertyModifiedDate = 0, Property.e_PropertyCreationDate = 1, Property.e_PropertyBorderColor = 2, Property.e_PropertyFillColor = 3 }
| 某些PDF注释属性的枚举。 更多...
enum | Type { Type.e_UnknownType = 0, Type.e_Note = 1, Type.e_Link = 2, Type.e_FreeText = 3, Type.e_Line = 4, Type.e_Square = 5, Type.e_Circle = 6, Type.e_Polygon = 7, Type.e_PolyLine = 8, Type.e_Highlight = 9, Type.e_Underline = 10, Type.e_Squiggly = 11, Type.e_StrikeOut = 12, Type.e_Stamp = 13, Type.e_Caret = 14, Type.e_Ink = 15, Type.e_PSInk = 16, Type.e_FileAttachment = 17, Type.e_Sound = 18, Type.e_Movie = 19, Type.e_Widget = 20, Type.e_Screen = 21, Type.e_PrinterMark = 22, Type.e_TrapNet = 23, Type.e_Watermark = 24, Type.e_3D = 25, Type.e_Popup = 26, Type.e_Redact = 27, Type.e_RichMedia = 28, Type.e_PagingSeal = 29 }
| PDF注释类型的枚举。 更多...

## Public 成员函数
| Widget ()
| 构造函数。
| Widget (Annot annot)
| 构造函数，使用父类对象。 更多...
Action | GetAction ()
| 获取动作。 更多...
string | GetAppearanceOnStateName ()
| 获取注释外观"ON"状态的名称。 更多...
string | GetAppearanceState ()
| 获取注释的外观状态，从外观子字典中选择适用的外观流。 更多...
Control | GetControl ()
| 获取关联的表单控件。 更多...
Field | GetField ()
| 获取关联的表单字段。 更多...
Annot.HighlightingMode | GetHighlightingMode ()
| 获取高亮模式。 更多...
Widget.LineSpacingStyle | GetLineSpacing (ref float line_spacing_value)
| 获取当前小部件的行间距。 更多...
int | GetMKBackgroundColor ()
| 获取 MK 字典中的背景颜色。 更多...
int | GetMKBorderColor ()
| 获取 MK 字典中的边框颜色。 更多...
string | GetMKDownCaption ()
| 获取 MK 字典中的向下标题字符串。 更多...
Bitmap | GetMKDownIconBitmap ()
| 获取MK字典中的按下图标位图。 更多...
Annot.MKIconCaptionRelation | GetMKIconCaptionRelation ()
| 获取MK字典中图标和标题的关系。 更多...
IconFit | GetMKIconFit ()
| 获取MK字典中的图标适合信息。 更多...
string | GetMKNormalCaption ()
| 获取 MK 字典中的普通标题字符串。 更多...
Bitmap | GetMKNormalIconBitmap ()
| 获取 MK 字典中的普通图标位图。 更多...
string | GetMKRolloverCaption ()
| 获取 MK 字典中的翻转标题字符串。 更多...
Bitmap | GetMKRolloverIconBitmap ()
| 获取 MK 字典中的翻转图标位图。 更多...
Rotation | GetMKRotation ()
| 获取 MK 字典中的旋转值。 更多...
bool | HasMKEntry (Annot.MKEntry mk_entry)
| 检查在 MK 字典中是否存在指定的条目。 更多...
void | RemoveAction ()
| 移除动作。 更多...
void | RemoveMKEntry (Annot.MKEntry mk_entry)
| 从 MK 字典中移除指定的条目。 更多...
void | SetAction (Action action)
| 设置动作。 更多...
void | SetAppearanceState (string appearance_state)
| 设置注释的外观状态，从外观子字典中选择适用的外观流。 更多...
void | SetHighlightingMode (Annot.HighlightingMode mode)
| 设置高亮模式。 更多...
void | SetLineSpacing (Widget.LineSpacingStyle line_spacing_style, float line_spacing_value)
| 设置当前小部件的行间距。 更多...
void | SetMKBackgroundColor (int color)
| 设置 MK 字典中的背景颜色。 更多...
void | SetMKBorderColor (int color)
| 设置 MK 字典中的边框颜色。 更多...
void | SetMKDownCaption (string caption)
| 设置 MK 字典中的向下标题字符串。 更多...
void | SetMKDownIconBitmap (Bitmap bitmap)
| 设置MK字典中的按下图标位图。 更多...
void | SetMKDownIconImage (Image image, int frame_index)
| 设置指定帧索引的图像作为MK字典中的按下图标。 更多...
void | SetMKIconCaptionRelation (Annot.MKIconCaptionRelation relation)
| 设置MK字典中图标和标题的关系。 更多...
void | SetMKIconFit (IconFit icon_fit)
| 设置MK字典中的图标适合信息。 更多...
void | SetMKNormalCaption (string caption)
| 设置 MK 字典中的普通标题字符串。 更多...
void | SetMKNormalIconBitmap (Bitmap bitmap)
| 设置一个位图作为 MK 字典中的普通图标。 更多...
void | SetMKNormalIconImage (Image image, int frame_index)
| 设置指定帧索引的图像作为 MK 字典中的普通图标。 更多...
void | SetMKRolloverCaption (string caption)
| 设置 MK 字典中的翻转标题字符串。 更多...
void | SetMKRolloverIconBitmap (Bitmap bitmap)
| 设置MK字典中的翻转图标位图。 更多...
void | SetMKRolloverIconImage (Image image, int frame_index)
| 设置指定帧索引的图像作为MK字典中的翻转图标。 更多...
void | SetMKRotation (Rotation rotation)
| 设置 MK 字典中的旋转值。 更多...
Public 成员函数 继承自 foxit.pdf.annots.Annot
| Annot (PDFPage page, PDFDictionary annot_dict)
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
| Annot (Annot annot)
| 构造函数，使用另一个注释对象。 更多...
| Annot ()
| 构造函数。
PDFStream | GetAppearanceStream (Annot.AppearanceType type, string appearance_state)
| 获取具有指定类型和状态的注释外观流。 更多...
int | GetBorderColor ()
| 获取边框颜色。 更多...
BorderInfo | GetBorderInfo ()
| 获取边框信息。 更多...
string | GetContent ()
| 获取内容。 更多...
RectI | GetDeviceRect (Matrix2D matrix)
| 获取设备坐标系统中的注释矩形。 更多...
PDFDictionary | GetDict ()
| 获取注释的字典对象。 更多...
Matrix2D | GetDisplayMatrix (Matrix2D page_display_matrix)
| 获取显示矩阵，从到 目标设备坐标系统。 更多...
int | GetFlags ()
| 获取注释标志。 更多...
int | GetIndex ()
| 获取当前注释在其所属页面中的索引。 更多...
DateTime | GetModifiedDateTime ()
| 获取最后修改日期时间。 更多...
PDFDictionary | GetOptionalContent ()
| 获取注释可选内容的PDF字典。 更多...
PDFPage | GetPage ()
| 获取相关的PDF页面。 更多...
RectF | GetRect ()
| 获取矩形，以表示。 更多...
Annot.Type | GetType ()
| 获取当前注释的实际注释类型。 更多...
string | GetUniqueID ()
| 获取唯一ID。 更多...
bool | HasProperty (Annot.Property property)
| 当前注释是否具有指定的注释属性。 更多...
bool | IsEmpty ()
| 检查当前对象是否为空。 更多...
bool | IsMarkup ()
| 检查当前注释是否为标记注释。 更多...
bool | Move (RectF rect)
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
bool | Move (RectF rect, bool is_reset_appearance)
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
bool | RemoveProperty (Annot.Property property)
| 删除指定的注释属性。 更多...
bool | ResetAppearanceStream ()
| 重置外观流。 更多...
bool | ResetAppearanceStream (bool is_generate_new_appearance_obj)
| 重置外观流。 更多...
void | SetBorderColor (int color)
| 设置边框颜色。 更多...
void | SetBorderInfo (BorderInfo border)
| 设置边框信息。 更多...
void | SetContent (string content)
| 设置内容。 更多...
void | SetFlags (int flags)
| 设置注释标志。 更多...
void | SetModifiedDateTime (DateTime date_time)
| 设置最后修改日期时间。 更多...
void | SetUniqueID (string unique_id)
| 设置唯一ID。 更多...

## 详细描述

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

参见
  Annot
  foxit.pdf.interform.Field
  foxit.pdf.interform.Control

## 成员枚举类型说明

## ◆ LineSpacingStyle

enum foxit.pdf.annots.Widget.LineSpacingStyle
| strong

行间距样式的枚举。

此枚举的值应单独使用。

枚举值
e_LineSpacingSingle | 行间距样式：单倍行间距。
e_LineSpacingOneAndHalf | 行间距样式：1.5倍行间距。
e_LineSpacingDouble | 行间距样式：双倍行间距。
e_LineSpacingExactValue | 行间距样式：精确值行间距。
e_LineSpacingAuto | 行间距样式：自动行间距。

## 构造及析构函数说明

## ◆ Widget()

foxit.pdf.annots.Widget.Widget | ( | Annot | annot | ) |
| inline

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

参数

  [in] | annot | 父类对象。

## 成员函数说明

## ◆ GetAction()

Action foxit.pdf.annots.Widget.GetAction | ( |  | ) |
| inline

获取动作。

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

返回
  接收动作数据的动作对象。如果返回的动作对象的函数 actions.Action.IsEmpty 返回值为 true，那意味着没有动作。

## ◆ GetAppearanceOnStateName()

string foxit.pdf.annots.Widget.GetAppearanceOnStateName | ( |  | ) |
| inline

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

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

## ◆ GetAppearanceState()

string foxit.pdf.annots.Widget.GetAppearanceState | ( |  | ) |
| inline

获取注释的外观状态，从外观子字典中选择适用的外观流。

返回
  注释的外观状态。

## ◆ GetControl()

Control foxit.pdf.annots.Widget.GetControl | ( |  | ) |
| inline

获取关联的表单控件。

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

## ◆ GetField()

Field foxit.pdf.annots.Widget.GetField | ( |  | ) |
| inline

获取关联的表单字段。

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

## ◆ GetHighlightingMode()

Annot.HighlightingMode foxit.pdf.annots.Widget.GetHighlightingMode | ( |  | ) |
| inline

获取高亮模式。

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

返回
  高亮模式值。请参考从foxit.pdf.annots.Annot.HighlightingMode.e_HighlightingNone 开始的值， 这将是这些值中的一个。

## ◆ GetLineSpacing()

Widget.LineSpacingStyle foxit.pdf.annots.Widget.GetLineSpacing | ( | ref float | line_spacing_value | ) |
| inline

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

这仅适用于与包含标志foxit.pdf.interform.Field.Flags.e_FlagTextMultiline 的文本字段关联的小部件。 对于其他类型的字段，这将无用。

参数

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

返回
  行间距样式。请参考从foxit.pdf.annots.Widget.LineSpacingStyle.e_LineSpacingSingle 开始的值， 这将是这些值中的一个。

## ◆ GetMKBackgroundColor()

int foxit.pdf.annots.Widget.GetMKBackgroundColor | ( |  | ) |
| inline

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

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

返回
  MK 字典中的背景颜色。值格式：0xRRGGBB。
  0 可能表示 MK 字典中没有背景颜色。在这种情况下，请使用值 foxit.pdf.annots.Annot.MKEntry.e_MKEntryBackgroundColor 调用函数 Widget.HasMKEntry 进行检查。

## ◆ GetMKBorderColor()

int foxit.pdf.annots.Widget.GetMKBorderColor | ( |  | ) |
| inline

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

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

返回
  MK 字典中的边框颜色。值格式：0xRRGGBB。
  0 可能表示 MK 字典中没有边框颜色。在这种情况下，请使用值 foxit.pdf.annots.Annot.MKEntry.e_MKEntryBorderColor 调用函数 Widget.HasMKEntry 进行检查。

## ◆ GetMKDownCaption()

string foxit.pdf.annots.Widget.GetMKDownCaption | ( |  | ) |
| inline

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

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

返回
  向下标题字符串。空字符串可能表示 MK 字典中没有向下标题。在这种情况下， 请使用值 foxit.pdf.annots.Annot.MKEntry.e_MKEntryDownCaption 调用函数 Widget.HasMKEntry 进行检查。

## ◆ GetMKDownIconBitmap()

Bitmap foxit.pdf.annots.Widget.GetMKDownIconBitmap | ( |  | ) |
| inline

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

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

返回
  按下图标位图。如果返回的位图对象的函数common.Bitmap.IsEmpty 返回true， 则表示当前小部件注释没有按下图标位图。

## ◆ GetMKIconCaptionRelation()

Annot.MKIconCaptionRelation foxit.pdf.annots.Widget.GetMKIconCaptionRelation | ( |  | ) |
| inline

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

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

返回
  标题和图标的关系位置。请参考foxit.pdf.annots.Annot.MKIconCaptionRelation.e_MKRelationNoIcon 值，这应该是这些值中的一个。

## ◆ GetMKIconFit()

IconFit foxit.pdf.annots.Widget.GetMKIconFit | ( |  | ) |
| inline

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

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

返回
  图标适合对象，包含MK字典中的图标适合信息。 如果图标适合对象的缩放方式类型是值foxit.pdf.annots.IconFit.ScaleWayType.e_ScaleWayNone ， 则表示MK字典中没有图标适合信息。

## ◆ GetMKNormalCaption()

string foxit.pdf.annots.Widget.GetMKNormalCaption | ( |  | ) |
| inline

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

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

返回
  普通标题字符串。 空字符串可能表示 MK 字典中没有普通标题。在这种情况下，请使用值 foxit.pdf.annots.Annot.MKEntry.e_MKEntryNormalCaption 调用函数 Widget.HasMKEntry 进行检查。

## ◆ GetMKNormalIconBitmap()

Bitmap foxit.pdf.annots.Widget.GetMKNormalIconBitmap | ( |  | ) |
| inline

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

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

返回
  普通图标位图。如果返回的位图对象的函数 common.Bitmap.IsEmpty 返回 true， 那意味着当前小部件注释没有普通图标位图。

## ◆ GetMKRolloverCaption()

string foxit.pdf.annots.Widget.GetMKRolloverCaption | ( |  | ) |
| inline

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

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

返回
  翻转标题字符串。 空字符串可能表示 MK 字典中没有翻转标题。在这种情况下，请使用值 foxit.pdf.annots.Annot.MKEntry.e_MKEntryRolloverCaption 调用函数 Widget.HasMKEntry 进行检查。

## ◆ GetMKRolloverIconBitmap()

Bitmap foxit.pdf.annots.Widget.GetMKRolloverIconBitmap | ( |  | ) |
| inline

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

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

返回
  翻转图标位图。如果返回的位图对象的函数 common.Bitmap.IsEmpty 返回 true，那意味着当前小部件注释没有翻转图标位图。

## ◆ GetMKRotation()

Rotation foxit.pdf.annots.Widget.GetMKRotation | ( |  | ) |
| inline

获取 MK 字典中的旋转值。

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

返回
  MK 字典中的旋转值。请参考从 foxit.common.Rotation.e_Rotation0 开始的值， 这将是这些值中的一个。值 foxit.common.Rotation.e_RotationUnknown 表示 MK 字典中没有旋转。 特别地，返回的旋转值表示逆时针方向。

## ◆ HasMKEntry()

bool foxit.pdf.annots.Widget.HasMKEntry | ( | Annot.MKEntry | mk_entry | ) |
| inline

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

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

参数

  [in] | mk_entry | MK 字典中的一个条目。请参考从 foxit.pdf.annots.Annot.MKEntry.e_MKEntryRotation 开始的值，这应该是这些值中的一个。

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

## ◆ RemoveAction()

void foxit.pdf.annots.Widget.RemoveAction | ( |  | ) |
| inline

移除动作。

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

返回
  无。

## ◆ RemoveMKEntry()

void foxit.pdf.annots.Widget.RemoveMKEntry | ( | Annot.MKEntry | mk_entry | ) |
| inline

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

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

参数

  [in] | mk_entry | MK 字典中的一个条目。请参考从 foxit.pdf.annots.Annot.MKEntry.e_MKEntryRotation 开始的值，这应该是这些值中的一个。

返回
  无。

## ◆ SetAction()

void foxit.pdf.annots.Widget.SetAction | ( | Action | action | ) |
| inline

设置动作。

此函数不能用于设置用作附加动作的动作。 如果用户想要设置任何附加动作，请参考类 foxit.pdf.actions.AdditionalAction 了解更多详情。

参数

  [in] | action | 要设置的新动作。它应该是有效的。 当前仅支持以下类型作为新动作： foxit.pdf.actions.Action.Type.e_TypeGoto , foxit.pdf.actions.Action.Type.e_TypeURI , foxit.pdf.actions.Action.Type.e_TypeJavaScript , foxit.pdf.actions.Action.Type.e_TypeNamed , foxit.pdf.actions.Action.Type.e_TypeGoToR , foxit.pdf.actions.Action.Type.e_TypeGoToE , foxit.pdf.actions.Action.Type.e_TypeSubmitForm , foxit.pdf.actions.Action.Type.e_TypeResetForm , foxit.pdf.actions.Action.Type.e_TypeHide , foxit.pdf.actions.Action.Type.e_TypeLaunch , foxit.pdf.actions.Action.Type.e_TypeImportData , foxit.pdf.actions.Action.Type.e_TypeRendition 。

返回
  无。

## ◆ SetAppearanceState()

void foxit.pdf.annots.Widget.SetAppearanceState | ( | string | appearance_state | ) |
| inline

设置注释的外观状态，从外观子字典中选择适用的外观流。

参数

  [in] | appearance_state | 注释的外观状态。

返回
  无。

## ◆ SetHighlightingMode()

void foxit.pdf.annots.Widget.SetHighlightingMode | ( | Annot.HighlightingMode | mode | ) |
| inline

设置高亮模式。

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

参数

  [in] | mode | 新的高亮模式值。请参考从 foxit.pdf.annots.Annot.HighlightingMode.e_HighlightingNone 开始的值， 这应该是这些值中的一个。

返回
  无。

## ◆ SetLineSpacing()

void foxit.pdf.annots.Widget.SetLineSpacing | ( | Widget.LineSpacingStyle | line_spacing_style,
|  | float | line_spacing_value
| ) |  |
| inline

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

这仅适用于与包含标志foxit.pdf.interform.Field.Flags.e_FlagTextMultiline 的文本字段关联的小部件。 对于其他类型的字段，这将无用。

参数

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

返回
  无。

## ◆ SetMKBackgroundColor()

void foxit.pdf.annots.Widget.SetMKBackgroundColor | ( | int | color | ) |
| inline

设置 MK 字典中的背景颜色。

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

参数

  [in] | color | 要在 MK 字典中设置的背景颜色。值格式：0xRRGGBB。

返回
  无。

## ◆ SetMKBorderColor()

void foxit.pdf.annots.Widget.SetMKBorderColor | ( | int | color | ) |
| inline

设置 MK 字典中的边框颜色。

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

参数

  [in] | color | 要在 MK 字典中设置的边框颜色。值格式：0xRRGGBB。

返回
  无。

## ◆ SetMKDownCaption()

void foxit.pdf.annots.Widget.SetMKDownCaption | ( | string | caption | ) |
| inline

设置 MK 字典中的向下标题字符串。

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

参数

  [in] | caption | 要在 MK 字典中设置的向下标题字符串。它可以是空字符串。

返回
  无。

## ◆ SetMKDownIconBitmap()

void foxit.pdf.annots.Widget.SetMKDownIconBitmap | ( | Bitmap | bitmap | ) |
| inline

设置MK字典中的按下图标位图。

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

参数

  [in] | bitmap | 要设置为MK字典中按下图标的有效位图。

返回
  无。

## ◆ SetMKDownIconImage()

void foxit.pdf.annots.Widget.SetMKDownIconImage | ( | Image | image,
|  | int | frame_index
| ) |  |
| inline

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

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

参数

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

## ◆ SetMKIconCaptionRelation()

void foxit.pdf.annots.Widget.SetMKIconCaptionRelation | ( | Annot.MKIconCaptionRelation | relation | ) |
| inline

设置MK字典中图标和标题的关系。

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

参数

  [in] | relation | 标题和图标的关系位置。请参考从 foxit.pdf.annots.Annot.MKIconCaptionRelation.e_MKRelationNoIcon 开始的值，这应该是这些值中的一个。

返回
  无。

## ◆ SetMKIconFit()

void foxit.pdf.annots.Widget.SetMKIconFit | ( | IconFit | icon_fit | ) |
| inline

设置MK字典中的图标适合信息。

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

参数

  [in] | icon_fit | 表示要在MK字典中设置的图标适合信息的图标适合对象。 如果此对象中任何成员的值无效，此函数将抛出异常 foxit.common.ErrorCode.e_ErrParam 。 请参考类IconFit 检查每个成员的有效值范围。

返回
  无。

## ◆ SetMKNormalCaption()

void foxit.pdf.annots.Widget.SetMKNormalCaption | ( | string | caption | ) |
| inline

设置 MK 字典中的普通标题字符串。

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

参数

  [in] | caption | 要在 MK 字典中设置的普通标题字符串。它可以是空字符串。

返回
  无。

## ◆ SetMKNormalIconBitmap()

void foxit.pdf.annots.Widget.SetMKNormalIconBitmap | ( | Bitmap | bitmap | ) |
| inline

设置一个位图作为 MK 字典中的普通图标。

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

参数

  [in] | bitmap | 要在 MK 字典中设置为普通图标的有效位图。

返回
  无。

## ◆ SetMKNormalIconImage()

void foxit.pdf.annots.Widget.SetMKNormalIconImage | ( | Image | image,
|  | int | frame_index
| ) |  |
| inline

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

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

参数

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

## ◆ SetMKRolloverCaption()

void foxit.pdf.annots.Widget.SetMKRolloverCaption | ( | string | caption | ) |
| inline

设置 MK 字典中的翻转标题字符串。

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

参数

  [in] | caption | 要在 MK 字典中设置的翻转标题字符串。它可以是空字符串。

返回
  无。

## ◆ SetMKRolloverIconBitmap()

void foxit.pdf.annots.Widget.SetMKRolloverIconBitmap | ( | Bitmap | bitmap | ) |
| inline

设置MK字典中的翻转图标位图。

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

参数

  [in] | bitmap | 要设置为MK字典中翻转图标的有效位图。

返回
  无。

## ◆ SetMKRolloverIconImage()

void foxit.pdf.annots.Widget.SetMKRolloverIconImage | ( | Image | image,
|  | int | frame_index
| ) |  |
| inline

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

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

参数

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

## ◆ SetMKRotation()

void foxit.pdf.annots.Widget.SetMKRotation | ( | Rotation | rotation | ) |
| inline

设置 MK 字典中的旋转值。

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

参数

  [in] | rotation | 要在 MK 字典中设置的旋转值。请参考从 foxit.common.Rotation.e_Rotation0 开始的值，这应该是这些值中的一个，除了 foxit.common.Rotation.e_RotationUnknown 。特别地，这里的旋转值表示逆时针方向。