GlossaryDocument

GlossaryDocument class

Представляет корневой элемент документа глоссария в документе Word. Документ глоссария представляет собой хранилище для автотекста, записей автозамены и стандартных блоков.

Чтобы узнать больше, посетитеОбъектная модель документа Aspose.Words (DOM) статья документации.

public class GlossaryDocument : DocumentBase

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

ИмяОписание
GlossaryDocument()Конструктор по умолчанию.

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

ИмяОписание
BackgroundShape { get; set; }Получает или задает форму фона документа. Возможнонулевой .
BuildingBlocks { get; }Возвращает типизированную коллекцию, которая представляет все стандартные блоки в документе глоссария.
Count { get; }Получает количество непосредственных дочерних элементов этого узла.
CustomNodeId { get; set; }Указывает пользовательский идентификатор узла.
override Document { get; }Получает этот экземпляр.
FirstBuildingBlock { get; }Получает первый стандартный блок в документе глоссария.
FirstChild { get; }Получает первого дочернего элемента узла.
FontInfos { get; }Предоставляет доступ к свойствам шрифтов, используемых в этом документе.
HasChildNodes { get; }Возвращаетистинный если у этого узла есть дочерние узлы.
override IsComposite { get; }Возвращаетистинный поскольку этот узел может иметь дочерние узлы.
LastBuildingBlock { get; }Получает последний стандартный блок в документе глоссария.
LastChild { get; }Получает последнего дочернего узла узла.
Lists { get; }Предоставляет доступ к форматированию списка, используемому в документе.
NextSibling { get; }Получает узел, следующий сразу за этим узлом.
NodeChangingCallback { get; set; }Вызывается, когда узел вставляется или удаляется в документе.
override NodeType { get; }ВозвращаетGlossaryDocument значение.
PageColor { get; set; }Получает или задает цвет страницы документа. Это свойство представляет собой более простую версиюBackgroundShape .
ParentNode { get; }Получает непосредственного родителя этого узла.
PreviousSibling { get; }Получает узел, непосредственно предшествующий этому узлу.
Range { get; }ВозвращаетRange объект, представляющий часть документа, содержащуюся в этом узле.
ResourceLoadingCallback { get; set; }Позволяет контролировать загрузку внешних ресурсов.
Styles { get; }Возвращает коллекцию стилей, определенных в документе.
WarningCallback { get; set; }Вызывается во время различных процедур обработки документов при обнаружении проблемы, которая может привести к потере данных или точности форматирования.

Методы

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

Примечания

Некоторые документы, обычно шаблоны, могут содержать автотекст, записи автозамены и/или стандартные блоки (также известные какзаписи в глоссарии документов ,части документа илистроительные блоки).

Чтобы получить доступ к стандартным блокам, вам необходимо загрузить документ вDocument объект. Строительные блоки будут доступны черезGlossaryDocument свойство.

GlossaryDocument может содержать любое количествоBuildingBlock объекты. КаждыйBuildingBlock представляет собой одну часть документа.

СоответствуетглоссарийДокумент иdocParts элементы в OOXML.

Примеры

Показывает способы доступа к строительным блокам в документе глоссария.

public void GlossaryDocument()
{
    Document doc = new Document();
    GlossaryDocument glossaryDoc = new GlossaryDocument();

    glossaryDoc.AppendChild(new BuildingBlock(glossaryDoc) { Name = "Block 1" });
    glossaryDoc.AppendChild(new BuildingBlock(glossaryDoc) { Name = "Block 2" });
    glossaryDoc.AppendChild(new BuildingBlock(glossaryDoc) { Name = "Block 3" });
    glossaryDoc.AppendChild(new BuildingBlock(glossaryDoc) { Name = "Block 4" });
    glossaryDoc.AppendChild(new BuildingBlock(glossaryDoc) { Name = "Block 5" });

    Assert.AreEqual(5, glossaryDoc.BuildingBlocks.Count);

    doc.GlossaryDocument = glossaryDoc;

    // Существуют различные способы доступа к строительным блокам.
    // 1 — Получить первый/последний стандартный блок в коллекции:
    Assert.AreEqual("Block 1", glossaryDoc.FirstBuildingBlock.Name);
    Assert.AreEqual("Block 5", glossaryDoc.LastBuildingBlock.Name);

    // 2 — Получить строительный блок по индексу:
    Assert.AreEqual("Block 2", glossaryDoc.BuildingBlocks[1].Name);
    Assert.AreEqual("Block 3", glossaryDoc.BuildingBlocks.ToArray()[2].Name);

    // 3 — Получить первый строительный блок, соответствующий галерее, имени и категории:
    Assert.AreEqual("Block 4", 
        glossaryDoc.GetBuildingBlock(BuildingBlockGallery.All, "(Empty Category)", "Block 4").Name);

    // Мы сделаем это с помощью специального посетителя,
    // который придаст каждому BuildingBlock в GlossaryDocument уникальный GUID
    GlossaryDocVisitor visitor = new GlossaryDocVisitor();
    glossaryDoc.Accept(visitor);
    Console.WriteLine(visitor.GetText());

    // В Microsoft Word мы можем получить доступ к строительным блокам через «Вставка» -> «Быстрые детали» -> «Организатор строительных блоков».
    doc.Save(ArtifactsDir + "BuildingBlocks.GlossaryDocument.dotx"); 
}

/// <summary>
/// Дает каждому строительному блоку в посещенном документе глоссария уникальный GUID.
/// Сохраняет пары блоков построения GUID в словаре.
/// </summary>
public class GlossaryDocVisitor : DocumentVisitor
{
    public GlossaryDocVisitor()
    {
        mBlocksByGuid = new Dictionary<Guid, BuildingBlock>();
        mBuilder = new StringBuilder();
    }

    public string GetText()
    {
        return mBuilder.ToString();
    }

    public Dictionary<Guid, BuildingBlock> GetDictionary()
    {
        return mBlocksByGuid;
    }

    public override VisitorAction VisitGlossaryDocumentStart(GlossaryDocument glossary)
    {
        mBuilder.AppendLine("Glossary document found!");
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitGlossaryDocumentEnd(GlossaryDocument glossary)
    {
        mBuilder.AppendLine("Reached end of glossary!");
        mBuilder.AppendLine("BuildingBlocks found: " + mBlocksByGuid.Count);
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitBuildingBlockStart(BuildingBlock block)
    {
        block.Guid = Guid.NewGuid();
        mBlocksByGuid.Add(block.Guid, block);
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitBuildingBlockEnd(BuildingBlock block)
    {
        mBuilder.AppendLine("\tVisited block \"" + block.Name + "\"");
        mBuilder.AppendLine("\t Type: " + block.Type);
        mBuilder.AppendLine("\t Gallery: " + block.Gallery);
        mBuilder.AppendLine("\t Behavior: " + block.Behavior);
        mBuilder.AppendLine("\t Description: " + block.Description);

        return VisitorAction.Continue;
    }

    private readonly Dictionary<Guid, BuildingBlock> mBlocksByGuid;
    private readonly StringBuilder mBuilder;
}

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