BeforeCaptionShowEventHandler Delegate (2007 System)

Represents the method that will handle the BeforeCaptionShow event of an Action.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word.v9.0 (in Microsoft.Office.Tools.Word.v9.0.dll)

Syntax

'Declaration
Public Delegate Sub BeforeCaptionShowEventHandler ( _
    sender As Object, _
    e As ActionEventArgs _
)

'Usage
Dim instance As New BeforeCaptionShowEventHandler(AddressOf HandlerMethod)

public delegate void BeforeCaptionShowEventHandler(
    Object sender,
    ActionEventArgs e
)

public delegate void BeforeCaptionShowEventHandler(
    Object^ sender, 
    ActionEventArgs^ e
)

JScript does not support delegates.

Parameters

• sender
  Type: System.Object

  The source of the event.

• e
  Type: Microsoft.Office.Tools.Word.ActionEventArgs

  An ActionEventArgs that contains the event data.

Remarks

When you create a BeforeCaptionShowEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about delegates, see Events and Delegates.

Examples

The following code example creates a smart tag that recognizes two terms and offers one action. It then adds event handlers for the BeforeCaptionShow and Click events. To test the code, type the words "term" and "recognize" in the document, and then try the smart tag actions.

This example is for a document-level customization.

Private WithEvents displayAddress As Microsoft.Office.Tools.Word.Action

Private Sub AddSmartTag()
    Dim smartTagDemo As New  _
        Microsoft.Office.Tools.Word.SmartTag( _
        "www.microsoft.com/Demo#DemoSmartTag", _
        "Demonstration Smart Tag")

    ' Specify the terms to recognize.
    smartTagDemo.Terms.Add("term")
    smartTagDemo.Terms.Add("recognize")

    ' Create the action.
    displayAddress = New Microsoft.Office.Tools.Word.Action("To be replaced")

    ' Add the action to the smart tag.
    smartTagDemo.Actions = New Microsoft.Office.Tools.Word.Action() { _
            displayAddress}

    ' Add the smart tag. 
    Me.VstoSmartTags.Add(smartTagDemo)
End Sub

private Microsoft.Office.Tools.Word.Action displayAddress;

private void AddSmartTag()
{
    Microsoft.Office.Tools.Word.SmartTag smartTagDemo =
        new Microsoft.Office.Tools.Word.SmartTag(
        "www.microsoft.com/Demo#DemoSmartTag",
        "Demonstration Smart Tag");

    // Specify the terms to recognize.
    smartTagDemo.Terms.Add("term");
    smartTagDemo.Terms.Add("recognize");

    // Create the action.
    displayAddress = new Microsoft.Office.Tools.Word.Action("To be replaced");

    // Add the action to the smart tag.
    smartTagDemo.Actions = new Microsoft.Office.Tools.Word.Action[] { 
        displayAddress };

    // Add the smart tag. 
    this.VstoSmartTags.Add(smartTagDemo);

    displayAddress.BeforeCaptionShow += new
        Microsoft.Office.Tools.Word.BeforeCaptionShowEventHandler(
        displayAddress_BeforeCaptionShow);

    displayAddress.Click += new
        Microsoft.Office.Tools.Word.ActionClickEventHandler(
        displayAddress_Click);
}

See Also

Reference

Microsoft.Office.Tools.Word Namespace