SmartTagCollection.Add(SmartTagBase) Method

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

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.

Adds a smart tag to the end of the SmartTagCollection. 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:
 int Add(Microsoft::Office::Tools::SmartTagBase ^ value);

public int Add (Microsoft.Office.Tools.SmartTagBase value);

abstract member Add : Microsoft.Office.Tools.SmartTagBase -> int

Public Function Add (value As SmartTagBase) As Integer

Parameters

value: SmartTagBase

The smart tag instance to be added.

Returns

Int32

The index of the new smart tag in the SmartTagCollection.

Examples

The following code uses the Add method to add a Microsoft.Office.Tools.Excel.SmartTag to the collection of smart tags exposed by the Microsoft.Office.Tools.Excel.Workbook.VstoSmartTags property. This code example is part of a larger example provided for Microsoft.Office.Tools.Excel.Action.

This example is for a document-level customization.

    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

Applies to

Partager via