FieldToc

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

public class FieldToc extends Field

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

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

Создает оглавление (которое также может быть таблицей рисунков), используя записи, заданные полями TC, их уровнями заголовков и указанными стилями, и вставляет эту таблицу в это место в документе.

Методы

Метод	Описание
equals(Object arg0)
getAreCustomStylesSpecified()
getBookmarkName()	Получает имя закладки, помечающей часть документа, используемую для построения таблицы.
getCaptionlessTableOfFiguresLabel()	Получает имя идентификатора последовательности, используемого при построении таблицы рисунков, которая не включает метку и номер подписи.
getClass()
getCustomStyles()	Получает список стилей, отличных от встроенных стилей заголовков, для включения в оглавление.
getDisplayResult()	Получает текст, представляющий отображаемый результат поля.
getEnd()	Получает узел, представляющий конец поля.
getEntryIdentifier()	Получает строку, которая должна соответствовать идентификаторам типов включаемых полей TC.
getEntryLevelRange()	Получает диапазон уровней включаемых записей оглавления.
getEntrySeparator()	Получает последовательность символов, разделяющую запись и номер ее страницы.
getEntryTypeCore()
getFieldCode()	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFieldCode(boolean includeChildFieldCodes)	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFormat()	ПолучаетFieldFormat объект, предоставляющий типизированный доступ к форматированию поля.
getHeadingLevelRange()	Получает диапазон уровней заголовков для включения.
getHideInWebLayout()	Определяет, следует ли скрывать закладку и номера страниц в представлении веб-макета.
getIncludeRefDocFields()
getIncludeTocEntryFields()
getInsertHyperlinks()	Получает, следует ли сделать записи оглавления гиперссылками.
getLevelForCustomStyle(Paragraph paragraph, Style style)
getLocaleId()	Получает LCID поля.
getPageNumberOmittingLevelRange()	Получает диапазон уровней записей оглавления, из которых следует исключить номера страниц.
getPrefixedSequenceIdentifier()	Получает идентификатор последовательности, для которой к номеру страницы записи следует добавить префикс.
getPreserveLineBreaks()	Определяет, следует ли сохранять символы новой строки в записях таблицы.
getPreserveTabs()	Определяет, следует ли сохранять записи вкладок в записях таблицы.
getRangeBookmark()
getResult()	Получает текст, который находится между разделителем полей и концом поля.
getSeparator()	Получает узел, представляющий разделитель полей.
getSequenceSeparator()	Получает последовательность символов, используемую для разделения порядковых номеров и номеров страниц.
getSkipTables()
getStart()	Получает узел, представляющий начало поля.
getSwitchType(String switchName)
getTableOfFiguresLabel()	Получает имя идентификатора последовательности, используемого при построении таблицы рисунков.
getType()	Получает тип поля Microsoft Word.
getUseParagraphOutlineLevel()	Получает, следует ли использовать примененный уровень структуры абзаца.
hashCode()
isBookmarkRangeSpecified()
isDirty()	Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isDirty(boolean value)	Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isEntryLevelRangeSpecified()
isHeadingLevelRangeSpecified()
isLocked()	Получает, заблокировано ли поле (не должно пересчитывать его результат).
isLocked(boolean value)	Устанавливает, будет ли поле заблокировано (не должно пересчитывать свой результат).
isTableOfFigures()
notify()
notifyAll()
remove()	Удаляет поле из документа.
setBookmarkName(String value)	Задает имя закладки, которая отмечает часть документа, используемую для построения таблицы.
setCaptionlessTableOfFiguresLabel(String value)	Задает имя идентификатора последовательности, используемого при построении таблицы рисунков, которая не включает метку и номер подписи.
setCustomStyles(String value)	Задает список стилей, отличных от встроенных стилей заголовков, для включения в оглавление.
setEntryIdentifier(String value)	Задает строку, которая должна соответствовать идентификаторам типов включаемых полей TC.
setEntryLevelRange(String value)	Задает диапазон уровней включаемых записей оглавления.
setEntrySeparator(String value)	Задает последовательность символов, разделяющую запись и номер ее страницы.
setHeadingLevelRange(String value)	Устанавливает диапазон уровней заголовков для включения.
setHideInWebLayout(boolean value)	Устанавливает, следует ли скрывать закладку и номера страниц в представлении веб-макета.
setInsertHyperlinks(boolean value)	Устанавливает, следует ли делать записи оглавления гиперссылками.
setLocaleId(int value)	Устанавливает LCID поля.
setPageNumberOmittingLevelRange(String value)	Задает диапазон уровней записей оглавления, из которых следует опускать номера страниц.
setPrefixedSequenceIdentifier(String value)	Задает идентификатор последовательности, для которой к номеру страницы записи следует добавить префикс.
setPreserveLineBreaks(boolean value)	Устанавливает, сохранять ли символы новой строки в записях таблицы.
setPreserveTabs(boolean value)	Устанавливает, сохранять ли записи вкладок в записях таблицы.
setResult(String value)	Задает текст, который находится между разделителем полей и концом поля.
setSequenceSeparator(String value)	Задает последовательность символов, используемую для разделения порядковых номеров и номеров страниц.
setTableOfFiguresLabel(String value)	Задает имя идентификатора последовательности, используемого при построении таблицы рисунков.
setUseParagraphOutlineLevel(boolean value)	Устанавливает, следует ли использовать примененный уровень структуры абзаца.
toString()
unlink()	Выполняет развязку поля.
update()	Выполняет обновление поля.
update(boolean ignoreMergeFormat)	Выполняет обновление поля.
updatePageNumbers()	Обновляет номера страниц для элементов в этом оглавлении.
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

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

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

getAreCustomStylesSpecified()

public boolean getAreCustomStylesSpecified()

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

getBookmarkName()

public String getBookmarkName()

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

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

getCaptionlessTableOfFiguresLabel()

public String getCaptionlessTableOfFiguresLabel()

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

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

getClass()

public final native Class<?> getClass()

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

getCustomStyles()

public String getCustomStyles()

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

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

getDisplayResult()

public String getDisplayResult()

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

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

getEnd()

public FieldEnd getEnd()

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

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

getEntryIdentifier()

public String getEntryIdentifier()

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

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

getEntryLevelRange()

public String getEntryLevelRange()

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

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

getEntrySeparator()

public String getEntrySeparator()

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

Возвращает: java.lang.String — последовательность символов, разделяющая запись и номер ее страницы.

getEntryTypeCore()

public int getEntryTypeCore()

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

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

getHeadingLevelRange()

public String getHeadingLevelRange()

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

Возвращает: java.lang.String — диапазон уровней заголовков для включения.

getHideInWebLayout()

public boolean getHideInWebLayout()

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

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

getIncludeRefDocFields()

public boolean getIncludeRefDocFields()

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

getIncludeTocEntryFields()

public boolean getIncludeTocEntryFields()

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

getInsertHyperlinks()

public boolean getInsertHyperlinks()

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

Возвращает: boolean - Делать ли записи оглавления гиперссылками.

getLevelForCustomStyle(Paragraph paragraph, Style style)

public int getLevelForCustomStyle(Paragraph paragraph, Style style)

Параметры:

Параметр	Тип	Описание
paragraph	Paragraph
style	Style

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

getLocaleId()

public int getLocaleId()

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

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

getPageNumberOmittingLevelRange()

public String getPageNumberOmittingLevelRange()

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

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

getPrefixedSequenceIdentifier()

public String getPrefixedSequenceIdentifier()

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

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

getPreserveLineBreaks()

public boolean getPreserveLineBreaks()

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

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

getPreserveTabs()

public boolean getPreserveTabs()

Определяет, следует ли сохранять записи вкладок в записях таблицы.

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

getRangeBookmark()

public Bookmark getRangeBookmark()

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

getResult()

public String getResult()

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

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

getSeparator()

public FieldSeparator getSeparator()

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

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

getSequenceSeparator()

public String getSequenceSeparator()

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

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

getSkipTables()

public boolean getSkipTables()

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

getStart()

public FieldStart getStart()

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

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

getSwitchType(String switchName)

public int getSwitchType(String switchName)

Параметры:

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

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

getTableOfFiguresLabel()

public String getTableOfFiguresLabel()

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

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

getType()

public int getType()

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

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

getUseParagraphOutlineLevel()

public boolean getUseParagraphOutlineLevel()

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

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

hashCode()

public native int hashCode()

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

isBookmarkRangeSpecified()

public boolean isBookmarkRangeSpecified()

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

isDirty()

public boolean isDirty()

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

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

isDirty(boolean value)

public void isDirty(boolean value)

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

Параметры:

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

isEntryLevelRangeSpecified()

public boolean isEntryLevelRangeSpecified()

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

isHeadingLevelRangeSpecified()

public boolean isHeadingLevelRangeSpecified()

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

isLocked()

public boolean isLocked()

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

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

isLocked(boolean value)

public void isLocked(boolean value)

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

Параметры:

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

isTableOfFigures()

public boolean isTableOfFigures()

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

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

remove()

public Node remove()

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

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

setBookmarkName(String value)

public void setBookmarkName(String value)

Задает имя закладки, которая отмечает часть документа, используемую для построения таблицы.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Имя закладки, которая отмечает часть документа, используемую для построения таблицы.

setCaptionlessTableOfFiguresLabel(String value)

public void setCaptionlessTableOfFiguresLabel(String value)

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

Параметры:

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

setCustomStyles(String value)

public void setCustomStyles(String value)

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

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Список стилей, отличных от встроенных стилей заголовков, для включения в оглавление.

setEntryIdentifier(String value)

public void setEntryIdentifier(String value)

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

Параметры:

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

setEntryLevelRange(String value)

public void setEntryLevelRange(String value)

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

Параметры:

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

setEntrySeparator(String value)

public void setEntrySeparator(String value)

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

Параметры:

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

setHeadingLevelRange(String value)

public void setHeadingLevelRange(String value)

Устанавливает диапазон уровней заголовков для включения.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Диапазон уровней заголовков для включения.

setHideInWebLayout(boolean value)

public void setHideInWebLayout(boolean value)

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

Параметры:

Параметр	Тип	Описание
value	boolean	Следует ли скрывать закладку и номера страниц в представлении веб-макета.

setInsertHyperlinks(boolean value)

public void setInsertHyperlinks(boolean value)

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

Параметры:

Параметр	Тип	Описание
value	boolean	Делать ли записи оглавления гиперссылками.

setLocaleId(int value)

public void setLocaleId(int value)

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

Параметры:

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

setPageNumberOmittingLevelRange(String value)

public void setPageNumberOmittingLevelRange(String value)

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

Параметры:

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

setPrefixedSequenceIdentifier(String value)

public void setPrefixedSequenceIdentifier(String value)

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

Параметры:

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

setPreserveLineBreaks(boolean value)

public void setPreserveLineBreaks(boolean value)

Устанавливает, сохранять ли символы новой строки в записях таблицы.

Параметры:

Параметр	Тип	Описание
value	boolean	Сохранять ли символы новой строки в записях таблицы.

setPreserveTabs(boolean value)

public void setPreserveTabs(boolean value)

Устанавливает, сохранять ли записи вкладок в записях таблицы.

Параметры:

Параметр	Тип	Описание
value	boolean	Сохранять ли записи вкладок в записях таблицы.

setResult(String value)

public void setResult(String value)

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

Параметры:

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

setSequenceSeparator(String value)

public void setSequenceSeparator(String value)

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

Параметры:

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

setTableOfFiguresLabel(String value)

public void setTableOfFiguresLabel(String value)

Задает имя идентификатора последовательности, используемого при построении таблицы рисунков.

Параметры:

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

setUseParagraphOutlineLevel(boolean value)

public void setUseParagraphOutlineLevel(boolean value)

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

Параметры:

Параметр	Тип	Описание
value	boolean	Использовать ли примененный уровень структуры абзаца.

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, в противном случае выполняется обычное обновление.

updatePageNumbers()

public boolean updatePageNumbers()

Обновляет номера страниц для элементов в этом оглавлении.

Возвращает: boolean — Истинно, если операция выполнена успешно. Если какая-либо из связанных закладок TOC была удалена, будет возвращено значение false.

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