com.aspose.words

Class FieldMacroButton

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldMacroButton

public class FieldMacroButton
extends Field

Implements the MACROBUTTON field.

To learn more, visit the Working with Fields documentation article.

Remarks:

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.

 
 Document doc = new Document(getMyDir() + "Macro.docm");
 DocumentBuilder builder = new DocumentBuilder(doc);

 Assert.assertTrue(doc.hasMacros());

 // Insert a MACROBUTTON field, and reference one of the document's macros by name in the MacroName property.
 FieldMacroButton field = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
 field.setMacroName("MyMacro");
 field.setDisplayText("Double click to run macro: " + field.getMacroName());

 Assert.assertEquals(" 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 = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
 field.setMacroName("ViewZoom200");
 field.setDisplayText("Run " + field.getMacroName());

 Assert.assertEquals(field.getFieldCode(), " MACROBUTTON  ViewZoom200 Run ViewZoom200");

 // Save the document as a macro-enabled document type.
 doc.save(getArtifactsDir() + "Field.MACROBUTTON.docm");
 
 

Method Summary

Modifier and Type	Method and Description
boolean	canWorkAsMergeField()
java.lang.String	getDisplayText() Gets the text to appear as the "button" that is selected to run the macro or command.
java.lang.String	getMacroName() Gets the name of the macro or command to run.
java.lang.String	getMergeFieldName()
boolean	isMergeValueRequired()
void	setDisplayText(java.lang.String value) Sets the text to appear as the "button" that is selected to run the macro or command.
void	setMacroName(java.lang.String value) Sets the name of the macro or command to run.

Methods inherited from class com.aspose.words.Field

getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMergeFieldName

public java.lang.String getMergeFieldName()

canWorkAsMergeField

public boolean canWorkAsMergeField()

isMergeValueRequired

public boolean isMergeValueRequired()

getMacroName

public java.lang.String getMacroName()

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

 
 Document doc = new Document(getMyDir() + "Macro.docm");
 DocumentBuilder builder = new DocumentBuilder(doc);

 Assert.assertTrue(doc.hasMacros());

 // Insert a MACROBUTTON field, and reference one of the document's macros by name in the MacroName property.
 FieldMacroButton field = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
 field.setMacroName("MyMacro");
 field.setDisplayText("Double click to run macro: " + field.getMacroName());

 Assert.assertEquals(" 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 = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
 field.setMacroName("ViewZoom200");
 field.setDisplayText("Run " + field.getMacroName());

 Assert.assertEquals(field.getFieldCode(), " MACROBUTTON  ViewZoom200 Run ViewZoom200");

 // Save the document as a macro-enabled document type.
 doc.save(getArtifactsDir() + "Field.MACROBUTTON.docm");
 
 

Returns:

The name of the macro or command to run.

setMacroName

public void setMacroName(java.lang.String value)
                  throws java.lang.Exception

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.

 
 Document doc = new Document(getMyDir() + "Macro.docm");
 DocumentBuilder builder = new DocumentBuilder(doc);

 Assert.assertTrue(doc.hasMacros());

 // Insert a MACROBUTTON field, and reference one of the document's macros by name in the MacroName property.
 FieldMacroButton field = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
 field.setMacroName("MyMacro");
 field.setDisplayText("Double click to run macro: " + field.getMacroName());

 Assert.assertEquals(" 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 = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
 field.setMacroName("ViewZoom200");
 field.setDisplayText("Run " + field.getMacroName());

 Assert.assertEquals(field.getFieldCode(), " MACROBUTTON  ViewZoom200 Run ViewZoom200");

 // Save the document as a macro-enabled document type.
 doc.save(getArtifactsDir() + "Field.MACROBUTTON.docm");
 
 

Parameters:

value - The name of the macro or command to run.

Throws:

java.lang.Exception

getDisplayText

public java.lang.String getDisplayText()

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

 
 Document doc = new Document(getMyDir() + "Macro.docm");
 DocumentBuilder builder = new DocumentBuilder(doc);

 Assert.assertTrue(doc.hasMacros());

 // Insert a MACROBUTTON field, and reference one of the document's macros by name in the MacroName property.
 FieldMacroButton field = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
 field.setMacroName("MyMacro");
 field.setDisplayText("Double click to run macro: " + field.getMacroName());

 Assert.assertEquals(" 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 = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
 field.setMacroName("ViewZoom200");
 field.setDisplayText("Run " + field.getMacroName());

 Assert.assertEquals(field.getFieldCode(), " MACROBUTTON  ViewZoom200 Run ViewZoom200");

 // Save the document as a macro-enabled document type.
 doc.save(getArtifactsDir() + "Field.MACROBUTTON.docm");
 
 

Returns:

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

setDisplayText

public void setDisplayText(java.lang.String value)
                    throws java.lang.Exception

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.

 
 Document doc = new Document(getMyDir() + "Macro.docm");
 DocumentBuilder builder = new DocumentBuilder(doc);

 Assert.assertTrue(doc.hasMacros());

 // Insert a MACROBUTTON field, and reference one of the document's macros by name in the MacroName property.
 FieldMacroButton field = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
 field.setMacroName("MyMacro");
 field.setDisplayText("Double click to run macro: " + field.getMacroName());

 Assert.assertEquals(" 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 = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
 field.setMacroName("ViewZoom200");
 field.setDisplayText("Run " + field.getMacroName());

 Assert.assertEquals(field.getFieldCode(), " MACROBUTTON  ViewZoom200 Run ViewZoom200");

 // Save the document as a macro-enabled document type.
 doc.save(getArtifactsDir() + "Field.MACROBUTTON.docm");
 
 

Parameters:

value - The text to appear as the "button" that is selected to run the macro or command.

Throws:

java.lang.Exception