Implements the MACROBUTTON field.

Allows a macro or command to be run.

In Aspose.Words this field can also act as a merge field.

Examples

Shows how to use MACROBUTTON fields to allow us to run a document's macros by clicking.

auto doc = MakeObject<Document>(MyDir + u"Macro.docm");
auto builder = MakeObject<DocumentBuilder>(doc);
 
ASSERT_TRUE(doc->get_HasMacros());
 
// Insert a MACROBUTTON field, and reference one of the document's macros by name in the MacroName property.
auto field = System::DynamicCast<FieldMacroButton>(builder->InsertField(FieldType::FieldMacroButton, true));
field->set_MacroName(u"MyMacro");
field->set_DisplayText(String(u"Double click to run macro: ") + field->get_MacroName());
 
ASSERT_EQ(u" MACROBUTTON  MyMacro Double click to run macro: MyMacro", field->GetFieldCode());
 
// Use the property to reference "ViewZoom200", a macro that ships with Microsoft Word.
// We can find all other macros via View -> Macros (dropdown) -> View Macros.
// In that menu, select "Word Commands" from the "Macros in:" drop down.
// If our document contains a custom macro with the same name as a stock macro,
// our macro will be the one that the MACROBUTTON field runs.
builder->InsertParagraph();
field = System::DynamicCast<FieldMacroButton>(builder->InsertField(FieldType::FieldMacroButton, true));
field->set_MacroName(u"ViewZoom200");
field->set_DisplayText(String(u"Run ") + field->get_MacroName());
 
ASSERT_EQ(u" MACROBUTTON  ViewZoom200 Run ViewZoom200", field->GetFieldCode());
 
// Save the document as a macro-enabled document type.
doc->Save(ArtifactsDir + u"Field.MACROBUTTON.docm");

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

Inheritance diagram for Aspose::Words::Fields::FieldMacroButton:

Public Member Functions
bool	CanWorkAsMergeField () override

String	get_DisplayText ()
	Gets or sets the text to appear as the "button" that is selected to run the macro or command. More...

SharedPtr< FieldEnd >	get_End () override
	Gets the node that represents the field end. More...

String	get_MacroName ()
	Gets or sets the name of the macro or command to run. More...

SharedPtr< FieldSeparator >	get_Separator () override
	Gets the node that represents the field separator. Can be null. More...

SharedPtr< FieldStart >	get_Start () override
	Gets the node that represents the start of the field. More...

String	GetMergeFieldName () override

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

bool	IsMergeValueRequired () override

void	set_DisplayText (String value)
	Setter for get_DisplayText. More...

void	set_MacroName (String value)
	Setter for get_MacroName. More...

Public Member Functions inherited from Field
String	get_DisplayResult ()
	Gets the text that represents the displayed field result. More...

SharedPtr< FieldEnd >	get_End () const
	Gets the node that represents the field end. More...

SharedPtr< FieldEnd >	get_FieldEnd () const
	Gets the node that represents the field end. More...

SharedPtr< FieldStart >	get_FieldStart () const
	Gets the node that represents the start of the field. More...

SharedPtr< FieldFormat >	get_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< FieldSeparator >	get_Separator ()
	Gets the node that represents the field separator. Can be null. More...

SharedPtr< FieldStart >	get_Start () const
	Gets the node that represents the start of the field. More...

virtual FieldType	get_Type ()
	Gets the Microsoft Word field type. 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< Node >	Remove ()
	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 (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 TypeInfo &	Type ()

Static Public Member Functions inherited from Field
static const TypeInfo &	Type ()

Member Function Documentation

◆ CanWorkAsMergeField()

bool Aspose::Words::Fields::FieldMacroButton::CanWorkAsMergeField ( )

override

◆ get_DisplayText()

System::String Aspose::Words::Fields::FieldMacroButton::get_DisplayText ( )

Gets or sets the text to appear as the "button" that is selected to run the macro or command.

Examples

Shows how to use MACROBUTTON fields to allow us to run a document's macros by clicking.

auto doc = MakeObject<Document>(MyDir + u"Macro.docm");
auto builder = MakeObject<DocumentBuilder>(doc);
 
ASSERT_TRUE(doc->get_HasMacros());
 
// Insert a MACROBUTTON field, and reference one of the document's macros by name in the MacroName property.
auto field = System::DynamicCast<FieldMacroButton>(builder->InsertField(FieldType::FieldMacroButton, true));
field->set_MacroName(u"MyMacro");
field->set_DisplayText(String(u"Double click to run macro: ") + field->get_MacroName());
 
ASSERT_EQ(u" MACROBUTTON  MyMacro Double click to run macro: MyMacro", field->GetFieldCode());
 
// Use the property to reference "ViewZoom200", a macro that ships with Microsoft Word.
// We can find all other macros via View -> Macros (dropdown) -> View Macros.
// In that menu, select "Word Commands" from the "Macros in:" drop down.
// If our document contains a custom macro with the same name as a stock macro,
// our macro will be the one that the MACROBUTTON field runs.
builder->InsertParagraph();
field = System::DynamicCast<FieldMacroButton>(builder->InsertField(FieldType::FieldMacroButton, true));
field->set_MacroName(u"ViewZoom200");
field->set_DisplayText(String(u"Run ") + field->get_MacroName());
 
ASSERT_EQ(u" MACROBUTTON  ViewZoom200 Run ViewZoom200", field->GetFieldCode());
 
// Save the document as a macro-enabled document type.
doc->Save(ArtifactsDir + u"Field.MACROBUTTON.docm");

◆ get_End()

System::SharedPtr<Aspose::Words::Fields::FieldEnd> Aspose::Words::Fields::FieldMacroButton::get_End ( )

override

Gets the node that represents the field end.

◆ get_MacroName()

System::String Aspose::Words::Fields::FieldMacroButton::get_MacroName ( )

Gets or sets the name of the macro or command to run.

Examples

Shows how to use MACROBUTTON fields to allow us to run a document's macros by clicking.

auto doc = MakeObject<Document>(MyDir + u"Macro.docm");
auto builder = MakeObject<DocumentBuilder>(doc);
 
ASSERT_TRUE(doc->get_HasMacros());
 
// Insert a MACROBUTTON field, and reference one of the document's macros by name in the MacroName property.
auto field = System::DynamicCast<FieldMacroButton>(builder->InsertField(FieldType::FieldMacroButton, true));
field->set_MacroName(u"MyMacro");
field->set_DisplayText(String(u"Double click to run macro: ") + field->get_MacroName());
 
ASSERT_EQ(u" MACROBUTTON  MyMacro Double click to run macro: MyMacro", field->GetFieldCode());
 
// Use the property to reference "ViewZoom200", a macro that ships with Microsoft Word.
// We can find all other macros via View -> Macros (dropdown) -> View Macros.
// In that menu, select "Word Commands" from the "Macros in:" drop down.
// If our document contains a custom macro with the same name as a stock macro,
// our macro will be the one that the MACROBUTTON field runs.
builder->InsertParagraph();
field = System::DynamicCast<FieldMacroButton>(builder->InsertField(FieldType::FieldMacroButton, true));
field->set_MacroName(u"ViewZoom200");
field->set_DisplayText(String(u"Run ") + field->get_MacroName());
 
ASSERT_EQ(u" MACROBUTTON  ViewZoom200 Run ViewZoom200", field->GetFieldCode());
 
// Save the document as a macro-enabled document type.
doc->Save(ArtifactsDir + u"Field.MACROBUTTON.docm");

◆ get_Separator()

System::SharedPtr<Aspose::Words::Fields::FieldSeparator> Aspose::Words::Fields::FieldMacroButton::get_Separator ( )

override

Gets the node that represents the field separator. Can be null.

◆ get_Start()

System::SharedPtr<Aspose::Words::Fields::FieldStart> Aspose::Words::Fields::FieldMacroButton::get_Start ( )

override

Gets the node that represents the start of the field.

◆ GetMergeFieldName()

System::String Aspose::Words::Fields::FieldMacroButton::GetMergeFieldName ( )

override

◆ GetType()

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

overridevirtual

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

◆ Is()

virtual bool Aspose::Words::Fields::FieldMacroButton::Is ( const System::TypeInfo & target ) const

overridevirtual

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

◆ IsMergeValueRequired()

bool Aspose::Words::Fields::FieldMacroButton::IsMergeValueRequired ( )

override

◆ set_DisplayText()

void Aspose::Words::Fields::FieldMacroButton::set_DisplayText ( System::String value )

Setter for Aspose::Words::Fields::FieldMacroButton::get_DisplayText.

◆ set_MacroName()

void Aspose::Words::Fields::FieldMacroButton::set_MacroName ( System::String value )

Setter for Aspose::Words::Fields::FieldMacroButton::get_MacroName.

◆ Type()

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

static

Public Member Functions

Static Public Member Functions

Member Function Documentation

◆ CanWorkAsMergeField()

◆ get_DisplayText()

◆ get_End()

◆ get_MacroName()

◆ get_Separator()

◆ get_Start()

◆ GetMergeFieldName()

◆ GetType()

◆ Is()

◆ IsMergeValueRequired()

◆ set_DisplayText()

◆ set_MacroName()

◆ Type()