Практическое руководство. Создание смарт-тегов с настраиваемыми распознавателями в Word и .NET Framework 4
В проектах Word, ориентированных на .NET Framework 4, можно контролировать, как Word распознает смарт-теги в документах, реализовав интерфейс ISmartTagExtension.
Чтобы выполнить смарт-тег, конечным пользователям должно быть предоставлено разрешение на выполнение смарт-тегов в приложениях Word или Excel. Дополнительные сведения см. в разделе Практическое руководство. Разрешение смарт-тегов в Word и Excel.
Применение. Сведения этого раздела применяются к проектам уровня документа и уровня приложения для Word 2007. Дополнительные сведения см. в разделе Доступность функций по типам приложений Office и проектов.
Добавление смарт-тега с настраиваемым распознавателем в документ Word
Создайте проект уровня документа или уровня приложения для Word 2007. Дополнительные сведения см. в разделе Практическое руководство. Создание проектов Office в Visual Studio.
Добавьте ссылку на сборку Microsoft.Office.Interop.SmartTag (версия 12.0.0.0) на вкладке .NET диалогового окна Добавить ссылку.
Добавьте в проект файл класса и создайте класс, реализующий интерфейс ISmartTagExtension.
В новом классе создайте объект SmartTag, представляющий смарт-тег, и один или несколько объектов Action, представляющих действия смарт-тегов. Создайте эти объекты с помощью методов Globals.Factory.CreateSmartTag и Globals.Factory.CreateAction.
Реализуйте метод Recognize и напишите собственное поведение настраиваемого распознавателя.
Чтобы приложение Word распознавало смарт-тег, ваша реализация должна вызывать метод PersistTag параметра context.
Реализуйте свойство ExtensionBase, чтобы вернуть объект SmartTag.
Напишите для созданных действий обработчики событий для события Click и, при необходимости, события BeforeCaptionShow.
В файле кода проекта документа следует добавить экземпляр смарт-тега в свойство VstoSmartTags класса ThisDocument (для проектов уровня документа) или в свойство VstoSmartTags класса ThisAddIn (для проекта уровня приложения).
Пример
В приведенном ниже примере кода показано, как создать в документе Word настраиваемый смарт-тег. В этом примере для распознавания выражений sales и organization реализуется метод Recognize. Метод Recognize добавляет пару "ключ-значение" в коллекцию ключевых свойств смарт-тега. Затем метод вызывает метод PersistTag для распознавания смарт-тега и для сохранения свойства нового смарт-тега.
Чтобы протестировать пример, введите слова продажи и организация в разные места документа, а затем попытайтесь выполнить действия смарт-тега. Одно действие выводит значение соответствующего свойства для распознанного термина, а другое — пространство имен и заголовок смарт-тега.
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; }
}
}
}
Компиляция кода
Добавьте в проекте ссылку на Microsoft Smart Tags 2.0 Type Library из вкладки COM диалогового окна Добавление ссылки. Проверьте, чтобы свойство Копировать локально ссылки имело значение false. Если свойству присвоено значение true, это значит, что ссылка указывает на неверную основную сборку взаимодействия; в этом случае необходимо установить сборку с установочного носителя Microsoft Office. Дополнительные сведения см. в разделе Практическое руководство. Установка основных сборок взаимодействия Microsoft Office.
Поместите пример кода в файл нового класса с именем CustomSmartTag.
В C# измените пространство имен, чтобы оно соответствовало имени проекта.
Добавьте операторы Imports (в Visual Basic) или using (в C#) для пространств имен Microsoft.Office.Tools.Word и Microsoft.Office.Interop.SmartTag в начало файла класса.
В обработчике событий проекта ThisDocument_Startup или ThisAddIn_Startup добавьте следующий код. Этот код добавляет в документ настраиваемый смарт-тег.
Me.VstoSmartTags.Add(New CustomSmartTag().Base)this.VstoSmartTags.Add(new CustomSmartTag().Base);
Безопасность
Чтобы смарт-тег работал, в приложении Word необходимо включить поддержку смарт-тегов. Дополнительные сведения см. в разделе Практическое руководство. Разрешение смарт-тегов в Word и Excel.
См. также
Задачи
Практическое руководство. Разрешение смарт-тегов в Word и Excel
Практическое руководство. Добавление смарт-тегов в документы Word
Практическое руководство. Добавление смарт-тегов в книги Excel
Пошаговое руководство. Создание смарт-тега с помощью настройки уровня документа
Пошаговое руководство. Создание смарт-тега с помощью надстройки уровня приложения