FieldOptions (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.FieldOptions

```
public final class FieldOptions
extends java.lang.Object
```
Represents options to control field handling in a document.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IBarcodeGenerator`	`getBarcodeGenerator()` Gets or set custom barcode generator.
`java.lang.String[]`	`getBuiltInTemplatesPaths()` Gets paths of MS Word built-in templates.
`IComparisonExpressionEvaluator`	`getComparisonExpressionEvaluator()` Gets the field comparison expressions evaluator.
`UserInformation`	`getCurrentUser()` Gets the current user information.
`java.lang.String`	`getCustomTocStyleSeparator()` Gets custom style separator for the \t switch in `FieldToc` field.
`java.lang.String`	`getDefaultDocumentAuthor()` Gets default document author's name.
`IFieldDatabaseProvider`	`getFieldDatabaseProvider()` Gets a provider that returns a query result for the `FieldDatabase` field.
`int`	`getFieldIndexFormat()` Gets a `getFieldIndexFormat()` / `setFieldIndexFormat(int)` that represents the formatting for the `FieldIndex` fields in the document.
`IFieldUpdateCultureProvider`	`getFieldUpdateCultureProvider()` Gets a provider that returns a culture object specific for each particular field.
`int`	`getFieldUpdateCultureSource()` Specifies what culture to use to format the field result.
`IFieldUpdatingCallback`	`getFieldUpdatingCallback()` Gets `IFieldUpdatingCallback` implementation
`java.lang.String`	`getFileName()` Gets the file name of the document.
`boolean`	`getLegacyNumberFormat()` Gets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
`CultureInfo`	`getPreProcessCulture()` Gets the culture to preprocess field values.
`IFieldResultFormatter`	`getResultFormatter()` Allows to control how the field result is formatted.
`java.lang.String`	`getTemplateName()` Gets the file name of the template used by the document.
`ToaCategories`	`getToaCategories()` Gets the table of authorities categories.
`boolean`	`getUseInvariantCultureNumberFormat()` Gets the value indicating that number format is parsed using invariant culture or not
`IFieldUserPromptRespondent`	`getUserPromptRespondent()` Gets the respondent to user prompts during field update.
`boolean`	`isBidiTextSupportedOnUpdate()` Gets the value indicating whether bidirectional text is fully supported during field update or not.
`void`	`isBidiTextSupportedOnUpdate(boolean value)` Sets the value indicating whether bidirectional text is fully supported during field update or not.
`void`	`setBarcodeGenerator(IBarcodeGenerator value)` Gets or set custom barcode generator.
`void`	`setBuiltInTemplatesPaths(java.lang.String[] value)` Sets paths of MS Word built-in templates.
`void`	`setComparisonExpressionEvaluator(IComparisonExpressionEvaluator value)` Sets the field comparison expressions evaluator.
`void`	`setCurrentUser(UserInformation value)` Sets the current user information.
`void`	`setCustomTocStyleSeparator(java.lang.String value)` Sets custom style separator for the \t switch in `FieldToc` field.
`void`	`setDefaultDocumentAuthor(java.lang.String value)` Sets default document author's name.
`void`	`setFieldDatabaseProvider(IFieldDatabaseProvider value)` Sets a provider that returns a query result for the `FieldDatabase` field.
`void`	`setFieldIndexFormat(int value)` Sets a `getFieldIndexFormat()` / `setFieldIndexFormat(int)` that represents the formatting for the `FieldIndex` fields in the document.
`void`	`setFieldUpdateCultureProvider(IFieldUpdateCultureProvider value)` Sets a provider that returns a culture object specific for each particular field.
`void`	`setFieldUpdateCultureSource(int value)` Specifies what culture to use to format the field result.
`void`	`setFieldUpdatingCallback(IFieldUpdatingCallback value)` Sets `IFieldUpdatingCallback` implementation
`void`	`setFileName(java.lang.String value)` Sets the file name of the document.
`void`	`setLegacyNumberFormat(boolean value)` Sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
`void`	`setPreProcessCulture(CultureInfo value)` Sets the culture to preprocess field values.
`void`	`setResultFormatter(IFieldResultFormatter value)` Allows to control how the field result is formatted.
`void`	`setTemplateName(java.lang.String value)` Sets the file name of the template used by the document.
`void`	`setToaCategories(ToaCategories value)` Sets the table of authorities categories.
`void`	`setUseInvariantCultureNumberFormat(boolean value)` Sets the value indicating that number format is parsed using invariant culture or not
`void`	`setUserPromptRespondent(IFieldUserPromptRespondent value)` Sets the respondent to user prompts during field update.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getFieldUpdateCultureSource
```
public final int getFieldUpdateCultureSource()
```
    Specifies what culture to use to format the field result.
    By default, the culture of the current thread is used.
    
    The setting affects only date/time fields with \\@ format switch.
    
    Returns:
    
    The corresponding int value. The returned value is one of FieldUpdateCultureSource constants.
  - setFieldUpdateCultureSource
```
public final void setFieldUpdateCultureSource(int value)
```
    Specifies what culture to use to format the field result.
    By default, the culture of the current thread is used.
    
    The setting affects only date/time fields with \\@ format switch.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of FieldUpdateCultureSource constants.
  - getFieldUpdateCultureProvider
```
public final IFieldUpdateCultureProvider getFieldUpdateCultureProvider()
```
    Gets a provider that returns a culture object specific for each particular field.
    The provider is requested when the value of getFieldUpdateCultureSource() / setFieldUpdateCultureSource(int) is FieldUpdateCultureSource.FieldCode.
    
    If the provider is present, then the culture object it returns is used for the field update. Otherwise, a system culture is used.
    
    Returns:
    
    A provider that returns a culture object specific for each particular field.
  - setFieldUpdateCultureProvider
```
public final void setFieldUpdateCultureProvider(IFieldUpdateCultureProvider value)
```
    Sets a provider that returns a culture object specific for each particular field.
    The provider is requested when the value of getFieldUpdateCultureSource() / setFieldUpdateCultureSource(int) is FieldUpdateCultureSource.FieldCode.
    
    If the provider is present, then the culture object it returns is used for the field update. Otherwise, a system culture is used.
    
    Parameters:
    
    value - A provider that returns a culture object specific for each particular field.
  - isBidiTextSupportedOnUpdate
```
public final boolean isBidiTextSupportedOnUpdate()
```
    Gets the value indicating whether bidirectional text is fully supported during field update or not.
    When this property is set to true, additional steps are performed to produce Right-To-Left language (i.e. Arabic or Hebrew) compatible field result during its update.
    
    When this property is set to false and Right-To-Left language is used, correctness of field result after its update is not guaranteed.
    
    The default value is false.
    
    Returns:
    
    The value indicating whether bidirectional text is fully supported during field update or not.
  - isBidiTextSupportedOnUpdate
```
public final void isBidiTextSupportedOnUpdate(boolean value)
```
    Sets the value indicating whether bidirectional text is fully supported during field update or not.
    When this property is set to true, additional steps are performed to produce Right-To-Left language (i.e. Arabic or Hebrew) compatible field result during its update.
    
    When this property is set to false and Right-To-Left language is used, correctness of field result after its update is not guaranteed.
    
    The default value is false.
    
    Parameters:
    
    value - The value indicating whether bidirectional text is fully supported during field update or not.
  - getUserPromptRespondent
```
public final IFieldUserPromptRespondent getUserPromptRespondent()
```
    Gets the respondent to user prompts during field update.
    If the value of this property is set to null, the fields that require user response on prompting (such as FieldAsk or FieldFillIn) are not updated.
    
    The default value is null.
    
    Returns:
    
    The respondent to user prompts during field update.
  - setUserPromptRespondent
```
public final void setUserPromptRespondent(IFieldUserPromptRespondent value)
```
    Sets the respondent to user prompts during field update.
    If the value of this property is set to null, the fields that require user response on prompting (such as FieldAsk or FieldFillIn) are not updated.
    
    The default value is null.
    
    Parameters:
    
    value - The respondent to user prompts during field update.
  - getComparisonExpressionEvaluator
```
public final IComparisonExpressionEvaluator getComparisonExpressionEvaluator()
```
    Gets the field comparison expressions evaluator.
    
    Returns:
    
    The field comparison expressions evaluator.
    
    See Also:
    
    IComparisonExpressionEvaluator
  - setComparisonExpressionEvaluator
```
public final void setComparisonExpressionEvaluator(IComparisonExpressionEvaluator value)
```
    Sets the field comparison expressions evaluator.
    
    Parameters:
    
    value - The field comparison expressions evaluator.
    
    See Also:
    
    IComparisonExpressionEvaluator
  - getDefaultDocumentAuthor
```
public final java.lang.String getDefaultDocumentAuthor()
```
    Gets default document author's name. If author's name is already specified in built-in document properties, this option is not considered.
    
    Returns:
    
    Default document author's name.
  - setDefaultDocumentAuthor
```
public final void setDefaultDocumentAuthor(java.lang.String value)
```
    Sets default document author's name. If author's name is already specified in built-in document properties, this option is not considered.
    
    Parameters:
    
    value - Default document author's name.
  - getCustomTocStyleSeparator
```
public final java.lang.String getCustomTocStyleSeparator()
```
    Gets custom style separator for the \t switch in FieldToc field. By default, custom styles defined by the \t switch in the FieldToc field are separated by a delimiter taken from the current culture. This property overrides that behaviour by specifying a user defined delimiter.
    
    Returns:
    
    Custom style separator for the \t switch in FieldToc field.
  - setCustomTocStyleSeparator
```
public final void setCustomTocStyleSeparator(java.lang.String value)
```
    Sets custom style separator for the \t switch in FieldToc field. By default, custom styles defined by the \t switch in the FieldToc field are separated by a delimiter taken from the current culture. This property overrides that behaviour by specifying a user defined delimiter.
    
    Parameters:
    
    value - Custom style separator for the \t switch in FieldToc field.
  - getLegacyNumberFormat
```
public final boolean getLegacyNumberFormat()
```
    Gets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
    When this property is set to true, template symbol "#" worked as in .net: Replaces the pound sign with the corresponding digit if one is present; otherwise, no symbols appears in the result string.
    
    When this property is set to false, template symbol "#" works as MS Word: This format item specifies the requisite numeric places to display in the result. If the result does not include a digit in that place, MS Word displays a space. For example, { = 9 + 6 \# $### } displays $ 15.
    
    The default value is false.
    
    Returns:
    
    The value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
  - setLegacyNumberFormat
```
public final void setLegacyNumberFormat(boolean value)
```
    Sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
    When this property is set to true, template symbol "#" worked as in .net: Replaces the pound sign with the corresponding digit if one is present; otherwise, no symbols appears in the result string.
    
    When this property is set to false, template symbol "#" works as MS Word: This format item specifies the requisite numeric places to display in the result. If the result does not include a digit in that place, MS Word displays a space. For example, { = 9 + 6 \# $### } displays $ 15.
    
    The default value is false.
    
    Parameters:
    
    value - The value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
  - getUseInvariantCultureNumberFormat
```
public final boolean getUseInvariantCultureNumberFormat()
```
    Gets the value indicating that number format is parsed using invariant culture or not
    When this property is set to true, number format is taken from an invariant culture.
    
    When this property is set to false, number format is taken from the current thread's culture.
    
    The default value is false.
    
    Returns:
    
    The value indicating that number format is parsed using invariant culture or not
  - setUseInvariantCultureNumberFormat
```
public final void setUseInvariantCultureNumberFormat(boolean value)
```
    Sets the value indicating that number format is parsed using invariant culture or not
    When this property is set to true, number format is taken from an invariant culture.
    
    When this property is set to false, number format is taken from the current thread's culture.
    
    The default value is false.
    
    Parameters:
    
    value - The value indicating that number format is parsed using invariant culture or not
  - getBarcodeGenerator
```
public final IBarcodeGenerator getBarcodeGenerator()
```
    Gets or set custom barcode generator. Custom barcode generator should implement public interface IBarcodeGenerator.
    
    Returns:
    
    Or set custom barcode generator.
  - setBarcodeGenerator
```
public final void setBarcodeGenerator(IBarcodeGenerator value)
```
    Gets or set custom barcode generator. Custom barcode generator should implement public interface IBarcodeGenerator.
    
    Parameters:
    
    value - Or set custom barcode generator.
  - getFieldDatabaseProvider
```
public final IFieldDatabaseProvider getFieldDatabaseProvider()
```
    Gets a provider that returns a query result for the FieldDatabase field.
    
    Returns:
    
    A provider that returns a query result for the FieldDatabase field.
  - setFieldDatabaseProvider
```
public final void setFieldDatabaseProvider(IFieldDatabaseProvider value)
```
    Sets a provider that returns a query result for the FieldDatabase field.
    
    Parameters:
    
    value - A provider that returns a query result for the FieldDatabase field.
  - getPreProcessCulture
```
public final CultureInfo getPreProcessCulture()
```
    Gets the culture to preprocess field values.
    Currently this property only affects value of the FieldDocProperty field.
    
    The default value is null. When this property is set to null, the FieldDocProperty field's value is preprocessed with the culture controlled by the getFieldUpdateCultureSource() / setFieldUpdateCultureSource(int) property.
    
    Returns:
    
    The culture to preprocess field values.
  - setPreProcessCulture
```
public final void setPreProcessCulture(CultureInfo value)
```
    Sets the culture to preprocess field values.
    Currently this property only affects value of the FieldDocProperty field.
    
    The default value is null. When this property is set to null, the FieldDocProperty field's value is preprocessed with the culture controlled by the getFieldUpdateCultureSource() / setFieldUpdateCultureSource(int) property.
    
    Parameters:
    
    value - The culture to preprocess field values.
  - getCurrentUser
```
public final UserInformation getCurrentUser()
```
    Gets the current user information.
    
    Returns:
    
    The current user information.
  - setCurrentUser
```
public final void setCurrentUser(UserInformation value)
```
    Sets the current user information.
    
    Parameters:
    
    value - The current user information.
  - getToaCategories
```
public final ToaCategories getToaCategories()
```
    Gets the table of authorities categories.
    
    Returns:
    
    The table of authorities categories.
  - setToaCategories
```
public final void setToaCategories(ToaCategories value)
```
    Sets the table of authorities categories.
    
    Parameters:
    
    value - The table of authorities categories.
  - getFieldIndexFormat
```
public final int getFieldIndexFormat()
```
    Gets a getFieldIndexFormat() / setFieldIndexFormat(int) that represents the formatting for the FieldIndex fields in the document.
    
    Returns:
    
    A getFieldIndexFormat() / setFieldIndexFormat(int) that represents the formatting for the FieldIndex fields in the document. The returned value is one of FieldIndexFormat constants.
  - setFieldIndexFormat
```
public final void setFieldIndexFormat(int value)
```
    Sets a getFieldIndexFormat() / setFieldIndexFormat(int) that represents the formatting for the FieldIndex fields in the document.
    
    Parameters:
    
    value - A getFieldIndexFormat() / setFieldIndexFormat(int) that represents the formatting for the FieldIndex fields in the document. The value must be one of FieldIndexFormat constants.
  - getFileName
```
public final java.lang.String getFileName()
```
    Gets the file name of the document.
    This property is used by the FieldFileName field with higher priority than the Document.getOriginalFileName() property.
    
    Returns:
    
    The file name of the document.
  - setFileName
```
public final void setFileName(java.lang.String value)
```
    Sets the file name of the document.
    This property is used by the FieldFileName field with higher priority than the Document.getOriginalFileName() property.
    
    Parameters:
    
    value - The file name of the document.
  - getTemplateName
```
public final java.lang.String getTemplateName()
```
    Gets the file name of the template used by the document.
    This property is used by the FieldTemplate field if the Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) property is empty.
    
    If this property is empty, the default template file name Normal.dotm is used.
    
    Returns:
    
    The file name of the template used by the document.
  - setTemplateName
```
public final void setTemplateName(java.lang.String value)
```
    Sets the file name of the template used by the document.
    This property is used by the FieldTemplate field if the Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) property is empty.
    
    If this property is empty, the default template file name Normal.dotm is used.
    
    Parameters:
    
    value - The file name of the template used by the document.
  - getResultFormatter
```
public final IFieldResultFormatter getResultFormatter()
```
    Allows to control how the field result is formatted.
    
    Returns:
    
    The corresponding IFieldResultFormatter value.
  - setResultFormatter
```
public final void setResultFormatter(IFieldResultFormatter value)
```
    Allows to control how the field result is formatted.
    
    Parameters:
    
    value - The corresponding IFieldResultFormatter value.
  - getBuiltInTemplatesPaths
```
public final java.lang.String[] getBuiltInTemplatesPaths()
```
    Gets paths of MS Word built-in templates.
    This property is used by the FieldAutoText and FieldGlossary fields, if referenced auto text entry is not found in the Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) template.
    
    By default MS Word stores built-in templates in c:\Users\\AppData\Roaming\Microsoft\Document Building Blocks\1033\16\Built-In Building Blocks.dotx and C:\Users\\AppData\Roaming\Microsoft\Templates\Normal.dotm files.
    
    Returns:
    
    Paths of MS Word built-in templates.
  - setBuiltInTemplatesPaths
```
public final void setBuiltInTemplatesPaths(java.lang.String[] value)
```
    Sets paths of MS Word built-in templates.
    This property is used by the FieldAutoText and FieldGlossary fields, if referenced auto text entry is not found in the Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) template.
    
    By default MS Word stores built-in templates in c:\Users\\AppData\Roaming\Microsoft\Document Building Blocks\1033\16\Built-In Building Blocks.dotx and C:\Users\\AppData\Roaming\Microsoft\Templates\Normal.dotm files.
    
    Parameters:
    
    value - Paths of MS Word built-in templates.
  - getFieldUpdatingCallback
```
public final IFieldUpdatingCallback getFieldUpdatingCallback()
```
    Gets IFieldUpdatingCallback implementation
    
    Returns:
    
    IFieldUpdatingCallback implementation
  - setFieldUpdatingCallback
```
public final void setFieldUpdatingCallback(IFieldUpdatingCallback value)
```
    Sets IFieldUpdatingCallback implementation
    
    Parameters:
    
    value - IFieldUpdatingCallback implementation

Class FieldOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFieldUpdateCultureSource

setFieldUpdateCultureSource

getFieldUpdateCultureProvider

setFieldUpdateCultureProvider

isBidiTextSupportedOnUpdate

isBidiTextSupportedOnUpdate

getUserPromptRespondent

setUserPromptRespondent

getComparisonExpressionEvaluator

setComparisonExpressionEvaluator

getDefaultDocumentAuthor

setDefaultDocumentAuthor

getCustomTocStyleSeparator

setCustomTocStyleSeparator

getLegacyNumberFormat

setLegacyNumberFormat

getUseInvariantCultureNumberFormat

setUseInvariantCultureNumberFormat

getBarcodeGenerator

setBarcodeGenerator

getFieldDatabaseProvider

setFieldDatabaseProvider

getPreProcessCulture

setPreProcessCulture

getCurrentUser

setCurrentUser

getToaCategories

setToaCategories

getFieldIndexFormat

setFieldIndexFormat

getFileName

setFileName

getTemplateName

setTemplateName

getResultFormatter

setResultFormatter

getBuiltInTemplatesPaths

setBuiltInTemplatesPaths

getFieldUpdatingCallback

setFieldUpdatingCallback