FieldOptions
Overview
FieldOptions is a class in Aspose.Words FOSS for Java.
Represents options to control field handling in a document.
Edition status of its 65 listed members (a property and its accessor methods are listed separately, overloads once): 65 not yet exercised by a verified example.
This class declares 44 methods for FieldOptions objects in Java programs.
Available methods include: getBarcodeGenerator, getBibliographyStylesProvider, getBuiltInTemplatesPaths, getComparisonExpressionEvaluator, getCurrentUser, getCustomTocStyleSeparator, getDefaultDocumentAuthor, getFieldDatabaseProvider, getFieldIndexFormat, getFieldUpdateCultureProvider, getFieldUpdateCultureSource, getFieldUpdatingCallback, and 31 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: barcodeGenerator, bibliographyStylesProvider, bidiTextSupportedOnUpdate, builtInTemplatesPaths, comparisonExpressionEvaluator, currentUser, and 16 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
fieldUpdateCultureSource | int | Read/Write | Specifies what culture to use to format the field result. |
fieldUpdateCultureProvider | IFieldUpdateCultureProvider | Read/Write | Gets or sets a provider that returns a culture object specific for each particular field. |
bidiTextSupportedOnUpdate | boolean | Read/Write | Gets or sets the value indicating whether bidirectional text is fully supported during field update or not. |
userPromptRespondent | IFieldUserPromptRespondent | Read/Write | Gets or sets the respondent to user prompts during field update. |
comparisonExpressionEvaluator | IComparisonExpressionEvaluator | Read/Write | Gets or sets the field comparison expressions evaluator. |
defaultDocumentAuthor | String | Read/Write | Gets or sets default document author’s name. |
customTocStyleSeparator | String | Read/Write | Gets or sets custom style separator for the \t switch in FieldToc field. |
legacyNumberFormat | boolean | Read/Write | Gets or sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not. |
useInvariantCultureNumberFormat | boolean | Read/Write | Gets or sets the value indicating that number format is parsed using invariant culture or not |
barcodeGenerator | IBarcodeGenerator | Read/Write | Gets or set custom barcode generator. |
fieldDatabaseProvider | IFieldDatabaseProvider | Read/Write | Gets or sets a provider that returns a query result for the FieldDatabase field. |
bibliographyStylesProvider | IBibliographyStylesProvider | Read/Write | Gets or sets a provider that returns a bibliography style for the FieldBibliography and FieldCitation fields. |
preProcessCulture | com.aspose.words.net.System.Globalization.CultureInfo | Read/Write | Gets or sets the pre process culture. |
currentUser | UserInformation | Read/Write | Gets or sets the current user information. |
toaCategories | ToaCategories | Read/Write | Gets or sets the table of authorities categories. |
fieldIndexFormat | int | Read/Write | Gets or sets a FieldIndexFormat that represents the formatting for the FieldIndex fields in the document. |
fileName | String | Read/Write | Gets or sets the file name of the document. |
templateName | String | Read/Write | Gets or sets the file name of the template used by the document. |
resultFormatter | IFieldResultFormatter | Read/Write | Allows to control how the field result is formatted. |
builtInTemplatesPaths | String[] | Read/Write | Gets or sets the built in templates paths. |
fieldUpdatingCallback | IFieldUpdatingCallback | Read/Write | Gets or sets IFieldUpdatingCallback implementation |
fieldUpdatingProgressCallback | IFieldUpdatingProgressCallback | Read/Write | Gets or sets IFieldUpdatingProgressCallback implementation. |
Methods
| Signature | Description |
|---|---|
getFieldUpdateCultureSource() → int | Specifies what culture to use to format the field result. |
setFieldUpdateCultureSource(value: int) | Sets the field update culture source value. |
getFieldUpdateCultureProvider() → IFieldUpdateCultureProvider | Gets or sets a provider that returns a culture object specific for each particular field. |
setFieldUpdateCultureProvider(value: IFieldUpdateCultureProvider) | Sets the field update culture provider value. |
isBidiTextSupportedOnUpdate() → boolean | Gets or sets the value indicating whether bidirectional text is fully supported during field update or not. |
isBidiTextSupportedOnUpdate(value: boolean) | Calls isBidiTextSupportedOnUpdate(value) on this FieldOptions instance. |
getUserPromptRespondent() → IFieldUserPromptRespondent | Gets or sets the respondent to user prompts during field update. |
setUserPromptRespondent(value: IFieldUserPromptRespondent) | Sets the user prompt respondent value. |
getComparisonExpressionEvaluator() → IComparisonExpressionEvaluator | Gets or sets the field comparison expressions evaluator. |
setComparisonExpressionEvaluator(value: IComparisonExpressionEvaluator) | Sets the comparison expression evaluator value. |
getDefaultDocumentAuthor() → String | Gets or sets default document author’s name. |
setDefaultDocumentAuthor(value: String) | Sets the default document author value. |
getCustomTocStyleSeparator() → String | Gets or sets custom style separator for the \t switch in FieldToc field. |
setCustomTocStyleSeparator(value: String) | Sets the custom toc style separator value. |
getLegacyNumberFormat() → boolean | Gets or sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not. |
setLegacyNumberFormat(value: boolean) | Sets the legacy number format value. |
getUseInvariantCultureNumberFormat() → boolean | Gets or sets the value indicating that number format is parsed using invariant culture or not |
setUseInvariantCultureNumberFormat(value: boolean) | Sets the use invariant culture number format value. |
getBarcodeGenerator() → IBarcodeGenerator | Gets or set custom barcode generator. |
setBarcodeGenerator(value: IBarcodeGenerator) | Sets the barcode generator value. |
getFieldDatabaseProvider() → IFieldDatabaseProvider | Gets or sets a provider that returns a query result for the FieldDatabase field. |
setFieldDatabaseProvider(value: IFieldDatabaseProvider) | Sets the field database provider value. |
getBibliographyStylesProvider() → IBibliographyStylesProvider | Gets or sets a provider that returns a bibliography style for the FieldBibliography and FieldCitation fields. |
setBibliographyStylesProvider(value: IBibliographyStylesProvider) | Sets the bibliography styles provider value. |
getPreProcessCulture() → com.aspose.words.net.System.Globalization.CultureInfo | Returns the pre process culture. |
setPreProcessCulture(value: com.aspose.words.net.System.Globalization.CultureInfo) | Sets the pre process culture value. |
getCurrentUser() → UserInformation | Gets or sets the current user information. |
setCurrentUser(value: UserInformation) | Sets the current user value. |
getToaCategories() → ToaCategories | Gets or sets the table of authorities categories. |
setToaCategories(value: ToaCategories) | Sets the toa categories value. |
getFieldIndexFormat() → int | Gets or sets a FieldIndexFormat that represents the formatting for the FieldIndex fields in the document. |
setFieldIndexFormat(value: int) | Sets the field index format value. |
getFileName() → String | Gets or sets the file name of the document. |
setFileName(value: String) | Sets the file name value. |
getTemplateName() → String | Gets or sets the file name of the template used by the document. |
setTemplateName(value: String) | Sets the template name value. |
getResultFormatter() → IFieldResultFormatter | Allows to control how the field result is formatted. |
setResultFormatter(value: IFieldResultFormatter) | Sets the result formatter value. |
getBuiltInTemplatesPaths() → String[] | Returns the built in templates paths. |
setBuiltInTemplatesPaths(value: String[]) | Sets the built in templates paths value. |
getFieldUpdatingCallback() → IFieldUpdatingCallback | Gets or sets IFieldUpdatingCallback implementation |
setFieldUpdatingCallback(value: IFieldUpdatingCallback) | Sets the field updating callback value. |
getFieldUpdatingProgressCallback() → IFieldUpdatingProgressCallback | Gets or sets IFieldUpdatingProgressCallback implementation. |
setFieldUpdatingProgressCallback(value: IFieldUpdatingProgressCallback) | Sets the field updating progress callback value. |