Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::Widget类 参考
类 FSDK::Widget 继承关系图:

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

## 静态 Public 属性
static | e_LineSpacingAuto
| 行间距样式：自动行距。
static | e_LineSpacingDouble
| 行间距样式：双倍行距。
static | e_LineSpacingExactValue
| 行间距样式：精确值行距。
static | e_LineSpacingOneAndHalf
| 行间距样式：一倍半行距。
static | e_LineSpacingSingle
| 行间距样式的枚举。 更多...
静态 Public 属性 继承自 FSDK::Annot
static | e_3D
| 注释类型：3D注释。<PDF reference 1.7>中的标准注释之一。
static | e_AppearanceTypeDown
| 注释的按下外观。
static | e_AppearanceTypeNormal
| 注释外观类型的枚举。 更多...
static | e_AppearanceTypeRollover
| 注释的翻转外观。
static | e_Caret
| 注释类型：插入符注释。<PDF reference 1.7>中的标准注释之一。
static | e_Circle
| 注释类型：圆形注释。<PDF reference 1.7>中的标准注释之一。
static | e_FileAttachment
| 注释类型：文件附件注释。<PDF reference 1.7>中的标准注释之一。
static | e_FlagHidden
| 注释标志：隐藏。 更多...
static | e_FlagInvisible
| PDF注释标志的枚举。 更多...
static | e_FlagLocked
| 注释标志：锁定。 更多...
static | e_FlagLockedContents
| 注释标志：锁定内容。 更多...
static | e_FlagNoRotate
| 注释标志：不旋转。 更多...
static | e_FlagNoView
| 注释标志：不查看。 更多...
static | e_FlagNoZoom
| 注释标志：不缩放。 更多...
static | e_FlagPrint
| 注释标志：打印。 更多...
static | e_FlagReadOnly
| 注释标志：只读。 更多...
static | e_FlagToggleNoView
| 注释标志：切换不查看。 更多...
static | e_FreeText
| 注释类型：自由文本注释。<PDF reference 1.7>中的标准注释之一。
static | e_Highlight
| 注释类型：高亮注释。<PDF reference 1.7>中的标准注释之一。
static | e_HighlightingInvert
| 高亮模式：反转，即反转注释矩形的内容。
static | e_HighlightingNone
| PDF注释高亮模式的枚举。 更多...
static | e_HighlightingOutline
| 高亮模式：轮廓，即反转注释的边框。
static | e_HighlightingPush
| 高亮模式：按下，即显示注释的按下外观（如果有）。
static | e_HighlightingToggle
| 高亮模式：切换。这仅对小部件注释有用。
static | e_Ink
| 注释类型：墨迹注释。<PDF reference 1.7>中的标准注释之一。
static | e_Line
| 注释类型：直线注释。<PDF reference 1.7>中的标准注释之一。
static | e_Link
| 注释类型：链接注释。<PDF reference 1.7>中的标准注释之一。
static | e_MKEntryBackgroundColor
| 背景颜色条目。MK字典中的"BG"。
static | e_MKEntryBorderColor
| 边框颜色条目。MK字典中的"BC"。
static | e_MKEntryDownCaption
| 按下标题（或替代标题）条目。MK字典中的"AC"。 更多...
static | e_MKEntryDownIcon
| 按下图标（或替代图标）条目。MK字典中的"IX"。 更多...
static | e_MKEntryIconCaptionRelation
| 图标和标题关系条目。MK字典中的"TP"。 更多...
static | e_MKEntryIconFit
| 图标适配信息条目。MK字典中的"IF"。 更多...
static | e_MKEntryNormalCaption
| 正常标题条目。MK字典中的"CA"。 更多...
static | e_MKEntryNormalIcon
| 正常图标条目。MK字典中的"I"。 更多...
static | e_MKEntryRolloverCaption
| 翻转标题条目。MK字典中的"RC"。 更多...
static | e_MKEntryRolloverIcon
| 翻转图标条目。MK字典中的"RI"。 更多...
static | e_MKEntryRotation
| 注释的MK字典（外观特性）条目的枚举。 更多...
static | e_MKRelationCaptionAboveIcon
| 标题在图标上方。
static | e_MKRelationCaptionBelowIcon
| 标题在图标下方。
static | e_MKRelationCaptionLeft
| 标题在图标左侧。
static | e_MKRelationCaptionOvrlayOnIcon
| 标题直接覆盖在图标上。
static | e_MKRelationCaptionRight
| 标题在图标右侧。
static | e_MKRelationNoCaption
| 无标题；仅图标。
static | e_MKRelationNoIcon
| 注释的MK字典中图标和标题相对位置的枚举。 更多...
static | e_Movie
| 注释类型：电影注释。<PDF reference 1.7>中的标准注释之一。
static | e_Note
| 注释类型：注释注释，即“文本”注释 - <PDF reference 1.7>中的标准注释之一。
static | e_PagingSeal
| 注释类型：分页印章注释。Foxit PDF SDK自定义注释类型（非标准注释类型）。
static | e_Polygon
| 注释类型：多边形注释。<PDF reference 1.7>中的标准注释之一。
static | e_PolyLine
| 注释类型：折线注释。<PDF reference 1.7>中的标准注释之一。
static | e_Popup
| 注释类型：弹出注释。<PDF reference 1.7>中的标准注释之一。
static | e_PrinterMark
| 注释类型：印刷商标记注释。<PDF reference 1.7>中的标准注释之一。
static | e_PropertyBorderColor
| 注释属性：边框颜色。 更多...
static | e_PropertyCreationDate
| 注释属性：创建日期。 更多...
static | e_PropertyFillColor
| 注释属性：填充颜色 更多...
static | e_PropertyModifiedDate
| 某些PDF注释属性的枚举。 更多...
static | e_PSInk
| 注释类型：压感墨迹注释。
static | e_Redact
| 注释类型：涂黑注释。
static | e_RichMedia
| 注释类型：富媒体注释。
static | e_Screen
| 注释类型：屏幕注释。<PDF reference 1.7>中的标准注释之一。
static | e_Sound
| 注释类型：声音注释。<PDF reference 1.7>中的标准注释之一。
static | e_Square
| 注释类型：正方形注释。<PDF reference 1.7>中的标准注释之一。
static | e_Squiggly
| 注释类型：波浪线注释。<PDF reference 1.7>中的标准注释之一。
static | e_Stamp
| 注释类型：图章注释。<PDF reference 1.7>中的标准注释之一。
static | e_StrikeOut
| 注释类型：删除线注释。<PDF reference 1.7>中的标准注释之一。
static | e_TrapNet
| 注释类型：陷阱网络注释。<PDF reference 1.7>中的标准注释之一。
static | e_Underline
| 注释类型：下划线注释。<PDF reference 1.7>中的标准注释之一。
static | e_UnknownType
| PDF注释类型的枚举。 更多...
static | e_Watermark
| 注释类型：水印注释。<PDF reference 1.7>中的标准注释之一。
static | e_Widget
| 注释类型：小部件注释。<PDF reference 1.7>中的标准注释之一。 更多...

## 详细描述

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

参见
  FSDK.Annot
  FSDK.Field
  FSDK.Control

## 成员函数说明

## ◆ constructor()

FSDK::Widget::constructor | ( | annot |  | ) |

构造函数，带有父类对象。

参数

  [in] | annot | 父类对象。

## ◆ GetAction()

FSDK::Widget::GetAction | ( |  | ) |

获取动作。

此函数不能用于获取用作附加动作的动作。 如果用户想要获取任何附加动作，请参阅类 FSDK.AdditionalAction 了解更多详细信息。

返回
  接收动作数据的动作对象。如果返回的动作对象的函数 FSDK.Action.IsEmpty 的返回值为 true，则表示没有动作。

## ◆ GetAppearanceOnStateName()

FSDK::Widget::GetAppearanceOnStateName | ( |  | ) |

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

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

## ◆ GetAppearanceState()

FSDK::Widget::GetAppearanceState | ( |  | ) |

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

返回
  注释的外观状态。

## ◆ GetControl()

FSDK::Widget::GetControl | ( |  | ) |

获取关联的表单控件。

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

## ◆ GetField()

FSDK::Widget::GetField | ( |  | ) |

获取关联的表单字段。

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

## ◆ GetHighlightingMode()

FSDK::Widget::GetHighlightingMode | ( |  | ) |

获取高亮模式。

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

返回
  高亮模式值。请参阅从 FSDK.Annot.e_HighlightingNone 开始的值， 这将是这些值之一。

## ◆ GetLineSpacing()

FSDK::Widget::GetLineSpacing | ( | line_spacing_value |  | ) |

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

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

参数

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

返回
  行间距样式。请参阅从 FSDK.Widget.e_LineSpacingSingle 开始的值， 这将是这些值之一。

## ◆ GetMKBackgroundColor()

FSDK::Widget::GetMKBackgroundColor | ( |  | ) |

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

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

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

## ◆ GetMKBorderColor()

FSDK::Widget::GetMKBorderColor | ( |  | ) |

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

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

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

## ◆ GetMKDownCaption()

FSDK::Widget::GetMKDownCaption | ( |  | ) |

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

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

返回
  按下标题字符串。空字符串可能表示 MK 字典中没有按下标题。在这种情况下， 请使用值 FSDK.Annot.e_MKEntryDownCaption 调用函数 FSDK.Widget.HasMKEntry 来检查。

## ◆ GetMKDownIconBitmap()

FSDK::Widget::GetMKDownIconBitmap | ( |  | ) |

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

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

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

## ◆ GetMKIconCaptionRelation()

FSDK::Widget::GetMKIconCaptionRelation | ( |  | ) |

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

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

返回
  标题和图标的关系位置。请参阅 FSDK.Annot.e_MKRelationNoIcon 的值，它应该是这些值之一。

## ◆ GetMKIconFit()

FSDK::Widget::GetMKIconFit | ( |  | ) |

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

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

返回
  一个图标适配对象，它包含 MK 字典中的图标适配信息。 如果图标适配对象的 缩放方式类型 为值 FSDK.IconFit.e_ScaleWayNone， 则表示 MK 字典中没有图标适配信息。

## ◆ GetMKNormalCaption()

FSDK::Widget::GetMKNormalCaption | ( |  | ) |

获取 MK 字典中的正常标题字符串。

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

返回
  正常标题字符串。 空字符串可能表示 MK 字典中没有正常标题。在这种情况下，请使用值 FSDK.Annot.e_MKEntryNormalCaption 调用函数 FSDK.Widget.HasMKEntry 来检查。

## ◆ GetMKNormalIconBitmap()

FSDK::Widget::GetMKNormalIconBitmap | ( |  | ) |

获取 MK 字典中的正常图标位图。

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

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

## ◆ GetMKRolloverCaption()

FSDK::Widget::GetMKRolloverCaption | ( |  | ) |

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

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

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

## ◆ GetMKRolloverIconBitmap()

FSDK::Widget::GetMKRolloverIconBitmap | ( |  | ) |

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

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

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

## ◆ GetMKRotation()

FSDK::Widget::GetMKRotation | ( |  | ) |

获取 MK 字典中的旋转值。

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

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

## ◆ HasMKEntry()

FSDK::Widget::HasMKEntry | ( | mk_entry |  | ) |

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

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

参数

  [in] | mk_entry | MK 字典中的条目。请参阅从 FSDK.Annot.e_MKEntryRotation 开始的值，这应该是这些值之一。

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

## ◆ RemoveAction()

FSDK::Widget::RemoveAction | ( |  | ) |

移除动作。

此函数不能用于移除用作附加动作的动作。 如果用户想要移除任何附加动作，请参阅类 FSDK.AdditionalAction 了解更多详细信息。

返回
  None.

## ◆ RemoveMKEntry()

FSDK::Widget::RemoveMKEntry | ( | mk_entry |  | ) |

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

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

参数

  [in] | mk_entry | MK 字典中的条目。请参阅从 FSDK.Annot.e_MKEntryRotation 开始的值，这应该是这些值之一。

返回
  None.

## ◆ SetAction()

FSDK::Widget::SetAction | ( | action |  | ) |

设置动作。

此函数不能用于设置用作附加动作的动作。 如果用户想要设置任何附加动作，请参阅类 FSDK.AdditionalAction 了解更多详细信息。

参数

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

返回
  None.

## ◆ SetAppearanceState()

FSDK::Widget::SetAppearanceState | ( | appearance_state |  | ) |

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

参数

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

返回
  None.

## ◆ SetHighlightingMode()

FSDK::Widget::SetHighlightingMode | ( | mode |  | ) |

设置高亮模式。

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

参数

  [in] | mode | 新的高亮模式值。请参阅从 FSDK.Annot.e_HighlightingNone 开始的值， 这应该是这些值之一。

返回
  None.

## ◆ SetLineSpacing()

FSDK::Widget::SetLineSpacing | ( | line_spacing_style | ,
|  | line_spacing_value |
| ) |  |

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

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

参数

  [in] | line_spacing_style | 要设置到当前小部件的行间距样式。请参阅从 FSDK.Widget.e_LineSpacingSingle 开始的值， 这将是这些值之一。
  [in] | line_spacing_value | 当参数 line_spacing_style 为 FSDK.Widget.e_LineSpacingExactValue 时，要设置到当前小部件的行间距精确值。 当此参数有用时，此参数必须为非负值，单位应为“pt”（称为磅）。 如果此值为零，行间距的效果将与单個行距相同。

返回
  None.

## ◆ SetMKBackgroundColor()

FSDK::Widget::SetMKBackgroundColor | ( | color |  | ) |

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

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

参数

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

返回
  None.

## ◆ SetMKBorderColor()

FSDK::Widget::SetMKBorderColor | ( | color |  | ) |

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

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

参数

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

返回
  None.

## ◆ SetMKDownCaption()

FSDK::Widget::SetMKDownCaption | ( | caption |  | ) |

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

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

参数

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

返回
  None.

## ◆ SetMKDownIconBitmap()

FSDK::Widget::SetMKDownIconBitmap | ( | bitmap |  | ) |

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

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

参数

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

返回
  None.

## ◆ SetMKDownIconImage()

FSDK::Widget::SetMKDownIconImage | ( | image | ,
|  | frame_index |
| ) |  |

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

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

参数

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

## ◆ SetMKIconCaptionRelation()

FSDK::Widget::SetMKIconCaptionRelation | ( | relation |  | ) |

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

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

参数

  [in] | relation | 标题和图标的关系位置。请参阅从 FSDK.Annot.e_MKRelationNoIcon 开始的值，这应该是这些值之一。

返回
  None.

## ◆ SetMKIconFit()

FSDK::Widget::SetMKIconFit | ( | icon_fit |  | ) |

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

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

参数

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

返回
  None.

## ◆ SetMKNormalCaption()

FSDK::Widget::SetMKNormalCaption | ( | caption |  | ) |

设置 MK 字典中的正常标题字符串。

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

参数

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

返回
  None.

## ◆ SetMKNormalIconBitmap()

FSDK::Widget::SetMKNormalIconBitmap | ( | bitmap |  | ) |

将位图设置为 MK 字典中的正常图标。

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

参数

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

返回
  None.

## ◆ SetMKNormalIconImage()

FSDK::Widget::SetMKNormalIconImage | ( | image | ,
|  | frame_index |
| ) |  |

将具有指定帧索引的图像设置为 MK 字典中的正常图标。

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

参数

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

## ◆ SetMKRolloverCaption()

FSDK::Widget::SetMKRolloverCaption | ( | caption |  | ) |

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

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

参数

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

返回
  None.

## ◆ SetMKRolloverIconBitmap()

FSDK::Widget::SetMKRolloverIconBitmap | ( | bitmap |  | ) |

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

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

参数

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

返回
  None.

## ◆ SetMKRolloverIconImage()

FSDK::Widget::SetMKRolloverIconImage | ( | image | ,
|  | frame_index |
| ) |  |

将具有指定帧索引的图像设置为 MK 字典中的翻滚图标。

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

参数

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

## ◆ SetMKRotation()

FSDK::Widget::SetMKRotation | ( | rotation |  | ) |

设置 MK 字典中的旋转值。

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

参数

  [in] | rotation | 要在 MK 字典中设置的旋转值。请参阅从 FSDK.e_Rotation0 开始的值，这应该是这些值之一，但不包括 FSDK.e_RotationUnknown。特别地，此处的旋转值以逆时针方向表示。

## 类成员变量说明

## ◆ e_LineSpacingSingle

FSDK::Widget::e_LineSpacingSingle
| static

行间距样式的枚举。

此枚举的值应单独使用。

行间距样式：单倍行距。