ApplicationFactory.CreateSmartTag(String, String, ISmartTagExtension) Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Excel

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a SmartTag object that represents a smart tag on a worksheet. 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 Microsoft.Office.Tools.Excel.SmartTag CreateSmartTag (string smartTagType, string caption, Microsoft.Office.Tools.Excel.ISmartTagExtension extension = default);

abstract member CreateSmartTag : string * string * Microsoft.Office.Tools.Excel.ISmartTagExtension -> Microsoft.Office.Tools.Excel.SmartTag

Public Function CreateSmartTag (smartTagType As String, caption As String, Optional extension As ISmartTagExtension = Nothing) As SmartTag

Parameters

smartTagType: String

A unique identifier for the smart tag, composed of a namespace URI and a tag type name separated by a number sign (#).

caption: String

The name of the smart tag, which is displayed on the smart tag menu.

extension: ISmartTagExtension

Optional. An extension object that defines a custom recognizer for the smart tag.

Returns

SmartTag

The new smart tag.

Exceptions

ArgumentException

smartTagType or caption is either null or empty, or smartTagType is not valid.

Examples

The following code example demonstrates how to create a smart tag and an action in an Excel add-in project. To use this example, run the code from the ThisAddIn class.

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

    private void AddSmartTag()
    {
        Microsoft.Office.Tools.Excel.SmartTag smartTagDemo =
            Globals.Factory.CreateSmartTag(
                "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}"));

        displayAddress = Globals.Factory.CreateAction("To be replaced");


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

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

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

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

WithEvents displayAddress As Microsoft.Office.Tools.Excel.Action

Private Sub AddSmartTag()

    Dim smartTagDemo As Microsoft.Office.Tools.Excel.SmartTag = _
        Globals.Factory.CreateSmartTag(
        "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}"))

    displayAddress = Globals.Factory.CreateAction("To be replaced")

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

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

Remarks

An example of a valid string for the smartTagType parameter is http://smarttags.contoso.com#TagName. A well-formed smart tag type string does not contain white space, and it starts with a letter (a-z, A-Z), an underscore (_), or a colon (:).

Applies to