Public 成员函数
def	GetAction ()
	获取动作。更多...

def	GetAppearanceOnStateName ()
	获取注释外观"ON"状态的名称。更多...

def	GetAppearanceState ()
	获取注释的外观状态，从外观子字典中选择适用的外观流。更多...

def	GetControl ()
	获取关联的表单控件。更多...

def	GetField ()
	获取关联的表单字段。更多...

def	GetHighlightingMode ()
	获取高亮模式。更多...

def	GetMKBackgroundColor ()
	获取 MK 字典中的背景颜色。更多...

def	GetMKBorderColor ()
	获取 MK 字典中的边框颜色。更多...

def	GetMKDownCaption ()
	获取 MK 字典中的向下标题字符串。更多...

def	GetMKDownIconBitmap ()
	获取MK字典中的按下图标位图。更多...

def	GetMKIconCaptionRelation ()
	获取MK字典中图标和标题的关系。更多...

def	GetMKIconFit ()
	获取MK字典中的图标适合信息。更多...

def	GetMKNormalCaption ()
	获取 MK 字典中的普通标题字符串。更多...

def	GetMKNormalIconBitmap ()
	获取 MK 字典中的普通图标位图。更多...

def	GetMKRolloverCaption ()
	获取 MK 字典中的翻转标题字符串。更多...

def	GetMKRolloverIconBitmap ()
	获取 MK 字典中的翻转图标位图。更多...

def	GetMKRotation ()
	获取 MK 字典中的旋转值。更多...

def	HasMKEntry (mk_entry)
	检查在 MK 字典中是否存在指定的条目。更多...

def	RemoveAction ()
	移除动作。更多...

def	RemoveMKEntry (mk_entry)
	从 MK 字典中移除指定的条目。更多...

def	SetAction (action)
	设置动作。更多...

def	SetAppearanceState (appearance_state)
	设置注释的外观状态，从外观子字典中选择适用的外观流。更多...

def	SetHighlightingMode (mode)
	设置高亮模式。更多...

def	SetLineSpacing (line_spacing_style, line_spacing_value)
	设置当前小部件的行间距。更多...

def	SetMKBackgroundColor (color)
	设置 MK 字典中的背景颜色。更多...

def	SetMKBorderColor (color)
	设置 MK 字典中的边框颜色。更多...

def	SetMKDownCaption (caption)
	设置 MK 字典中的向下标题字符串。更多...

def	SetMKDownIconBitmap (bitmap)
	设置MK字典中的按下图标位图。更多...

def	SetMKDownIconImage (image, frame_index)
	设置指定帧索引的图像作为MK字典中的按下图标。更多...

def	SetMKIconCaptionRelation (relation)
	设置MK字典中图标和标题的关系。更多...

def	SetMKIconFit (icon_fit)
	设置MK字典中的图标适合信息。更多...

def	SetMKNormalCaption (caption)
	设置 MK 字典中的普通标题字符串。更多...

def	SetMKNormalIconBitmap (bitmap)
	设置一个位图作为 MK 字典中的普通图标。更多...

def	SetMKNormalIconImage (image, frame_index)
	设置指定帧索引的图像作为 MK 字典中的普通图标。更多...

def	SetMKRolloverCaption (caption)
	设置 MK 字典中的翻转标题字符串。更多...

def	SetMKRolloverIconBitmap (bitmap)
	设置MK字典中的翻转图标位图。更多...

def	SetMKRolloverIconImage (image, frame_index)
	设置指定帧索引的图像作为MK字典中的翻转图标。更多...

def	SetMKRotation (rotation)
	设置 MK 字典中的旋转值。更多...

详细描述

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

参见: Annot; fsdk.Field; fsdk.Control

成员函数说明

◆ GetAction()

def fsdk.Widget.GetAction ( )

获取动作。

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

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

◆ GetAppearanceOnStateName()

def fsdk.Widget.GetAppearanceOnStateName ( )

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

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

◆ GetAppearanceState()

def fsdk.Widget.GetAppearanceState ( )

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

返回: 注释的外观状态。

◆ GetControl()

def fsdk.Widget.GetControl ( )

获取关联的表单控件。

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

◆ GetField()

def fsdk.Widget.GetField ( )

获取关联的表单字段。

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

◆ GetHighlightingMode()

def fsdk.Widget.GetHighlightingMode ( )

获取高亮模式。

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

返回: 高亮模式值。请参考从fsdk.AnnotE_HighlightingNone 开始的值，这将是这些值中的一个。

◆ GetMKBackgroundColor()

def fsdk.Widget.GetMKBackgroundColor ( )

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

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

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

◆ GetMKBorderColor()

def fsdk.Widget.GetMKBorderColor ( )

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

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

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

◆ GetMKDownCaption()

def fsdk.Widget.GetMKDownCaption ( )

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

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

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

◆ GetMKDownIconBitmap()

def fsdk.Widget.GetMKDownIconBitmap ( )

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

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

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

◆ GetMKIconCaptionRelation()

def fsdk.Widget.GetMKIconCaptionRelation ( )

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

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

返回: 标题和图标的关系位置。请参考fsdk.AnnotE_MKRelationNoIcon 值，这应该是这些值中的一个。

◆ GetMKIconFit()

def fsdk.Widget.GetMKIconFit ( )

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

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

返回: 图标适合对象，包含MK字典中的图标适合信息。如果图标适合对象的缩放方式类型是值fsdk.IconFitE_ScaleWayNone ，则表示MK字典中没有图标适合信息。

◆ GetMKNormalCaption()

def fsdk.Widget.GetMKNormalCaption ( )

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

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

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

◆ GetMKNormalIconBitmap()

def fsdk.Widget.GetMKNormalIconBitmap ( )

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

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

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

◆ GetMKRolloverCaption()

def fsdk.Widget.GetMKRolloverCaption ( )

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

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

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

◆ GetMKRolloverIconBitmap()

def fsdk.Widget.GetMKRolloverIconBitmap ( )

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

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

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

◆ GetMKRotation()

def fsdk.Widget.GetMKRotation ( )

获取 MK 字典中的旋转值。

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

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

◆ HasMKEntry()

def fsdk.Widget.HasMKEntry ( mk_entry )

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

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

参数

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

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

◆ RemoveAction()

def fsdk.Widget.RemoveAction ( )

移除动作。

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

返回: 无。

◆ RemoveMKEntry()

def fsdk.Widget.RemoveMKEntry ( mk_entry )

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

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

参数

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

返回: 无。

◆ SetAction()

def fsdk.Widget.SetAction ( action )

设置动作。

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

参数

[in] action 要设置的新动作。它应该是有效的。当前仅支持以下类型作为新动作：
fsdk.ActionE_TypeGoto , fsdk.ActionE_TypeURI , fsdk.ActionE_TypeJavaScript , fsdk.ActionE_TypeNamed , fsdk.ActionE_TypeGoToR , fsdk.ActionE_TypeGoToE , fsdk.ActionE_TypeSubmitForm , fsdk.ActionE_TypeResetForm , fsdk.ActionE_TypeHide , fsdk.ActionE_TypeLaunch , fsdk.ActionE_TypeImportData , fsdk.ActionE_TypeRendition 。

返回: 无。

◆ SetAppearanceState()

def fsdk.Widget.SetAppearanceState ( appearance_state )

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

参数

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

返回: 无。

◆ SetHighlightingMode()

def fsdk.Widget.SetHighlightingMode ( mode )

设置高亮模式。

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

参数

[in] mode 新的高亮模式值。请参考从 fsdk.AnnotE_HighlightingNone 开始的值，这应该是这些值中的一个。

返回: 无。

◆ SetLineSpacing()

def fsdk.Widget.SetLineSpacing	(	line_spacing_style,
		line_spacing_value
	)

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

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

参数

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

返回: 无。

◆ SetMKBackgroundColor()

def fsdk.Widget.SetMKBackgroundColor ( color )

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

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

参数

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

返回: 无。

◆ SetMKBorderColor()

def fsdk.Widget.SetMKBorderColor ( color )

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

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

参数

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

返回: 无。

◆ SetMKDownCaption()

def fsdk.Widget.SetMKDownCaption ( caption )

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

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

参数

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

返回: 无。

◆ SetMKDownIconBitmap()

def fsdk.Widget.SetMKDownIconBitmap ( bitmap )

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

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

参数

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

返回: 无。

◆ SetMKDownIconImage()

def fsdk.Widget.SetMKDownIconImage	(	image,
		frame_index
	)

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

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

参数

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

◆ SetMKIconCaptionRelation()

def fsdk.Widget.SetMKIconCaptionRelation ( relation )

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

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

参数

[in] relation 标题和图标的关系位置。请参考从 fsdk.AnnotE_MKRelationNoIcon 开始的值，这应该是这些值中的一个。

返回: 无。

◆ SetMKIconFit()

def fsdk.Widget.SetMKIconFit ( icon_fit )

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

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

参数

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

返回: 无。

◆ SetMKNormalCaption()

def fsdk.Widget.SetMKNormalCaption ( caption )

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

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

参数

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

返回: 无。

◆ SetMKNormalIconBitmap()

def fsdk.Widget.SetMKNormalIconBitmap ( bitmap )

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

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

参数

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

返回: 无。

◆ SetMKNormalIconImage()

def fsdk.Widget.SetMKNormalIconImage	(	image,
		frame_index
	)

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

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

参数

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

◆ SetMKRolloverCaption()

def fsdk.Widget.SetMKRolloverCaption ( caption )

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

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

参数

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

返回: 无。

◆ SetMKRolloverIconBitmap()

def fsdk.Widget.SetMKRolloverIconBitmap ( bitmap )

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

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

参数

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

返回: 无。

◆ SetMKRolloverIconImage()

def fsdk.Widget.SetMKRolloverIconImage	(	image,
		frame_index
	)

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

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

参数

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

◆ SetMKRotation()

def fsdk.Widget.SetMKRotation ( rotation )

设置 MK 字典中的旋转值。

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

参数

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

Public 成员函数

详细描述

成员函数说明

◆ GetAction()

◆ GetAppearanceOnStateName()

◆ GetAppearanceState()

◆ GetControl()

◆ GetField()

◆ GetHighlightingMode()

◆ GetMKBackgroundColor()

◆ GetMKBorderColor()

◆ GetMKDownCaption()

◆ GetMKDownIconBitmap()

◆ GetMKIconCaptionRelation()

◆ GetMKIconFit()

◆ GetMKNormalCaption()

◆ GetMKNormalIconBitmap()

◆ GetMKRolloverCaption()

◆ GetMKRolloverIconBitmap()

◆ GetMKRotation()

◆ HasMKEntry()

◆ RemoveAction()

◆ RemoveMKEntry()

◆ SetAction()

◆ SetAppearanceState()

◆ SetHighlightingMode()

◆ SetLineSpacing()

◆ SetMKBackgroundColor()

◆ SetMKBorderColor()

◆ SetMKDownCaption()

◆ SetMKDownIconBitmap()

◆ SetMKDownIconImage()

◆ SetMKIconCaptionRelation()

◆ SetMKIconFit()

◆ SetMKNormalCaption()

◆ SetMKNormalIconBitmap()

◆ SetMKNormalIconImage()

◆ SetMKRolloverCaption()

◆ SetMKRolloverIconBitmap()

◆ SetMKRolloverIconImage()

◆ SetMKRotation()