Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::Field类 参考

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

## 静态 Public 属性
static | e_FlagButtonNoToggleToOff
| （仅对单选按钮有用）如果设置，始终必须选择一个单选按钮； 单击当前选中的按钮没有效果。如果清除，单击选中的按钮会取消选择它， 不留下任何按钮被选中。
static | e_FlagButtonRadiosInUnison
| （仅对单选按钮有用）如果设置，单选按钮字段中使用相同“打开”状态值的 一组单选按钮将一致地打开和关闭；即如果选中一个，它们全部都被选中。 如果清除，按钮是互斥的。
static | e_FlagChoiceCommitOnSelChange
| （仅对选择字段有用）如果设置，一旦使用指点设备进行选择，就会立即提交新值； 如果清除，直到用户退出字段才提交新值。
static | e_FlagChoiceMultiSelect
| （仅对列表框有用）如果设置，可以同时选择多个项目； 如果清除，一次最多只能选择一个项目。
static | e_FlagChoiceSort
| （仅对选择字段有用）如果设置，字段的选项项目应按字母顺序排序。
static | e_FlagComboEdit
| （仅对组合框有用）如果设置，组合框包括一个带下拉列表的可编辑文本控件， 如果清除，它仅包括一个下拉列表。
static | e_FlagNoExport
| 如果设置，字段不得通过提交表单操作导出。
static | e_FlagReadOnly
| 表单字段标志的枚举。 更多...
static | e_FlagRequired
| 如果设置，字段在通过提交表单操作导出时必须有一个值。
static | e_FlagTextComb
| （仅对文本字段有用）如果设置，使用梳状格。 更多...
static | e_FlagTextDoNotScroll
| （仅对文本字段有用）如果设置，字段不滚动（单行字段水平滚动， 多行字段垂直滚动）以容纳超出其注释矩形的更多文本。 一旦字段已满，就不再接受更多文本。
static | e_FlagTextFileSelect
| （仅对文本字段有用）如果设置，在字段中输入的文本表示文件的路径名， 该文件的内容将作为字段的值提交。
static | e_FlagTextMultiline
| （仅对文本字段有用）如果设置，文本字段可以包含多行文本； 如果清除，字段的文本被限制为单行。
static | e_FlagTextNoSpellCheck
| （仅对文本字段有用）如果设置，在字段中输入的文本不进行拼写检查。
static | e_FlagTextPassword
| （仅对文本字段有用）如果设置，字段用于输入不应 在屏幕上可见地回显。从键盘输入的字符应以 某种不可读的形式回显，例如星号或项目符号字符。 更多...
static | e_FlagTextRichText
| （仅对文本字段有用）如果设置，此字段的值应表示为富文本字符串。
static | e_TypeCheckBox
| 表单字段类型：复选框。
static | e_TypeComboBox
| 表单字段类型：组合框。
static | e_TypeListBox
| 表单字段类型：列表框。
static | e_TypePushButton
| 表单字段类型：按钮。
static | e_TypeRadioButton
| 表单字段类型：单选按钮。
static | e_TypeSignature
| 表单字段类型：签名字段。
static | e_TypeTextField
| 表单字段类型：文本字段。
static | e_TypeUnknown
| 表单字段类型的枚举。 更多...

## 详细描述

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

参见
  FSDK.Form
  FSDK.Signature
  FSDK.AdditionalAction

## 成员函数说明

## ◆ constructor()

FSDK::Field::constructor | ( | document | ,
|  | field_dict |
| ) |  |

从字段字典构造的构造函数。

参数

  [in] | document | 有效的 PDF 文档。
  [in] | field_dict | 表示表单字段的 PDF 字典。它应该属于参数 document 指定的 PDF 文档。

## ◆ GetAlignment()

FSDK::Field::GetAlignment | ( |  | ) |

获取对齐值。

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

返回
  对齐值。请参阅从 FSDK.e_AlignmentLeft 开始的值，并且 这将是这些值中的一个。

## ◆ GetAlternateName()

FSDK::Field::GetAlternateName | ( |  | ) |

获取备用名称。

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

返回
  备用名称。

## ◆ GetControl() [1/2]

FSDK::Field::GetControl | ( | index |  | ) |

通过索引获取表单控件。

参数

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

返回
  表单控件对象。

## ◆ GetControl() [2/2]

FSDK::Field::GetControl | ( | page | ,
|  | index |
| ) |  |

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

参数

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

返回
  表单控件对象。

## ◆ GetControlCount() [1/2]

FSDK::Field::GetControlCount | ( |  | ) |

获取表单控件的数量。

返回
  表单控件的数量。

## ◆ GetControlCount() [2/2]

FSDK::Field::GetControlCount | ( | page |  | ) |

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

参数

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

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

## ◆ GetDefaultAppearance()

FSDK::Field::GetDefaultAppearance | ( |  | ) |

获取默认外观数据。

返回
  默认外观数据。

## ◆ GetDefaultValue()

FSDK::Field::GetDefaultValue | ( |  | ) |

获取默认值。

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

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

## ◆ GetDefaultValueObj()

FSDK::Field::GetDefaultValueObj | ( |  | ) |

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

字段默认值的格式因字段类型而异。有关更多详细信息， 请参阅 <PDF reference 1.7> P676中的"表8.69 所有字段字典的公共条目"。

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

## ◆ GetDict()

FSDK::Field::GetDict | ( |  | ) |

获取当前对象的PDF字典。

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

## ◆ GetFlags()

FSDK::Field::GetFlags | ( |  | ) |

获取字段标志。

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

返回
  表单字段标志。请参阅从 FSDK.Field.e_FlagReadOnly 开始的值，并且 这将是这些值中的一个或组合。

## ◆ GetInheritedAttribute()

FSDK::Field::GetInheritedAttribute | ( | attribute_name |  | ) |

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

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

参数

  [in] | attribute_name | 要查找的属性名称。

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

## ◆ GetMappingName()

FSDK::Field::GetMappingName | ( |  | ) |

获取映射名称。

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

返回
  映射名称。

## ◆ GetMaxLength()

FSDK::Field::GetMaxLength | ( |  | ) |

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

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

返回
  字段文本的最大长度。

## ◆ GetName()

FSDK::Field::GetName | ( |  | ) |

获取字段名称。

返回
  字段名称字符串。

## ◆ GetOptions()

FSDK::Field::GetOptions | ( |  | ) |

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

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

返回
  包含选项的数组。

## ◆ GetTopVisibleIndex()

FSDK::Field::GetTopVisibleIndex | ( |  | ) |

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

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

返回
  列表框可见范围内的第一个项目的索引。

## ◆ GetType()

FSDK::Field::GetType | ( |  | ) |

获取字段类型。

返回
  表单字段类型。请参阅从 FSDK.Field.e_TypeUnknown 开始的值，并且 这将是这些值中的一个。

## ◆ GetValue()

FSDK::Field::GetValue | ( |  | ) |

获取值。

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

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

## ◆ GetValueObj()

FSDK::Field::GetValueObj | ( |  | ) |

获取字段值的PDF对象。

字段值的格式因字段类型而异。有关更多详细信息，请参阅 <PDF reference 1.7> P676中的"表8.69 所有字段字典的公共条目"。

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

## ◆ IsEmpty()

FSDK::Field::IsEmpty | ( |  | ) |

检查当前对象是否为空。

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

返回
  true 表示当前对象为空，而 false 表示不是。

## ◆ Reset()

FSDK::Field::Reset | ( |  | ) |

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

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

## ◆ SetAlignment()

FSDK::Field::SetAlignment | ( | alignment |  | ) |

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

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

参数

  [in] | alignment | 可变文本的新默认对齐类型。请参阅从 FSDK.e_AlignmentLeft 开始的值，这应该是这些值中的一个。 如果使用其他值来设置，默认情况下将使用 FSDK.e_AlignmentLeft。

返回
  无。

## ◆ SetAlternateName()

FSDK::Field::SetAlternateName | ( | alternate_name |  | ) |

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

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

参数

  [in] | alternate_name | 新的备用名称字符串。它不应是空字符串。

返回
  无。

## ◆ SetDefaultAppearance()

FSDK::Field::SetDefaultAppearance | ( | default_ap |  | ) |

设置默认外观数据。

参数

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

返回
  无。

## ◆ SetDefaultValue()

FSDK::Field::SetDefaultValue | ( | value |  | ) |

设置默认值。

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

参数

  [in] | value | 新的默认值字符串。它不应是空字符串。

返回
  无。

## ◆ SetFlags()

FSDK::Field::SetFlags | ( | flags |  | ) |

设置字段标志。

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

参数

  [in] | flags | 新的表单字段标志。请参阅从 FSDK.Field.e_FlagReadOnly 开始的值，并且 这应该是这些值中的一个或组合。

返回
  无。

## ◆ SetMappingName()

FSDK::Field::SetMappingName | ( | name |  | ) |

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

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

参数

  [in] | name | 新的映射名称字符串。它不应是空字符串。

返回
  无。

## ◆ SetMaxLength()

FSDK::Field::SetMaxLength | ( | max_length |  | ) |

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

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

参数

  [in] | max_length | 字段文本的新最大长度。它应该是非负的。

返回
  无。

## ◆ SetOptions()

FSDK::Field::SetOptions | ( | option_array |  | ) |

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

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

参数

  [in] | option_array | 要设置到列表框或组合框的选项数组。

返回
  无。

## ◆ SetTopVisibleIndex()

FSDK::Field::SetTopVisibleIndex | ( | index |  | ) |

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

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

参数

  [in] | index | 列表中可见的第一个选项的索引。

返回
  无。

## ◆ SetValue()

FSDK::Field::SetValue | ( | value |  | ) |

设置值。

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

参数

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

返回
  无。

## 类成员变量说明

## ◆ e_FlagReadOnly

FSDK::Field::e_FlagReadOnly
| static

表单字段标志的枚举。

此枚举的值可以单独使用或组合使用。

如果设置，用户不得更改字段的值。任何相关的微件注释将不与用户交互； 也就是说，它们不会响应鼠标单击，也不会响应鼠标移动而改变其外观。 此标志对于值由计算或从数据库导入的字段很有用。

## ◆ e_FlagTextComb

FSDK::Field::e_FlagTextComb
| static

（仅对文本字段有用）如果设置，使用梳状格。

如果设置，字段被自动分为与字段文本的最大长度值相同数量的等间距位置 或梳状格，并且文本被布局到这些梳状格中。

## ◆ e_FlagTextPassword

FSDK::Field::e_FlagTextPassword
| static

（仅对文本字段有用）如果设置，字段用于输入不应 在屏幕上可见地回显。从键盘输入的字符应以 某种不可读的形式回显，例如星号或项目符号字符。

注解
  为了保护密码机密性，如果设置了此标志，查看器应用程序应该永远不在PDF文件中 存储文本字段的值。

## ◆ e_TypeUnknown

FSDK::Field::e_TypeUnknown
| static

表单字段类型的枚举。

此枚举的值应单独使用。

表单字段类型：未知。