Aspose::Words::Fields::FieldMergeField Class Reference

Detailed Description

Implements the MERGEFIELD field.

#include <Aspose.Words.Cpp/Fields/FieldMergeField.h>

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

Public Member Functions

String get_FieldName ()
 Gets the name of a data field. More...
 
String get_FieldNameNoPrefix () const
 Returns just the name of the data field. Any prefix is stripped to the prefix property. More...
 
bool get_IsMapped ()
 Gets whether this field is a mapped field. More...
 
bool get_IsVerticalFormatting ()
 Gets whether to enable character conversion for vertical formatting. More...
 
String get_TextAfter ()
 Gets the text to be inserted after the field if the field is not blank. More...
 
String get_TextBefore ()
 Gets the text to be inserted before the field if the field is not blank. More...
 
FieldType get_Type () override
 Gets the Microsoft Word field type. More...
 
FieldSwitchType GetSwitchType (String switchName) override
 
virtual const TypeInfoGetType () const override
 
virtual bool Is (const TypeInfo &target) const override
 
void set_FieldName (const String &value)
 Sets the name of a data field. More...
 
void set_IsMapped (bool value)
 Sets whether this field is a mapped field. More...
 
void set_IsVerticalFormatting (bool value)
 Sets whether to enable character conversion for vertical formatting. More...
 
void set_TextAfter (const String &value)
 Sets the text to be inserted after the field if the field is not blank. More...
 
void set_TextBefore (const String &value)
 Sets the text to be inserted before the field if the field is not blank. More...
 
- Public Member Functions inherited from Field
String get_DisplayResult ()
 Gets the text that represents the displayed field result. More...
 
SharedPtr< FieldEndget_End () const
 Gets the node that represents the field end. More...
 
SharedPtr< FieldEndget_FieldEnd () const
 Gets the node that represents the field end. More...
 
SharedPtr< FieldStartget_FieldStart () const
 Gets the node that represents the start of the field. More...
 
SharedPtr< FieldFormatget_Format ()
 Gets a FieldFormat object that provides typed access to field's formatting. More...
 
bool get_IsDirty ()
 Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. More...
 
bool get_IsLocked ()
 Gets or sets whether the field is locked (should not recalculate its result). More...
 
int32_t get_LocaleId ()
 Gets or sets the LCID of the field. More...
 
String get_Result ()
 Gets or sets text that is between the field separator and field end. More...
 
SharedPtr< FieldSeparatorget_Separator ()
 Gets the node that represents the field separator. Can be null. More...
 
SharedPtr< FieldStartget_Start () const
 Gets the node that represents the start of the field. More...
 
String GetFieldCode ()
 Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. More...
 
String GetFieldCode (bool includeChildFieldCodes)
 Returns text between field start and field separator (or field end if there is no separator). More...
 
SharedPtr< NodeRemove ()
 Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null. More...
 
void set_IsDirty (bool value)
 Setter for get_IsDirty. More...
 
void set_IsLocked (bool value)
 Setter for get_IsLocked. More...
 
void set_LocaleId (int32_t value)
 Setter for get_LocaleId. More...
 
void set_Result (const String &value)
 Setter for get_Result. More...
 
bool Unlink ()
 Performs the field unlink. More...
 
void Update ()
 Performs the field update. Throws if the field is being updated already. More...
 
void Update (bool ignoreMergeFormat)
 Performs a field update. Throws if the field is being updated already. More...
 

Static Public Member Functions

static const TypeInfoType ()
 
- Static Public Member Functions inherited from Field
static const TypeInfoType ()
 

Member Function Documentation

◆ get_FieldName()

System::String Aspose::Words::Fields::FieldMergeField::get_FieldName ( )

Gets the name of a data field.

◆ get_FieldNameNoPrefix()

System::String Aspose::Words::Fields::FieldMergeField::get_FieldNameNoPrefix ( ) const

Returns just the name of the data field. Any prefix is stripped to the prefix property.

◆ get_IsMapped()

bool Aspose::Words::Fields::FieldMergeField::get_IsMapped ( )

Gets whether this field is a mapped field.

◆ get_IsVerticalFormatting()

bool Aspose::Words::Fields::FieldMergeField::get_IsVerticalFormatting ( )

Gets whether to enable character conversion for vertical formatting.

◆ get_TextAfter()

System::String Aspose::Words::Fields::FieldMergeField::get_TextAfter ( )

Gets the text to be inserted after the field if the field is not blank.

◆ get_TextBefore()

System::String Aspose::Words::Fields::FieldMergeField::get_TextBefore ( )

Gets the text to be inserted before the field if the field is not blank.

◆ get_Type()

Aspose::Words::Fields::FieldType Aspose::Words::Fields::FieldMergeField::get_Type ( )
overridevirtual

Gets the Microsoft Word field type.

Reimplemented from Aspose::Words::Fields::Field.

◆ GetSwitchType()

Aspose::Words::Fields::FieldSwitchType Aspose::Words::Fields::FieldMergeField::GetSwitchType ( System::String  switchName)
override

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Fields::FieldMergeField::GetType ( ) const
overridevirtual

Reimplemented from Aspose::Words::Fields::Field.

◆ Is()

virtual bool Aspose::Words::Fields::FieldMergeField::Is ( const System::TypeInfo target) const
overridevirtual

Reimplemented from Aspose::Words::Fields::Field.

◆ set_FieldName()

void Aspose::Words::Fields::FieldMergeField::set_FieldName ( const System::String value)

Sets the name of a data field.

◆ set_IsMapped()

void Aspose::Words::Fields::FieldMergeField::set_IsMapped ( bool  value)

Sets whether this field is a mapped field.

◆ set_IsVerticalFormatting()

void Aspose::Words::Fields::FieldMergeField::set_IsVerticalFormatting ( bool  value)

Sets whether to enable character conversion for vertical formatting.

◆ set_TextAfter()

void Aspose::Words::Fields::FieldMergeField::set_TextAfter ( const System::String value)

Sets the text to be inserted after the field if the field is not blank.

◆ set_TextBefore()

void Aspose::Words::Fields::FieldMergeField::set_TextBefore ( const System::String value)

Sets the text to be inserted before the field if the field is not blank.

◆ Type()

static const System::TypeInfo& Aspose::Words::Fields::FieldMergeField::Type ( )
static