SmartTag

SmartTag class

Этот элемент определяет наличие смарт-тега вокруг одной или нескольких встроенных структур (выступов, изображений, полей и т. д.) внутри абзаца.

Чтобы узнать больше, посетитеСтруктурированные теги документов или контроль содержимого документальная статья.

public class SmartTag : CompositeNode

Конструкторы

Имя	Описание
SmartTag(DocumentBase)	Инициализирует новый экземпляр`SmartTag` класс.

Характеристики

Имя	Описание
Count { get; }	Получает количество непосредственных потомков этого узла.
CustomNodeId { get; set; }	Указывает пользовательский идентификатор узла.
virtual Document { get; }	Получает документ, к которому принадлежит этот узел.
Element { get; set; }	Указывает имя смарт-тега в документе.
FirstChild { get; }	Получает первый дочерний элемент узла.
HasChildNodes { get; }	Возврат`истинный` если у этого узла есть дочерние узлы.
override IsComposite { get; }	Возврат`истинный` так как этот узел может иметь дочерние узлы.
LastChild { get; }	Получает последний дочерний элемент узла.
NextSibling { get; }	Получает узел, следующий сразу за данным узлом.
override NodeType { get; }	ВозвратSmartTag .
ParentNode { get; }	Получает непосредственного родителя этого узла.
PreviousSibling { get; }	Получает узел, непосредственно предшествующий данному узлу.
Properties { get; }	Коллекция свойств смарт-тегов.
Range { get; }	Возвращает`Range`объект, представляющий часть документа, содержащуюся в этом узле.
Uri { get; set; }	Указывает URI пространства имен смарт-тега.

Методы

Имя	Описание
override Accept(DocumentVisitor)	Принимает посетителя.
override AcceptEnd(DocumentVisitor)	Принимает посетителя для посещения конца SmartTag.
override AcceptStart(DocumentVisitor)	Принимает посетителя для посещения начала SmartTag.
AppendChild<T>(T)	Добавляет указанный узел в конец списка дочерних узлов для данного узла.
Clone(bool)	Создает дубликат узла.
CreateNavigator()	Создает навигатор, который можно использовать для перемещения и чтения узлов.
GetAncestor(NodeType)	Получает первого предка указанного`NodeType` .
GetAncestor(Type)	Получает первого предка указанного типа объекта.
GetChild(NodeType, int, bool)	Возвращает N-й дочерний узел, соответствующий указанному типу.
GetChildNodes(NodeType, bool)	Возвращает живую коллекцию дочерних узлов, соответствующих указанному типу.
GetEnumerator()	Обеспечивает поддержку для каждой итерации стиля по дочерним узлам этого узла.
override GetText()	Получает текст этого узла и всех его дочерних узлов.
IndexOf(Node)	Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
InsertAfter<T>(T, Node)	Вставляет указанный узел сразу после указанного ссылочного узла.
InsertBefore<T>(T, Node)	Вставляет указанный узел непосредственно перед указанным ссылочным узлом.
NextPreOrder(Node)	Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
PrependChild<T>(T)	Добавляет указанный узел в начало списка дочерних узлов для данного узла.
PreviousPreOrder(Node)	Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
Remove()	Удаляет себя из родителя.
RemoveAllChildren()	Удаляет все дочерние узлы текущего узла.
RemoveChild<T>(T)	Удаляет указанный дочерний узел.
RemoveSmartTags()	Удаляет все`SmartTag` узлы-потомки текущего узла.
SelectNodes(string)	Выбирает список узлов, соответствующих выражению XPath.
SelectSingleNode(string)	Выбирает первый`Node` что соответствует выражению XPath.
ToString(SaveFormat)	Экспортирует содержимое узла в строку указанного формата.
ToString(SaveOptions)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Примечания

Смарт-теги — это своего рода пользовательская разметка XML. Смарт-теги предоставляют возможность встраивания семантики, определяемой пользователем, в документ с помощью возможности предоставления базового пространства имен/имени для прогона или набора прогонов в документе.

SmartTag может быть ребенкомParagraph или другойSmartTag узел.

Полный список дочерних узлов, которые могут встречаться внутри смарт-тега, состоит из BookmarkStart ,BookmarkEnd , FieldStart ,FieldSeparator ,FieldEnd ,FormField , Comment ,Footnote , Run ,SpecialChar , Shape ,GroupShape , CommentRangeStart , CommentRangeEnd , SmartTag.

Примеры

Показывает, как создавать смарт-теги.

public void Create()
{
    Document doc = new Document();

    // Смарт-тег появляется в документе, в котором Microsoft Word распознает часть текста как некоторую форму данных,
    // например имя, дату или адрес, и преобразует его в гиперссылку, которая отображается подчеркиванием из фиолетовых точек.
    SmartTag smartTag = new SmartTag(doc);

    // Смарт-теги — это составные узлы, содержащие распознанный текст целиком.
    // Добавьте содержимое в этот смарт-тег вручную.
    smartTag.AppendChild(new Run(doc, "May 29, 2019"));

    // Microsoft Word может распознать указанное выше содержимое как дату.
    // Смарт-теги используют свойство «Элемент» для отражения типа содержащихся в них данных.
    smartTag.Element = "date";

    // Некоторые типы смарт-тегов дополнительно обрабатывают свое содержимое в пользовательские свойства XML.
    smartTag.Properties.Add(new CustomXmlProperty("Day", string.Empty, "29"));
    smartTag.Properties.Add(new CustomXmlProperty("Month", string.Empty, "5"));
    smartTag.Properties.Add(new CustomXmlProperty("Year", string.Empty, "2019"));

    // Установите URI смарт-тега на значение по умолчанию.
    smartTag.Uri = "urn:schemas-microsoft-com:office:smarttags";

    doc.FirstSection.Body.FirstParagraph.AppendChild(smartTag);
    doc.FirstSection.Body.FirstParagraph.AppendChild(new Run(doc, " is a date. "));

    // Создайте еще один смарт-тег для биржевого тикера.
    smartTag = new SmartTag(doc);
    smartTag.Element = "stockticker";
    smartTag.Uri = "urn:schemas-microsoft-com:office:smarttags";

    smartTag.AppendChild(new Run(doc, "MSFT"));

    doc.FirstSection.Body.FirstParagraph.AppendChild(smartTag);
    doc.FirstSection.Body.FirstParagraph.AppendChild(new Run(doc, " is a stock ticker."));

    // Распечатаем все смарт-теги в нашем документе с помощью посетителя документа.
    doc.Accept(new SmartTagPrinter());

    // Старые версии Microsoft Word поддерживают смарт-теги.
    doc.Save(ArtifactsDir + "SmartTag.Create.doc");

    // Используйте метод «RemoveSmartTags» для удаления всех смарт-тегов из документа.
    Assert.AreEqual(2, doc.GetChildNodes(NodeType.SmartTag, true).Count);

    doc.RemoveSmartTags();

    Assert.AreEqual(0, doc.GetChildNodes(NodeType.SmartTag, true).Count);
}

/// <summary>
/// Печатает посещённые смарт-теги и их содержимое.
/// </summary>
private class SmartTagPrinter : DocumentVisitor
{
    /// <summary>
    /// Вызывается, когда в документе встречается узел SmartTag.
    /// </summary>
    public override VisitorAction VisitSmartTagStart(SmartTag smartTag)
    {
        Console.WriteLine($"Smart tag type: {smartTag.Element}");
        return VisitorAction.Continue;
    }

    /// <summary>
    /// Вызывается, когда посещение узла SmartTag завершено.
    /// </summary>
    public override VisitorAction VisitSmartTagEnd(SmartTag smartTag)
    {
        Console.WriteLine($"\tContents: \"{smartTag.ToString(SaveFormat.Text)}\"");

        if (smartTag.Properties.Count == 0)
        {
            Console.WriteLine("\tContains no properties");
        }
        else
        {
            Console.Write("\tProperties: ");
            string[] properties = new string[smartTag.Properties.Count];
            int index = 0;

            foreach (CustomXmlProperty cxp in smartTag.Properties)
                properties[index++] = $"\"{cxp.Name}\" = \"{cxp.Value}\"";

            Console.WriteLine(string.Join(", ", properties));
        }

        return VisitorAction.Continue;
    }
}

Смотрите также

class CompositeNode
пространство имен Aspose.Words.Markup
сборка Aspose.Words

SdtType Enum StructuredDocumentTag Class