Gewusst wie: Erstellen von Smarttags mit benutzerdefinierten Erkennungen in Word und .NET Framework 4

Artikel
08/10/2011

In Word-Projekten, die auf .NET Framework 4 ausgerichtet sind, können Sie steuern, wie Smarttags in Word-Dokumenten erkannt werden, indem Sie die ISmartTagExtension-Schnittstelle implementieren.

Wenn Endbenutzer ein Smarttag ausführen möchten, müssen Smarttags in Word oder Excel aktiviert sein. Weitere Informationen hierzu 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 Word 2007. Weitere Informationen finden Sie unter Verfügbare Funktionen nach Office-Anwendung und Projekttyp.

So fügen Sie einem Word-Dokument ein Smarttag mit einer benutzerdefinierten Erkennung hinzu

Erstellen Sie ein neues Projekt für Word 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 die ISmartTagExtension-Schnittstelle implementiert.
Erstellen Sie in der neuen Klasse ein SmartTag-Objekt, das das Smarttag darstellt, und erstellen Sie ein oder mehrere Action-Objekte, die die Smarttagaktionen darstellen. Verwenden Sie die Methoden Globals.Factory.CreateSmartTag und Globals.Factory.CreateAction, um diese Objekte zu erstellen.
Implementieren Sie die Recognize-Methode, und schreiben Sie Ihr eigenes benutzerdefiniertes Erkennungsverhalten.

Die Implementierung muss die PersistTag-Methode des context-Parameters aufrufen, damit Word das Smarttag erkennt.
Implementieren Sie die ExtensionBase-Eigenschaft, um zum SmartTag-Objekt zurückzukehren.
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 das Projektdokument die Smarttag-Instanz zur VstoSmartTags-Eigenschaft der ThisDocument-Klasse (für ein Projekt auf Dokumentebene) oder zur VstoSmartTags-Eigenschaft der ThisAddIn-Klasse (für ein Projekt auf Anwendungsebene) hinzu.

Beispiel

Das folgende Codebeispiel zeigt, wie ein benutzerdefiniertes Smarttag in einem Word-Dokument erstellt wird. In dem Beispiel wird die Recognize-Methode so implementiert, 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 an verschiedenen Positionen des Dokuments 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 System
Imports System.Windows.Forms
Imports Microsoft.Office.Interop.SmartTag
Imports Microsoft.Office.Tools.Word

Public Class CustomSmartTag
    Implements ISmartTagExtension
    ' Declare the smart tag.
    Private smartTagDemo As Microsoft.Office.Tools.Word.SmartTag

    ' Declare actions for this smart tag.
    WithEvents Action1 As Microsoft.Office.Tools.Word.Action
    WithEvents Action2 As Microsoft.Office.Tools.Word.Action

    Public Sub New()
        Me.smartTagDemo = Globals.Factory.CreateSmartTag(
            "https://www.contoso.com/Demo#DemoSmartTag", "Custom Smart Tag", Me)

        Action1 = Globals.Factory.CreateAction("Display property value")
        Action2 = Globals.Factory.CreateAction("Display smart tag details")

        smartTagDemo.Terms.AddRange(New String() {"sales", "organization"})
        smartTagDemo.Actions = New Microsoft.Office.Tools.Word.Action() {Action1, Action2}

    End Sub

    Private Sub Recognize(ByVal text As String,
        ByVal site As ISmartTagRecognizerSite,
        ByVal tokenList As ISmartTagTokenList,
        ByVal context As SmartTagRecognizeContext) Implements ISmartTagExtension.Recognize

        For Each term As String In smartTagDemo.Terms
            ' Search the text for the current smart tag term.
            Dim index As Integer = text.IndexOf(term, 0)

            While (index >= 0)
                ' 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.ToString())

                ' Attach the smart tag to the term in the document
                context.PersistTag(index, term.Length, propertyBag)

                ' Increment the index and then find the next instance of the smart tag term.
                index += term.Length
                index = text.IndexOf(term, index)
            End While
        Next
    End Sub

    ' This action displays the property value for the term.
    Private Sub Action1_Click(ByVal sender As Object,
        ByVal e As Microsoft.Office.Tools.Word.ActionEventArgs) Handles Action1.Click
        Dim propertyBag As ISmartTagProperties = e.Properties
        Dim key As String = "Key1"
        MessageBox.Show(("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 Microsoft.Office.Tools.Word.ActionEventArgs) Handles Action2.Click
        MessageBox.Show(("The current smart tag caption is '" &
            smartTagDemo.Caption & "'. The current smart tag type is '") &
            smartTagDemo.SmartTagType & "'.")
    End Sub

    Public ReadOnly Property Base() As Microsoft.Office.Tools.Word.SmartTag
        Get
            Return (smartTagDemo)
        End Get
    End Property

    Public ReadOnly Property ExtensionBase() As Object Implements ISmartTagExtension.ExtensionBase
        Get
            Return (smartTagDemo)
        End Get
    End Property
End Class

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

namespace CustomSmartTagExample
{
    public class CustomSmartTag : ISmartTagExtension
    {
        // Declare the smart tag.
        Microsoft.Office.Tools.Word.SmartTag smartTagDemo;

        // Declare actions for this smart tag.
        private Microsoft.Office.Tools.Word.Action Action1;
        private Microsoft.Office.Tools.Word.Action Action2;

        public CustomSmartTag()
        {
            this.smartTagDemo = Globals.Factory.CreateSmartTag(
                "https://www.contoso.com/Demo#DemoSmartTag", "Custom Smart Tag", this);

            Action1 = Globals.Factory.CreateAction("Display property value");
            Action2 = Globals.Factory.CreateAction("Display smart tag details");

            smartTagDemo.Terms.AddRange(new string[] { "sales", "organization" });
            smartTagDemo.Actions = new Microsoft.Office.Tools.Word.Action[] { Action1, Action2 };

            Action1.Click += new ActionClickEventHandler(Action1_Click);
            Action2.Click += new ActionClickEventHandler(Action2_Click);
        }

        void ISmartTagExtension.Recognize(string text, ISmartTagRecognizerSite site, ISmartTagTokenList tokenList, 
            SmartTagRecognizeContext context)
        {

            foreach (string term in smartTagDemo.Terms)
            {
                // Search the text for the current smart tag term.
                int index = text.IndexOf(term, 0);

                while (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
                    context.PersistTag(index, term.Length, propertyBag);

                    // Increment the index and then find the next instance of the smart tag term.
                    index += term.Length;
                    index = text.IndexOf(term, index);
                }
            }
        }

        // This action displays the property value for the term.
        private void Action1_Click(object sender,
            Microsoft.Office.Tools.Word.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,
            Microsoft.Office.Tools.Word.ActionEventArgs e)
        {
            MessageBox.Show("The current smart tag caption is '" +
                smartTagDemo.Caption + "'. The current smart tag type is '" + smartTagDemo.SmartTagType + "'.");
        }


        public Microsoft.Office.Tools.Word.SmartTag Base
        {
            get { return smartTagDemo; }
        }

        public object ExtensionBase
        {
            get { return smartTagDemo; }
        }

    }
}

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.Word-Namespace und den Microsoft.Office.Interop.SmartTag-Namespace ein.
Fügen Sie dem ThisDocument_Startup-Ereignishandler oder dem ThisAddIn_Startup-Ereignishandler in Ihrem Projekt den folgenden Code hinzu. Dieser Code fügt dem Dokument das benutzerdefinierte Smarttag hinzu.
```
Me.VstoSmartTags.Add(New CustomSmartTag().Base)
```
```
this.VstoSmartTags.Add(new CustomSmartTag().Base);
```

Sicherheit

Um das Smarttag auszuführen, müssen Smarttags in Word aktiviert sein. Weitere Informationen finden Sie unter Gewusst wie: Aktivieren von Smarttags in Word und Excel.

Siehe auch

Freigeben über

Gewusst wie: Erstellen von Smarttags mit benutzerdefinierten Erkennungen in Word und .NET Framework 4

So fügen Sie einem Word-Dokument ein Smarttag mit einer benutzerdefinierten Erkennung hinzu

Beispiel

Kompilieren des Codes

Sicherheit

Siehe auch

Aufgaben

Konzepte

Weitere Ressourcen

Zusätzliche Ressourcen