FieldTemplate

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

public class FieldTemplate extends Field

Реализует поле ШАБЛОН.

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

Извлекает имя файла шаблона, используемого текущим документом.

Методы

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

Параметры:

ПараметрТипОписание
arg0java.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 - Узел, представляющий конец поля.

getFieldCode()

public String getFieldCode()

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

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

getFieldCode(boolean includeChildFieldCodes)

public String getFieldCode(boolean includeChildFieldCodes)

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

Параметры:

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

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

getFormat()

public FieldFormat getFormat()

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

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

getIncludeFullPath()

public boolean getIncludeFullPath()

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

Возвращает: boolean — включать ли полный путь к файлу.

getLocaleId()

public int getLocaleId()

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

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

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)

Параметры:

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

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

getType()

public int getType()

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

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

hashCode()

public native int hashCode()

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

isDirty()

public boolean isDirty()

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

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

isDirty(boolean value)

public void isDirty(boolean value)

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

Параметры:

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

isLocked()

public boolean isLocked()

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

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

isLocked(boolean value)

public void isLocked(boolean value)

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

Параметры:

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

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

remove()

public Node remove()

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

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

setIncludeFullPath(boolean value)

public void setIncludeFullPath(boolean value)

Устанавливает, следует ли включать полное имя пути к файлу.

Параметры:

ПараметрТипОписание
valuebooleanВключать ли полный путь к файлу.

setLocaleId(int value)

public void setLocaleId(int value)

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

Параметры:

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

setResult(String value)

public void setResult(String value)

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

Параметры:

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

toString()

public String toString()

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

public boolean unlink()

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

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

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

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

update()

public void update()

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

update(boolean ignoreMergeFormat)

public void update(boolean ignoreMergeFormat)

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

Параметры:

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

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

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

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

ПараметрТипОписание
arg0long
arg1int