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

Represents options to control field handling in a document. More...

#include "Aspose.Words.Cpp/Model/Fields/FieldOptions.h"

Inherits System::Object.

Public Member Functions

Aspose::Words::Fields::FieldUpdateCultureSource get_FieldUpdateCultureSource () const
 Specifies what culture to use to format the field result. More...
 
void set_FieldUpdateCultureSource (Aspose::Words::Fields::FieldUpdateCultureSource value)
 Setter for Aspose::Words::Fields::FieldOptions::get_FieldUpdateCultureSource. More...
 
System::SharedPtr< Aspose::Words::Fields::IFieldUpdateCultureProvider > get_FieldUpdateCultureProvider () const
 Gets or sets a provider that returns a culture object specific for each particular field. More...
 
void set_FieldUpdateCultureProvider (System::SharedPtr< Aspose::Words::Fields::IFieldUpdateCultureProvider > value)
 Setter for Aspose::Words::Fields::FieldOptions::get_FieldUpdateCultureProvider. More...
 
bool get_IsBidiTextSupportedOnUpdate () const
 Gets or sets the value indicating whether bidirectional text is fully supported during field update or not. More...
 
void set_IsBidiTextSupportedOnUpdate (bool value)
 Setter for Aspose::Words::Fields::FieldOptions::get_IsBidiTextSupportedOnUpdate. More...
 
System::SharedPtr< Aspose::Words::Fields::IFieldUserPromptRespondent > get_UserPromptRespondent () const
 Gets or sets the respondent to user prompts during field update. More...
 
void set_UserPromptRespondent (System::SharedPtr< Aspose::Words::Fields::IFieldUserPromptRespondent > value)
 Setter for Aspose::Words::Fields::FieldOptions::get_UserPromptRespondent. More...
 
System::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...
 
void set_DefaultDocumentAuthor (System::String value)
 Setter for Aspose::Words::Fields::FieldOptions::get_DefaultDocumentAuthor. More...
 
System::String get_CustomTocStyleSeparator () const
 Gets or sets custom style separator for the \t switch in TOC field. More...
 
void set_CustomTocStyleSeparator (System::String value)
 Setter for Aspose::Words::Fields::FieldOptions::get_CustomTocStyleSeparator. 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...
 
void set_LegacyNumberFormat (bool value)
 Setter for Aspose::Words::Fields::FieldOptions::get_LegacyNumberFormat. More...
 
bool get_UseInvariantCultureNumberFormat () const
 Gets or sets the value indicating that number format is parsed using invariant culture or not More...
 
void set_UseInvariantCultureNumberFormat (bool value)
 Setter for Aspose::Words::Fields::FieldOptions::get_UseInvariantCultureNumberFormat. More...
 
System::SharedPtr< Aspose::Words::Fields::IBarcodeGenerator > get_BarcodeGenerator () const
 Gets or set custom barcode generator. More...
 
void set_BarcodeGenerator (System::SharedPtr< Aspose::Words::Fields::IBarcodeGenerator > value)
 Setter for Aspose::Words::Fields::FieldOptions::get_BarcodeGenerator. More...
 
System::SharedPtr< System::Globalization::CultureInfoget_PreProcessCulture () const
 Gets or sets the culture to preprocess field values. More...
 
void set_PreProcessCulture (System::SharedPtr< System::Globalization::CultureInfo > value)
 Setter for Aspose::Words::Fields::FieldOptions::get_PreProcessCulture. More...
 
System::SharedPtr< Aspose::Words::Fields::UserInformationget_CurrentUser () const
 Gets or sets the current user information. More...
 
void set_CurrentUser (System::SharedPtr< Aspose::Words::Fields::UserInformation > value)
 Setter for Aspose::Words::Fields::FieldOptions::get_CurrentUser. More...
 
System::SharedPtr< Aspose::Words::Fields::ToaCategoriesget_ToaCategories () const
 Gets or sets the table of authorities categories. More...
 
void set_ToaCategories (System::SharedPtr< Aspose::Words::Fields::ToaCategories > value)
 Setter for Aspose::Words::Fields::FieldOptions::get_ToaCategories. More...
 
System::String get_FileName () const
 Gets or sets the file name of the document. More...
 
void set_FileName (System::String value)
 Setter for Aspose::Words::Fields::FieldOptions::get_FileName. More...
 
System::SharedPtr< Aspose::Words::Fields::IFieldResultFormatter > get_ResultFormatter () const
 Allows to control how the field result is formatted. More...
 
void set_ResultFormatter (System::SharedPtr< Aspose::Words::Fields::IFieldResultFormatter > value)
 Setter for Aspose::Words::Fields::FieldOptions::get_ResultFormatter. More...
 
System::ArrayPtr< System::Stringget_BuiltInTemplatesPaths () const
 Gets or sets paths of MS Word built-in templates. More...
 
void set_BuiltInTemplatesPaths (System::ArrayPtr< System::String > value)
 Setter for Aspose::Words::Fields::FieldOptions::get_BuiltInTemplatesPaths. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Represents options to control field handling in a document.

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 Aspose::Words::Fields::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 Aspose::Words::Document::get_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 or sets 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 Aspose::Words::Fields::FieldOptions::get_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 Aspose::Words::Document::get_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 Aspose::Words::Fields::FieldOptions::get_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 or sets 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)

◆ 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)

◆ set_ToaCategories()

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

◆ 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)