Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit::pdf::interform::Control类 参考
类 foxit::pdf::interform::Control 继承关系图:

## Public 成员函数
| Control (const Control &other)
| 构造函数，使用另一个表单控件对象。 更多...
| ~Control ()
| 析构函数。
common::Alignment | GetAlignment ()
| 获取对齐值。 更多...
DefaultAppearance | GetDefaultAppearance () const
| 获取默认外观数据。 更多...
WString | GetExportValue () const
| 当相关表单字段是复选框或单选按钮时，获取导出映射名称。 更多...
Field | GetField () const
| 获取相关的表单字段。 更多...
int | GetIndex () const
| 获取当前表单控件在相关表单字段的所有控件中的索引。 更多...
annots::Widget | GetWidget () const
| 获取相关的控件注释。 更多...
objects::PDFDictionary * | GetWidgetDict () const
| 获取相关控件注释的字典。 更多...
bool | IsChecked () const
| 检查当相关表单字段是复选框或单选按钮时，当前表单控件是否被选中。 更多...
bool | IsDefaultChecked () const
| 检查当相关表单字段是复选框或单选按钮时，当前表单控件是否默认被选中。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator!= (const Control &other) const
| 不等于操作符。 更多...
Control & | operator= (const Control &other)
| 赋值操作符。 更多...
bool | operator== (const Control &other) const
| 等于操作符。 更多...
void | SetAlignment (common::Alignment alignment)
| 设置当前表单控件的对齐属性。 更多...
void | SetChecked (bool checked_status)
| 当相关表单字段是复选框或单选按钮时，设置当前表单控件的选中状态。 更多...
void | SetDefaultAppearance (const DefaultAppearance &default_ap)
| 设置默认外观数据。 更多...
void | SetDefaultChecked (bool checked_status)
| 当相关表单字段是复选框或单选按钮时，设置当前表单控件的默认选中状态。 更多...
void | SetExportValue (const wchar_t *value)
| 当相关表单字段是复选框或单选按钮时，设置导出映射名称。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

Foxit PDF SDK定义"表单控件"以将表单字段与其相关的控件注释关联。 表单字段可能有一个或多个表单控件，每个表单控件都与一个控件注释关联。 表单控件对象可以通过以下函数检索：

- 从表单，请使用函数Form::GetControl。
- 从表单字段，请使用函数Field::GetControl。

表单控件还提供获取相关表单字段对象和控件注释对象的函数。
函数Form::AddControl可用于向表单字段添加新的表单控件，函数 Form::RemoveControl可用于删除表单控件。

参见
  Form
  Field

## 构造及析构函数说明

## ◆ Control()

foxit::pdf::interform::Control::Control | ( | const Control & | other | ) |

构造函数，使用另一个表单控件对象。

参数

  [in] | other | 另一个表单控件对象。

## 成员函数说明

## ◆ GetAlignment()

common::Alignment foxit::pdf::interform::Control::GetAlignment | ( |  | ) |

获取对齐值。

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

返回
  对齐值。请参考从common::e_AlignmentLeft开始的值， 这将是其中一个值。

## ◆ GetDefaultAppearance()

DefaultAppearance foxit::pdf::interform::Control::GetDefaultAppearance | ( |  | ) | const

获取默认外观数据。

返回
  默认外观数据。

## ◆ GetExportValue()

WString foxit::pdf::interform::Control::GetExportValue | ( |  | ) | const

当相关表单字段是复选框或单选按钮时，获取导出映射名称。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型，此函数将返回空字符串。

返回
  导出映射名称。

## ◆ GetField()

Field foxit::pdf::interform::Control::GetField | ( |  | ) | const

获取相关的表单字段。

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

## ◆ GetIndex()

int foxit::pdf::interform::Control::GetIndex | ( |  | ) | const

获取当前表单控件在相关表单字段的所有控件中的索引。

返回
  表单控件的索引。

## ◆ GetWidget()

annots::Widget foxit::pdf::interform::Control::GetWidget | ( |  | ) | const

获取相关的控件注释。

返回
  相关的控件注释。

## ◆ GetWidgetDict()

objects::PDFDictionary* foxit::pdf::interform::Control::GetWidgetDict | ( |  | ) | const

获取相关控件注释的字典。

返回
  相关控件注释的字典。如果有任何错误，函数将返回NULL。

## ◆ IsChecked()

bool foxit::pdf::interform::Control::IsChecked | ( |  | ) | const

检查当相关表单字段是复选框或单选按钮时，当前表单控件是否被选中。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型，此函数将返回false。

返回
  true 表示选中，false 表示未选中。

## ◆ IsDefaultChecked()

bool foxit::pdf::interform::Control::IsDefaultChecked | ( |  | ) | const

检查当相关表单字段是复选框或单选按钮时，当前表单控件是否默认被选中。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型，此函数将返回false。

返回
  true 表示默认选中，false 表示默认未选中。

## ◆ IsEmpty()

bool foxit::pdf::interform::Control::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

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

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

## ◆ operator!=()

bool foxit::pdf::interform::Control::operator!= | ( | const Control & | other | ) | const

不等于操作符。

参数

  [in] | other | 另一个表单控件对象。此函数将检查当前对象是否不等于此对象。

返回
  true 表示不相等，false 表示相等。

## ◆ operator=()

Control& foxit::pdf::interform::Control::operator= | ( | const Control & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个表单控件对象，其值将被赋给当前对象。

返回
  对当前对象本身的引用。

## ◆ operator==()

bool foxit::pdf::interform::Control::operator== | ( | const Control & | other | ) | const

等于操作符。

参数

  [in] | other | 另一个表单控件对象。此函数将检查当前对象是否等于此对象。

返回
  true 表示相等，false 表示不相等。

## ◆ SetAlignment()

void foxit::pdf::interform::Control::SetAlignment | ( | common::Alignment | alignment | ) |

设置当前表单控件的对齐属性。

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

参数

  [in] | alignment | 可变文本的新默认对齐类型。请参考从 common::e_AlignmentLeft开始的值，这应该是其中一个值。 如果使用其他值设置，默认将使用common::e_AlignmentLeft。

返回
  无。

## ◆ SetChecked()

void foxit::pdf::interform::Control::SetChecked | ( | bool | checked_status | ) |

当相关表单字段是复选框或单选按钮时，设置当前表单控件的选中状态。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型，此函数不执行任何操作。

参数

  [in] | checked_status | true 表示选中，false 表示未选中。

返回
  无。

## ◆ SetDefaultAppearance()

void foxit::pdf::interform::Control::SetDefaultAppearance | ( | const DefaultAppearance & | default_ap | ) |

设置默认外观数据。

参数

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

返回
  无。

## ◆ SetDefaultChecked()

void foxit::pdf::interform::Control::SetDefaultChecked | ( | bool | checked_status | ) |

当相关表单字段是复选框或单选按钮时，设置当前表单控件的默认选中状态。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型，此函数不执行任何操作。

参数

  [in] | checked_status | true 表示默认选中，false 表示默认未选中。

返回
  无。

## ◆ SetExportValue()

void foxit::pdf::interform::Control::SetExportValue | ( | const wchar_t * | value | ) |

当相关表单字段是复选框或单选按钮时，设置导出映射名称。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型，此函数不执行任何操作。

参数

  [in] | value | 新的导出映射名称。它不应该是空字符串。

返回
  无。