SmartTagCollection Class (2007 System)

Represents a collection of smart tags in a Visual Studio Tools for Office solution.

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

Syntax

'Declaration
<PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
Public Class SmartTagCollection _
    Inherits CollectionBase _
    Implements ISupportInitialize, IDisposable

'Usage
Dim instance As SmartTagCollection

[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public class SmartTagCollection : CollectionBase, 
    ISupportInitialize, IDisposable

[PermissionSetAttribute(SecurityAction::Demand, Name = L"FullTrust")]
public ref class SmartTagCollection : public CollectionBase, 
    ISupportInitialize, IDisposable

public class SmartTagCollection extends CollectionBase implements ISupportInitialize, IDisposable

Remarks

When you create a smart tag in a Visual Studio Tools for Office solution, you add a SmartTagBase object to the Workbook.VstoSmartTags or Document.VstoSmartTags properties. These properties have the type SmartTagCollection.

For more information about smart tags in Visual Studio Tools for Office solutions, see Smart Tags Overview.

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 Workbook.VstoSmartTags property. This code example is part of a larger example provided for the Microsoft.Office.Tools.Excel.Action class.

This example is for a document-level customization.

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

Private Sub AddSmartTag()
    Dim smartTagDemo As 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. 
    Me.VstoSmartTags.Add(smartTagDemo)
End Sub

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. 
    this.VstoSmartTags.Add(smartTagDemo);

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

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

Inheritance Hierarchy

System.Object
  System.Collections.CollectionBase
    Microsoft.Office.Tools.SmartTagCollection

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

SmartTagCollection Members

Microsoft.Office.Tools Namespace

Other Resources

Smart Tags Overview