Aspose::Words::Fields::FieldOptions Class Reference

Detailed Description

Represents options to control field handling in a document.

#include <Aspose.Words.Cpp/Model/Fields/FieldOptions.h>

+ Inheritance diagram for Aspose::Words::Fields::FieldOptions:

Public Member Functions

SharedPtr< IBarcodeGeneratorget_BarcodeGenerator () const
 Gets or set custom barcode generator. More...
 
ArrayPtr< Stringget_BuiltInTemplatesPaths () const
 Gets or sets paths of MS Word built-in templates. More...
 
SharedPtr< UserInformationget_CurrentUser () const
 Gets the current user information. More...
 
String get_CustomTocStyleSeparator () const
 Gets or sets custom style separator for the \t switch in TOC field. More...
 
String get_DefaultDocumentAuthor () const
 Gets or sets default document author's name. If author's name is already specified in built-in document properties, this option is not considered. More...
 
SharedPtr< IFieldUpdateCultureProviderget_FieldUpdateCultureProvider () const
 Gets or sets a provider that returns a culture object specific for each particular field. More...
 
FieldUpdateCultureSource get_FieldUpdateCultureSource () const
 Specifies what culture to use to format the field result. More...
 
String get_FileName () const
 Gets or sets the file name of the document. More...
 
bool get_IsBidiTextSupportedOnUpdate () const
 Gets or sets the value indicating whether bidirectional text is fully supported during field update or not. More...
 
bool get_LegacyNumberFormat () const
 Gets or sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not. More...
 
SharedPtr< CultureInfoget_PreProcessCulture () const
 Gets or sets the culture to preprocess field values. More...
 
SharedPtr< IFieldResultFormatterget_ResultFormatter () const
 Allows to control how the field result is formatted. More...
 
SharedPtr< ToaCategoriesget_ToaCategories () const
 Gets the table of authorities categories. More...
 
bool get_UseInvariantCultureNumberFormat () const
 Gets or sets the value indicating that number format is parsed using invariant culture or not More...
 
SharedPtr< IFieldUserPromptRespondentget_UserPromptRespondent () const
 Gets or sets the respondent to user prompts during field update. More...
 
void set_BarcodeGenerator (SharedPtr< IBarcodeGenerator > value)
 Setter for get_BarcodeGenerator. More...
 
void set_BuiltInTemplatesPaths (ArrayPtr< String > value)
 Setter for get_BuiltInTemplatesPaths. More...
 
void set_CurrentUser (SharedPtr< UserInformation > value)
 Sets the current user information. More...
 
void set_CustomTocStyleSeparator (String value)
 Setter for get_CustomTocStyleSeparator. More...
 
void set_DefaultDocumentAuthor (String value)
 Setter for get_DefaultDocumentAuthor. More...
 
void set_FieldUpdateCultureProvider (SharedPtr< IFieldUpdateCultureProvider > value)
 Setter for get_FieldUpdateCultureProvider. More...
 
void set_FieldUpdateCultureSource (FieldUpdateCultureSource value)
 Setter for get_FieldUpdateCultureSource. More...
 
void set_FileName (String value)
 Setter for get_FileName. More...
 
void set_IsBidiTextSupportedOnUpdate (bool value)
 Setter for get_IsBidiTextSupportedOnUpdate. More...
 
void set_LegacyNumberFormat (bool value)
 Setter for get_LegacyNumberFormat. More...
 
void set_PreProcessCulture (SharedPtr< CultureInfo > value)
 Setter for get_PreProcessCulture. More...
 
void set_ResultFormatter (SharedPtr< IFieldResultFormatter > value)
 Allows to control how the field result is formatted. More...
 
void set_ToaCategories (SharedPtr< ToaCategories > value)
 Sets the table of authorities categories. More...
 
void set_UseInvariantCultureNumberFormat (bool value)
 Setter for get_UseInvariantCultureNumberFormat. More...
 
void set_UserPromptRespondent (SharedPtr< IFieldUserPromptRespondent > value)
 Setter for get_UserPromptRespondent. More...
 
- Public Member Functions inherited from Object
ASPOSECPP_SHARED_API Object ()
 
ASPOSECPP_SHARED_API Object (Object const &x)
 
virtual ASPOSECPP_SHARED_API ~Object ()
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 
Detail::SmartPtrCounter * GetCounter ()
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 
ASPOSECPP_SHARED_API void Lock ()
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 
Objectoperator= (Object const &x)
 
bool ReferenceEquals (String const &str, std::nullptr_t)
 
bool ReferenceEquals (String const &str1, String const &str2)
 
int RemovedSharedRefs (int count)
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 
int SharedCount () const
 
ObjectSharedRefAdded ()
 
int SharedRefRemovedSafe ()
 
virtual ASPOSECPP_SHARED_API String ToString () const
 
ASPOSECPP_SHARED_API void Unlock ()
 
Detail::SmartPtrCounter * WeakRefAdded ()
 
void WeakRefRemoved ()
 

Additional Inherited Members

- Public Types inherited from Object
typedef SmartPtr< Objectptr
 
typedef System::Details::SharedMembersType shared_members_type
 
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
 
bool Equals (float const &objA, float const &objB)
 
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 
static const TypeInfoType ()
 

Member Function Documentation

◆ get_BarcodeGenerator()

System::SharedPtr<Aspose::Words::Fields::IBarcodeGenerator> Aspose::Words::Fields::FieldOptions::get_BarcodeGenerator ( ) const

Gets or set custom barcode generator.

Custom barcode generator should implement public interface IBarcodeGenerator.

◆ get_BuiltInTemplatesPaths()

System::ArrayPtr<System::String> Aspose::Words::Fields::FieldOptions::get_BuiltInTemplatesPaths ( ) const

Gets or sets paths of MS Word built-in templates.

This property is used by the AUTOTEXT and GLOSSARY fields, if referenced auto text entry is not found in the AttachedTemplate template.

By defalut MS Word stores built-in templates in c:\Users\<username>\AppData\Roaming\Microsoft\Document Building Blocks\1033\16\Built-In Building Blocks.dotx and C:\Users\<username>\AppData\Roaming\Microsoft\Templates\Normal.dotm files.

◆ get_CurrentUser()

System::SharedPtr<Aspose::Words::Fields::UserInformation> Aspose::Words::Fields::FieldOptions::get_CurrentUser ( ) const

Gets the current user information.

◆ get_CustomTocStyleSeparator()

System::String Aspose::Words::Fields::FieldOptions::get_CustomTocStyleSeparator ( ) const

Gets or sets custom style separator for the \t switch in TOC field.

By default, custom styles defined by the \t switch in the TOC field are separated by a delimiter taken from the current culture. This property overrides that behaviour by specifying a user defined delimiter.

◆ get_DefaultDocumentAuthor()

System::String Aspose::Words::Fields::FieldOptions::get_DefaultDocumentAuthor ( ) const

Gets 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_FieldUpdateCultureProvider()

System::SharedPtr<Aspose::Words::Fields::IFieldUpdateCultureProvider> Aspose::Words::Fields::FieldOptions::get_FieldUpdateCultureProvider ( ) const

Gets or sets a provider that returns a culture object specific for each particular field.

The provider is requested when the value of FieldUpdateCultureSource 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.

◆ get_FieldUpdateCultureSource()

Aspose::Words::Fields::FieldUpdateCultureSource Aspose::Words::Fields::FieldOptions::get_FieldUpdateCultureSource ( ) const

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.

◆ get_FileName()

System::String Aspose::Words::Fields::FieldOptions::get_FileName ( ) const

Gets or sets the file name of the document.

This property is used by the FILENAME field with higher priority than the OriginalFileName property.

◆ get_IsBidiTextSupportedOnUpdate()

bool Aspose::Words::Fields::FieldOptions::get_IsBidiTextSupportedOnUpdate ( ) const

Gets or 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.

◆ get_LegacyNumberFormat()

bool Aspose::Words::Fields::FieldOptions::get_LegacyNumberFormat ( ) const

Gets or 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.

◆ get_PreProcessCulture()

System::SharedPtr<System::Globalization::CultureInfo> Aspose::Words::Fields::FieldOptions::get_PreProcessCulture ( ) const

Gets or sets the culture to preprocess field values.

Currently this property only affects value of the DOCPROPERTY field.

The default value is null. When this property is set to null, the DOCPROPERTY field's value is preprocessed with the culture controlled by the FieldUpdateCultureSource property.

◆ get_ResultFormatter()

System::SharedPtr<Aspose::Words::Fields::IFieldResultFormatter> Aspose::Words::Fields::FieldOptions::get_ResultFormatter ( ) const

Allows to control how the field result is formatted.

◆ get_ToaCategories()

System::SharedPtr<Aspose::Words::Fields::ToaCategories> Aspose::Words::Fields::FieldOptions::get_ToaCategories ( ) const

Gets the table of authorities categories.

◆ get_UseInvariantCultureNumberFormat()

bool Aspose::Words::Fields::FieldOptions::get_UseInvariantCultureNumberFormat ( ) const

Gets or 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.

◆ get_UserPromptRespondent()

System::SharedPtr<Aspose::Words::Fields::IFieldUserPromptRespondent> Aspose::Words::Fields::FieldOptions::get_UserPromptRespondent ( ) const

Gets or 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 ASK or FILLIN) are not updated.

The default value is null.

◆ set_BarcodeGenerator()

void Aspose::Words::Fields::FieldOptions::set_BarcodeGenerator ( System::SharedPtr< Aspose::Words::Fields::IBarcodeGenerator value)

◆ set_BuiltInTemplatesPaths()

void Aspose::Words::Fields::FieldOptions::set_BuiltInTemplatesPaths ( System::ArrayPtr< System::String value)

◆ set_CurrentUser()

void Aspose::Words::Fields::FieldOptions::set_CurrentUser ( System::SharedPtr< Aspose::Words::Fields::UserInformation value)

Sets the current user information.

◆ set_CustomTocStyleSeparator()

void Aspose::Words::Fields::FieldOptions::set_CustomTocStyleSeparator ( System::String  value)

◆ set_DefaultDocumentAuthor()

void Aspose::Words::Fields::FieldOptions::set_DefaultDocumentAuthor ( System::String  value)

◆ set_FieldUpdateCultureProvider()

void Aspose::Words::Fields::FieldOptions::set_FieldUpdateCultureProvider ( System::SharedPtr< Aspose::Words::Fields::IFieldUpdateCultureProvider value)

◆ set_FieldUpdateCultureSource()

void Aspose::Words::Fields::FieldOptions::set_FieldUpdateCultureSource ( Aspose::Words::Fields::FieldUpdateCultureSource  value)

◆ set_FileName()

void Aspose::Words::Fields::FieldOptions::set_FileName ( System::String  value)

◆ set_IsBidiTextSupportedOnUpdate()

void Aspose::Words::Fields::FieldOptions::set_IsBidiTextSupportedOnUpdate ( bool  value)

◆ set_LegacyNumberFormat()

void Aspose::Words::Fields::FieldOptions::set_LegacyNumberFormat ( bool  value)

◆ set_PreProcessCulture()

void Aspose::Words::Fields::FieldOptions::set_PreProcessCulture ( System::SharedPtr< System::Globalization::CultureInfo value)

◆ set_ResultFormatter()

void Aspose::Words::Fields::FieldOptions::set_ResultFormatter ( System::SharedPtr< Aspose::Words::Fields::IFieldResultFormatter value)

Allows to control how the field result is formatted.

◆ set_ToaCategories()

void Aspose::Words::Fields::FieldOptions::set_ToaCategories ( System::SharedPtr< Aspose::Words::Fields::ToaCategories value)

Sets the table of authorities categories.

◆ set_UseInvariantCultureNumberFormat()

void Aspose::Words::Fields::FieldOptions::set_UseInvariantCultureNumberFormat ( bool  value)

◆ set_UserPromptRespondent()

void Aspose::Words::Fields::FieldOptions::set_UserPromptRespondent ( System::SharedPtr< Aspose::Words::Fields::IFieldUserPromptRespondent value)