Aspose::Words::Fields::FieldOptions class

FieldOptions class

Represents options to control field handling in a document. To learn more, visit the Working with Fields documentation article.

class FieldOptions : public System::Object

Methods

MethodDescription
get_BarcodeGenerator() constGets or set custom barcode generator.
get_BibliographyStylesProvider() constGets or sets a provider that returns a bibliography style for the FieldBibliography and FieldCitation fields.
get_BuiltInTemplatesPaths() constGets or sets paths of MS Word built-in templates.
get_ComparisonExpressionEvaluator() constGets or sets the field comparison expressions evaluator.
get_CurrentUser() constGets or sets the current user information.
get_CustomTocStyleSeparator() constGets or sets custom style separator for the \t switch in FieldToc field.
get_DefaultDocumentAuthor() constGets or sets default document author’s name. If author’s name is already specified in built-in document properties, this option is not considered.
get_FieldDatabaseProvider() constGets a provider that returns a query result for the FieldDatabase field.
get_FieldIndexFormat()Gets or sets a FieldIndexFormat that represents the formatting for the FieldIndex fields in the document.
get_FieldUpdateCultureProvider() constGets or sets a provider that returns a culture object specific for each particular field.
get_FieldUpdateCultureSource() constSpecifies what culture to use to format the field result.
get_FieldUpdatingCallback() constGets IFieldUpdatingCallback implementation
get_FieldUpdatingProgressCallback() constGets IFieldUpdatingProgressCallback implementation.
get_FileName() constGets or sets the file name of the document.
get_IsBidiTextSupportedOnUpdate() constGets or sets the value indicating whether bidirectional text is fully supported during field update or not.
get_LegacyNumberFormat() constGets or sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
get_PreProcessCulture() constGets or sets the culture to preprocess field values.
get_ResultFormatter() constAllows to control how the field result is formatted.
get_TemplateName() constGets or sets the file name of the template used by the document.
get_ToaCategories() constGets or sets the table of authorities categories.
get_UseInvariantCultureNumberFormat() constGets or sets the value indicating that number format is parsed using invariant culture or not
get_UserPromptRespondent() constGets or sets the respondent to user prompts during field update.
set_BarcodeGenerator(const System::SharedPtr<Aspose::Words::Fields::IBarcodeGenerator> &)Gets or set custom barcode generator.
set_BibliographyStylesProvider(const System::SharedPtr<Aspose::Words::Fields::IBibliographyStylesProvider> &)Sets a provider that returns a bibliography style for the FieldBibliography and FieldCitation fields.
set_BuiltInTemplatesPaths(const System::ArrayPtr<System::String> &)Sets paths of MS Word built-in templates.
set_ComparisonExpressionEvaluator(const System::SharedPtr<Aspose::Words::Fields::IComparisonExpressionEvaluator> &)Sets the field comparison expressions evaluator.
set_CurrentUser(const System::SharedPtr<Aspose::Words::Fields::UserInformation> &)Sets the current user information.
set_CustomTocStyleSeparator(const System::String &)Sets custom style separator for the \t switch in FieldToc field.
set_DefaultDocumentAuthor(const System::String &)Sets default document author’s name. If author’s name is already specified in built-in document properties, this option is not considered.
set_FieldDatabaseProvider(const System::SharedPtr<Aspose::Words::Fields::IFieldDatabaseProvider> &)Sets a provider that returns a query result for the FieldDatabase field.
set_FieldIndexFormat(Aspose::Words::Fields::FieldIndexFormat)Sets a FieldIndexFormat that represents the formatting for the FieldIndex fields in the document.
set_FieldUpdateCultureProvider(const System::SharedPtr<Aspose::Words::Fields::IFieldUpdateCultureProvider> &)Sets a provider that returns a culture object specific for each particular field.
set_FieldUpdateCultureSource(Aspose::Words::Fields::FieldUpdateCultureSource)Specifies what culture to use to format the field result.
set_FieldUpdatingCallback(const System::SharedPtr<Aspose::Words::Fields::IFieldUpdatingCallback> &)Sets IFieldUpdatingCallback implementation
set_FieldUpdatingProgressCallback(const System::SharedPtr<Aspose::Words::Fields::IFieldUpdatingProgressCallback> &)Sets IFieldUpdatingProgressCallback implementation.
set_FileName(const System::String &)Sets the file name of the document.
set_IsBidiTextSupportedOnUpdate(bool)Sets the value indicating whether bidirectional text is fully supported during field update or not.
set_LegacyNumberFormat(bool)Sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
set_PreProcessCulture(const System::SharedPtr<System::Globalization::CultureInfo> &)Sets the culture to preprocess field values.
set_ResultFormatter(const System::SharedPtr<Aspose::Words::Fields::IFieldResultFormatter> &)Allows to control how the field result is formatted.
set_TemplateName(const System::String &)Sets the file name of the template used by the document.
set_ToaCategories(const System::SharedPtr<Aspose::Words::Fields::ToaCategories> &)Sets the table of authorities categories.
set_UseInvariantCultureNumberFormat(bool)Sets the value indicating that number format is parsed using invariant culture or not
set_UserPromptRespondent(const System::SharedPtr<Aspose::Words::Fields::IFieldUserPromptRespondent> &)Sets the respondent to user prompts during field update.

See Also