Class BuildingBlock

BuildingBlock class

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

public class BuildingBlock : CompositeNode

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

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

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

Имя	Описание
Behavior { get; set; }	Определяет поведение, которое должно применяться, когда содержимое стандартного блока вставляется в основной документ.
Category { get; set; }	Задает категоризацию второго уровня для стандартного блока.
ChildNodes { get; }	Получает все непосредственные дочерние узлы этого узла.
Count { get; }	Получает количество непосредственных дочерних элементов этого узла.
CustomNodeId { get; set; }	Указывает идентификатор пользовательского узла.
Description { get; set; }	Получает или задает описание, связанное с этим стандартным блоком.
virtual Document { get; }	Получает документ, которому принадлежит этот узел.
FirstChild { get; }	Получает первого потомка узла.
FirstSection { get; }	Получает первый раздел в стандартном блоке.
Gallery { get; set; }	Задает категоризацию первого уровня для стандартного блока в целях классификации или сортировки пользовательского интерфейса.
Guid { get; set; }	Получает или задает идентификатор (128-битный GUID), однозначно идентифицирующий этот строительный блок.
HasChildNodes { get; }	Возвращает true, если у этого узла есть дочерние узлы.
override IsComposite { get; }	Возвращает true, так как этот узел может иметь дочерние узлы.
LastChild { get; }	Получает последний дочерний элемент узла.
LastSection { get; }	Получает последний раздел в строительном блоке.
Name { get; set; }	Получает или задает имя этого стандартного блока.
NextSibling { get; }	Получает узел, следующий сразу за этим узлом.
override NodeType { get; }	ВозвращаетBuildingBlock значение.
ParentNode { get; }	Получает непосредственного родителя этого узла.
PreviousSibling { get; }	Получает узел, непосредственно предшествующий этому узлу.
Range { get; }	Возвращает Диапазон объект, представляющий часть документа, содержащегося в этом узле.
Sections { get; }	Возвращает коллекцию, представляющую все разделы в стандартном блоке.
Type { get; set; }	Указывает тип стандартного блока.

Методы

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

Примечания

BuildingBlock может содержать толькоSection узлы.

BuildingBlock может быть только ребенкомGlossaryDocument.

Вы можете создавать новые стандартные блоки и вставлять их в глоссарий. Вы можете изменять или удалять существующие стандартные блоки. Вы можете копировать или перемещать стандартные блоки между документами. Вы можете вставить содержимое стандартного блока в документ.

Соответствует docPart , docPartPr а также docPartBodyэлементы в OOXML.

Примеры

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

public void CreateAndInsert()
{
    // Глоссарий документа хранит строительные блоки.
    Document doc = new Document();
    GlossaryDocument glossaryDoc = new GlossaryDocument();
    doc.GlossaryDocument = glossaryDoc;

    // Создайте стандартный блок, назовите его, а затем добавьте в глоссарий.
    BuildingBlock block = new BuildingBlock(glossaryDoc)
    {
        Name = "Custom Block"
    };

    glossaryDoc.AppendChild(block);

    // Все новые GUID строительных блоков по умолчанию имеют одно и то же нулевое значение, и мы можем присвоить им новое уникальное значение.
    Assert.AreEqual("00000000-0000-0000-0000-000000000000", block.Guid.ToString());

    block.Guid = Guid.NewGuid();

    // Следующие свойства классифицируют строительные блоки
    // в меню мы можем получить доступ в Microsoft Word через «Вставить» -> "Быстрые детали" -> «Организатор строительных блоков».
    Assert.AreEqual("(Empty Category)", block.Category);
    Assert.AreEqual(BuildingBlockType.None, block.Type);
    Assert.AreEqual(BuildingBlockGallery.All, block.Gallery);
    Assert.AreEqual(BuildingBlockBehavior.Content, block.Behavior);

    // Прежде чем мы сможем добавить этот строительный блок в наш документ, нам нужно дать ему некоторое содержимое,
    // что мы и сделаем с помощью посетителя документа. Этот посетитель также установит категорию, галерею и поведение.
    BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc);
    block.Accept(visitor);

    // Мы можем получить доступ к только что созданному блоку из глоссария.
    BuildingBlock customBlock = glossaryDoc.GetBuildingBlock(BuildingBlockGallery.QuickParts,
        "My custom building blocks", "Custom Block");

    // Сам блок представляет собой раздел, содержащий текст.
    Assert.AreEqual($"Text inside {customBlock.Name}\f", customBlock.FirstSection.Body.FirstParagraph.GetText());
    Assert.AreEqual(customBlock.FirstSection, customBlock.LastSection);

    // Теперь мы можем вставить его в документ как новый раздел.
    doc.AppendChild(doc.ImportNode(customBlock.FirstSection, true));

    // Мы также можем найти его в Организаторе строительных блоков Microsoft Word и разместить вручную.
    doc.Save(ArtifactsDir + "BuildingBlocks.CreateAndInsert.dotx");
}

/// <summary>
/// Настраивает посещенный стандартный блок для вставки в документ в качестве быстрой части и добавляет текст к его содержимому.
/// </summary>
public class BuildingBlockVisitor : DocumentVisitor
{
    public BuildingBlockVisitor(GlossaryDocument ownerGlossaryDoc)
    {
        mBuilder = new StringBuilder();
        mGlossaryDoc = ownerGlossaryDoc;
    }

    public override VisitorAction VisitBuildingBlockStart(BuildingBlock block)
    {
        // Настройте стандартный блок как быструю часть и добавьте свойства, используемые Организатором стандартных блоков.
        block.Behavior = BuildingBlockBehavior.Paragraph;
        block.Category = "My custom building blocks";
        block.Description =
            "Using this block in the Quick Parts section of word will place its contents at the cursor.";
        block.Gallery = BuildingBlockGallery.QuickParts;

        // Добавляем раздел с текстом.
        // Вставка блока в документ добавит этот раздел с его дочерними узлами в этом месте.
        Section section = new Section(mGlossaryDoc);
        block.AppendChild(section);
        block.FirstSection.EnsureMinimum();

        Run run = new Run(mGlossaryDoc, "Text inside " + block.Name);
        block.FirstSection.Body.FirstParagraph.AppendChild(run);

        return VisitorAction.Continue;
    }

    public override VisitorAction VisitBuildingBlockEnd(BuildingBlock block)
    {
        mBuilder.Append("Visited " + block.Name + "\r\n");
        return VisitorAction.Continue;
    }

    private readonly StringBuilder mBuilder;
    private readonly GlossaryDocument mGlossaryDoc;
}

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

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

Enum BuildingBlockBehavior