fsdk.FreeText类 参考

Public 成员函数
def	AllowTextOverflow (is_text_overflow)
	决定是否允许自由文本的文本溢出。 更多...
def	GetAlignment ()
def	GetCalloutLineEndingStyle ()
	获取标注线起点的线条结束样式。 更多...
def	GetCalloutLinePoints ()
	获取标注线点。 更多...
def	GetDefaultAppearance ()
	获取默认外观数据。 更多...
def	GetFillColor ()
	获取填充颜色。 更多...
def	GetInnerRect ()
	获取内部矩形。 更多...
def	GetRotation ()
	获取当前旋转值（顺时针）。 更多...
def	GetTextMatrix ()
def	Rotate (rotation)
	从当前状态按指定旋转值（顺时针）旋转当前注释。 更多...
def	SetAlignment (alignment)
def	SetCalloutLineEndingStyle (ending_style)
	设置标注线起点的线条结束样式。 更多...
def	SetCalloutLinePoints (point_array)
	设置标注线的点。 更多...
def	SetDefaultAppearance (default_ap)
	设置默认外观数据。 更多...
def	SetFillColor (fill_color)
	设置填充颜色。 更多...
def	SetInnerRect (inner_rect)
	设置内部矩形。 更多...
def	SetRotation (rotation)
	设置旋转值（顺时针）。 更多...
def	SetTextMatrix (text_matrix)

详细描述

自由文本注释直接在页面上显示文本。因此自由文本注释不需要相关的弹出注释来显示文本。
自由文本注释是一种标记注释，所以类FreeText 派生自 类Markup ，并且还提供了获取/设置自由文本注释属性和 重置自由文本注释外观流的函数。

注解

对于新创建的自由文本注释，如果用户直接调用函数fsdk.Annot.ResetAppearanceStream 而不设置任何属性，将使用默认外观：
边框宽度 = 1.0，边框样式 = fsdk.BorderInfoE_Solid ， 边框颜色 = 0xFFFF0000（红色），不透明度 = 1.0，对齐方式 = 0（左对齐）， 默认外观标志 = fsdk.DefaultAppearanceE_FlagFont | fsdk.DefaultAppearanceE_FlagTextColor | fsdk.DefaultAppearanceE_FlagFontSize ， 默认外观字体基于fsdk.FontE_StdIDHelvetica 创建， 默认外观文本大小 = 12，默认外观文本颜色 = 0xFF0000FF（蓝色）。

参见

Markup

成员函数说明

AllowTextOverflow()

def fsdk.FreeText.AllowTextOverflow

(

is_text_overflow

)

决定是否允许自由文本的文本溢出。

对于标注对象和文本框对象，如果未调用此函数，默认情况下标注或文本框的文本允许溢出。 对于打字机对象，如果未调用此函数，默认情况下打字机的文本不允许溢出。

参数

[in]

is_text_overflow

决定当自由文本矩形的大小小于文本内容大小时， 是否允许文本内容溢出的布尔值： true表示文本内容允许溢出。在这种情况下， 溢出的文本内容将被截断。 false表示文本内容不允许溢出。在这种情况下， 标注矩形将自动适应以包含整个文本内容。

返回

无。

GetAlignment()

def fsdk.FreeText.GetAlignment

(

)

弃用:

当前函数自福昕PDF SDK 8.2起已被弃用。此属性将不再对自由文本注释的外观 产生任何影响。要获取对齐属性，请调用函数fsdk.Markup.GetRichTextStyle 。 有关RichText相关函数的更多详细信息，请参考Markup 。

此属性对自由文本注释的外观有影响。

返回

对齐值。请参考从fsdk.E_AlignmentLeft 开始的值， 这将是这些值中的一个。

GetCalloutLineEndingStyle()

def fsdk.FreeText.GetCalloutLineEndingStyle

(

)

获取标注线起点的线条结束样式。

只有当自由文本注释的意图名称为"FreeTextCallout"时， 此自由文本注释才能具有线条结束样式属性，且此属性对这种 自由文本注释的外观有影响。

返回

起点的线条结束样式。请参考从fsdk.MarkupE_EndingStyleNone 开始的值， 这将是这些值中的一个。

GetCalloutLinePoints()

def fsdk.FreeText.GetCalloutLinePoints

(

)

获取标注线点。

只有当自由文本注释的意图名称为"FreeTextCallout"时，此自由文本注释才能 具有标注线点属性，且此属性对这种自由文本注释的外观有影响。对于标注线， 它可以包含2个或3个点：

• 2个点表示标注线的起点和终点。

• 3个点表示标注线的起点、拐点和终点。

返回

表示标注自由文本注释的标注线所用点的点数组。

GetDefaultAppearance()

def fsdk.FreeText.GetDefaultAppearance

(

)

获取默认外观数据。

此属性对自由文本注释的外观有影响。默认外观数据可用于 格式化文本。

返回

默认外观数据。

GetFillColor()

def fsdk.FreeText.GetFillColor

(

)

获取填充颜色。

此属性对自由文本注释的外观有影响。填充颜色用于填充 文本框的背景，也用于某些标注线结束样式：
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。

返回

填充颜色。格式：0xRRGGBB。 如果找不到填充颜色，将返回0x000000。

GetInnerRect()

def fsdk.FreeText.GetInnerRect

(

)

获取内部矩形。

此属性对自由文本注释的外观有影响。对于自由文本注释， 内部矩形是应该显示注释文本的位置。内部矩形可能与注释矩形相同 或小于注释矩形，但绝不应大于注释矩形。

返回

内部矩形。

GetRotation()

def fsdk.FreeText.GetRotation

(

)

获取当前旋转值（顺时针）。

返回

当前旋转值（顺时针）。请参考从fsdk.E_Rotation0 开始的值， 这将是这些值中的一个。

GetTextMatrix()

def fsdk.FreeText.GetTextMatrix

(

)

弃用:

当前函数自福昕PDF SDK 7.4起已被弃用。此属性将不再对注释外观 产生任何影响。

此属性对自由文本注释的外观有影响。此属性可用于 改变文本显示的倾斜度。

返回

默认外观中用于文本的矩阵。

Rotate()

def fsdk.FreeText.Rotate

(

rotation

)

从当前状态按指定旋转值（顺时针）旋转当前注释。

参数

[in]

rotation

表示用于从当前状态顺时针旋转当前注释的度数的旋转值。 请参考从fsdk.E_Rotation0 开始的值， 这应该是这些值中的一个，除了fsdk.E_RotationUnknown 。 特别地，如果输入值是fsdk.E_Rotation0 （意味着不旋转当前注释），当前函数将不执行任何操作。

返回

true表示成功，而false表示失败。

SetAlignment()

def fsdk.FreeText.SetAlignment

(

alignment

)

弃用:

当前函数自福昕PDF SDK 8.2起已被弃用。此属性将不再对自由文本注释的外观 产生任何影响。要设置对齐属性，请调用函数fsdk.Markup.SetRichTextStyle 。 有关RichText相关函数的更多详细信息，请参考Markup 。

此属性对自由文本注释的外观有影响。如果用户希望新的对齐方式对注释外观 产生效果，请在设置新对齐方式后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in]

alignment

新的对齐值。请参考从fsdk.E_AlignmentLeft 开始的值， 这应该是这些值中的一个。 如果使用其他值进行设置，默认将使用fsdk.E_AlignmentLeft 。

返回

无。

SetCalloutLineEndingStyle()

def fsdk.FreeText.SetCalloutLineEndingStyle

(

ending_style

)

设置标注线起点的线条结束样式。

只有当自由文本注释的意图名称为"FreeTextCallout"时， 此自由文本注释才能具有线条结束样式属性，且此属性对这种 自由文本注释的外观有影响。
如果用户希望新的线条结束样式对注释外观产生效果，请在设置新线条结束样式后 调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in]

ending_style

要设置的起点线条结束样式。请参考从 fsdk.MarkupE_EndingStyleNone 开始的值， 这应该是这些值中的一个。

返回

无。

SetCalloutLinePoints()

def fsdk.FreeText.SetCalloutLinePoints

(

point_array

)

设置标注线的点。

只有当自由文本注释的意图名称为"FreeTextCallout"时，此自由文本注释才能 具有标注线点属性，且此属性对这种自由文本注释的外观有影响。对于标注线， 它可以包含2个或3个点：

• 2个点表示标注线的起点和终点。

• 3个点表示标注线的起点、拐点和终点。

如果用户希望新的标注线点对注释外观产生效果，请在设置新标注线点后 调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in]

point_array

指定标注线起点、拐点（如果有）和终点的新点数组。 元素数量应为2或3： 2个点表示起点和终点；3个点表示起点、拐点和终点。 如果元素数量超过3，只有前3个点将被用于设置标注线。

返回

无。

SetDefaultAppearance()

def fsdk.FreeText.SetDefaultAppearance

(

default_ap

)

设置默认外观数据。

此属性对自由文本注释的外观有影响。默认外观数据可用于 格式化文本。
如果用户希望新的默认外观数据对注释外观产生效果， 请在设置新默认外观数据后调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in]

default_ap

要设置的新默认外观数据。 输入数据的flags可用于决定哪些信息将用新数据更新； 对于那些不更新的数据，它们将继续使用旧数据。

返回

true表示成功，而false表示失败。 特别地，如果参数default_ap包含任何不正确的值， 此函数将返回false，例如：

• 输入数据的flags包含fsdk.DefaultAppearanceE_FlagFont 但输入数据的font无效。

• 输入数据的flags包含fsdk.DefaultAppearanceE_FlagFontSize 但输入数据的text size不大于零。

SetFillColor()

def fsdk.FreeText.SetFillColor

(

fill_color

)

设置填充颜色。

此属性对自由文本注释的外观有影响。填充颜色用于填充文本框的背景， 也用于某些标注线结束样式：
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。
如果用户希望新的填充颜色对注释外观产生效果，请在设置新填充颜色后 调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in]

fill_color

要设置的新填充颜色。格式：0xRRGGBB。

返回

无。

SetInnerRect()

def fsdk.FreeText.SetInnerRect

(

inner_rect

)

设置内部矩形。

此属性对自由文本注释的外观有影响。对于自由文本注释， 内部矩形是应该显示注释文本的位置。内部矩形可能与注释矩形相同 或小于注释矩形，但绝不应大于注释矩形。
如果用户希望新的内部矩形对注释外观产生效果，请在设置新内部矩形后 调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in]

inner_rect

要设置的新内部矩形。它应该与注释矩形相同或小于注释矩形。

返回

无。

SetRotation()

def fsdk.FreeText.SetRotation

(

rotation

)

设置旋转值（顺时针）。

此属性对自由文本注释的外观有影响。如果用户希望新的旋转 对注释外观产生效果，请在设置新旋转后调用函数 fsdk.Annot.ResetAppearanceStream 。

参数

[in]

rotation

要设置给当前自由文本注释的新旋转值（顺时针）。 请参考从fsdk.E_Rotation0 开始的值， 这应该是这些值中的一个，除了fsdk.E_RotationUnknown 。

返回

无。

SetTextMatrix()

def fsdk.FreeText.SetTextMatrix

(

text_matrix

)

弃用:

当前函数自福昕PDF SDK 7.4起已被弃用。此属性将不再对注释外观 产生任何影响。

此属性对自由文本注释的外观有影响。此属性可用于 改变文本显示的倾斜度。
如果用户希望新的文本矩阵对注释外观产生效果，请在设置新文本矩阵后 调用函数fsdk.Annot.ResetAppearanceStream 。

参数

[in]

text_matrix

新的文本矩阵。

返回

无。