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