Aspose::Words::Fields::FormField класс

FormField class

Представляет отдельное поле формы. Чтобы узнать больше, посетите статью документации Working with Form Fields.

class FormField : public Aspose::Words::SpecialChar

Методы

МетодОписание
Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) overrideПринимает посетителя.
Clone(bool)Создаёт дубликат узла.
get_CalculateOnExit()True, если ссылки на указанный поле формы автоматически обновляются при выходе из поля.
get_CheckBoxSize()Получает или задает размер флажка в пунктах. Действует только когда IsCheckBoxExactSize true.
get_Checked()Получает или задает состояние отметки флажка формы. Значение по умолчанию для этого свойства false.
get_CustomNodeId() constУказывает пользовательский идентификатор узла.
get_Default()Получает или задает значение по умолчанию флажка формы. Значение по умолчанию для этого свойства false.
virtual get_Document() constВозвращает документ, к которому принадлежит этот узел.
get_DropDownItems()Обеспечивает доступ к элементам раскрывающегося поля формы.
get_DropDownSelectedIndex()Получает индекс, указывающий текущий выбранный элемент в раскрывающемся поле формы.
get_Enabled()Истина, если поле формы включено.
get_EntryMacro()Возвращает или задает имя макроса входа для поля формы.
get_ExitMacro()Возвращает или задает имя макроса выхода для поля формы.
get_Font()Предоставляет доступ к форматированию шрифта этого объекта.
get_HelpText()Возвращает или задает текст, отображаемый в диалоговом окне сообщения, когда поле формы имеет фокус и пользователь нажимает F1.
get_IsCheckBoxExactSize()Получает или задает логическое значение, указывающее, является ли размер текстового поля автоматическим или задан явно.
virtual get_IsComposite()Возвращает true, если этот узел может содержать другие узлы.
get_IsDeleteRevision()Возвращает true, если этот объект был удалён в Microsoft Word при включённом отслеживании изменений.
get_IsFormatRevision()Возвращает true, если форматирование объекта было изменено в Microsoft Word при включённом отслеживании изменений.
get_IsInsertRevision()Возвращает true, если этот объект был вставлен в Microsoft Word при включённом отслеживании изменений.
get_IsMoveFromRevision()Возвращает true, если этот объект был перемещён (удалён) в Microsoft Word при включённом отслеживании изменений.
get_IsMoveToRevision()Возвращает true, если этот объект был перемещён (вставлен) в Microsoft Word при включённом отслеживании изменений.
get_MaxLength()Максимальная длина текстового поля. Ноль, если длина не ограничена.
get_Name()Получает или задает имя поля формы.
get_NextNode() const
get_NextSibling()Возвращает узел, непосредственно следующий за этим узлом.
get_NodeType() const overrideВозвращает FormField.
get_OwnHelp()Указывает источник текста, отображаемого в диалоговом окне сообщения, когда поле формы имеет фокус и пользователь нажимает F1.
get_OwnStatus()Указывает источник текста, отображаемого в строке состояния, когда поле формы имеет фокус.
get_ParentNode()Возвращает непосредственного родителя этого узла.
get_ParentParagraph()Получает родительский Paragraph этого узла.
get_PreviousSibling()Возвращает узел, непосредственно предшествующий этому узлу.
get_PrevNode() const
get_Range()Возвращает объект Range, представляющий часть документа, содержащуюся в этом узле.
get_Result()Получает или задает строку, представляющую результат этого поля формы.
get_StatusText()Возвращает или задает текст, отображаемый в строке состояния, когда поле формы имеет фокус.
get_TextInputDefault()Получает или задает строку по умолчанию или выражение вычисления текстового поля формы.
get_TextInputFormat()Возвращает или задает форматирование текста для текстового поля формы.
get_TextInputType()Получает тип текстового поля формы.
get_Type()Возвращает тип поля формы.
GetAncestor(Aspose::Words::NodeType)Возвращает первого предка указанного NodeType.
GetAncestorOf()
GetText() overrideПолучает специальный символ, который представляет этот узел.
GetType() const override
Is(const System::TypeInfo&) const override
IsAncestorNode(const System::SharedPtr<Aspose::Words::Node>&)
NextPreOrder(const System::SharedPtr<Aspose::Words::Node>&)Получает следующий узел согласно алгоритму обхода дерева в порядке предобхода.
static NodeTypeToString(Aspose::Words::NodeType)Вспомогательный метод, преобразующий значение перечисления типа узла в удобочитаемую строку.
PreviousPreOrder(const System::SharedPtr<Aspose::Words::Node>&)Получает предыдущий узел согласно алгоритму обхода дерева в порядке предобхода.
Remove()Удаляет себя из родительского узла.
RemoveField()Удаляет полностью поле формы, а не только специальный символ поля формы.
set_CalculateOnExit(bool)Сеттер для Aspose::Words::Fields::FormField::get_CalculateOnExit.
set_CheckBoxSize(double)Сеттер для Aspose::Words::Fields::FormField::get_CheckBoxSize.
set_Checked(bool)Сеттер для Aspose::Words::Fields::FormField::get_Checked.
set_CustomNodeId(int32_t)Сеттер для Aspose::Words::Node::get_CustomNodeId.
set_Default(bool)Сеттер для Aspose::Words::Fields::FormField::get_Default.
set_DropDownSelectedIndex(int32_t)Задает индекс, указывающий текущий выбранный элемент в раскрывающемся поле формы.
set_Enabled(bool)Истина, если поле формы включено.
set_EntryMacro(const System::String&)Сеттер для Aspose::Words::Fields::FormField::get_EntryMacro.
set_ExitMacro(const System::String&)Сеттер для Aspose::Words::Fields::FormField::get_ExitMacro.
set_HelpText(const System::String&)Сеттер для Aspose::Words::Fields::FormField::get_HelpText.
set_IsCheckBoxExactSize(bool)Сеттер для Aspose::Words::Fields::FormField::get_IsCheckBoxExactSize.
set_MaxLength(int32_t)Максимальная длина текстового поля. Ноль, если длина не ограничена.
set_Name(const System::String&)Сеттер для Aspose::Words::Fields::FormField::get_Name.
set_NextNode(const System::SharedPtr<Aspose::Words::Node>&)
set_OwnHelp(bool)Сеттер для Aspose::Words::Fields::FormField::get_OwnHelp.
set_OwnStatus(bool)Сеттер для Aspose::Words::Fields::FormField::get_OwnStatus.
set_PrevNode(const System::SharedPtr<Aspose::Words::Node>&)
set_Result(const System::String&)Сеттер для Aspose::Words::Fields::FormField::get_Result.
set_StatusText(const System::String&)Сеттер для Aspose::Words::Fields::FormField::get_StatusText.
set_TextInputDefault(const System::String&)Сеттер для Aspose::Words::Fields::FormField::get_TextInputDefault.
set_TextInputFormat(const System::String&)Сеттер для Aspose::Words::Fields::FormField::get_TextInputFormat.
set_TextInputType(Aspose::Words::Fields::TextFormFieldType)Устанавливает тип текстового поля формы.
SetParent(const System::SharedPtr<Aspose::Words::Node>&)
SetTextInputValue(const System::SharedPtr<System::Object>&)Применяет текстовый формат, указанный в TextInputFormat, и сохраняет значение в Result.
ToString(Aspose::Words::SaveFormat)Экспортирует содержимое узла в строку в указанном формате.
ToString(const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&)Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
static Type()

Примечания

Microsoft Word предоставляет следующие поля формы: флажок, ввод текста и раскрывающийся список (комбобокс).

FormField is an inline-node and can only be a child of Paragraph.

FormField is represented in a document by a special character and positioned as a character within a line of text.

Полное поле формы в документе Word представляет собой сложную структуру, состоящую из нескольких узлов: начало поля, код поля, такой как FORMTEXT, данные поля формы, разделитель поля, результат поля, конец поля и закладка. Чтобы программно создавать поля формы в документе Word, используйте InsertCheckBox(), InsertTextInput() и InsertComboBox(), которые гарантируют, что все узлы поля формы созданы в правильном порядке и находятся в надлежащем состоянии.

Примеры

Показывает, как вставить комбобокс.

auto doc = System::MakeObject<Aspose::Words::Document>();
auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);

builder->Write(u"Please select a fruit: ");

// Вставьте комбобокс, который позволит пользователю выбрать вариант из набора строк.
System::SharedPtr<Aspose::Words::Fields::FormField> comboBox = builder->InsertComboBox(u"MyComboBox", System::MakeArray<System::String>({u"Apple", u"Banana", u"Cherry"}), 0);

ASSERT_EQ(u"MyComboBox", comboBox->get_Name());
ASSERT_EQ(Aspose::Words::Fields::FieldType::FieldFormDropDown, comboBox->get_Type());
ASSERT_EQ(u"Apple", comboBox->get_Result());

// Поле формы будет отображаться в виде HTML‑тега "select".
doc->Save(get_ArtifactsDir() + u"FormFields.Create.html");

Показывает, как отформатировать весь FormField, включая значение поля.

auto doc = System::MakeObject<Aspose::Words::Document>(get_MyDir() + u"Form fields.docx");

System::SharedPtr<Aspose::Words::Fields::FormField> formField = doc->get_Range()->get_FormFields()->idx_get(0);
formField->get_Font()->set_Bold(true);
formField->get_Font()->set_Size(24);
formField->get_Font()->set_Color(System::Drawing::Color::get_Red());

formField->set_Result(u"Aspose.FormField");

doc = Aspose::Words::ApiExamples::DocumentHelper::SaveOpen(doc);

System::SharedPtr<Aspose::Words::Run> formFieldRun = doc->get_FirstSection()->get_Body()->get_FirstParagraph()->get_Runs()->idx_get(1);

ASSERT_EQ(u"Aspose.FormField", formFieldRun->get_Text());
ASPOSE_ASSERT_EQ(true, formFieldRun->get_Font()->get_Bold());
ASPOSE_ASSERT_EQ(24, formFieldRun->get_Font()->get_Size());
ASSERT_EQ(System::Drawing::Color::get_Red().ToArgb(), formFieldRun->get_Font()->get_Color().ToArgb());

См. также

Aspose::Words::Fields::FieldXE класс Aspose::Words::Fields::FormFieldCollection класс