FieldRef

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

public class FieldRef extends Field

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

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

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

Методы

Метод	Описание
canWorkAsMergeField()
equals(Object arg0)
getBookmarkName()	Получает имя закладки, на которую указывает ссылка.
getClass()
getDisplayResult()	Получает текст, представляющий отображаемый результат поля.
getEnd()	Получает узел, представляющий конец поля.
getFieldCode()	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFieldCode(boolean includeChildFieldCodes)	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFormat()	ПолучаетFieldFormat объект, предоставляющий типизированный доступ к форматированию поля.
getIncludeNoteOrComment()	Определяет, следует ли увеличивать номера сносок, концевых сносок и аннотаций, отмеченных закладкой, и вставлять соответствующие сноски, концевые сноски и текст комментариев.
getInsertHyperlink()	Получает, следует ли создавать гиперссылку на отмеченный закладкой абзац.
getInsertParagraphNumber()	Получает, следует ли вставлять номер абзаца указанного абзаца точно так, как он отображается в документе.
getInsertParagraphNumberInFullContext()	Определяет, следует ли вставлять номер абзаца указанного абзаца в полный контекст.
getInsertParagraphNumberInRelativeContext()	Определяет, вставлять ли номер абзаца ссылочного абзаца в относительный контекст.
getInsertRelativePosition()	Получает, следует ли вставить относительное положение абзаца, на который делается ссылка.
getLocaleId()	Получает LCID поля.
getMergeFieldName()
getNumberSeparator()	Получает последовательность символов, используемую для разделения порядковых номеров и номеров страниц.
getResult()	Получает текст, который находится между разделителем полей и концом поля.
getSeparator()	Получает узел, представляющий разделитель полей.
getStart()	Получает узел, представляющий начало поля.
getSuppressNonDelimiters()	Определяет, нужно ли подавлять символы, не являющиеся разделителями.
getSwitchType(String switchName)
getType()	Получает тип поля Microsoft Word.
hashCode()
isDirty()	Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isDirty(boolean value)	Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isLocked()	Получает, заблокировано ли поле (не должно пересчитывать его результат).
isLocked(boolean value)	Устанавливает, будет ли поле заблокировано (не должно пересчитывать свой результат).
isMergeValueRequired()
notify()
notifyAll()
remove()	Удаляет поле из документа.
setBookmarkName(String value)	Устанавливает имя закладки, на которую указывает ссылка.
setIncludeNoteOrComment(boolean value)	Устанавливает, следует ли увеличивать сноску, концевую сноску и аннотацию, отмеченные закладкой, и вставлять соответствующую сноску, концевую сноску и текст комментария.
setInsertHyperlink(boolean value)	Устанавливает, следует ли создавать гиперссылку на отмеченный закладкой абзац.
setInsertParagraphNumber(boolean value)	Устанавливает, следует ли вставлять номер абзаца ссылочного абзаца точно так, как он отображается в документе.
setInsertParagraphNumberInFullContext(boolean value)	Устанавливает, вставлять ли номер абзаца ссылочного абзаца в полный контекст.
setInsertParagraphNumberInRelativeContext(boolean value)	Устанавливает, вставлять ли номер абзаца ссылочного абзаца в относительный контекст.
setInsertRelativePosition(boolean value)	Устанавливает, следует ли вставлять относительное положение абзаца, на который делается ссылка.
setLocaleId(int value)	Устанавливает LCID поля.
setNumberSeparator(String value)	Задает последовательность символов, используемую для разделения порядковых номеров и номеров страниц.
setResult(String value)	Задает текст, который находится между разделителем полей и концом поля.
setSuppressNonDelimiters(boolean value)	Устанавливает, подавлять ли символы, не являющиеся разделителями.
toString()
unlink()	Выполняет развязку поля.
update()	Выполняет обновление поля.
update(boolean ignoreMergeFormat)	Выполняет обновление поля.
wait()
wait(long arg0)
wait(long arg0, int arg1)

canWorkAsMergeField()

public boolean canWorkAsMergeField()

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

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.Класс

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)

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

Параметры:

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

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

getFormat()

public FieldFormat getFormat()

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

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

getIncludeNoteOrComment()

public boolean getIncludeNoteOrComment()

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

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

getInsertHyperlink()

public boolean getInsertHyperlink()

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

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

getInsertParagraphNumber()

public boolean getInsertParagraphNumber()

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

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

getInsertParagraphNumberInFullContext()

public boolean getInsertParagraphNumberInFullContext()

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

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

getInsertParagraphNumberInRelativeContext()

public boolean getInsertParagraphNumberInRelativeContext()

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

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

getInsertRelativePosition()

public boolean getInsertRelativePosition()

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

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

getLocaleId()

public int getLocaleId()

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

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

getMergeFieldName()

public String getMergeFieldName()

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

getNumberSeparator()

public String getNumberSeparator()

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

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

getResult()

public String getResult()

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

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

getSeparator()

public FieldSeparator getSeparator()

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

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

getStart()

public FieldStart getStart()

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

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

getSuppressNonDelimiters()

public boolean getSuppressNonDelimiters()

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

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

getSwitchType(String switchName)

public int getSwitchType(String switchName)

Параметры:

Параметр	Тип	Описание
switchName	java.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)

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

Параметры:

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

isLocked()

public boolean isLocked()

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

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

isLocked(boolean value)

public void isLocked(boolean value)

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

Параметры:

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

isMergeValueRequired()

public boolean isMergeValueRequired()

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

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	Имя указанной закладки.

setIncludeNoteOrComment(boolean value)

public void setIncludeNoteOrComment(boolean value)

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

Параметры:

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

setInsertHyperlink(boolean value)

public void setInsertHyperlink(boolean value)

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

Параметры:

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

setInsertParagraphNumber(boolean value)

public void setInsertParagraphNumber(boolean value)

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

Параметры:

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

setInsertParagraphNumberInFullContext(boolean value)

public void setInsertParagraphNumberInFullContext(boolean value)

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

Параметры:

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

setInsertParagraphNumberInRelativeContext(boolean value)

public void setInsertParagraphNumberInRelativeContext(boolean value)

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

Параметры:

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

setInsertRelativePosition(boolean value)

public void setInsertRelativePosition(boolean value)

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

Параметры:

Параметр	Тип	Описание
value	boolean	Вставлять ли относительное положение ссылочного абзаца.

setLocaleId(int value)

public void setLocaleId(int value)

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

Параметры:

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

setNumberSeparator(String value)

public void setNumberSeparator(String value)

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

Параметры:

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

setResult(String value)

public void setResult(String value)

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

Параметры:

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

setSuppressNonDelimiters(boolean value)

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