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

NameTypeAccessDescription
fieldUpdateCultureSourceintRead/WriteSpecifies what culture to use to format the field result.
fieldUpdateCultureProviderIFieldUpdateCultureProviderRead/WriteGets or sets a provider that returns a culture object specific for each particular field.
bidiTextSupportedOnUpdatebooleanRead/WriteGets or sets the value indicating whether bidirectional text is fully supported during field update or not.
userPromptRespondentIFieldUserPromptRespondentRead/WriteGets or sets the respondent to user prompts during field update.
comparisonExpressionEvaluatorIComparisonExpressionEvaluatorRead/WriteGets or sets the field comparison expressions evaluator.
defaultDocumentAuthorStringRead/WriteGets or sets default document author’s name.
customTocStyleSeparatorStringRead/WriteGets or sets custom style separator for the \t switch in FieldToc field.
legacyNumberFormatbooleanRead/WriteGets or sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
useInvariantCultureNumberFormatbooleanRead/WriteGets or sets the value indicating that number format is parsed using invariant culture or not
barcodeGeneratorIBarcodeGeneratorRead/WriteGets or set custom barcode generator.
fieldDatabaseProviderIFieldDatabaseProviderRead/WriteGets or sets a provider that returns a query result for the FieldDatabase field.
bibliographyStylesProviderIBibliographyStylesProviderRead/WriteGets or sets a provider that returns a bibliography style for the FieldBibliography and FieldCitation fields.
preProcessCulturecom.aspose.words.net.System.Globalization.CultureInfoRead/WriteGets or sets the pre process culture.
currentUserUserInformationRead/WriteGets or sets the current user information.
toaCategoriesToaCategoriesRead/WriteGets or sets the table of authorities categories.
fieldIndexFormatintRead/WriteGets or sets a FieldIndexFormat that represents the formatting for the FieldIndex fields in the document.
fileNameStringRead/WriteGets or sets the file name of the document.
templateNameStringRead/WriteGets or sets the file name of the template used by the document.
resultFormatterIFieldResultFormatterRead/WriteAllows to control how the field result is formatted.
builtInTemplatesPathsString[]Read/WriteGets or sets the built in templates paths.
fieldUpdatingCallbackIFieldUpdatingCallbackRead/WriteGets or sets IFieldUpdatingCallback implementation
fieldUpdatingProgressCallbackIFieldUpdatingProgressCallbackRead/WriteGets or sets IFieldUpdatingProgressCallback implementation.

Methods

SignatureDescription
getFieldUpdateCultureSource() → intSpecifies what culture to use to format the field result.
setFieldUpdateCultureSource(value: int)Sets the field update culture source value.
getFieldUpdateCultureProvider() → IFieldUpdateCultureProviderGets 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() → booleanGets 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() → IFieldUserPromptRespondentGets or sets the respondent to user prompts during field update.
setUserPromptRespondent(value: IFieldUserPromptRespondent)Sets the user prompt respondent value.
getComparisonExpressionEvaluator() → IComparisonExpressionEvaluatorGets or sets the field comparison expressions evaluator.
setComparisonExpressionEvaluator(value: IComparisonExpressionEvaluator)Sets the comparison expression evaluator value.
getDefaultDocumentAuthor() → StringGets or sets default document author’s name.
setDefaultDocumentAuthor(value: String)Sets the default document author value.
getCustomTocStyleSeparator() → StringGets or sets custom style separator for the \t switch in FieldToc field.
setCustomTocStyleSeparator(value: String)Sets the custom toc style separator value.
getLegacyNumberFormat() → booleanGets 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() → booleanGets 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() → IBarcodeGeneratorGets or set custom barcode generator.
setBarcodeGenerator(value: IBarcodeGenerator)Sets the barcode generator value.
getFieldDatabaseProvider() → IFieldDatabaseProviderGets or sets a provider that returns a query result for the FieldDatabase field.
setFieldDatabaseProvider(value: IFieldDatabaseProvider)Sets the field database provider value.
getBibliographyStylesProvider() → IBibliographyStylesProviderGets 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.CultureInfoReturns the pre process culture.
setPreProcessCulture(value: com.aspose.words.net.System.Globalization.CultureInfo)Sets the pre process culture value.
getCurrentUser() → UserInformationGets or sets the current user information.
setCurrentUser(value: UserInformation)Sets the current user value.
getToaCategories() → ToaCategoriesGets or sets the table of authorities categories.
setToaCategories(value: ToaCategories)Sets the toa categories value.
getFieldIndexFormat() → intGets 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() → StringGets or sets the file name of the document.
setFileName(value: String)Sets the file name value.
getTemplateName() → StringGets or sets the file name of the template used by the document.
setTemplateName(value: String)Sets the template name value.
getResultFormatter() → IFieldResultFormatterAllows 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() → IFieldUpdatingCallbackGets or sets IFieldUpdatingCallback implementation
setFieldUpdatingCallback(value: IFieldUpdatingCallback)Sets the field updating callback value.
getFieldUpdatingProgressCallback() → IFieldUpdatingProgressCallbackGets or sets IFieldUpdatingProgressCallback implementation.
setFieldUpdatingProgressCallback(value: IFieldUpdatingProgressCallback)Sets the field updating progress callback value.

See Also