FieldOptions

Наследование: java.lang.Object

public class FieldOptions

Представляет параметры для управления обработкой полей в документе.

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

Методы

МетодОписание
equals(Object arg0)
getBarcodeGenerator()Получает или задает пользовательский генератор штрих-кода.
getBuiltInTemplatesPaths()Получает пути к встроенным шаблонам MS Word.
getClass()
getComparisonExpressionEvaluator()Получает средство оценки выражений сравнения полей.
getCurrentUser()Получает информацию о текущем пользователе.
getCustomTocStyleSeparator()Получает разделитель пользовательского стиля для\ \t включитьFieldToc поле.
getDefaultDocumentAuthor()Получает имя автора документа по умолчанию.
getFieldDatabaseProvider()Получает поставщика, который возвращает результат запроса дляFieldDatabase поле.
getFieldIndexFormat()ПолучаетgetFieldIndexFormat() / setFieldIndexFormat(int) который представляет форматирование дляFieldIndex поля в документе.
getFieldUpdateCultureProvider()Получает поставщика, возвращающего объект культуры для каждого конкретного поля.
getFieldUpdateCultureSource()Указывает, какую культуру использовать для форматирования результата поля.
getFieldUpdatingCallback()ПолучаетIFieldUpdatingCallback реализация
getFileName()Получает имя файла документа.
getLegacyNumberFormat()Получает значение, указывающее, включен ли устаревший (более ранний, чем AW 13.10) числовой формат для полей.
getPreProcessCulture()Получает культуру для предварительной обработки значений поля.
getResultFormatter()Позволяет управлять форматированием результата поля.
getTemplateName()Получает имя файла шаблона, используемого документом.
getToaCategories()Получает таблицу категорий полномочий.
getUseInvariantCultureNumberFormat()Получает значение, указывающее, анализируется ли числовой формат с использованием инвариантного языка и региональных параметров.
getUserPromptRespondent()Получает респондента на запросы пользователя во время обновления поля.
hashCode()
isBidiTextSupportedOnUpdate()Получает значение, указывающее, полностью ли поддерживается двунаправленный текст во время обновления поля.
isBidiTextSupportedOnUpdate(boolean value)Задает значение, указывающее, полностью ли поддерживается двунаправленный текст во время обновления поля.
notify()
notifyAll()
setBarcodeGenerator(IBarcodeGenerator value)Получает или задает пользовательский генератор штрих-кода.
setBuiltInTemplatesPaths(String[] value)Задает пути к встроенным шаблонам MS Word.
setComparisonExpressionEvaluator(IComparisonExpressionEvaluator value)Устанавливает оценщик выражений сравнения полей.
setCurrentUser(UserInformation value)Устанавливает текущую информацию о пользователе.
setCustomTocStyleSeparator(String value)Устанавливает разделитель пользовательского стиля для\ \t включитьFieldToc поле.
setDefaultDocumentAuthor(String value)Устанавливает имя автора документа по умолчанию.
setFieldDatabaseProvider(IFieldDatabaseProvider value)Задает поставщика, который возвращает результат запроса дляFieldDatabase поле.
setFieldIndexFormat(int value)УстанавливаетgetFieldIndexFormat() / setFieldIndexFormat(int) который представляет форматирование дляFieldIndex поля в документе.
setFieldUpdateCultureProvider(IFieldUpdateCultureProvider value)Задает поставщика, который возвращает объект культуры для каждого конкретного поля.
setFieldUpdateCultureSource(int value)Указывает, какую культуру использовать для форматирования результата поля.
setFieldUpdatingCallback(IFieldUpdatingCallback value)НаборыIFieldUpdatingCallback реализация
setFileName(String value)Устанавливает имя файла документа.
setLegacyNumberFormat(boolean value)Устанавливает значение, указывающее, включен ли устаревший (ранее, чем AW 13.10) числовой формат для полей.
setPreProcessCulture(System.Globalization.CultureInfo value)Устанавливает культуру для предварительной обработки значений поля.
setResultFormatter(IFieldResultFormatter value)Позволяет управлять форматированием результата поля.
setTemplateName(String value)Задает имя файла шаблона, используемого документом.
setToaCategories(ToaCategories value)Задает таблицу категорий полномочий.
setUseInvariantCultureNumberFormat(boolean value)Задает значение, указывающее, что числовой формат анализируется с использованием инвариантного языка и региональных параметров или нет.
setUserPromptRespondent(IFieldUserPromptRespondent value)Настраивает респондента на подсказки пользователя во время обновления поля.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

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

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

getBarcodeGenerator()

public IBarcodeGenerator getBarcodeGenerator()

Получает или задает пользовательский генератор штрих-кода. Пользовательский генератор штрих-кода должен реализовывать общедоступный интерфейсIBarcodeGenerator.

Возвращает: IBarcodeGenerator - Или установите пользовательский генератор штрих-кода.

getBuiltInTemplatesPaths()

public String[] getBuiltInTemplatesPaths()

Получает пути к встроенным шаблонам MS Word.

Это свойство используетсяFieldAutoText а такжеFieldGlossary полей, если указанная запись автотекста не найдена вDocument.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) шаблон.

По умолчанию MS Word хранит встроенные шаблоны в c:\Пользователи\\Данные приложения\Роуминг\Майкрософт\Строительные блоки документа\1033\16\Built-In Building Blocks.dotx и C:\Пользователи\\Данные приложения\Роуминг\Майкрософт\Шаблоны\Файлы \Normal.dotm.

Возвращает: java.lang.String[] - Пути встроенных шаблонов MS Word.

getClass()

public final native Class<?> getClass()

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

getComparisonExpressionEvaluator()

public IComparisonExpressionEvaluator getComparisonExpressionEvaluator()

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

Возвращает: IComparisonExpressionEvaluator - Оценщик выражений сравнения полей.

getCurrentUser()

public UserInformation getCurrentUser()

Получает информацию о текущем пользователе.

Возвращает: UserInformation - Текущая информация о пользователе.

getCustomTocStyleSeparator()

public String getCustomTocStyleSeparator()

Получает разделитель пользовательского стиля для\ \t включитьFieldToc поле. По умолчанию пользовательские стили, определенные\ \t переключиться вFieldToc поля разделены разделителем, взятым из текущей культуры. Это свойство переопределяет это поведение, указывая определяемый пользователем разделитель.

Возвращает: java.lang.String — разделитель пользовательского стиля для\ \t включитьFieldToc поле.

getDefaultDocumentAuthor()

public String getDefaultDocumentAuthor()

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

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

getFieldDatabaseProvider()

public IFieldDatabaseProvider getFieldDatabaseProvider()

Получает поставщика, который возвращает результат запроса дляFieldDatabase поле.

Возвращает: IFieldDatabaseProvider - Провайдер, который возвращает результат запроса дляFieldDatabase поле.

getFieldIndexFormat()

public int getFieldIndexFormat()

ПолучаетgetFieldIndexFormat() / setFieldIndexFormat(int) который представляет форматирование дляFieldIndex поля в документе.

Возвращает: интервал - АgetFieldIndexFormat() / setFieldIndexFormat(int) который представляет форматирование дляFieldIndex поля в документе. Возвращаемое значение является одним изFieldIndexFormat константы.

getFieldUpdateCultureProvider()

public IFieldUpdateCultureProvider getFieldUpdateCultureProvider()

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

Провайдер запрашивается, когда значениеgetFieldUpdateCultureSource() / setFieldUpdateCultureSource(int) являетсяFieldUpdateCultureSource.FieldCode.

Если поставщик присутствует, то возвращаемый им объект культуры используется для обновления поля. В противном случае используется системная культура.

Возвращает: IFieldUpdateCultureProvider - Поставщик, возвращающий объект культуры для каждого конкретного поля.

getFieldUpdateCultureSource()

public int getFieldUpdateCultureSource()

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

По умолчанию используется культура текущего потока.

Настройка влияет только на поля даты/времени с\\Переключатель формата @.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изFieldUpdateCultureSource константы.

getFieldUpdatingCallback()

public IFieldUpdatingCallback getFieldUpdatingCallback()

ПолучаетIFieldUpdatingCallback реализация

Возвращает: IFieldUpdatingCallback -{IFieldUpdatingCallback реализация

getFileName()

public String getFileName()

Получает имя файла документа.

Это свойство используетсяFieldFileName поле с более высоким приоритетом, чемDocument.getOriginalFileName() имущество.

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

getLegacyNumberFormat()

public boolean getLegacyNumberFormat()

Получает значение, указывающее, включен ли устаревший (более ранний, чем AW 13.10) числовой формат для полей.

Когда это свойство установлено вtrue, символ шаблона “#” работает так же, как и в .net: заменяет знак решетки соответствующей цифрой, если она присутствует; в противном случае в строке результата символы не появляются.

Когда это свойство установлено вfalse, символ шаблона “\ #” работает как MS Word: этот элемент формата указывает необходимые числовые позиции для отображения в результате. Если результат не содержит цифры в этом месте, MS Word отображает пробел. Например,\ { = 9 + 6\\ #$### } отображает 15 долларов.

Значение по умолчаниюfalse.

Возвращает: boolean — значение, указывающее, включен ли устаревший (до AW 13.10) числовой формат для полей или нет.

getPreProcessCulture()

public System.Globalization.CultureInfo getPreProcessCulture()

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

В настоящее время это свойство влияет только на значениеFieldDocProperty поле.

Значение по умолчаниюnull . Когда это свойство установлено вnull ,FieldDocProperty значение поля предварительно обрабатывается культурой, контролируемойgetFieldUpdateCultureSource() / setFieldUpdateCultureSource(int) имущество.

Возвращает: CultureInfo - Культура для предварительной обработки значений полей.

getResultFormatter()

public IFieldResultFormatter getResultFormatter()

Позволяет управлять форматированием результата поля.

Возвращает: IFieldResultFormatter - соответствующийIFieldResultFormatter ценность.

getTemplateName()

public String getTemplateName()

Получает имя файла шаблона, используемого документом.

Это свойство используетсяFieldTemplate поле, еслиDocument.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) свойство пусто.

Если это свойство пусто, используется имя файла шаблона по умолчанию Normal.dotm.

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

getToaCategories()

public ToaCategories getToaCategories()

Получает таблицу категорий полномочий.

Возвращает: ToaCategories Таблица категорий полномочий.

getUseInvariantCultureNumberFormat()

public boolean getUseInvariantCultureNumberFormat()

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

Когда это свойство установлено вtrue, числовой формат берется из инвариантного языка и региональных параметров.

Когда это свойство установлено вfalse, числовой формат берется из культуры текущего потока.

Значение по умолчаниюfalse.

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

getUserPromptRespondent()

public IFieldUserPromptRespondent getUserPromptRespondent()

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

Если значение этого свойства установлено вnull , поля, которые требуют ответа пользователя при запросе (например,FieldAsk или жеFieldFillIn) не обновляются.

Значение по умолчаниюnull.

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

hashCode()

public native int hashCode()

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

isBidiTextSupportedOnUpdate()

public boolean isBidiTextSupportedOnUpdate()

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

Когда это свойство установлено вtrue, выполняются дополнительные шаги для создания результата поля, совместимого с написанием справа налево (т. е. арабского или иврита), во время его обновления.

Когда это свойство установлено вfalse и используется язык справа налево, корректность результата поля после его обновления не гарантируется.

Значение по умолчаниюfalse.

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

isBidiTextSupportedOnUpdate(boolean value)

public void isBidiTextSupportedOnUpdate(boolean value)

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

Когда это свойство установлено вtrue, выполняются дополнительные шаги для создания результата поля, совместимого с написанием справа налево (т. е. арабского или иврита), во время его обновления.

Когда это свойство установлено вfalse и используется язык справа налево, корректность результата поля после его обновления не гарантируется.

Значение по умолчаниюfalse.

Параметры:

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

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setBarcodeGenerator(IBarcodeGenerator value)

public void setBarcodeGenerator(IBarcodeGenerator value)

Получает или задает пользовательский генератор штрих-кода. Пользовательский генератор штрих-кода должен реализовывать общедоступный интерфейсIBarcodeGenerator.

Параметры:

ПараметрТипОписание
valueIBarcodeGeneratorИли установите собственный генератор штрих-кода.

setBuiltInTemplatesPaths(String[] value)

public void setBuiltInTemplatesPaths(String[] value)

Задает пути к встроенным шаблонам MS Word.

Это свойство используетсяFieldAutoText а такжеFieldGlossary полей, если указанная запись автотекста не найдена вDocument.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) шаблон.

По умолчанию MS Word хранит встроенные шаблоны в c:\Пользователи\\Данные приложения\Роуминг\Майкрософт\Строительные блоки документа\1033\16\Built-In Building Blocks.dotx и C:\Пользователи\\Данные приложения\Роуминг\Майкрософт\Шаблоны\Файлы \Normal.dotm.

Параметры:

ПараметрТипОписание
valuejava.lang.String[]Пути встроенных шаблонов MS Word.

setComparisonExpressionEvaluator(IComparisonExpressionEvaluator value)

public void setComparisonExpressionEvaluator(IComparisonExpressionEvaluator value)

Устанавливает оценщик выражений сравнения полей.

Параметры:

ПараметрТипОписание
valueIComparisonExpressionEvaluatorОценщик выражений сравнения полей.

setCurrentUser(UserInformation value)

public void setCurrentUser(UserInformation value)

Устанавливает текущую информацию о пользователе.

Параметры:

ПараметрТипОписание
valueUserInformationИнформация о текущем пользователе.

setCustomTocStyleSeparator(String value)

public void setCustomTocStyleSeparator(String value)

Устанавливает разделитель пользовательского стиля для\ \t включитьFieldToc поле. По умолчанию пользовательские стили, определенные\ \t переключиться вFieldToc поля разделены разделителем, взятым из текущей культуры. Это свойство переопределяет это поведение, указывая определяемый пользователем разделитель.

Параметры:

ПараметрТипОписание
valuejava.lang.StringПользовательский разделитель стилей для\ \t включитьFieldToc поле.

setDefaultDocumentAuthor(String value)

public void setDefaultDocumentAuthor(String value)

Устанавливает имя автора документа по умолчанию. Если имя автора уже указано во встроенных свойствах документа, этот вариант не учитывается.

Параметры:

ПараметрТипОписание
valuejava.lang.StringИмя автора документа по умолчанию.

setFieldDatabaseProvider(IFieldDatabaseProvider value)

public void setFieldDatabaseProvider(IFieldDatabaseProvider value)

Задает поставщика, который возвращает результат запроса дляFieldDatabase поле.

Параметры:

ПараметрТипОписание
valueIFieldDatabaseProviderПровайдер, который возвращает результат запроса дляFieldDatabase поле.

setFieldIndexFormat(int value)

public void setFieldIndexFormat(int value)

УстанавливаетgetFieldIndexFormat() / setFieldIndexFormat(int) который представляет форматирование дляFieldIndex поля в документе.

Параметры:

ПараметрТипОписание
valueintАgetFieldIndexFormat() / setFieldIndexFormat(int) который представляет форматирование дляFieldIndex поля в документе. Значение должно быть одним изFieldIndexFormat константы.

setFieldUpdateCultureProvider(IFieldUpdateCultureProvider value)

public void setFieldUpdateCultureProvider(IFieldUpdateCultureProvider value)

Задает поставщика, который возвращает объект культуры для каждого конкретного поля.

Провайдер запрашивается, когда значениеgetFieldUpdateCultureSource() / setFieldUpdateCultureSource(int) являетсяFieldUpdateCultureSource.FieldCode.

Если поставщик присутствует, то возвращаемый им объект культуры используется для обновления поля. В противном случае используется системная культура.

Параметры:

ПараметрТипОписание
valueIFieldUpdateCultureProviderПоставщик, возвращающий объект культуры для каждого конкретного поля.

setFieldUpdateCultureSource(int value)

public void setFieldUpdateCultureSource(int value)

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

По умолчанию используется культура текущего потока.

Настройка влияет только на поля даты/времени с\\Переключатель формата @.

Параметры:

ПараметрТипОписание
valueintСоответствующее целочисленное значение. Значение должно быть одним изFieldUpdateCultureSource константы.

setFieldUpdatingCallback(IFieldUpdatingCallback value)

public void setFieldUpdatingCallback(IFieldUpdatingCallback value)

НаборыIFieldUpdatingCallback реализация

Параметры:

ПараметрТипОписание
valueIFieldUpdatingCallback{IFieldUpdatingCallback реализация

setFileName(String value)

public void setFileName(String value)

Устанавливает имя файла документа.

Это свойство используетсяFieldFileName поле с более высоким приоритетом, чемDocument.getOriginalFileName() имущество.

Параметры:

ПараметрТипОписание
valuejava.lang.StringИмя файла документа.

setLegacyNumberFormat(boolean value)

public void setLegacyNumberFormat(boolean value)

Устанавливает значение, указывающее, включен ли устаревший (ранее, чем AW 13.10) числовой формат для полей.

Когда это свойство установлено вtrue, символ шаблона “#” работает так же, как и в .net: заменяет знак решетки соответствующей цифрой, если она присутствует; в противном случае в строке результата символы не появляются.

Когда это свойство установлено вfalse, символ шаблона “\ #” работает как MS Word: этот элемент формата указывает необходимые числовые позиции для отображения в результате. Если результат не содержит цифры в этом месте, MS Word отображает пробел. Например,\ { = 9 + 6\\ #$### } отображает 15 долларов.

Значение по умолчаниюfalse.

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, включен ли устаревший (ранее, чем AW 13.10) числовой формат для полей.

setPreProcessCulture(System.Globalization.CultureInfo value)

public void setPreProcessCulture(System.Globalization.CultureInfo value)

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

В настоящее время это свойство влияет только на значениеFieldDocProperty поле.

Значение по умолчаниюnull . Когда это свойство установлено вnull ,FieldDocProperty значение поля предварительно обрабатывается культурой, контролируемойgetFieldUpdateCultureSource() / setFieldUpdateCultureSource(int) имущество.

Параметры:

ПараметрТипОписание
valueCultureInfoКультура для предварительной обработки значений поля.

setResultFormatter(IFieldResultFormatter value)

public void setResultFormatter(IFieldResultFormatter value)

Позволяет управлять форматированием результата поля.

Параметры:

ПараметрТипОписание
valueIFieldResultFormatterСоответствующийIFieldResultFormatter ценность.

setTemplateName(String value)

public void setTemplateName(String value)

Задает имя файла шаблона, используемого документом.

Это свойство используетсяFieldTemplate поле, еслиDocument.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) свойство пусто.

Если это свойство пусто, используется имя файла шаблона по умолчанию Normal.dotm.

Параметры:

ПараметрТипОписание
valuejava.lang.StringИмя файла шаблона, используемого документом.

setToaCategories(ToaCategories value)

public void setToaCategories(ToaCategories value)

Задает таблицу категорий полномочий.

Параметры:

ПараметрТипОписание
valueToaCategoriesТаблица категорий полномочий.

setUseInvariantCultureNumberFormat(boolean value)

public void setUseInvariantCultureNumberFormat(boolean value)

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

Когда это свойство установлено вtrue, числовой формат берется из инвариантного языка и региональных параметров.

Когда это свойство установлено вfalse, числовой формат берется из культуры текущего потока.

Значение по умолчаниюfalse.

Параметры:

ПараметрТипОписание
valuebooleanЗначение, указывающее, что числовой формат анализируется с использованием инвариантного языка и региональных параметров или нет.

setUserPromptRespondent(IFieldUserPromptRespondent value)

public void setUserPromptRespondent(IFieldUserPromptRespondent value)

Настраивает респондента на подсказки пользователя во время обновления поля.

Если значение этого свойства установлено вnull , поля, которые требуют ответа пользователя при запросе (например,FieldAsk или жеFieldFillIn) не обновляются.

Значение по умолчаниюnull.

Параметры:

ПараметрТипОписание
valueIFieldUserPromptRespondentОтветчик на запросы пользователя во время обновления поля.

toString()

public String toString()

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

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

ПараметрТипОписание
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

ПараметрТипОписание
arg0long
arg1int