FieldSymbol

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

public class FieldSymbol extends Field

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

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

Извлекает символ, значение кодовой точки которого указано в десятичном или шестнадцатеричном формате.

Методы

Метод	Описание
equals(Object arg0)
getCharacterCode()	Получает значение кодовой точки символа в десятичном или шестнадцатеричном формате.
getClass()
getDisplayResult()	Получает текст, представляющий отображаемый результат поля.
getDontAffectsLineSpacing()	Определяет, влияет ли символ, извлеченный полем, на межстрочный интервал абзаца.
getEnd()	Получает узел, представляющий конец поля.
getFieldCode()	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFieldCode(boolean includeChildFieldCodes)	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет).
getFontName()	Получает имя шрифта символа, извлеченного полем.
getFontSize()	Получает размер в пунктах шрифта символа, извлеченного полем.
getFormat()	ПолучаетFieldFormat объект, предоставляющий типизированный доступ к форматированию поля.
getLocaleId()	Получает LCID поля.
getResult()	Получает текст, который находится между разделителем полей и концом поля.
getSeparator()	Получает узел, представляющий разделитель полей.
getStart()	Получает узел, представляющий начало поля.
getSwitchType(String switchName)
getType()	Получает тип поля Microsoft Word.
hashCode()
isAnsi()	Определяет, интерпретируется ли код символа как значение символа ANSI.
isAnsi(boolean value)	Устанавливает, интерпретируется ли код символа как значение символа ANSI.
isDirty()	Получает информацию о том, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isDirty(boolean value)	Устанавливает, является ли текущий результат поля неправильным (устаревшим) из-за других изменений, внесенных в документ.
isLocked()	Получает, заблокировано ли поле (не должно пересчитывать его результат).
isLocked(boolean value)	Устанавливает, будет ли поле заблокировано (не должно пересчитывать свой результат).
isShiftJis()	Определяет, интерпретируется ли код символа как значение символа SHIFT-JIS.
isShiftJis(boolean value)	Устанавливает, интерпретируется ли код символа как значение символа SHIFT-JIS.
isUnicode()	Определяет, интерпретируется ли код символа как значение символа Юникода.
isUnicode(boolean value)	Устанавливает, интерпретируется ли код символа как значение символа Unicode.
notify()
notifyAll()
remove()	Удаляет поле из документа.
setCharacterCode(String value)	Устанавливает значение кодовой точки символа в десятичном или шестнадцатеричном формате.
setDontAffectsLineSpacing(boolean value)	Устанавливает, влияет ли символ, полученный полем, на межстрочный интервал абзаца.
setFontName(String value)	Задает имя шрифта символа, извлекаемого полем.
setFontSize(String 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)

Параметры:

Параметр	Тип	Описание
arg0	java.lang.Object

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

getCharacterCode()

public String getCharacterCode()

Получает значение кодовой точки символа в десятичном или шестнадцатеричном формате.

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

getClass()

public final native Class<?> getClass()

Возвращает: java.lang.Класс

getDisplayResult()

public String getDisplayResult()

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

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

getDontAffectsLineSpacing()

public boolean getDontAffectsLineSpacing()

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

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

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

getFontName()

public String getFontName()

Получает имя шрифта символа, извлеченного полем.

Возвращает: java.lang.String — имя шрифта символа, извлекаемого полем.

getFontSize()

public String getFontSize()

Получает размер в пунктах шрифта символа, извлеченного полем.

Возвращает: java.lang.String — размер в пунктах шрифта символа, полученного полем.

getFormat()

public FieldFormat getFormat()

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

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

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)

Параметры:

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

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

getType()

public int getType()

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

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

hashCode()

public native int hashCode()

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

isAnsi()

public boolean isAnsi()

Определяет, интерпретируется ли код символа как значение символа ANSI.

Возвращает: boolean — интерпретируется ли код символа как значение символа ANSI.

isAnsi(boolean value)

public void isAnsi(boolean value)

Устанавливает, интерпретируется ли код символа как значение символа ANSI.

Параметры:

Параметр	Тип	Описание
value	boolean	Интерпретируется ли код символа как значение символа ANSI.

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	Заблокировано ли поле (не должно пересчитывать свой результат).

isShiftJis()

public boolean isShiftJis()

Определяет, интерпретируется ли код символа как значение символа SHIFT-JIS.

Возвращает: boolean — интерпретируется ли код символа как значение символа SHIFT-JIS.

isShiftJis(boolean value)

public void isShiftJis(boolean value)

Устанавливает, интерпретируется ли код символа как значение символа SHIFT-JIS.

Параметры:

Параметр	Тип	Описание
value	boolean	Интерпретируется ли код символа как значение символа SHIFT-JIS.

isUnicode()

public boolean isUnicode()

Определяет, интерпретируется ли код символа как значение символа Юникода.

Возвращает: boolean — интерпретируется ли код символа как значение символа Unicode.

isUnicode(boolean value)

public void isUnicode(boolean value)

Устанавливает, интерпретируется ли код символа как значение символа Unicode.

Параметры:

Параметр	Тип	Описание
value	boolean	Интерпретируется ли код символа как значение символа Unicode.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

remove()

public Node remove()

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

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

setCharacterCode(String value)

public void setCharacterCode(String value)

Устанавливает значение кодовой точки символа в десятичном или шестнадцатеричном формате.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Значение кодовой точки символа в десятичном или шестнадцатеричном формате.

setDontAffectsLineSpacing(boolean value)

public void setDontAffectsLineSpacing(boolean value)

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

Параметры:

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

setFontName(String value)

public void setFontName(String value)

Задает имя шрифта символа, извлекаемого полем.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Имя шрифта символа, извлекаемого полем.

setFontSize(String value)

public void setFontSize(String value)

Устанавливает размер в пунктах шрифта символа, извлекаемого полем.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Размер в пунктах шрифта символа, полученного полем.

setLocaleId(int value)

public void setLocaleId(int value)

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

Параметры:

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

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