FieldXE

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

public class FieldXE extends Field

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

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

Определяет текст и номер страницы для элемента индекса, который используется полем ИНДЕКС.

Методы

Метод	Описание
equals(Object arg0)
getClass()
getDisplayResult()	Получает текст, представляющий отображаемый результат поля.
getEnd()	Получает узел, представляющий конец поля.
getEntryType()	Получает тип записи индекса.
getFieldCode()	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFieldCode(boolean includeChildFieldCodes)	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFormat()	ПолучаетFieldFormat объект, предоставляющий типизированный доступ к форматированию поля.
getLocaleId()	Получает LCID поля.
getPageNumberReplacement()	Получает текст, используемый вместо номера страницы.
getPageRangeBookmarkName()	Получает имя закладки, помечающей диапазон страниц, который вставляется в качестве номера страницы записи.
getResult()	Получает текст, который находится между разделителем полей и концом поля.
getSeparator()	Получает узел, представляющий разделитель полей.
getStart()	Получает узел, представляющий начало поля.
getSwitchType(String switchName)
getText()	Получает текст записи.
getType()	Получает тип поля Microsoft Word.
getYomi()	Получает ёми (первый фонетический символ для сортировки индексов) для записи индекса
hashCode()
isBold()	Определяет, следует ли применять полужирное форматирование к номеру страницы записи.
isBold(boolean value)	Устанавливает, следует ли применять полужирное форматирование к номеру страницы записи.
isDirty()	Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isDirty(boolean value)	Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isItalic()	Определяет, следует ли применять курсивное форматирование к номеру страницы записи.
isItalic(boolean value)	Устанавливает, следует ли применять курсивное форматирование к номеру страницы записи.
isLocked()	Получает, заблокировано ли поле (не должно пересчитывать его результат).
isLocked(boolean value)	Устанавливает, будет ли поле заблокировано (не должно пересчитывать свой результат).
notify()
notifyAll()
remove()	Удаляет поле из документа.
setEntryType(String value)	Задает тип записи индекса.
setLocaleId(int value)	Устанавливает LCID поля.
setPageNumberReplacement(String value)	Устанавливает текст, используемый вместо номера страницы.
setPageRangeBookmarkName(String value)	Задает имя закладки, помечающей диапазон страниц, который вставляется в качестве номера страницы записи.
setResult(String value)	Задает текст, который находится между разделителем полей и концом поля.
setText(String value)	Устанавливает текст записи.
setYomi(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 — текст, представляющий результат отображаемого поля.

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

getLocaleId()

public int getLocaleId()

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

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

getPageNumberReplacement()

public String getPageNumberReplacement()

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

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

getPageRangeBookmarkName()

public String getPageRangeBookmarkName()

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

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

getResult()

public String getResult()

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

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

getSeparator()

public FieldSeparator getSeparator()

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

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

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 константы.

getYomi()

public String getYomi()

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

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

hashCode()

public native int hashCode()

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

isBold()

public boolean isBold()

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

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

isBold(boolean value)

public void isBold(boolean value)

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

Параметры:

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

isDirty()

public boolean isDirty()

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

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

isDirty(boolean value)

public void isDirty(boolean value)

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

Параметры:

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

isItalic()

public boolean isItalic()

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

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

isItalic(boolean value)

public void isItalic(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

setEntryType(String value)

public void setEntryType(String value)

Задает тип записи индекса.

Параметры:

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

setLocaleId(int value)

public void setLocaleId(int value)

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

Параметры:

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

setPageNumberReplacement(String value)

public void setPageNumberReplacement(String value)

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

Параметры:

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

setPageRangeBookmarkName(String value)

public void setPageRangeBookmarkName(String value)

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

Параметры:

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

setResult(String value)

public void setResult(String value)

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

Параметры:

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

setText(String value)

public void setText(String value)

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

Параметры:

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

setYomi(String value)

public void setYomi(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