fsdk.Field类 参考

Public 成员函数
def	GetAlignment ()
	获取对齐值。 更多...
def	GetAlternateName ()
	获取备用名称。 更多...
def	GetControl (index)
	通过索引获取表单控件。 更多...
def	GetControl (page, index)
	在指定PDF页面中通过索引获取表单控件。 更多...
def	GetControlCount (a, interface)
	获取表单控件数量。 更多...
def	GetControlCount (page)
	获取指定PDF页面中的表单控件数量。 更多...
def	GetDefaultAppearance ()
	获取默认外观数据。 更多...
def	GetDefaultValue ()
	获取默认值。 更多...
def	GetDefaultValueObj ()
	获取字段默认值的PDF对象。 更多...
def	GetDict ()
	获取当前对象的PDF字典。 更多...
def	GetFlags ()
	获取字段标志。 更多...
def	GetInheritedAttribute (attribute_name)
	获取指定属性的PDF对象，该属性可能从字段树中的祖先节点继承。 更多...
def	GetMappingName ()
	获取映射名称。 更多...
def	GetMaxLength ()
	获取字段文本的最大长度（以字符为单位）。 更多...
def	GetName ()
	获取字段名称。 更多...
def	GetOptions ()
	获取列表框或组合框的选项。 更多...
def	GetTopVisibleIndex ()
	获取可滚动列表框的选项顶部索引。 更多...
def	GetType ()
	获取字段类型。 更多...
def	GetValue ()
	获取值。 更多...
def	GetValueObj ()
	获取字段值的PDF对象。 更多...
def	IsEmpty ()
	检查当前对象是否为空。 更多...
def	Reset ()
	将当前字段中的数据重置为其默认值。（不支持签名字段） 更多...
def	SetAlignment (alignment)
	设置表单的对齐属性，作为文档范围的默认值。（不支持签名字段） 更多...
def	SetAlternateName (alternate_name)
	设置备用名称。（不支持签名字段） 更多...
def	SetDefaultAppearance (default_ap)
	设置默认外观数据。 更多...
def	SetDefaultValue (value)
	设置默认值。 更多...
def	SetFlags (flags)
	设置字段标志。 更多...
def	SetMappingName (name)
	设置映射名称。（不支持签名字段） 更多...
def	SetMaxLength (max_length)
	设置字段文本的最大长度（以字符为单位）。 更多...
def	SetOptions (option_array)
	设置列表框或组合框的选项。 更多...
def	SetTopVisibleIndex (index)
	设置可滚动列表框的顶部索引。 更多...
def	SetValue (value)
	设置值。 更多...

详细描述

在PDF文档中，表单字段出现在页面的任何组合上，所有这些字段组成一个跨越整个文档的 单一全局交互式表单。函数fsdk.Form.GetField 可用于从交互式表单获取表单字段。 此类提供了获取表单字段一些信息/属性、将表单字段重置为其默认值以及从表单字段获取 表单控件的函数。
当表单字段的类型为fsdk.FieldE_TypeSignature 时， 表单字段对象实际上是一个签名对象。
要访问附加操作，请使用Field对象构造fsdk.AdditionalAction 对象。

参见

Form

fsdk.Signature

fsdk.AdditionalAction

成员函数说明

GetAlignment()

def fsdk.Field.GetAlignment

(

)

获取对齐值。

对齐是可变文本的属性，仅对文本字段、列表框和组合框有用， 这些字段可能包含可变文本作为其内容。
如果文本字段或列表框有自己的对齐值，则将忽略文档范围的默认对齐值； 否则，将为文本字段或列表框使用文档范围的默认对齐值。

返回

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

GetAlternateName()

def fsdk.Field.GetAlternateName

(

)

获取备用名称。

备用字段名称用于在用户界面中必须标识字段的任何地方 （例如在引用字段的错误或状态消息中）代替实际字段名称。 此文本在提取文档内容以支持残障用户的可访问性或其他目的时也很有用。

返回

备用名称。

GetControl() [1/2]

def fsdk.Field.GetControl

(

index

)

通过索引获取表单控件。

参数

[in]

index

表单控件索引。有效范围：从0到(count-1)。 count由函数fsdk.Field.GetControlCount 返回。

返回

表单控件对象。

GetControl() [2/2]

def fsdk.Field.GetControl	(		page,
			index
	)

在指定PDF页面中通过索引获取表单控件。

参数

[in]	page	有效的PDF页面对象。它应该与当前表单字段在同一文档中。
[in]	index	表单控件索引。有效范围：从0到(count-1)。 count由函数fsdk.Field.GetControlCount 使用 相同参数page返回。

返回

表单控件对象。

GetControlCount() [1/2]

def fsdk.Field.GetControlCount	(		a,
			interface
	)

获取表单控件数量。

返回

表单控件的数量。

GetControlCount() [2/2]

def fsdk.Field.GetControlCount

(

page

)

获取指定PDF页面中的表单控件数量。

参数

[in]

page

有效的PDF页面对象。它应该与当前表单字段在同一文档中。

返回

指定PDF页面中表单控件的数量。

GetDefaultAppearance()

def fsdk.Field.GetDefaultAppearance

(

)

获取默认外观数据。

返回

默认外观数据。

GetDefaultValue()

def fsdk.Field.GetDefaultValue

(

)

获取默认值。

适用于除按钮以外的所有字段。

返回

默认值字符串。对于不适用的字段类型，将返回空字符串。

GetDefaultValueObj()

def fsdk.Field.GetDefaultValueObj

(

)

获取字段默认值的PDF对象。

字段默认值的格式因字段类型而异。有关更多详细信息， 请参考《PDF参考1.7》P676中的"表8.69 所有字段字典的通用条目"。

返回

PDF对象。如果没有"DV"条目或发生任何错误，此函数将返回null。

GetDict()

def fsdk.Field.GetDict

(

)

获取当前对象的PDF字典。

返回

当前对象的PDF字典。如果有任何错误，函数将返回null。

GetFlags()

def fsdk.Field.GetFlags

(

)

获取字段标志。

字段标志指定表单字段的各种特征。

返回

表单字段标志。请参考从fsdk.FieldE_FlagReadOnly 开始的值， 这将是其中一个值或这些值的组合。

GetInheritedAttribute()

def fsdk.Field.GetInheritedAttribute

(

attribute_name

)

获取指定属性的PDF对象，该属性可能从字段树中的祖先节点继承。

某些字段属性被指定为可继承的，例如"Ff"、"V"、"DV"等。 请参考《PDF参考1.7》P675中的"表8.69 所有字段字典的通用条目"。 如果没有由attribute_name指定的条目或发生任何错误，此函数将返回null。

参数

[in]

attribute_name

要查找的属性名称。

返回

PDF对象。如果未找到，此函数将返回null。

GetMappingName()

def fsdk.Field.GetMappingName

(

)

获取映射名称。

映射名称用于从文档导出交互式表单字段数据时使用。

返回

映射名称。

GetMaxLength()

def fsdk.Field.GetMaxLength

(

)

获取字段文本的最大长度（以字符为单位）。

适用于文本字段。对于不适用的字段类型，此函数将返回0。

返回

字段文本的最大长度。

GetName()

def fsdk.Field.GetName

(

)

获取字段名称。

返回

字段名称字符串。

GetOptions()

def fsdk.Field.GetOptions

(

)

获取列表框或组合框的选项。

适用于列表框和组合框。对于不适用的字段类型， 此函数将返回空数组。

返回

包含选项的数组。

GetTopVisibleIndex()

def fsdk.Field.GetTopVisibleIndex

(

)

获取可滚动列表框的选项顶部索引。

适用于列表框。对于不适用的字段类型， 此函数将返回0。
选项的顶部索引是列表中第一个可见选项的索引。

返回

列表框可见范围内第一项的索引。

GetType()

def fsdk.Field.GetType

(

)

获取字段类型。

返回

表单字段类型。请参考从fsdk.FieldE_TypeUnknown 开始的值， 这将是其中一个值。

GetValue()

def fsdk.Field.GetValue

(

)

获取值。

适用于除按钮以外的所有字段。 对于不适用的字段类型，将返回空字符串。 对于复选框和单选框，此函数将返回外观状态值。

返回

值字符串。特别地，当当前字段是具有多个值的列表框字段时， 只返回第一个值。

GetValueObj()

def fsdk.Field.GetValueObj

(

)

获取字段值的PDF对象。

字段值的格式因字段类型而异。有关更多详细信息，请参考 《PDF参考1.7》P676中的"表8.69 所有字段字典的通用条目"。

返回

PDF对象。如果没有"V"条目或发生任何错误，此函数将返回null。

IsEmpty()

def fsdk.Field.IsEmpty

(

)

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回

true 表示当前对象为空，false 表示非空。

Reset()

def fsdk.Field.Reset

(

)

将当前字段中的数据重置为其默认值。（不支持签名字段）

返回

true 表示成功，false 表示当前表单字段是签名字段或失败。

SetAlignment()

def fsdk.Field.SetAlignment

(

alignment

)

设置表单的对齐属性，作为文档范围的默认值。（不支持签名字段）

对齐是可变文本的属性，仅对文本字段、列表框和组合框有用， 这些字段可能包含可变文本作为其内容。
如果文本字段或列表框有自己的对齐值，则将忽略文档范围的默认对齐值； 否则，将为文本字段或列表框使用文档范围的默认对齐值。
如果当前表单字段是签名字段，此函数不执行任何操作。

参数

[in]

alignment

可变文本的新默认对齐类型。请参考从 fsdk.E_AlignmentLeft 开始的值，这应该是其中一个值。 如果使用其他值设置，默认将使用fsdk.E_AlignmentLeft 。

返回

无。

SetAlternateName()

def fsdk.Field.SetAlternateName

(

alternate_name

)

设置备用名称。（不支持签名字段）

备用字段名称用于在用户界面中必须标识字段的任何地方 （例如在引用字段的错误或状态消息中）代替实际字段名称。 此文本在提取文档内容以支持残障用户的可访问性或其他目的时也很有用。
如果当前表单字段是签名字段，此函数不执行任何操作。

参数

[in]

alternate_name

新的备用名称字符串。它不应该是空字符串。

返回

无。

SetDefaultAppearance()

def fsdk.Field.SetDefaultAppearance

(

default_ap

)

设置默认外观数据。

参数

[in]

default_ap

新的默认外观。输入数据的flags可用于决定 哪些信息要用新数据更新；对于那些没有更新的数据， 它们将继续使用旧数据。 如果输入默认外观数据的text_size为0，意味着文本大小 应该自动计算。

返回

无。

SetDefaultValue()

def fsdk.Field.SetDefaultValue

(

value

)

设置默认值。

适用于除按钮以外的所有字段。 对于不适用的字段类型，此函数不执行任何操作。

参数

[in]

value

新的默认值字符串。它不应该是空字符串。

返回

无。

SetFlags()

def fsdk.Field.SetFlags

(

flags

)

设置字段标志。

字段标志指定表单字段的各种特征。

参数

[in]

flags

新的表单字段标志。请参考从fsdk.FieldE_FlagReadOnly 开始的值， 这应该是其中一个值或这些值的组合。

返回

无。

SetMappingName()

def fsdk.Field.SetMappingName

(

name

)

设置映射名称。（不支持签名字段）

映射名称用于从文档导出交互式表单字段数据时使用。 如果当前表单字段是签名字段，此函数不执行任何操作。

参数

[in]

name

新的映射名称字符串。它不应该是空字符串。

返回

无。

SetMaxLength()

def fsdk.Field.SetMaxLength

(

max_length

)

设置字段文本的最大长度（以字符为单位）。

适用于文本字段。对于不适用的字段类型，此函数不执行任何操作。

参数

[in]

max_length

字段文本的新最大长度。它应该是非负数。

返回

无。

SetOptions()

def fsdk.Field.SetOptions

(

option_array

)

设置列表框或组合框的选项。

适用于列表框和组合框。对于不适用的字段类型， 此函数不执行任何操作。

参数

[in]

option_array

要设置到列表框或组合框的选项数组。

返回

无。

SetTopVisibleIndex()

def fsdk.Field.SetTopVisibleIndex

(

index

)

设置可滚动列表框的顶部索引。

适用于列表框。对于不适用的字段类型， 此函数不执行任何操作。
选项的顶部索引是列表中第一个可见选项的索引。

参数

[in]

index

列表中第一个可见选项的索引。

返回

无。

SetValue()

def fsdk.Field.SetValue

(

value

)

设置值。

适用于除按钮以外的所有字段。对于不适用的字段类型， 此函数不执行任何操作。
特别地，对于组合框和文本字段，当成功设置值时，此函数还将 触发相关的计算和格式化事件并更新字段的外观。

参数

[in]

value

新值字符串。特别地，当当前字段是列表框字段时，此参数可以 包含多个值： 当要设置多个值时，每个值应该用"()"包装。例如， "(ABC)(CCC)" 表示设置两个值 "ABC" 和 "CCC"。 如果值包含"()"或"\\"作为其内容，请在每个"()"或"\\"字符前 添加额外的"\\"作为转义字符。例如： "ABC" 表示设置值 "ABC"。 "(ABC)" 表示设置值 "ABC"。 "(ABC" 表示设置值 "(ABC"。 "(\\\\(ABC\\\\)\\\\(BBB\\\\)\\\\(CCC\\\\))" 表示设置值 "(ABC)(BBB)(CCC)"。 "456\\\\\\\\" 表示设置值 "456\\"。 "(\\\\(ABC\\\\))" 表示设置值 "(ABC)"。

返回

无。