Gewusst wie: Erstellen von Smarttags mit benutzerdefinierten Erkennungen in Word

Artikel
04/28/2010

Aktualisiert: Juli 2008

Betrifft
Die Informationen in diesem Thema gelten nur für die angegebenen Projekte und Versionen von Visual Studio Tools for Office von Microsoft Office. Projekte auf Dokumentebene Excel 2003 Excel 2007 Word 2003 Word 2007 Projekte auf Anwendungsebene Excel 2007 Word 2007 Weitere Informationen hierzu finden Sie unter Verfügbare Features nach Anwendung und Projekttyp.

Die Informationen in diesem Thema gelten nur für die angegebenen Projekte und Versionen von Visual Studio Tools for Office von Microsoft Office.

Projekte auf Dokumentebene

Excel 2003
Excel 2007
Word 2003
Word 2007

Projekte auf Anwendungsebene

Excel 2007
Word 2007

Weitere Informationen hierzu finden Sie unter Verfügbare Features nach Anwendung und Projekttyp.

Durch Ableiten von der Microsoft.Office.Tools.Word.SmartTag-Klasse und Überschreiben der Recognize-Methode können Sie steuern, wie Microsoft Office Word Smarttags in Dokumenten erkennt.

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.

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

Erstellen Sie ein neues Projekt für Word auf Dokumentebene oder auf Anwendungsebene. Weitere Informationen finden Sie unter Gewusst wie: Erstellen von Visual Studio Tools for Office-Projekte.

Hinweis:

Um ein Projekt auf Anwendungsebene zu verwenden, müssen Sie Visual Studio 2008 Service Pack 1 (SP1) haben.
Fügen Sie im Dialogfeld Verweis hinzufügen auf der Registerkarte COM einen Verweis auf die Microsoft Smart Tags 2.0-Typbibliothek hinzu.
Fügen Sie dem Projekt eine Klassendatei hinzu, und erstellen Sie eine Klasse, die von Microsoft.Office.Tools.Word.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 Recognize-Methode, um ein eigenes benutzerdefiniertes Erkennungsverhalten zu implementieren.

Die Implementierung von Recognize muss die PersistTag-Methode aufrufen, damit Word das Smarttag erkennt.
Erstellen Sie Ereignishandler, um auf das Click-Ereignis und optional auf das BeforeCaptionShow-Ereignis der erstellten Aktionen zu reagieren.

Hinweis:
Um ein Projekt auf Anwendungsebene zu verwenden, müssen Sie Visual Studio 2008 Service Pack 1 (SP1) haben.

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.

Hinweis:
Wenn Sie ein Projekt auf Anwendungsebene verwenden, das Sie vor der Installation von SP1 erstellt haben, müssen Sie das Projekt ändern, um die VstoSmartTags-Eigenschaft zu generieren. Weitere Informationen hierzu finden Sie unter Gewusst wie: Hinzufügen von Smarttags auf Anwendungsebene in Projekten, die vor SP1 erstellt wurden.

Beispiel

Das folgende Codebeispiel zeigt, wie ein benutzerdefiniertes Smarttag in einem Word-Dokument 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 an verschiedenen Positionen des Dokuments eingeben und anschließend die Smarttagaktionen ausprobieren. Die eine Aktion zeigt den korrespondierenden Eigenschaftenwert für den Begriff an. Die andere Aktion zeigt den Namespace und die Beschriftung des Smarttags an.

Imports Microsoft.Office.Tools.Word
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 text for the current smart tag term.
            Dim index As Integer = Me.ParagraphText.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)

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

                ' Increment the index and then find the next
                ' instance of the smart tag term.
                index += Term.Length
                index = ParagraphText.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 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.Word;
using Microsoft.Office.Interop.SmartTag;

public class CustomSmartTag : Microsoft.Office.Tools.Word.SmartTag
{

    // Declare Actions for this SmartTag
    private Microsoft.Office.Tools.Word.Action Action1 =
        new Microsoft.Office.Tools.Word.Action("Display property value");
    private Microsoft.Office.Tools.Word.Action Action2 =
        new Microsoft.Office.Tools.Word.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.Word.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)
    {
        foreach (string term in this.Terms)
        {
            // Search the text for the current smart tag term.
            int index = this.ParagraphText.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
                this.PersistTag(index, term.Length, propertyBag);

                // Increment the index and then find the next
                // instance of the smart tag term.
                index += term.Length;
                index = ParagraphText.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 '" + 
            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.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())
```
```
this.VstoSmartTags.Add(new CustomSmartTag());
```

Sicherheit

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