FieldIncludeText

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

public class FieldIncludeText extends Field

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

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

Вставляет весь или часть текста и графики, содержащихся в другом документе.

Методы

Метод	Описание
equals(Object arg0)
getBookmarkName()	Получает имя закладки в документе для включения.
getClass()
getDisplayResult()	Получает текст, представляющий отображаемый результат поля.
getEncoding()	Получает кодировку, применяемую к данным в указанном файле.
getEnd()	Получает узел, представляющий конец поля.
getFieldCode()	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFieldCode(boolean includeChildFieldCodes)	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFormat()	ПолучаетFieldFormat объект, предоставляющий типизированный доступ к форматированию поля.
getLocaleId()	Получает LCID поля.
getLockFields()	Получает значение, запрещающее обновление полей во включенном документе.
getMimeType()	Получает тип MIME указанного файла.
getNamespaceMappings()	Получает сопоставления пространств имен для запросов XPath.
getResult()	Получает текст, который находится между разделителем полей и концом поля.
getSeparator()	Получает узел, представляющий разделитель полей.
getSourceFullName()	Получает расположение документа с помощью IRI.
getSourceFullNameArgumentIndex()
getStart()	Получает узел, представляющий начало поля.
getSwitchType(String switchName)
getTextConverter()	Получает имя преобразователя текста для формата включаемого файла.
getType()	Получает тип поля Microsoft Word.
getXPath()	Получает XPath для нужной части XML-файла.
getXslTransformation()	Получает расположение XSL-преобразования для форматирования XML-данных.
hashCode()
isDirty()	Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isDirty(boolean value)	Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isLocked()	Получает, заблокировано ли поле (не должно пересчитывать его результат).
isLocked(boolean value)	Устанавливает, будет ли поле заблокировано (не должно пересчитывать свой результат).
notify()
notifyAll()
remove()	Удаляет поле из документа.
setBookmarkName(String value)	Задает имя закладки в документе для включения.
setEncoding(String value)	Устанавливает кодировку, применяемую к данным в указанном файле.
setLocaleId(int value)	Устанавливает LCID поля.
setLockFields(boolean value)	Устанавливает, следует ли предотвратить обновление полей во включенном документе.
setMimeType(String value)	Задает тип MIME для файла, на который указывает ссылка.
setNamespaceMappings(String value)	Задает сопоставления пространств имен для запросов XPath.
setResult(String value)	Задает текст, который находится между разделителем полей и концом поля.
setSourceFullName(String value)	Устанавливает местоположение документа с помощью IRI.
setTextConverter(String value)	Задает имя текстового преобразователя для формата включаемого файла.
setXPath(String value)	Задает XPath для нужной части XML-файла.
setXslTransformation(String value)	Задает расположение преобразования XSL для форматирования данных XML.
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.Класс

getDisplayResult()

public String getDisplayResult()

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

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

getEncoding()

public String getEncoding()

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

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

getLocaleId()

public int getLocaleId()

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

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

getLockFields()

public boolean getLockFields()

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

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

getMimeType()

public String getMimeType()

Получает тип MIME указанного файла.

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

getNamespaceMappings()

public String getNamespaceMappings()

Получает сопоставления пространств имен для запросов XPath.

Возвращает: java.lang.String — сопоставления пространств имен для запросов XPath.

getResult()

public String getResult()

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

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

getSeparator()

public FieldSeparator getSeparator()

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

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

getSourceFullName()

public String getSourceFullName()

Получает расположение документа с помощью IRI.

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

getSourceFullNameArgumentIndex()

public int getSourceFullNameArgumentIndex()

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

getStart()

public FieldStart getStart()

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

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

getSwitchType(String switchName)

public int getSwitchType(String switchName)

Параметры:

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

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

getTextConverter()

public String getTextConverter()

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

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

getType()

public int getType()

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

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

getXPath()

public String getXPath()

Получает XPath для нужной части XML-файла.

Возвращает: java.lang.String — XPath для нужной части XML-файла.

getXslTransformation()

public String getXslTransformation()

Получает расположение XSL-преобразования для форматирования XML-данных.

Возвращает: java.lang.String — расположение преобразования XSL для форматирования данных XML.

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	Имя закладки в документе для включения.

setEncoding(String value)

public void setEncoding(String value)

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

Параметры:

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

setLocaleId(int value)

public void setLocaleId(int value)

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

Параметры:

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

setLockFields(boolean value)

public void setLockFields(boolean value)

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

Параметры:

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

setMimeType(String value)

public void setMimeType(String value)

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

Параметры:

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

setNamespaceMappings(String value)

public void setNamespaceMappings(String value)

Задает сопоставления пространств имен для запросов XPath.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Сопоставления пространств имен для запросов XPath.

setResult(String value)

public void setResult(String value)

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

Параметры:

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

setSourceFullName(String value)

public void setSourceFullName(String value)

Устанавливает местоположение документа с помощью IRI.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Расположение документа с использованием IRI.

setTextConverter(String value)

public void setTextConverter(String value)

Задает имя текстового преобразователя для формата включаемого файла.

Параметры:

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

setXPath(String value)

public void setXPath(String value)

Задает XPath для нужной части XML-файла.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	XPath для нужной части файла XML.

setXslTransformation(String value)

public void setXslTransformation(String value)

Задает расположение преобразования XSL для форматирования данных XML.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Расположение преобразования XSL для форматирования данных XML.

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