Практическое руководство. Создание в приложении Word смарт-тегов с настраиваемыми распознавателями
Обновлен: Июль 2008
Применение |
|---|
Сведения в данном разделе относятся только к указанным проектам Visual Studio Tools for Office и версиям приложений Microsoft Office. Проекты уровня документа
Проекты уровня приложения
Дополнительные сведения см. в разделе Доступность функций по типам приложений и проектов. |
Чтобы контролировать процесс распознавания приложением Microsoft Office Word смарт-тегов в документах, создайте класс, производный от класса Microsoft.Office.Tools.Word.SmartTag, и переопределите метод Recognize.
Чтобы выполнить смарт-тег, конечным пользователям должно быть предоставлено разрешение на выполнение смарт-тегов в приложениях Word или Excel. Дополнительные сведения см. в разделе Практическое руководство. Разрешение смарт-тегов в Word и Excel.
Добавление смарт-тега с настраиваемым распознавателем в документ Word
Необходимо создать новый проект уровня документа или уровня приложения для Word. Дополнительные сведения см. в разделе Практическое руководство. Создание проектов Visual Studio Tools for Office.
.gif "Примечание")
Примечание.Чтобы использовать проект уровня приложения необходимо установить Visual Studio 2008 с пакетом обновления 1 (SP 1).
Добавьте ссылку на Microsoft Smart Tags 2.0 Type Library из вкладки COM диалогового окна Добавление ссылки.
Добавьте в проект файл класса и создайте класс, производный от класса Microsoft.Office.Tools.Word.SmartTag.
В новом классе создайте действия для смарт-тегов. Действиями являются элементы меню смарт-тегов. Создайте действия, добавив экземпляры типа Action в коллекцию Actions класса.
Чтобы реализовать собственный способ распознавания, переопределите метод Recognize.
Чтобы приложение Word распознавало смарт-тег, в реализации метода Recognize должен вызываться метод PersistTag.
Напишите для созданных действий обработчик событий для события Click и, при необходимости, события BeforeCaptionShow.
В файле кода проекта документа следует добавить экземпляр смарт-тега в свойство VstoSmartTags класса ThisDocument (для проектов уровня документа) или в свойство VstoSmartTags класса ThisAddIn (для проекта уровня приложения).
Примечание.Если используется проект уровня приложения, созданный до установки пакета обновления 1 (SP 1), следует изменить проект, чтобы создать свойство VstoSmartTags. Дополнительные сведения см. в разделе Практическое руководство. Добавление смарт-тегов уровня приложения в проекты, созданные до версии пакета обновлений 1..
Пример
В приведенном ниже примере кода показано, как создать в документе Word настраиваемый смарт-тег. В этом примере для распознавания выражений sales и organization переопределяется метод Recognize. Метод Recognize добавляет пару "ключ-значение" в коллекцию ключевых свойств смарт-тега. Затем метод вызывает метод PersistTag для распознавания смарт-тега и для сохранения свойства нового смарт-тега.
Чтобы протестировать пример, введите слова продажи и организация в разные места документа, а затем попытайтесь выполнить действия смарт-тега. Одно действие выводит значение соответствующего свойства для распознанного термина, а другое — пространство имен и заголовок смарт-тега.
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 + "'.");
}
}
Компиляция кода
Добавьте в проекте ссылку на 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())this.VstoSmartTags.Add(new CustomSmartTag());
Безопасность
Чтобы смарт-тег работал, в приложении Word необходимо включить поддержку смарт-тегов. Дополнительные сведения см. в разделе Практическое руководство. Разрешение смарт-тегов в Word и Excel.
См. также
Задачи
Практическое руководство. Разрешение смарт-тегов в Word и Excel
Практическое руководство. Добавление смарт-тегов в документы Word
Практическое руководство. Добавление смарт-тегов в книги Excel
Практическое руководство. Создание смарт-тегов с настраиваемыми распознавателями в Excel
Пошаговое руководство. Создание смарт-тега с помощью настройки уровня документа.
Пошаговое руководство. Создание смарт-тега с помощью надстройки уровня приложения
Основные понятия
Журнал изменений
Дата |
Журнал |
Причина |
|---|---|---|
Июль 2008 |
Добавлены новые сведения для надстроек уровня приложения. |
Изменение функции SP1. |