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.

Allows a macro or command to be run.

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

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.

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.

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.

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.

Parameters:

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

Throws:

java.lang.Exception