FieldMacroButton
Наследование: java.lang.Object, com.aspose.words.Field
public class FieldMacroButton extends Field
Реализует поле MACROBUTTON.
Чтобы узнать больше, посетитеWorking with Fields документальная статья.
Позволяет запустить макрос или команду.
В Aspose.Words это поле также может действовать как поле слияния.
Методы
| Метод | Описание |
|---|---|
| canWorkAsMergeField() | |
| equals(Object arg0) | |
| getClass() | |
| getDisplayResult() | Получает текст, представляющий отображаемый результат поля. |
| getDisplayText() | Получает текст, отображаемый как «кнопка», выбранная для запуска макроса или команды. |
| getEnd() | Получает узел, представляющий конец поля. |
| getFieldCode() | Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет). |
| getFieldCode(boolean includeChildFieldCodes) | Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет). |
| getFormat() | ПолучаетFieldFormat объект, предоставляющий типизированный доступ к форматированию поля. |
| getLocaleId() | Получает LCID поля. |
| getMacroName() | Получает имя макроса или команды для запуска. |
| getMergeFieldName() | |
| getResult() | Получает текст, который находится между разделителем полей и концом поля. |
| getSeparator() | Получает узел, представляющий разделитель полей. |
| getStart() | Получает узел, представляющий начало поля. |
| getType() | Получает тип поля Microsoft Word. |
| hashCode() | |
| isDirty() | Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ. |
| isDirty(boolean value) | Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ. |
| isLocked() | Получает, заблокировано ли поле (не должно пересчитывать его результат). |
| isLocked(boolean value) | Устанавливает, будет ли поле заблокировано (не должно пересчитывать свой результат). |
| isMergeValueRequired() | |
| notify() | |
| notifyAll() | |
| remove() | Удаляет поле из документа. |
| setDisplayText(String value) | Задает отображение текста в виде «кнопки», выбранной для запуска макроса или команды. |
| setLocaleId(int value) | Устанавливает LCID поля. |
| setMacroName(String value) | Устанавливает имя макроса или команды для запуска. |
| setResult(String 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 |
Возвращает: логический
getClass()
public final native Class<?> getClass()
Возвращает: java.lang.Класс
getDisplayResult()
public String getDisplayResult()
Получает текст, представляющий отображаемый результат поля.Document.updateListLabels() метод должен быть вызван, чтобы получить правильное значение дляFieldListNum, FieldAutoNum, FieldAutoNumOut а такжеFieldAutoNumLgl поля.
Возвращает: java.lang.String — текст, представляющий результат отображаемого поля.
getDisplayText()
public String getDisplayText()
Получает текст, отображаемый как «кнопка», выбранная для запуска макроса или команды.
Возвращает: 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 поля.
getMacroName()
public String getMacroName()
Получает имя макроса или команды для запуска.
Возвращает: java.lang.String — имя макроса или команды для запуска.
getMergeFieldName()
public String getMergeFieldName()
Возвращает: java.lang.String
getResult()
public String getResult()
Получает текст, который находится между разделителем полей и концом поля.
Возвращает: java.lang.String — текст между разделителем полей и концом поля.
getSeparator()
public FieldSeparator getSeparator()
Получает узел, представляющий разделитель полей. Может быть нулевым.
Возвращает: FieldSeparator - Узел, представляющий разделитель полей.
getStart()
public FieldStart getStart()
Получает узел, представляющий начало поля.
Возвращает: FieldStart - Узел, представляющий начало поля.
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
setDisplayText(String value)
public void setDisplayText(String value)
Задает отображение текста в виде «кнопки», выбранной для запуска макроса или команды.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | java.lang.String | Текст, который будет отображаться как «кнопка», выбранная для запуска макроса или команды. |
setLocaleId(int value)
public void setLocaleId(int value)
Устанавливает LCID поля.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | int | LCID поля. |
setMacroName(String value)
public void setMacroName(String value)
Устанавливает имя макроса или команды для запуска.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | java.lang.String | Имя макроса или команды для запуска. |
setResult(String value)
public void setResult(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 |
