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; }	Предоставляет доступ к свойствам шрифтов, используемых в этом документе.
FootnoteSeparators { 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)	Принимает посетителя.
override AcceptEnd(DocumentVisitor)	Принимает посетителя для посещения конца документа Глоссария.
override AcceptStart(DocumentVisitor)	Принимает посетителя для посещения начала документа Глоссария.
AppendChild<T>(T)	Добавляет указанный узел в конец списка дочерних узлов для данного узла.
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<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)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Примечания

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

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

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

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

Примеры

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

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

    BuildingBlock child1 = new BuildingBlock(glossaryDoc) { Name = "Block 1" };
    glossaryDoc.AppendChild(child1);
    BuildingBlock child2 = new BuildingBlock(glossaryDoc) { Name = "Block 2" };
    glossaryDoc.AppendChild(child2);
    BuildingBlock child3 = new BuildingBlock(glossaryDoc) { Name = "Block 3" };
    glossaryDoc.AppendChild(child3);
    BuildingBlock child4 = new BuildingBlock(glossaryDoc) { Name = "Block 4" };
    glossaryDoc.AppendChild(child4);
    BuildingBlock child5 = new BuildingBlock(glossaryDoc) { Name = "Block 5" };
    glossaryDoc.AppendChild(child5);

    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);
    // Посетить только начало документа Глоссарий.
    glossaryDoc.AcceptStart(visitor);
    // Посетите только конец документа Глоссарий.
    glossaryDoc.AcceptEnd(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;
}

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

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

BuildingBlockType Enum