FormField

Наследование: java.lang.Object, com.aspose.words.Node, com.aspose.words.Inline, com.aspose.words.SpecialChar

public class FormField extends SpecialChar

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

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

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

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

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

Полное поле формы в документе Word представляет собой сложную структуру, представленную несколькими узлами: начало поля, код поля, такой как FORMTEXT, данные поля формы, разделитель полей, результат поля, конец поля и закладка. Чтобы программно создать поля формы в документе Word, используйтеDocumentBuilder.insertCheckBox(java.lang.String, boolean, int), M:Aspose.Words.DocumentBuilder.InsertTextInput(System.String,Aspose.Words.Fields.TextFormFieldType,System.String,System.String,System.Int32) а такжеDocumentBuilder.insertComboBox(java.lang.String, java.lang.String[], int) которые гарантируют, что все узлы поля формы созданы в правильном порядке и в подходящем состоянии.

Методы

Метод	Описание
accept(DocumentVisitor visitor)	Принимает посетителя.
clearRunAttrs()
dd()
deepClone(boolean isCloneChildren)	Создает дубликат узла.
equals(Object arg0)
fetchInheritedRunAttr(int fontAttr)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)	Получает первого предка указанного типа объекта.
getCalculateOnExit()	Истинно, если ссылки на указанное поле формы автоматически обновляются при выходе из поля.
getCheckBoxSize()	Получает размер флажка в пунктах.
getChecked()	Получает проверенный статус поля формы флажка.
getClass()
getCustomNodeId()	Задает идентификатор пользовательского узла.
getDefault()	Получает значение по умолчанию для поля формы флажка.
getDirectRunAttr(int fontAttr)
getDocument()	Получает документ, которому принадлежит этот узел.
getDocument_IInline()
getDropDownItems()	Предоставляет доступ к элементам раскрывающегося поля формы.
getDropDownSelectedIndex()	Получает индекс, указывающий текущий выбранный элемент в поле раскрывающейся формы.
getEnabled()	Истинно, если поле формы включено.
getEntryMacro()	Получает имя макроса записи для поля формы.
getExitMacro()	Получает имя макроса выхода для поля формы.
getFont()	Предоставляет доступ к форматированию шрифта этого объекта.
getHelpText()	Получает текст, отображаемый в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает клавишу F1.
getMaxLength()	Максимальная длина текстового поля.
getName()	Получает имя поля формы.
getNextSibling()	Получает узел, следующий сразу за этим узлом.
getNodeType()	ВозвращаетNodeType.FormField.
getOwnHelp()	Указывает источник текста, отображаемого в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает клавишу F1.
getOwnStatus()	Указывает источник текста, который отображается в строке состояния, когда поле формы находится в фокусе.
getParentNode()	Получает непосредственного родителя этого узла.
getParentParagraph()	Извлекает родителяParagraph этого узла.
getParentParagraph_IInline()
getPreviousSibling()	Получает узел, непосредственно предшествующий этому узлу.
getRange()	ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.
getResult()	Получает строку, представляющую результат этого поля формы.
getStatusText()	Получает текст, отображаемый в строке состояния, когда поле формы имеет фокус.
getText()	Получает специальный символ, который представляет этот узел.
getTextInputDefault()	Получает строку по умолчанию или выражение вычисления поля текстовой формы.
getTextInputFormat()	Получает форматирование текста для поля текстовой формы.
getTextInputType()	Получает тип поля текстовой формы.
getType()	Возвращает тип поля формы.
hashCode()
isCheckBoxExactSize()	Получает логическое значение, указывающее, является ли размер текстового поля автоматическим или заданным явно.
isCheckBoxExactSize(boolean value)	Задает логическое значение, указывающее, является ли размер текстового поля автоматическим или заданным явно.
isComposite()	Возвращает true, если этот узел может содержать другие узлы.
isDeleteRevision()	Возвращает true, если этот объект был удален в Microsoft Word при включенном отслеживании изменений.
isFormatRevision()	Возвращает true, если форматирование объекта было изменено в Microsoft Word при включенном отслеживании изменений.
isInsertRevision()	Возвращает true, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений.
isMoveFromRevision()	Возвращаетtrue если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений.
isMoveToRevision()	Возвращаетtrue если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений.
nextPreOrder(Node rootNode)	Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
nodeTypeToString(int nodeType)
notify()
notifyAll()
previousPreOrder(Node rootNode)	Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
remove()	Удаляет себя из родителя.
removeField()	Удаляет все поле формы, а не только специальный символ поля формы.
removeMoveRevisions()
removeRunAttr(int key)
setCalculateOnExit(boolean value)	Истинно, если ссылки на указанное поле формы автоматически обновляются при выходе из поля.
setCheckBoxSize(double value)	Устанавливает размер флажка в пунктах.
setChecked(boolean value)	Устанавливает проверенный статус поля формы флажка.
setCustomNodeId(int value)	Задает идентификатор пользовательского узла.
setDefault(boolean value)	Задает значение по умолчанию для поля формы флажка.
setDropDownSelectedIndex(int value)	Задает индекс, указывающий текущий выбранный элемент в поле раскрывающейся формы.
setEnabled(boolean value)	Истинно, если поле формы включено.
setEntryMacro(String value)	Задает имя макроса записи для поля формы.
setExitMacro(String value)	Задает имя макроса выхода для поля формы.
setHelpText(String value)	Задает текст, отображаемый в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает клавишу F1.
setMaxLength(int value)	Максимальная длина текстового поля.
setName(String value)	Задает имя поля формы.
setOwnHelp(boolean value)	Указывает источник текста, отображаемого в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает клавишу F1.
setOwnStatus(boolean value)	Указывает источник текста, который отображается в строке состояния, когда поле формы находится в фокусе.
setResult(String value)	Задает строку, представляющую результат этого поля формы.
setRunAttr(int key, Object value)
setStatusText(String value)	Задает текст, отображаемый в строке состояния, когда поле формы находится в фокусе.
setTextInputDefault(String value)	Задает строку по умолчанию или выражение вычисления поля текстовой формы.
setTextInputFormat(String value)	Задает форматирование текста для поля текстовой формы.
setTextInputType(int value)	Задает тип поля текстовой формы.
setTextInputValue(Object newValue)	Применяет формат текста, указанный вgetTextInputFormat() / setTextInputFormat(java.lang.String) и сохраняет значение вgetResult() / setResult(java.lang.String).
toString()
toString(SaveOptions saveOptions)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
toString(int saveFormat)
wait()
wait(long arg0)
wait(long arg0, int arg1)

accept(DocumentVisitor visitor)

public boolean accept(DocumentVisitor visitor)

Принимает посетителя.

Вызывает DocumentVisitor.VisitFormField.

Дополнительные сведения см. в шаблоне проектирования «Посетитель».

Параметры:

Параметр	Тип	Описание
visitor	DocumentVisitor	Посетитель, который посетит узел.

Возвращает: boolean — False, если посетитель запросил остановку перечисления.

clearRunAttrs()

public void clearRunAttrs()

dd()

public void dd()

deepClone(boolean isCloneChildren)

public Node deepClone(boolean isCloneChildren)

Создает дубликат узла.

Этот метод служит конструктором копирования для узлов. Клонированный узел не имеет родителя, но принадлежит к тому же документу, что и исходный узел.

Этот метод всегда выполняет глубокую копию узла.isCloneChildren Параметр указывает, следует ли также выполнять копирование всех дочерних узлов.

Параметры:

Параметр	Тип	Описание
isCloneChildren	boolean	Значение true, чтобы рекурсивно клонировать поддерево в указанном узле; false, чтобы клонировать только сам узел.

Возвращает: Node - Клонированный узел.

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

Параметр	Тип	Описание
arg0	java.lang.Object

Возвращает: логический

fetchInheritedRunAttr(int fontAttr)

public Object fetchInheritedRunAttr(int fontAttr)

Параметры:

Параметр	Тип	Описание
fontAttr	int

Возвращает: java.lang.Объект

getAncestor(int ancestorType)

public CompositeNode getAncestor(int ancestorType)

Параметры:

Параметр	Тип	Описание
ancestorType	int

Возвращает: CompositeNode

getAncestor(Class ancestorType)

public CompositeNode getAncestor(Class ancestorType)

Получает первого предка указанного типа объекта.

Параметры:

Параметр	Тип	Описание
ancestorType	java.lang.Class	Тип объекта-предка для извлечения.

Возвращает: CompositeNode - предок указанного типа или ноль, если предок этого типа не найден.

Тип предка совпадает, если он равен ancestorType или является производным от ancestorType.

getCalculateOnExit()

public boolean getCalculateOnExit()

Истинно, если ссылки на указанное поле формы автоматически обновляются при выходе из поля.

ПараметрCalculateOnExit влияет только на поведение поля формы при открытии документа в Microsoft Word. Aspose.Words никогда не обновляет ссылки на поле формы.

Возвращает: boolean - соответствующее логическое значение.

getCheckBoxSize()

public double getCheckBoxSize()

Получает размер флажка в пунктах. Имеет эффект только тогда, когдаisCheckBoxExactSize() / isCheckBoxExactSize(boolean) правда.

Применимо только к полю формы флажка.

Возвращает: double - Размер флажка в пунктах.

getChecked()

public boolean getChecked()

Получает проверенный статус поля формы флажка. Значение по умолчанию для этого свойстваfalse.

Применимо только к полю формы флажка.

Возвращает: boolean - проверенный статус поля формы флажка.

getClass()

public final native Class<?> getClass()

Возвращает: java.lang.Класс

getCustomNodeId()

public int getCustomNodeId()

Задает идентификатор пользовательского узла.

По умолчанию ноль.

Этот идентификатор можно установить и использовать произвольно. Например, как ключ для получения внешних данных.

Важное примечание: указанное значение не сохраняется в выходной файл и существует только в течение срока службы узла.

Возвращает: int - соответствующее значение int.

getDefault()

public boolean getDefault()

Получает значение по умолчанию для поля формы флажка. Значение по умолчанию для этого свойстваfalse.

Применимо только к полю формы флажка.

Возвращает: boolean — значение по умолчанию для поля формы флажка.

getDirectRunAttr(int fontAttr)

public Object getDirectRunAttr(int fontAttr)

Параметры:

Параметр	Тип	Описание
fontAttr	int

Возвращает: java.lang.Объект

getDocument()

public DocumentBase getDocument()

Получает документ, которому принадлежит этот узел.

Узел всегда принадлежит документу, даже если он только что создан и еще не добавлен в дерево или удален из дерева.

Возвращает: DocumentBase - Документ, которому принадлежит этот узел.

getDocument_IInline()

public DocumentBase getDocument_IInline()

Возвращает: DocumentBase

getDropDownItems()

public DropDownItemCollection getDropDownItems()

Предоставляет доступ к элементам раскрывающегося поля формы.

Microsoft Word допускает не более 25 элементов в раскрывающемся поле формы.

Возвращает: DropDownItemCollection - соответствующийDropDownItemCollection ценность.

getDropDownSelectedIndex()

public int getDropDownSelectedIndex()

Получает индекс, указывающий текущий выбранный элемент в поле раскрывающейся формы.

Возвращает: int - индекс, указывающий текущий выбранный элемент в поле выпадающей формы.

getEnabled()

public boolean getEnabled()

Истинно, если поле формы включено.

Если поле формы включено, его содержимое может быть изменено по мере заполнения формы.

Возвращает: boolean - соответствующее логическое значение.

getEntryMacro()

public String getEntryMacro()

Получает имя макроса записи для поля формы.

Макрос ввода запускается, когда поле формы получает фокус в Microsoft Word.

Microsoft Word позволяет использовать строки длиной не более 32 символов.

Возвращает: java.lang.String — Имя макроса записи для поля формы.

getExitMacro()

public String getExitMacro()

Получает имя макроса выхода для поля формы.

Макрос выхода запускается, когда поле формы теряет фокус в Microsoft Word.

Microsoft Word позволяет использовать строки длиной не более 32 символов.

Возвращает: java.lang.String — имя макроса выхода для поля формы.

getFont()

public Font getFont()

Предоставляет доступ к форматированию шрифта этого объекта.

Возвращает: Font - соответствующийFont ценность.

getHelpText()

public String getHelpText()

Получает текст, отображаемый в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает клавишу F1.

Если для свойства OwnHelp установлено значение True, HelpText указывает значение текстовой строки. Если для параметра OwnHelp задано значение False, HelpText указывает имя записи автотекста, которая содержит текст справки для поля формы.

Microsoft Word позволяет использовать строки длиной не более 255 символов.

Возвращает: java.lang.String — текст, отображаемый в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает F1.

getMaxLength()

public int getMaxLength()

Максимальная длина текстового поля. Ноль, когда длина не ограничена.

Возвращает: int - соответствующее значение int.

getName()

public String getName()

Получает имя поля формы. Microsoft Word позволяет использовать строки длиной не более 20 символов.

Возвращает: java.lang.String — имя поля формы.

getNextSibling()

public Node getNextSibling()

Получает узел, следующий сразу за этим узлом. Если следующего узла нет, возвращается нуль.

Возвращает: Node - Узел, непосредственно следующий за этим узлом.

getNodeType()

public int getNodeType()

ВозвращаетNodeType.FormField.

Возвращает: инт -NodeType.FormField . Возвращаемое значение является одним изNodeType константы.

getOwnHelp()

public boolean getOwnHelp()

Указывает источник текста, отображаемого в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает клавишу F1.

Если True, отображается текст, заданный свойством HelpText. Если задано значение False, отображается текст в записи автотекста, заданный свойством HelpText.

Возвращает: boolean - соответствующее логическое значение.

getOwnStatus()

public boolean getOwnStatus()

Указывает источник текста, который отображается в строке состояния, когда поле формы находится в фокусе.

Если true, отображается текст, заданный свойством StatusText. Если установлено значение false, отображается текст записи автотекста, заданный свойством StatusText.

Возвращает: boolean - соответствующее логическое значение.

getParentNode()

public CompositeNode getParentNode()

Получает непосредственного родителя этого узла.

Если узел был только что создан и еще не добавлен в дерево, или если он был удален из дерева, родитель имеет значение null.

Возвращает: CompositeNode - Непосредственный родитель этого узла.

getParentParagraph()

public Paragraph getParentParagraph()

Извлекает родителяParagraph этого узла.

Возвращает: Paragraph - соответствующийParagraph ценность.

getParentParagraph_IInline()

public Paragraph getParentParagraph_IInline()

Возвращает: Paragraph

getPreviousSibling()

public Node getPreviousSibling()

Получает узел, непосредственно предшествующий этому узлу. Если предыдущего узла нет, возвращается нуль.

Возвращает: Node - Узел, непосредственно предшествующий этому узлу.

getRange()

public Range getRange()

ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.

Возвращает: Range - АRange объект, который представляет часть документа, содержащегося в этом узле.

getResult()

public String getResult()

Получает строку, представляющую результат этого поля формы.

Для поля текстовой формы результатом является текст, который находится в поле.

Для поля формы флажка результат может быть «1» или «0», чтобы указать, отмечен или не отмечен.

Для раскрывающегося поля формы результатом является строка, выбранная в раскрывающемся списке.

ПараметрgetResult() / setResult(java.lang.String) для поля текстовой формы не применяется текстовый формат, указанный вgetTextInputFormat() / setTextInputFormat(java.lang.String) . Если вы хотите установить значение и применить формат, используйтеsetTextInputValue(java.lang.Object) метод.

Для поля текстовой формыgetTextInputDefault() / setTextInputDefault(java.lang.String) значение применяется, если значение равно null .

Возвращает: java.lang.String — строка, представляющая результат этого поля формы.

getStatusText()

public String getStatusText()

Получает текст, отображаемый в строке состояния, когда поле формы имеет фокус.

Если для свойства OwnStatus установлено значение true, свойство StatusText определяет текст строки состояния. Если для свойства OwnStatus задано значение false, свойство StatusText указывает имя записи автотекста, которая содержит текст строки состояния для поля формы.

Microsoft Word позволяет использовать строки длиной не более 138 символов.

Возвращает: java.lang.String — текст, отображаемый в строке состояния, когда поле формы находится в фокусе.

getText()

public String getText()

Получает специальный символ, который представляет этот узел.

Возвращает: java.lang.String — строка, содержащая символ, который представляет этот узел.

getTextInputDefault()

public String getTextInputDefault()

Получает строку по умолчанию или выражение вычисления поля текстовой формы.

Смысл этого свойства зависит от значенияgetTextInputType() / setTextInputType(int) имущество.

КогдаgetTextInputType() / setTextInputType(int) являетсяTextFormFieldType.REGULAR или жеTextFormFieldType.NUMBER, эта строка указывает строку по умолчанию для поля текстовой формы. Эта строка представляет собой содержимое, которое Microsoft Word будет отображать в документе, когда поле формы пусто.

КогдаgetTextInputType() / setTextInputType(int) являетсяTextFormFieldType.CALCULATED, то эта строка содержит вычисляемое выражение. Выражение должно быть формулой, допустимой в соответствии с требованиями поля формулы Microsoft Word. Когда вы устанавливаете новое выражение с помощью этого свойства, Aspose.Words автоматически вычисляет результат формулы и вставляет его в поле формы.

Microsoft Word позволяет использовать строки длиной не более 255 символов.

Возвращает: java.lang.String — строка по умолчанию или расчетное выражение поля текстовой формы.

getTextInputFormat()

public String getTextInputFormat()

Получает форматирование текста для поля текстовой формы.

Если поле текстовой формы содержит обычный текст, допустимыми строками формата являются “”, “ВЕРХНИЙ РЕГИСТР”, “НИЖНИЙ РЕГИСТР”, “ПЕРВАЯ ЗАГЛАВНАЯ” и “ЗАГЛАВНЫЙ РЕГИСТР”. Строки нечувствительны к регистру.

Если поле текстовой формы содержит число или значение даты/времени, допустимыми строками формата являются числа или строки формата даты и времени.

Microsoft Word позволяет использовать строки длиной не более 64 символов.

Возвращает: java.lang.String — Форматирование текста для поля текстовой формы.

getTextInputType()

public int getTextInputType()

Получает тип поля текстовой формы.

Возвращает: int - Тип поля текстовой формы. Возвращаемое значение является одним изTextFormFieldType константы.

getType()

public int getType()

Возвращает тип поля формы.

Возвращает: int - Тип поля формы. Возвращаемое значение является одним изFieldType константы.

hashCode()

public native int hashCode()

Возвращает: инт

isCheckBoxExactSize()

public boolean isCheckBoxExactSize()

Получает логическое значение, указывающее, является ли размер текстового поля автоматическим или заданным явно.

Применимо только к полю формы флажка.

Возвращает: boolean — логическое значение, указывающее, является ли размер текстового поля автоматическим или заданным явно.

isCheckBoxExactSize(boolean value)

public void isCheckBoxExactSize(boolean value)

Задает логическое значение, указывающее, является ли размер текстового поля автоматическим или заданным явно.

Применимо только к полю формы флажка.

Параметры:

Параметр	Тип	Описание
value	boolean	Логическое значение, указывающее, является ли размер текстового поля автоматическим или заданным явно.

isComposite()

public boolean isComposite()

Возвращает true, если этот узел может содержать другие узлы. (31110,6)

Возвращает: boolean — Истинно, если этот узел может содержать другие узлы.

isDeleteRevision()

public boolean isDeleteRevision()

Возвращает true, если этот объект был удален в Microsoft Word при включенном отслеживании изменений.

Возвращает: boolean — Истинно, если этот объект был удален в Microsoft Word при включенном отслеживании изменений.

isFormatRevision()

public boolean isFormatRevision()

Возвращает true, если форматирование объекта было изменено в Microsoft Word при включенном отслеживании изменений.

Возвращает: boolean — Истинно, если форматирование объекта было изменено в Microsoft Word при включенном отслеживании изменений.

isInsertRevision()

public boolean isInsertRevision()

Возвращает true, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений.

Возвращает: boolean — True, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений.

isMoveFromRevision()

public boolean isMoveFromRevision()

Возвращаетtrue если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений.

Возвращает: логический -true если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений.

isMoveToRevision()

public boolean isMoveToRevision()

Возвращаетtrue если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений.

Возвращает: логический -true если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений.

nextPreOrder(Node rootNode)

public Node nextPreOrder(Node rootNode)

Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.

Параметры:

Параметр	Тип	Описание
rootNode	Node	Верхний узел (предел) обхода.

Возвращает: Node - Следующий узел в порядке предварительного заказа. Null, если достигнут rootNode.

nodeTypeToString(int nodeType)

public static String nodeTypeToString(int nodeType)

Параметры:

Параметр	Тип	Описание
nodeType	int

Возвращает: java.lang.String

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

previousPreOrder(Node rootNode)

public Node previousPreOrder(Node rootNode)

Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.

Параметры:

Параметр	Тип	Описание
rootNode	Node	Верхний узел (предел) обхода.

Возвращает: Node - Предыдущий узел в порядке предварительного заказа. Null, если достигнут rootNode.

remove()

public void remove()

Удаляет себя из родителя.

removeField()

public void removeField()

Удаляет все поле формы, а не только специальный символ поля формы. Если есть закладка, связанная с полем формы, закладка не удаляется.

removeMoveRevisions()

public void removeMoveRevisions()

removeRunAttr(int key)

public void removeRunAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

setCalculateOnExit(boolean value)

public void setCalculateOnExit(boolean value)

Истинно, если ссылки на указанное поле формы автоматически обновляются при выходе из поля.

Параметры:

Параметр	Тип	Описание
value	boolean	Соответствующее логическое значение.

setCheckBoxSize(double value)

public void setCheckBoxSize(double value)

Устанавливает размер флажка в пунктах. Имеет эффект только тогда, когдаisCheckBoxExactSize() / isCheckBoxExactSize(boolean) правда.

Применимо только к полю формы флажка.

Параметры:

Параметр	Тип	Описание
value	double	Размер флажка в пунктах.

setChecked(boolean value)

public void setChecked(boolean value)

Устанавливает проверенный статус поля формы флажка. Значение по умолчанию для этого свойстваfalse.

Применимо только к полю формы флажка.

Параметры:

Параметр	Тип	Описание
value	boolean	Отмеченный статус поля формы флажка.

setCustomNodeId(int value)

public void setCustomNodeId(int value)

Задает идентификатор пользовательского узла.

По умолчанию ноль.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение.

setDefault(boolean value)

public void setDefault(boolean value)

Задает значение по умолчанию для поля формы флажка. Значение по умолчанию для этого свойстваfalse.

Применимо только к полю формы флажка.

Параметры:

Параметр	Тип	Описание
value	boolean	Значение по умолчанию поля формы флажка.

setDropDownSelectedIndex(int value)

public void setDropDownSelectedIndex(int value)

Задает индекс, указывающий текущий выбранный элемент в поле раскрывающейся формы.

Параметры:

Параметр	Тип	Описание
value	int	Индекс, указывающий текущий выбранный элемент в раскрывающемся поле формы.

setEnabled(boolean value)

public void setEnabled(boolean value)

Истинно, если поле формы включено.

Если поле формы включено, его содержимое может быть изменено по мере заполнения формы.

Параметры:

Параметр	Тип	Описание
value	boolean	Соответствующее логическое значение.

setEntryMacro(String value)

public void setEntryMacro(String value)

Задает имя макроса записи для поля формы.

Макрос ввода запускается, когда поле формы получает фокус в Microsoft Word.

Microsoft Word позволяет использовать строки длиной не более 32 символов.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Имя макроса записи для поля формы.

setExitMacro(String value)

public void setExitMacro(String value)

Задает имя макроса выхода для поля формы.

Макрос выхода запускается, когда поле формы теряет фокус в Microsoft Word.

Microsoft Word позволяет использовать строки длиной не более 32 символов.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Имя макроса выхода для поля формы.

setHelpText(String value)

public void setHelpText(String value)

Задает текст, отображаемый в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает клавишу F1.

Microsoft Word позволяет использовать строки длиной не более 255 символов.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Текст, отображаемый в окне сообщения, когда поле формы находится в фокусе и пользователь нажимает клавишу F1.

setMaxLength(int value)

public void setMaxLength(int value)

Максимальная длина текстового поля. Ноль, когда длина не ограничена.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение.

setName(String value)

public void setName(String value)

Задает имя поля формы. Microsoft Word позволяет использовать строки длиной не более 20 символов.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Имя поля формы.

setOwnHelp(boolean value)

public void setOwnHelp(boolean value)

Параметры:

Параметр	Тип	Описание
value	boolean	Соответствующее логическое значение.

setOwnStatus(boolean value)

public void setOwnStatus(boolean value)

Указывает источник текста, который отображается в строке состояния, когда поле формы находится в фокусе.

Параметры:

Параметр	Тип	Описание
value	boolean	Соответствующее логическое значение.

setResult(String value)

public void setResult(String value)

Задает строку, представляющую результат этого поля формы.

Для поля текстовой формы результатом является текст, который находится в поле.

Для поля формы флажка результат может быть «1» или «0», чтобы указать, отмечен или не отмечен.

Для раскрывающегося поля формы результатом является строка, выбранная в раскрывающемся списке.

Для поля текстовой формыgetTextInputDefault() / setTextInputDefault(java.lang.String) значение применяется, если значение равно null .

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Строка, представляющая результат этого поля формы.

setRunAttr(int key, Object value)

public void setRunAttr(int key, Object value)

Параметры:

Параметр	Тип	Описание
key	int
value	java.lang.Object

setStatusText(String value)

public void setStatusText(String value)

Задает текст, отображаемый в строке состояния, когда поле формы находится в фокусе.

Microsoft Word позволяет использовать строки длиной не более 138 символов.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Текст, отображаемый в строке состояния, когда поле формы находится в фокусе.

setTextInputDefault(String value)

public void setTextInputDefault(String value)

Задает строку по умолчанию или выражение вычисления поля текстовой формы.

Смысл этого свойства зависит от значенияgetTextInputType() / setTextInputType(int) имущество.

Microsoft Word позволяет использовать строки длиной не более 255 символов.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Строка по умолчанию или расчетное выражение поля текстовой формы.

setTextInputFormat(String value)

public void setTextInputFormat(String value)

Задает форматирование текста для поля текстовой формы.

Microsoft Word позволяет использовать строки длиной не более 64 символов.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Форматирование текста для поля текстовой формы.

setTextInputType(int value)

public void setTextInputType(int value)

Задает тип поля текстовой формы.

Параметры:

Параметр	Тип	Описание
value	int	Тип поля текстовой формы. Значение должно быть одним изTextFormFieldType константы.

setTextInputValue(Object newValue)

public void setTextInputValue(Object newValue)

Применяет формат текста, указанный вgetTextInputFormat() / setTextInputFormat(java.lang.String) и сохраняет значение вgetResult() / setResult(java.lang.String).

Параметры:

Параметр	Тип	Описание
newValue	java.lang.Object	Может быть строкой, числом или объектом DateTime.getTextInputDefault() / setTextInputDefault(java.lang.String) value применяется, если newValue равно null .

toString()

public String toString()

Возвращает: java.lang.String

toString(SaveOptions saveOptions)

public String toString(SaveOptions saveOptions)

Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Параметры:

Параметр	Тип	Описание
saveOptions	SaveOptions	Указывает параметры, управляющие способом сохранения узла.

Возвращает: java.lang.String — содержимое узла в указанном формате.

toString(int saveFormat)

public String toString(int saveFormat)

Параметры:

Параметр	Тип	Описание
saveFormat	int

Возвращает: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

Параметр	Тип	Описание
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

Параметр	Тип	Описание
arg0	long
arg1	int

FootnoteType FormFieldCollection