Share via

ActionBase.Caption Property

  • Reference

Definition

Namespace:
Microsoft.Office.Tools
Assemblies:
Microsoft.Office.Tools.Common.dll, Microsoft.Office.Tools.Excel.v4.0.Utilities.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

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

public:
 property System::String ^ Caption { System::String ^ get(); void set(System::String ^ value); };
public string Caption { get; set; }
member this.Caption : string with get, set
Public Property Caption As String

Property Value

String

The name of the action.

Examples

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;
    }
}

Private Sub DisplayAddress_BeforeCaptionShow(ByVal sender As Object, _
    ByVal e As Microsoft.Office.Tools.Excel.ActionEventArgs) _
    Handles DisplayAddress.BeforeCaptionShow

    Dim clickedAction As Microsoft.Office.Tools.Excel.Action = _
        TryCast(sender, Microsoft.Office.Tools.Excel.Action)

    If clickedAction IsNot Nothing Then
        clickedAction.Caption = "Display the address of " & e.Text
    End If
End Sub

Applies to