This documentation is archived and is not being maintained.

BeforeCaptionShowEventHandler Delegate

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

Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel (in microsoft.office.tools.excel.dll)

public delegate void BeforeCaptionShowEventHandler (
	Object sender,
	ActionEventArgs e
)

Parameters

sender

The source of the event.

e

An ActionEventArgs that contains the event data.

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.

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

private Microsoft.Office.Tools.Excel.Action DisplayAddress;

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

    // Specify a term and an expression to recognize.
    SmartTagDemo.Terms.Add("sale");
    SmartTagDemo.Expressions.Add(
        new System.Text.RegularExpressions.Regex(
        @"[I|i]ssue\s\d{5,6}"));

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

    // Add the action to the smart tag.
    SmartTagDemo.Actions = new
        Microsoft.Office.Tools.Excel.Action[] { 
        DisplayAddress };

    // Add the smart tag to the workbook.
    this.VstoSmartTags.Add(SmartTagDemo);

    DisplayAddress.BeforeCaptionShow += new 
        Microsoft.Office.Tools.Excel.BeforeCaptionShowEventHandler(
        DisplayAddress_BeforeCaptionShow);

    DisplayAddress.Click += new 
        Microsoft.Office.Tools.Excel.ActionClickEventHandler(
        DisplayAddress_Click);
}

Show: