FieldToa
Наследование: java.lang.Object, com.aspose.words.Field
public class FieldToa extends Field
Реализует поле TOA.
Чтобы узнать больше, посетитеWorking with Fields документальная статья.
Создает таблицу полномочий (то есть список ссылок в юридическом документе, таких как ссылки на дела, уставы и правила, а также номера страниц, на которых появляются ссылки), используя записи, указанные в полях ТА. .
Методы
| Метод | Описание |
|---|---|
| equals(Object arg0) | |
| getBookmarkName() | Получает имя закладки, помечающей часть документа, используемую для построения таблицы. |
| getClass() | |
| getDisplayResult() | Получает текст, представляющий отображаемый результат поля. |
| getEnd() | Получает узел, представляющий конец поля. |
| getEntryCategory() | Получает интегральную категорию для записей, включенных в таблицу. |
| getEntrySeparator() | Получает последовательность символов, используемую для разделения записи таблицы авторитетных источников и ее номера страницы. |
| getFieldCode() | Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет). |
| getFieldCode(boolean includeChildFieldCodes) | Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет). |
| getFormat() | ПолучаетFieldFormat объект, предоставляющий типизированный доступ к форматированию поля. |
| getLocaleId() | Получает LCID поля. |
| getPageNumberListSeparator() | Получает последовательность символов, используемую для разделения двух номеров страниц в списке номеров страниц. |
| getPageRangeSeparator() | Получает последовательность символов, используемую для разделения начала и конца диапазона страниц. |
| getRemoveEntryFormatting() | Получает, следует ли удалить форматирование текста записи в документе из записи в таблице авторитетов. |
| getResult() | Получает текст, который находится между разделителем полей и концом поля. |
| getSeparator() | Получает узел, представляющий разделитель полей. |
| getSequenceName() | Получает имя последовательности, номер которой включен в номер страницы. |
| getSequenceSeparator() | Получает последовательность символов, используемую для разделения порядковых номеров и номеров страниц. |
| getStart() | Получает узел, представляющий начало поля. |
| getSwitchType(String switchName) | |
| getType() | Получает тип поля Microsoft Word. |
| getUseHeading() | Определяет, следует ли включать заголовок категории для записей в авторитетной таблице. |
| getUsePassim() | Получает, следует ли заменить пять или более разных ссылок на один и тот же источник словом «passim», которое используется для обозначения того, что слово или отрывок часто встречается в цитируемой работе. |
| hashCode() | |
| isDirty() | Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ. |
| isDirty(boolean value) | Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ. |
| isLocked() | Получает, заблокировано ли поле (не должно пересчитывать его результат). |
| isLocked(boolean value) | Устанавливает, будет ли поле заблокировано (не должно пересчитывать свой результат). |
| notify() | |
| notifyAll() | |
| remove() | Удаляет поле из документа. |
| setBookmarkName(String value) | Задает имя закладки, которая отмечает часть документа, используемую для построения таблицы. |
| setEntryCategory(String value) | Устанавливает интегральную категорию для записей, включенных в таблицу. |
| setEntrySeparator(String value) | Устанавливает последовательность символов, используемую для разделения записи таблицы авторитетных источников и ее номера страницы. |
| setLocaleId(int value) | Устанавливает LCID поля. |
| setPageNumberListSeparator(String value) | Задает последовательность символов, используемую для разделения двух номеров страниц в списке номеров страниц. |
| setPageRangeSeparator(String value) | Задает последовательность символов, используемую для разделения начала и конца диапазона страниц. |
| setRemoveEntryFormatting(boolean value) | Устанавливает, следует ли удалять форматирование текста записи в документе из записи в таблице авторитетов. |
| setResult(String value) | Задает текст, который находится между разделителем полей и концом поля. |
| setSequenceName(String value) | Задает имя последовательности, номер которой включен в номер страницы. |
| setSequenceSeparator(String value) | Задает последовательность символов, используемую для разделения порядковых номеров и номеров страниц. |
| setUseHeading(boolean value) | Устанавливает, включать ли заголовок категории для записей в авторитетной таблице. |
| setUsePassim(boolean value) | Устанавливает, заменять ли пять или более различных ссылок на один и тот же источник словом «passim», которое используется для обозначения того, что слово или отрывок часто встречается в цитируемой работе. |
| 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 — текст, представляющий результат отображаемого поля.
getEnd()
public FieldEnd getEnd()
Получает узел, представляющий конец поля.
Возвращает: FieldEnd - Узел, представляющий конец поля.
getEntryCategory()
public String getEntryCategory()
Получает интегральную категорию для записей, включенных в таблицу.
Возвращает: java.lang.String — интегральная категория для записей, включенных в таблицу.
getEntrySeparator()
public String getEntrySeparator()
Получает последовательность символов, используемую для разделения записи таблицы авторитетных источников и ее номера страницы.
Возвращает: 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 поля.
getPageNumberListSeparator()
public String getPageNumberListSeparator()
Получает последовательность символов, используемую для разделения двух номеров страниц в списке номеров страниц.
Возвращает: java.lang.String — последовательность символов, используемая для разделения двух номеров страниц в списке номеров страниц.
getPageRangeSeparator()
public String getPageRangeSeparator()
Получает последовательность символов, используемую для разделения начала и конца диапазона страниц.
Возвращает: java.lang.String — последовательность символов, используемая для разделения начала и конца диапазона страниц.
getRemoveEntryFormatting()
public boolean getRemoveEntryFormatting()
Получает, следует ли удалить форматирование текста записи в документе из записи в таблице авторитетов.
Возвращает: boolean - Удалять ли форматирование текста записи в документе из записи в таблице авторитетов.
getResult()
public String getResult()
Получает текст, который находится между разделителем полей и концом поля.
Возвращает: java.lang.String — текст между разделителем полей и концом поля.
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 константы.
getUseHeading()
public boolean getUseHeading()
Определяет, следует ли включать заголовок категории для записей в авторитетной таблице.
Возвращает: boolean - Включать ли заголовок категории для записей в авторитетной таблице.
getUsePassim()
public boolean getUsePassim()
Получает, следует ли заменить пять или более разных ссылок на один и тот же источник словом «passim», которое используется для обозначения того, что слово или отрывок часто встречается в цитируемой работе.
Возвращает: boolean — следует ли заменять пять или более различных ссылок на один и тот же источник словом «passim», которое используется для обозначения того, что слово или отрывок часто встречается в цитируемой работе.
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 | Имя закладки, которая отмечает часть документа, используемую для построения таблицы. |
setEntryCategory(String value)
public void setEntryCategory(String value)
Устанавливает интегральную категорию для записей, включенных в таблицу.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | java.lang.String | Интегральная категория для записей, включенных в таблицу. |
setEntrySeparator(String value)
public void setEntrySeparator(String value)
Устанавливает последовательность символов, используемую для разделения записи таблицы авторитетных источников и ее номера страницы.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | java.lang.String | Последовательность символов, используемая для разделения записи в таблице авторитетных источников и номера ее страницы. |
setLocaleId(int value)
public void setLocaleId(int value)
Устанавливает LCID поля.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | int | LCID поля. |
setPageNumberListSeparator(String value)
public void setPageNumberListSeparator(String value)
Задает последовательность символов, используемую для разделения двух номеров страниц в списке номеров страниц.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | java.lang.String | Последовательность символов, используемая для разделения двух номеров страниц в списке номеров страниц. |
setPageRangeSeparator(String value)
public void setPageRangeSeparator(String value)
Задает последовательность символов, используемую для разделения начала и конца диапазона страниц.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | java.lang.String | Последовательность символов, используемая для разделения начала и конца диапазона страниц. |
setRemoveEntryFormatting(boolean value)
public void setRemoveEntryFormatting(boolean value)
Устанавливает, следует ли удалять форматирование текста записи в документе из записи в таблице авторитетов.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | boolean | Удалять ли форматирование текста записи в документе из записи в таблице авторитетов. |
setResult(String value)
public void setResult(String value)
Задает текст, который находится между разделителем полей и концом поля.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | java.lang.String | Текст, который находится между разделителем полей и концом поля. |
setSequenceName(String value)
public void setSequenceName(String value)
Задает имя последовательности, номер которой включен в номер страницы.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | java.lang.String | Имя последовательности, номер которой включен в номер страницы. |
setSequenceSeparator(String value)
public void setSequenceSeparator(String value)
Задает последовательность символов, используемую для разделения порядковых номеров и номеров страниц.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | java.lang.String | Последовательность символов, используемая для разделения порядковых номеров и номеров страниц. |
setUseHeading(boolean value)
public void setUseHeading(boolean value)
Устанавливает, включать ли заголовок категории для записей в авторитетной таблице.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | boolean | Включать ли заголовок категории для записей в авторитетной таблице. |
setUsePassim(boolean value)
public void setUsePassim(boolean value)
Устанавливает, заменять ли пять или более различных ссылок на один и тот же источник словом «passim», которое используется для обозначения того, что слово или отрывок часто встречается в цитируемой работе.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | boolean | Следует ли заменять пять или более разных ссылок на один и тот же источник словом «passim», которое используется для обозначения того, что слово или отрывок часто встречается в цитируемой работе. |
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 |
