FormField

FormField class

Представляет одно поле формы.

Чтобы узнать больше, посетитеРабота с полями формы статья документации.

public class FormField : SpecialChar

Характеристики

ИмяОписание
CalculateOnExit { get; set; }True, если ссылки на указанное поле формы автоматически обновляются при выходе из поля.
CheckBoxSize { get; set; }Получает или задает размер флажка в пунктах. Имеет эффект только тогда, когдаIsCheckBoxExactSize являетсяистинный .
Checked { get; set; }Получает или задает проверенный статус поля формы флажка. Значение по умолчанию для этого свойства:ЛОЖЬ .
CustomNodeId { get; set; }Указывает пользовательский идентификатор узла.
Default { get; set; }Получает или задает значение по умолчанию для поля формы флажка. Значение по умолчанию для этого свойства:ЛОЖЬ .
virtual Document { get; }Получает документ, которому принадлежит этот узел.
DropDownItems { get; }Обеспечивает доступ к элементам поля раскрывающейся формы.
DropDownSelectedIndex { get; set; }Получает или задает индекс, определяющий текущий выбранный элемент в поле раскрывающейся формы.
Enabled { get; set; }True, если поле формы включено.
EntryMacro { get; set; }Возвращает или задает имя макроса записи для поля формы.
ExitMacro { get; set; }Возвращает или задает имя макроса выхода для поля формы.
Font { get; }Предоставляет доступ к форматированию шрифта этого объекта.
HelpText { get; set; }Возвращает или задает текст, который отображается в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает F1.
IsCheckBoxExactSize { get; set; }Получает или задает логическое значение, указывающее, является ли размер текстового поля автоматическим или заданным явно.
virtual IsComposite { get; }Возвращаетистинный если этот узел может содержать другие узлы.
IsDeleteRevision { get; }Возвращает true, если этот объект был удален в Microsoft Word при включенном отслеживании изменений.
IsFormatRevision { get; }Возвращает true, если форматирование объекта было изменено в Microsoft Word при включенном отслеживании изменений.
IsInsertRevision { get; }Возвращает true, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений.
IsMoveFromRevision { get; }Возвращаетистинный если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений.
IsMoveToRevision { get; }Возвращаетистинный если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений.
MaxLength { get; set; }Максимальная длина текстового поля. Ноль, если длина не ограничена.
Name { get; set; }Получает или задает имя поля формы.
NextSibling { get; }Получает узел, следующий сразу за этим узлом.
override NodeType { get; }ВозвращаетFormField .
OwnHelp { get; set; }Указывает источник текста, который отображается в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает F1.
OwnStatus { get; set; }Указывает источник текста, который отображается в строке состояния, когда поле формы имеет фокус.
ParentNode { get; }Получает непосредственного родителя этого узла.
ParentParagraph { get; }Получает родительский элементParagraph этого узла.
PreviousSibling { get; }Получает узел, непосредственно предшествующий этому узлу.
Range { get; }ВозвращаетRange объект, представляющий часть документа, содержащуюся в этом узле.
Result { get; set; }Получает или задает строку, представляющую результат этого поля формы.
StatusText { get; set; }Возвращает или задает текст, который отображается в строке состояния, когда поле формы находится в фокусе.
TextInputDefault { get; set; }Получает или задает строку по умолчанию или выражение вычисления поля текстовой формы.
TextInputFormat { get; set; }Возвращает или задает форматирование текста для поля текстовой формы.
TextInputType { get; set; }Получает или задает тип поля текстовой формы.
Type { get; }Возвращает тип поля формы.

Методы

ИмяОписание
override Accept(DocumentVisitor)Принимает посетителя.
Clone(bool)Создает дубликат узла.
GetAncestor(NodeType)Получает первого предка указанногоNodeType .
GetAncestor(Type)Получает первого предка указанного типа объекта.
override GetText()Получает специальный символ, который представляет этот узел.
NextPreOrder(Node)Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного заказа.
PreviousPreOrder(Node)Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного заказа.
Remove()Удаляет себя от родителя.
RemoveField()Удаляет все поле формы, а не только специальный символ поля формы.
SetTextInputValue(object)Применяет текстовый формат, указанный вTextInputFormat и сохраняет значение вResult .
ToString(SaveFormat)Экспортирует содержимое узла в строку указанного формата.
ToString(SaveOptions)Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Примечания

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

FormFieldявляется встроенным узлом и может быть только дочерним элементомParagraph.

FormField представлен в документе специальным символом and , позиционируемым как символ внутри строки текста.

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

Примеры

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

Document doc = new Document(MyDir + "Form fields.docx");

FormField formField = doc.Range.FormFields[0];
formField.Font.Bold = true;
formField.Font.Size = 24;
formField.Font.Color = Color.Red;

formField.Result = "Aspose.FormField";

doc = DocumentHelper.SaveOpen(doc);

Run formFieldRun = doc.FirstSection.Body.FirstParagraph.Runs[1];

Assert.AreEqual("Aspose.FormField", formFieldRun.Text);
Assert.AreEqual(true, formFieldRun.Font.Bold);
Assert.AreEqual(24, formFieldRun.Font.Size);
Assert.AreEqual(Color.Red.ToArgb(), formFieldRun.Font.Color.ToArgb());

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

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Write("Please select a fruit: ");

// Вставляем поле со списком, которое позволит пользователю выбрать вариант из коллекции строк.
FormField comboBox = builder.InsertComboBox("MyComboBox", new[] { "Apple", "Banana", "Cherry" }, 0);

Assert.AreEqual("MyComboBox", comboBox.Name);
Assert.AreEqual(FieldType.FieldFormDropDown, comboBox.Type);
Assert.AreEqual("Apple", comboBox.Result);

// Поле формы появится в виде html-тега select.
doc.Save(ArtifactsDir + "FormFields.Create.html");

Смотрите также

FieldXE Class FormFieldCollection Class