ActionBase.Caption Property

 

Gets or sets the name of the action, as displayed in the smart tag menu.

This type or member is intended to be used only in projects for the 2007 Microsoft Office system. Smart tags are deprecated in Office 2010.

.

Namespace:   Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

string Caption { get; set; }

Property Value

Type: System.String

The name of the action.

The following code example demonstrates a handler for the BeforeCaptionShow event. The event handler uses the Caption property to add the recognized smart tag term to the menu caption of a smart tag action. This code example is part of a larger example provided for Microsoft.Office.Tools.Excel.Action.

void DisplayAddress_BeforeCaptionShow(object sender, 
    Microsoft.Office.Tools.Excel.ActionEventArgs e)
{
    Microsoft.Office.Tools.Excel.Action clickedAction =
        sender as Microsoft.Office.Tools.Excel.Action;

    if (clickedAction != null)
    {
        clickedAction.Caption = "Display the address of " +
            e.Text;
    }
}
Return to top
Show: