FieldIndex

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

public class FieldIndex extends Field

Реализует поле ИНДЕКС.

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

Создает индекс, используя записи индекса, указанные в полях XE, и вставляет этот индекс в это место в документе.

Методы

Метод	Описание
equals(Object arg0)
getBookmarkName()	Получает имя закладки, помечающей часть документа, используемую для построения индекса.
getClass()
getCrossReferenceSeparator()	Получает последовательность символов, используемую для разделения перекрестных ссылок и других записей.
getDisplayResult()	Получает текст, представляющий отображаемый результат поля.
getEnd()	Получает узел, представляющий конец поля.
getEntryType()	Получает тип записи индекса, используемый для построения индекса.
getFieldCode()	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFieldCode(boolean includeChildFieldCodes)	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFormat()	ПолучаетFieldFormat объект, предоставляющий типизированный доступ к форматированию поля.
getHeading()	Получает заголовок, который появляется в начале каждого набора записей для любой заданной буквы.
getLanguageId()	Получает идентификатор языка, используемый для создания индекса.
getLetterRange()	Получает диапазон букв, которым ограничивается индекс.
getLocaleId()	Получает LCID поля.
getNumberOfColumns()	Получает количество столбцов на странице, используемых при построении индекса.
getPageNumberListSeparator()	Получает последовательность символов, используемую для разделения двух номеров страниц в списке номеров страниц.
getPageNumberSeparator()	Получает последовательность символов, которая используется для разделения записи указателя и ее номера страницы.
getPageRangeSeparator()	Получает последовательность символов, используемую для разделения начала и конца диапазона страниц.
getResult()	Получает текст, который находится между разделителем полей и концом поля.
getRunSubentriesOnSameLine()	Получает, запускаются ли подзаписи в той же строке, что и основная запись.
getSeparator()	Получает узел, представляющий разделитель полей.
getSequenceName()	Получает имя последовательности, номер которой включен в номер страницы.
getSequenceSeparator()	Получает последовательность символов, используемую для разделения порядковых номеров и номеров страниц.
getStart()	Получает узел, представляющий начало поля.
getSwitchType(String switchName)
getType()	Получает тип поля Microsoft Word.
getUseYomi()	Определяет, следует ли разрешить использование текста йоми для записей указателя.
hasPageNumberSeparator()	Получает значение, указывающее, переопределяется ли разделитель номеров страниц кодом поля.
hasSequenceName()	Получает значение, указывающее, следует ли использовать последовательность при построении результатов поля.
hashCode()
isDirty()	Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isDirty(boolean value)	Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isLocked()	Получает, заблокировано ли поле (не должно пересчитывать его результат).
isLocked(boolean value)	Устанавливает, будет ли поле заблокировано (не должно пересчитывать свой результат).
notify()
notifyAll()
remove()	Удаляет поле из документа.
setBookmarkName(String value)	Задает имя закладки, которая отмечает часть документа, используемую для построения индекса.
setCrossReferenceSeparator(String value)	Задает последовательность символов, используемую для разделения перекрестных ссылок и других записей.
setEntryType(String value)	Задает тип записи индекса, используемый для построения индекса.
setHeading(String value)	Устанавливает заголовок, который появляется в начале каждого набора записей для любой заданной буквы.
setLanguageId(String value)	Задает идентификатор языка, используемый для создания индекса.
setLetterRange(String value)	Задает диапазон букв, которым ограничивается индекс.
setLocaleId(int value)	Устанавливает LCID поля.
setNumberOfColumns(String value)	Задает количество столбцов на странице, используемых при построении индекса.
setPageNumberListSeparator(String value)	Задает последовательность символов, используемую для разделения двух номеров страниц в списке номеров страниц.
setPageNumberSeparator(String value)	Задает последовательность символов, используемую для разделения записи указателя и ее номера страницы.
setPageRangeSeparator(String value)	Задает последовательность символов, используемую для разделения начала и конца диапазона страниц.
setResult(String value)	Задает текст, который находится между разделителем полей и концом поля.
setRunSubentriesOnSameLine(boolean value)	Устанавливает, будут ли подзаголовки запускаться в той же строке, что и основная запись.
setSequenceName(String value)	Задает имя последовательности, номер которой включен в номер страницы.
setSequenceSeparator(String value)	Задает последовательность символов, используемую для разделения порядковых номеров и номеров страниц.
setUseYomi(boolean 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

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

getBookmarkName()

public String getBookmarkName()

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

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

getClass()

public final native Class<?> getClass()

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

getCrossReferenceSeparator()

public String getCrossReferenceSeparator()

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

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

getDisplayResult()

public String getDisplayResult()

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

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

getEnd()

public FieldEnd getEnd()

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

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

getEntryType()

public String getEntryType()

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

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

getHeading()

public String getHeading()

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

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

getLanguageId()

public String getLanguageId()

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

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

getLetterRange()

public String getLetterRange()

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

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

getLocaleId()

public int getLocaleId()

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

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

getNumberOfColumns()

public String getNumberOfColumns()

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

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

getPageNumberListSeparator()

public String getPageNumberListSeparator()

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

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

getPageNumberSeparator()

public String getPageNumberSeparator()

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

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

getPageRangeSeparator()

public String getPageRangeSeparator()

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

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

getResult()

public String getResult()

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

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

getRunSubentriesOnSameLine()

public boolean getRunSubentriesOnSameLine()

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

Возвращает: boolean - Выполнять ли подзаголовки в той же строке, что и основной ввод.

getSeparator()

public FieldSeparator getSeparator()

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

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

getSequenceName()

public String getSequenceName()

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

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

getSequenceSeparator()

public String getSequenceSeparator()

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

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

getStart()

public FieldStart getStart()

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

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

getSwitchType(String switchName)

public int getSwitchType(String switchName)

Параметры:

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

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

getType()

public int getType()

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

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

getUseYomi()

public boolean getUseYomi()

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

Возвращает: boolean — разрешить ли использование текста yomi для записей указателя.

hasPageNumberSeparator()

public boolean hasPageNumberSeparator()

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

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

hasSequenceName()

public boolean hasSequenceName()

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

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

hashCode()

public native int hashCode()

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

isDirty()

public boolean isDirty()

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

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

isDirty(boolean value)

public void isDirty(boolean value)

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

Параметры:

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

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

setBookmarkName(String value)

public void setBookmarkName(String value)

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

Параметры:

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

setCrossReferenceSeparator(String value)

public void setCrossReferenceSeparator(String value)

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

Параметры:

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

setEntryType(String value)

public void setEntryType(String value)

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

Параметры:

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

setHeading(String value)

public void setHeading(String value)

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

Параметры:

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

setLanguageId(String value)

public void setLanguageId(String value)

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

Параметры:

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

setLetterRange(String value)

public void setLetterRange(String value)

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

Параметры:

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

setLocaleId(int value)

public void setLocaleId(int value)

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

Параметры:

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

setNumberOfColumns(String value)

public void setNumberOfColumns(String value)

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

Параметры:

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

setPageNumberListSeparator(String value)

public void setPageNumberListSeparator(String value)

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

Параметры:

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

setPageNumberSeparator(String value)

public void setPageNumberSeparator(String value)

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

Параметры:

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

setPageRangeSeparator(String value)

public void setPageRangeSeparator(String value)

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

Параметры:

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

setResult(String value)

public void setResult(String value)

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

Параметры:

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

setRunSubentriesOnSameLine(boolean value)

public void setRunSubentriesOnSameLine(boolean value)

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

Параметры:

Параметр	Тип	Описание
value	boolean	Выполнять ли подзаписи в той же строке, что и основную запись.

setSequenceName(String value)

public void setSequenceName(String value)

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

Параметры:

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

setSequenceSeparator(String value)

public void setSequenceSeparator(String value)

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

Параметры:

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

setUseYomi(boolean value)

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

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