FieldStart

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

public class FieldStart extends FieldChar

Представляет начало поля Word в документе.

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

FieldStart является узлом встроенного уровня и представленControlChar.FIELD_START_CHAR управляющий символ в документе.

FieldStart может быть только ребенкомParagraph.

Полное поле в документе Microsoft Word представляет собой сложную структуру, состоящую из начального символа поля, кода поля, символа-разделителя полей, результата поля и конечного символа поля. Некоторые поля имеют только начало поля, код поля и конец поля.

Чтобы легко вставить новое поле в документ, используйтеDocumentBuilder.insertField(java.lang.String) метод.

Методы

Метод	Описание
accept(DocumentVisitor visitor)	Принимает посетителя.
clearRunAttrs()
dd()
deepClone(boolean isCloneChildren)	Создает дубликат узла.
equals(Object arg0)
fetchInheritedRunAttr(int fontAttr)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)	Получает первого предка указанного типа объекта.
getClass()
getCustomNodeId()	Задает идентификатор пользовательского узла.
getDirectRunAttr(int fontAttr)
getDocument()	Получает документ, которому принадлежит этот узел.
getDocument_IInline()
getField()	Возвращает поле для поля char.
getFieldData()	Получает данные настраиваемого поля, связанные с полем.
getFieldType()	Возвращает тип поля.
getFont()	Предоставляет доступ к форматированию шрифта этого объекта.
getNextSibling()	Получает узел, следующий сразу за этим узлом.
getNodeType()	ВозвращаетNodeType.FIELD_START.
getParentNode()	Получает непосредственного родителя этого узла.
getParentParagraph()	Извлекает родителяParagraph этого узла.
getParentParagraph_IInline()
getPreviousSibling()	Получает узел, непосредственно предшествующий этому узлу.
getRange()	ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.
getText()	Получает специальный символ, который представляет этот узел.
hashCode()
isComposite()	Возвращает true, если этот узел может содержать другие узлы.
isDeleteRevision()	Возвращает true, если этот объект был удален в Microsoft Word при включенном отслеживании изменений.
isDirty()	Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isDirty(boolean value)	Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isFormatRevision()	Возвращает true, если форматирование объекта было изменено в Microsoft Word при включенном отслеживании изменений.
isInsertRevision()	Возвращает true, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений.
isLocked()	Определяет, заблокировано ли родительское поле (не должно пересчитывать его результат).
isLocked(boolean value)	Устанавливает, заблокировано ли родительское поле (не должно пересчитывать его результат).
isMoveFromRevision()	Возвращаетtrue если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений.
isMoveToRevision()	Возвращаетtrue если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений.
nextPreOrder(Node rootNode)	Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
nodeTypeToString(int nodeType)
notify()
notifyAll()
previousPreOrder(Node rootNode)	Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
remove()	Удаляет себя из родителя.
removeMoveRevisions()
removeRunAttr(int key)
setCustomNodeId(int value)	Задает идентификатор пользовательского узла.
setRunAttr(int fontAttr, Object value)
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.visitFieldStart(com.aspose.words.FieldStart).

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

Параметры:

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

Возвращает: логический -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.

getClass()

public final native Class<?> getClass()

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

getCustomNodeId()

public int getCustomNodeId()

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

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

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

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

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

getDirectRunAttr(int fontAttr)

public Object getDirectRunAttr(int fontAttr)

Параметры:

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

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

getDocument()

public DocumentBase getDocument()

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

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

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

getDocument_IInline()

public DocumentBase getDocument_IInline()

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

getField()

public Field getField()

Возвращает поле для поля char. новыйField объект создается каждый раз при вызове метода.

Возвращает: Field - Поле для поля char.

getFieldData()

public byte[] getFieldData()

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

Возвращает: байт[] — данные пользовательского поля, связанные с полем.

getFieldType()

public int getFieldType()

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

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

getFont()

public Font getFont()

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

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

getNextSibling()

public Node getNextSibling()

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

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

getNodeType()

public int getNodeType()

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

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

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

getText()

public String getText()

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

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

hashCode()

public native int hashCode()

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

isComposite()

public boolean isComposite()

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

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

isDeleteRevision()

public boolean isDeleteRevision()

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

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

isDirty()

public boolean isDirty()

Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.

Возвращает: boolean - Является ли текущий результат поля более неверным (устаревшим) из-за других изменений, внесенных в документ.

isDirty(boolean value)

public void isDirty(boolean value)

Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.

Параметры:

Параметр	Тип	Описание
value	boolean	Является ли текущий результат поля более неправильным (устаревшим) из-за других изменений, внесенных в документ.

isFormatRevision()

public boolean isFormatRevision()

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

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

isInsertRevision()

public boolean isInsertRevision()

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

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

isLocked()

public boolean isLocked()

Определяет, заблокировано ли родительское поле (не должно пересчитывать его результат).

Возвращает: boolean — заблокировано ли родительское поле (не должно пересчитывать результат).

isLocked(boolean value)

public void isLocked(boolean value)

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

Параметры:

Параметр	Тип	Описание
value	boolean	Заблокировано ли родительское поле (не должно пересчитывать его результат).

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()

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

removeMoveRevisions()

public void removeMoveRevisions()

removeRunAttr(int key)

public void removeRunAttr(int key)

Параметры:

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

setCustomNodeId(int value)

public void setCustomNodeId(int value)

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

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

Параметры:

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

setRunAttr(int fontAttr, Object value)

public void setRunAttr(int fontAttr, Object value)

Параметры:

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

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

FieldSkipIf FieldStyleRef