FieldTC

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

public class FieldTC extends Field

Реализует поле TC.

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

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

Методы

Метод	Описание
equals(Object arg0)
getClass()
getDisplayResult()	Получает текст, представляющий отображаемый результат поля.
getDocumentOutlineTitle()
getEnd()	Получает узел, представляющий конец поля.
getEntryLevel()	Получает уровень записи.
getFieldCode()	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFieldCode(boolean includeChildFieldCodes)	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFormat()	ПолучаетFieldFormat объект, предоставляющий типизированный доступ к форматированию поля.
getLevel()
getLocaleId()	Получает LCID поля.
getOmitPageNumber()	Определяет, следует ли опускать номер страницы в оглавлении для этого поля.
getPageNumber()
getParagraph()
getResult()	Получает текст, который находится между разделителем полей и концом поля.
getSeparator()	Получает узел, представляющий разделитель полей.
getSequenceValue(String sequenceIdentifier)
getStart()	Получает узел, представляющий начало поля.
getSwitchType(String switchName)
getText()	Получает текст записи.
getType()	Получает тип поля Microsoft Word.
getTypeIdentifier()	Получает идентификатор типа для этого поля (обычно это буква).
hasBookmark()
hashCode()
isDirty()	Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isDirty(boolean value)	Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isInFieldCode()
isLocked()	Получает, заблокировано ли поле (не должно пересчитывать его результат).
isLocked(boolean value)	Устанавливает, будет ли поле заблокировано (не должно пересчитывать свой результат).
notify()
notifyAll()
remove()	Удаляет поле из документа.
setEntryLevel(String value)	Устанавливает уровень входа.
setLocaleId(int value)	Устанавливает LCID поля.
setOmitPageNumber(boolean value)	Устанавливает, следует ли опускать номер страницы в оглавлении для этого поля.
setResult(String value)	Задает текст, который находится между разделителем полей и концом поля.
setText(String value)	Устанавливает текст записи.
setTypeIdentifier(String value)	Задает идентификатор типа для этого поля (обычно это буква).
toString()
unlink()	Выполняет развязку поля.
update()	Выполняет обновление поля.
update(boolean ignoreMergeFormat)	Выполняет обновление поля.
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

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

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

getClass()

public final native Class<?> getClass()

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

getDisplayResult()

public String getDisplayResult()

Получает текст, представляющий отображаемый результат поля.Document.updateListLabels() метод должен быть вызван, чтобы получить правильное значение дляFieldListNum, FieldAutoNum, FieldAutoNumOut а такжеFieldAutoNumLgl поля.

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

getDocumentOutlineTitle()

public String getDocumentOutlineTitle()

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

getEnd()

public FieldEnd getEnd()

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

Возвращает: FieldEnd - Узел, представляющий конец поля.

getEntryLevel()

public String getEntryLevel()

Получает уровень записи.

Возвращает: java.lang.String — Уровень записи.

getFieldCode()

public String getFieldCode()

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

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

getFieldCode(boolean includeChildFieldCodes)

public String getFieldCode(boolean includeChildFieldCodes)

Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).

Параметры:

Параметр	Тип	Описание
includeChildFieldCodes	boolean	{ True, если должны быть включены коды дочерних полей.

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

getFormat()

public FieldFormat getFormat()

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

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

getLevel()

public int getLevel()

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

getLocaleId()

public int getLocaleId()

Получает LCID поля.

Возвращает: int — LCID поля.

getOmitPageNumber()

public boolean getOmitPageNumber()

Определяет, следует ли опускать номер страницы в оглавлении для этого поля.

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

getPageNumber()

public int getPageNumber()

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

getParagraph()

public Paragraph getParagraph()

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

getResult()

public String getResult()

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

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

getSeparator()

public FieldSeparator getSeparator()

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

Возвращает: FieldSeparator - Узел, представляющий разделитель полей.

getSequenceValue(String sequenceIdentifier)

public int getSequenceValue(String sequenceIdentifier)

Параметры:

Параметр	Тип	Описание
sequenceIdentifier	java.lang.String

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

getStart()

public FieldStart getStart()

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

Возвращает: FieldStart - Узел, представляющий начало поля.

getSwitchType(String switchName)

public int getSwitchType(String switchName)

Параметры:

Параметр	Тип	Описание
switchName	java.lang.String

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

getText()

public String getText()

Получает текст записи.

Возвращает: java.lang.String — текст записи.

getType()

public int getType()

Получает тип поля Microsoft Word.

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

getTypeIdentifier()

public String getTypeIdentifier()

Получает идентификатор типа для этого поля (обычно это буква).

Возвращает: java.lang.String — идентификатор типа для этого поля (обычно это буква).

hasBookmark()

public boolean hasBookmark()

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

hashCode()

public native int hashCode()

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

isDirty()

public boolean isDirty()

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

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

isDirty(boolean value)

public void isDirty(boolean value)

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

Параметры:

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

isInFieldCode()

public boolean isInFieldCode()

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

isLocked()

public boolean isLocked()

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

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

isLocked(boolean value)

public void isLocked(boolean value)

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

Параметры:

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

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

remove()

public Node remove()

Удаляет поле из документа. Возвращает узел сразу после поля. Если конец поля является последним дочерним элементом его родительского узла, возвращает его родительский абзац. Если поле уже удалено, возвращаетnull.

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

setEntryLevel(String value)

public void setEntryLevel(String value)

Устанавливает уровень входа.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Уровень входа.

setLocaleId(int value)

public void setLocaleId(int value)

Устанавливает LCID поля.

Параметры:

Параметр	Тип	Описание
value	int	LCID поля.

setOmitPageNumber(boolean value)

public void setOmitPageNumber(boolean value)

Устанавливает, следует ли опускать номер страницы в оглавлении для этого поля.

Параметры:

Параметр	Тип	Описание
value	boolean	Должен ли номер страницы в оглавлении быть опущен для этого поля.

setResult(String value)

public void setResult(String value)

Задает текст, который находится между разделителем полей и концом поля.

Параметры:

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

setText(String value)

public void setText(String value)

Устанавливает текст записи.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Текст записи.

setTypeIdentifier(String value)

public void setTypeIdentifier(String value)

Задает идентификатор типа для этого поля (обычно это буква).

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Идентификатор типа для этого поля (обычно это буква).

toString()

public String toString()

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

unlink()

public boolean unlink()

Выполняет развязку поля.

Заменяет поле самым последним результатом.

Некоторые поля, такие как поля XE (запись индекса) и поля SEQ (последовательность), нельзя разъединить.

Возвращает: логический -{ True, если связь с полем отсутствует, иначе false.

update()

public void update()

Выполняет обновление поля. Выдает, если поле уже обновляется.

update(boolean ignoreMergeFormat)

public void update(boolean ignoreMergeFormat)

Выполняет обновление поля. Выдает, если поле уже обновляется.

Параметры:

Параметр	Тип	Описание
ignoreMergeFormat	boolean	Если значение равно true, то прямое форматирование результата поля прекращается, независимо от переключателя MERGEFORMAT, в противном случае выполняется обычное обновление.

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