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 и InsertComboBoxwhich убедитесь, что все узлы полей формы созданы в правильном порядке и в подходящем состоянии.

Примеры

Показывает, как форматировать весь 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");

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

class SpecialChar
пространство имен Aspose.Words.Fields
сборка Aspose.Words

FieldXE Class FormFieldCollection Class