Gewusst wie: Erstellen von Smarttags mit benutzerdefinierten Erkennungen in Excel und .NET Framework 3.5

Artikel
08/10/2011

In Excel-Projekten, die auf .NET Framework 3.5 ausgerichtet sind, können Sie durch Ableiten von der Microsoft.Office.Tools.Excel.SmartTag-Klasse und Überschreiben der Recognize-Methode steuern, wie Smarttags in Dokumenten von Excel erkannt werden.

Wenn Endbenutzer ein Smarttag ausführen möchten, müssen Smarttags aktiviert sein. Weitere Informationen finden Sie unter Gewusst wie: Aktivieren von Smarttags in Word und Excel.

Betrifft: Die Informationen in diesem Thema betreffen Projekte auf Dokument- und auf Anwendungsebene für Excel 2007. Weitere Informationen finden Sie unter Verfügbare Funktionen nach Office-Anwendung und Projekttyp.

So fügen Sie einer Excel-Arbeitsmappe ein Smarttag mit einer benutzerdefinierten Erkennung hinzu

Erstellen Sie ein neues Projekt für Excel 2007 auf Dokumentebene oder auf Anwendungsebene. Weitere Informationen finden Sie unter Gewusst wie: Erstellen von Office-Projekten in Visual Studio.
Fügen Sie auf der Registerkarte .NET des Dialogfelds Verweis hinzufügen einen Verweis auf die Microsoft.Office.Interop.SmartTag-Assembly (Version 12.0.0.0) hinzu.
Fügen Sie dem Projekt eine Klassendatei hinzu, und erstellen Sie eine Klasse, die von Microsoft.Office.Tools.Excel.SmartTag erbt.
Erstellen Sie in der neuen Klasse die Aktionen für die Smarttags. Aktionen sind Elemente, die im Smarttagmenü angezeigt werden. Erstellen Sie Aktionen, indem Sie der Actions-Auflistung der Klasse Instanzen des Action-Typs hinzufügen.
Überschreiben Sie die SmartTagBase.Recognize-Methode, um ein eigenes benutzerdefiniertes Erkennungsverhalten zu implementieren.

Durch Überschreiben der Recognize-Methode muss die Microsoft.Office.Tools.Excel.SmartTag.PersistTag-Methode aufgerufen werden, damit das Smarttag von Excel erkannt wird.
Erstellen Sie Ereignishandler, um auf das Click-Ereignis und optional auf das BeforeCaptionShow-Ereignis der erstellten Aktionen zu reagieren.
Fügen Sie in der Codedatei für die Projektarbeitsmappe die Smarttag-Instanz der VstoSmartTags-Eigenschaft der ThisWorkbook-Klasse (für ein Projekt auf Dokumentebene) oder der VstoSmartTags-Eigenschaft der ThisAddIn-Klasse (für ein Projekt auf Anwendungsebene) hinzu.

Beispiel

Das folgende Codebeispiel zeigt, wie ein benutzerdefiniertes Smarttag in einer Excel-Arbeitsmappe erstellt wird. In dem Beispiel wird die Recognize-Methode so überschrieben, dass die Begriffe sales und organization erkannt werden. Die Recognize-Methode fügt der Auflistung von Schlüsseleigenschaften ein Schlüssel-Wert-Paar für das Smarttag hinzu. Anschließend ruft die Methode die PersistTag -Methode auf, um das Smarttag zu erkennen und die neue Smarttageigenschaft zu speichern.

Testen Sie das Beispiel, indem Sie die Wörter sales und organization in verschiedenen Zellen der Arbeitsmappe eingeben und anschließend die Smarttagaktionen ausprobieren. Die eine Aktion zeigt den korrespondierenden Eigenschaftswert für den Begriff an. Die andere Aktion zeigt den Namespace und die Beschriftung des Smarttags an.

Imports Microsoft.Office.Tools.Excel
Imports Microsoft.Office.Interop.SmartTag

Public Class CustomSmartTag
    Inherits SmartTag

    ' Declare Actions for this SmartTag
    WithEvents Action1 As New Action("Display property value")
    WithEvents Action2 As New Action("Display smart tag details")

    Public Sub New()
        MyBase.New("https://www.contoso.com/Demo#DemoSmartTag", _
            "Custom Smart Tag")
        Me.Terms.AddRange(New String() {"sales", "organization"})
        Actions = New Action() {Action1, Action2}
    End Sub

    Protected Overrides Sub Recognize(ByVal text As String, _
        ByVal site As ISmartTagRecognizerSite, _
        ByVal tokenList As ISmartTagTokenList)

        ' Determine whether each smart tag term exists in 
        ' the document text.
        Dim Term As String
        For Each Term In Me.Terms

            ' Search the cell text for the first instance of 
            ' the current smart tag term.
            Dim index As Integer = Me.CellText.IndexOf(Term, 0)

            If (index >= 0) Then

                ' Create a smart tag token and a property bag for the 
                ' recognized term.
                Dim propertyBag As ISmartTagProperties = _
                    site.GetNewPropertyBag()

                ' Write a new property value.
                Dim key As String = "Key1"
                propertyBag.Write(key, DateTime.Now)

                ' Attach the smart tag to the term in the document
                Me.PersistTag(propertyBag)

                ' This implementation only finds the first instance
                ' of a smart tag term in the cell. 
                Exit For
            End If
        Next
    End Sub

    ' This action displays the property value for the term.
    Private Sub Action1_Click(ByVal sender As Object, _
        ByVal e As ActionEventArgs) Handles Action1.Click

        Dim propertyBag As ISmartTagProperties = e.Properties
        Dim key As String = "Key1"
        MsgBox("The corresponding value of " & _
            key & " is: " & propertyBag.Read(key))
    End Sub

    ' This action displays smart tag details.
    Private Sub Action2_Click(ByVal sender As Object, _
        ByVal e As ActionEventArgs) Handles Action2.Click

        MsgBox("The current smart tag caption is '" & _
            Me.Caption & "'. The current smart tag type is '" & _
            Me.SmartTagType & "'.")
    End Sub
End Class

using System;
using System.Windows.Forms;
using Microsoft.Office.Tools.Excel;
using Microsoft.Office.Interop.SmartTag;

    public class CustomSmartTag : SmartTag {

        // Declare Actions for this SmartTag
        Microsoft.Office.Tools.Excel.Action Action1 =
            new Microsoft.Office.Tools.Excel.Action("Display property value");
        Microsoft.Office.Tools.Excel.Action Action2 =
            new Microsoft.Office.Tools.Excel.Action("Display smart tag details");

        public CustomSmartTag() : base(
            "https://www.contoso.com/Demo#DemoSmartTag", 
            "Custom Smart Tag")
        {
            this.Terms.AddRange(new string[] { 
                "sales", "organization" });
            Actions = new Microsoft.Office.Tools.Excel.Action[] { Action1, Action2 };
            Action1.Click +=
                new ActionClickEventHandler(Action1_Click);
            Action2.Click += 
                new ActionClickEventHandler(Action2_Click);
        }

        protected override void Recognize(string text, 
            ISmartTagRecognizerSite site, ISmartTagTokenList tokenList)
        {
            // Determine whether each smart tag term exists in 
            // the document text.
            foreach (string term in this.Terms)
            {
                // Search the cell text for the first instance of 
                // the current smart tag term.
                int index = this.CellText.IndexOf(term, 0);

                if (index >= 0)
                {
                    // Create a smart tag token and a property bag for the 
                    // recognized term.
                    ISmartTagProperties propertyBag = 
                        site.GetNewPropertyBag();

                    // Write a new property value.                 
                    string key = "Key1";
                    propertyBag.Write(key, DateTime.Now.ToString());

                    // Attach the smart tag to the term in the document
                    this.PersistTag(propertyBag);

                    // This implementation only finds the first instance
                    // of a smart tag term in the cell. 
                    break;
                }
            }
        }

        // This action displays the property value for the term.
        private void Action1_Click(object sender, ActionEventArgs e)
        {
            ISmartTagProperties propertyBag = e.Properties;
            string key = "Key1";
            MessageBox.Show("The corresponding value of " + key +
                " is: " + propertyBag.get_Read(key));
        }

        // This action displays smart tag details.
        private void Action2_Click(object sender, ActionEventArgs e)
        {
            MessageBox.Show("The current smart tag caption is '" + 
                this.Caption + "'. The current smart tag type is '" + 
                this.SmartTagType + "'.");
        }
    }

Kompilieren des Codes

Fügen Sie im Projekt im Dialogfeld Verweis hinzufügen auf der Registerkarte COM einen Verweis auf die Microsoft Smart Tags 2.0-Typbibliothek hinzu. Stellen Sie sicher, dass die Lokale Kopie-Eigenschaft des Verweises false ist. Wenn die Eigenschaft true ist, zeigt der Verweis nicht auf die richtige primäre Interopassembly, und Sie müssen die Assembly vom Microsoft Office-Installationsmedium installieren. Weitere Informationen finden Sie unter Gewusst wie: Installieren von primären Interopassemblys für Office.
Fügen Sie den Beispielcode in eine neue Klassendatei mit dem Namen CustomSmartTag ein.
Ändern Sie in C# den Namespace, sodass er dem Projektnamen entspricht.
Fügen Sie am Anfang der Klassendatei Imports-Anweisungen (in Visual Basic) bzw. using-Anweisungen (in C#) für den Microsoft.Office.Tools.Excel-Namespace und den Microsoft.Office.Interop.SmartTag-Namespace ein.
Fügen Sie dem ThisWorkbook_Startup-Ereignishandler oder dem ThisAddIn_Startup-Ereignishandler in Ihrem Projekt den folgenden Code hinzu. Dieser Code fügt der Arbeitsmappe das benutzerdefinierte Smarttag hinzu.
```
Me.VstoSmartTags.Add(New CustomSmartTag())
```
```
this.VstoSmartTags.Add(new CustomSmartTag());
```

Sicherheit

Sie müssen Smarttags in Excel aktivieren. Standardmäßig werden Smarttags nicht aktiviert. Weitere Informationen finden Sie unter Gewusst wie: Aktivieren von Smarttags in Word und Excel.

Siehe auch

Gewusst wie: Erstellen von Smarttags mit benutzerdefinierten Erkennungen in Excel und .NET Framework 3.5

So fügen Sie einer Excel-Arbeitsmappe ein Smarttag mit einer benutzerdefinierten Erkennung hinzu

Beispiel

Kompilieren des Codes

Sicherheit

Siehe auch

Aufgaben

Konzepte

Weitere Ressourcen

Zusätzliche Ressourcen