GlossaryDocument

GlossaryDocument class

Stellt das Stammelement für ein Glossardokument innerhalb eines Word-Dokuments dar. Ein Glossardokument ist ein Speicher für AutoText-, AutoKorrektur-Einträge und Bausteine.

Um mehr zu erfahren, besuchen Sie dieAspose.Words Dokumentobjektmodell (DOM) Dokumentationsartikel.

public class GlossaryDocument : DocumentBase

Konstrukteure

Name	Beschreibung
GlossaryDocument()	Default_Constructor

Eigenschaften

Name	Beschreibung
BackgroundShape { get; set; }	Ruft die Hintergrundform des Dokuments ab oder legt sie fest. Kann seinnull .
BuildingBlocks { get; }	Gibt eine typisierte Sammlung zurück, die alle Bausteine im Glossardokument darstellt.
Count { get; }	Ruft die Anzahl der unmittelbar untergeordneten Elemente dieses Knotens ab.
CustomNodeId { get; set; }	Gibt die benutzerdefinierte Knotenkennung an.
override Document { get; }	Ruft diese Instanz ab.
FirstBuildingBlock { get; }	Ruft den ersten Baustein im Glossardokument ab.
FirstChild { get; }	Ruft das erste untergeordnete Element des Knotens ab.
FontInfos { get; }	Bietet Zugriff auf die Eigenschaften der in diesem Dokument verwendeten Schriftarten.
FootnoteSeparators { get; }	Bietet Zugriff auf die im Dokument definierten Fußnoten-/Endnotentrennzeichen.
HasChildNodes { get; }	RückgabenWAHR wenn dieser Knoten untergeordnete Knoten hat.
override IsComposite { get; }	RückgabenWAHR da dieser Knoten untergeordnete Knoten haben kann.
LastBuildingBlock { get; }	Ruft den letzten Baustein im Glossardokument ab.
LastChild { get; }	Ruft das letzte untergeordnete Element des Knotens ab.
Lists { get; }	Bietet Zugriff auf die im Dokument verwendete Listenformatierung.
NextSibling { get; }	Ruft den Knoten ab, der diesem Knoten unmittelbar folgt.
NodeChangingCallback { get; set; }	Wird aufgerufen, wenn ein Knoten im Dokument eingefügt oder daraus entfernt wird.
override NodeType { get; }	Gibt dieGlossaryDocument Wert.
PageColor { get; set; }	Ruft die Seitenfarbe des Dokuments ab oder legt sie fest. Diese Eigenschaft ist eine einfachere Version vonBackgroundShape .
ParentNode { get; }	Ruft den unmittelbar übergeordneten Knoten dieses Knotens ab.
PreviousSibling { get; }	Ruft den Knoten ab, der diesem Knoten unmittelbar vorausgeht.
Range { get; }	Gibt einenRangeObjekt, das den Teil eines Dokuments darstellt, der in diesem Knoten enthalten ist.
ResourceLoadingCallback { get; set; }	Ermöglicht die Steuerung des Ladens externer Ressourcen.
Styles { get; }	Gibt eine Sammlung der im Dokument definierten Stile zurück.
WarningCallback { get; set; }	Wird während verschiedener Dokumentverarbeitungsverfahren aufgerufen, wenn ein Problem erkannt wird, das zu einem Verlust der Daten- oder Formatierungsgenauigkeit führen kann.

Methoden

Name	Beschreibung
override Accept(DocumentVisitor)	Nimmt einen Besucher auf.
override AcceptEnd(DocumentVisitor)	Akzeptiert einen Besucher für den Besuch des Endes des Glossardokuments.
override AcceptStart(DocumentVisitor)	Akzeptiert einen Besucher für den Besuch des Anfangs des Glossardokuments.
AppendChild<T>(T)	Fügt den angegebenen Knoten am Ende der Liste der untergeordneten Knoten für diesen Knoten hinzu.
Clone(bool)	Erstellt ein Duplikat des Knotens.
CreateNavigator()	Erstellt einen Navigator, der zum Durchlaufen und Lesen von Knoten verwendet werden kann.
GetAncestor(NodeType)	Ruft den ersten Vorfahren des angegebenenNodeType .
GetAncestor(Type)	Ruft den ersten Vorgänger des angegebenen Objekttyps ab.
GetBuildingBlock(BuildingBlockGallery, string, string)	Findet einen Baustein anhand der angegebenen Galerie, Kategorie und des Namens.
GetChild(NodeType, int, bool)	Gibt einen N-ten untergeordneten Knoten zurück, der dem angegebenen Typ entspricht.
GetChildNodes(NodeType, bool)	Gibt eine Live-Sammlung von untergeordneten Knoten zurück, die dem angegebenen Typ entsprechen.
GetEnumerator()	Bietet Unterstützung für die Iteration des For-Each-Stils über die untergeordneten Knoten dieses Knotens.
override GetText()	Ruft den Text dieses Knotens und aller seiner untergeordneten Knoten ab.
ImportNode(Node, bool)	Importiert einen Knoten aus einem anderen Dokument in das aktuelle Dokument.
ImportNode(Node, bool, ImportFormatMode)	Importiert einen Knoten aus einem anderen Dokument in das aktuelle Dokument mit einer Option zur Steuerung der Formatierung.
IndexOf(Node)	Gibt den Index des angegebenen untergeordneten Knotens im untergeordneten Knoten-Array zurück.
InsertAfter<T>(T, Node)	Fügt den angegebenen Knoten unmittelbar nach dem angegebenen Referenzknoten ein.
InsertBefore<T>(T, Node)	Fügt den angegebenen Knoten unmittelbar vor dem angegebenen Referenzknoten ein.
NextPreOrder(Node)	Ruft den nächsten Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
PrependChild<T>(T)	Fügt den angegebenen Knoten am Anfang der Liste der untergeordneten Knoten für diesen Knoten hinzu.
PreviousPreOrder(Node)	Ruft den vorherigen Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
Remove()	Entfernt sich selbst vom übergeordneten Element.
RemoveAllChildren()	Entfernt alle untergeordneten Knoten des aktuellen Knotens.
RemoveChild<T>(T)	Entfernt den angegebenen untergeordneten Knoten.
RemoveSmartTags()	Entfernt alleSmartTag Nachkommenknoten des aktuellen Knotens.
SelectNodes(string)	Wählt eine Liste von Knoten aus, die dem XPath-Ausdruck entsprechen.
SelectSingleNode(string)	Wählt den erstenNode das dem XPath-Ausdruck entspricht.
ToString(SaveFormat)	Exportiert den Inhalt des Knotens in eine Zeichenfolge im angegebenen Format.
ToString(SaveOptions)	Exportiert den Inhalt des Knotens unter Verwendung der angegebenen Speicheroptionen in eine Zeichenfolge.

Bemerkungen

Einige Dokumente, in der Regel Vorlagen, können AutoText, AutoKorrektur-Einträge und/oder Bausteine (auch bekannt alsGlossardokumenteinträge ,Dokumentteile oderBausteine).

Um auf Bausteine zuzugreifen, müssen Sie ein Dokument in einDocument Objekt. Bausteine werden verfügbar sein über dieGlossaryDocument Eigentum.

GlossaryDocument kann eine beliebige Anzahl vonBuildingBlockObjekte. JedesBuildingBlock stellt einen Dokumentteil dar.

Entspricht demGlossarDokument UnddocPartsElemente in OOXML.

Beispiele

Zeigt Möglichkeiten zum Zugriff auf Bausteine in einem Glossardokument.

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;

    // Es gibt verschiedene Möglichkeiten, auf Bausteine zuzugreifen.
    // 1 - Holen Sie sich die ersten/letzten Bausteine in der Sammlung:
    Assert.AreEqual("Block 1", glossaryDoc.FirstBuildingBlock.Name);
    Assert.AreEqual("Block 5", glossaryDoc.LastBuildingBlock.Name);

    // 2 - Holen Sie sich einen Baustein nach Index:
    Assert.AreEqual("Block 2", glossaryDoc.BuildingBlocks[1].Name);
    Assert.AreEqual("Block 3", glossaryDoc.BuildingBlocks.ToArray()[2].Name);

    // 3 - Holen Sie sich den ersten Baustein, der einer Galerie, einem Namen und einer Kategorie entspricht:
    Assert.AreEqual("Block 4", 
        glossaryDoc.GetBuildingBlock(BuildingBlockGallery.All, "(Empty Category)", "Block 4").Name);

    // Wir werden das mit einem benutzerdefinierten Besucher tun,
    // Dadurch erhält jeder BuildingBlock im GlossaryDocument eine eindeutige GUID
    GlossaryDocVisitor visitor = new GlossaryDocVisitor();
    // Besuchen Sie den Anfang/das Ende des Glossardokuments.
    glossaryDoc.Accept(visitor);
    // Besuchen Sie nur den Anfang des Glossardokuments.
    glossaryDoc.AcceptStart(visitor);
    // Besuchen Sie nur das Ende des Glossardokuments.
    glossaryDoc.AcceptEnd(visitor);
    Console.WriteLine(visitor.GetText());

    // In Microsoft Word können wir über „Einfügen“ -> „Schnellbausteine“ -> „Baustein-Organizer“ auf die Bausteine zugreifen.
    doc.Save(ArtifactsDir + "BuildingBlocks.GlossaryDocument.dotx"); 
}

/// <summary>
/// Gibt jedem Baustein in einem besuchten Glossardokument eine eindeutige GUID.
/// Speichert die GUID-Bausteinpaare in einem Wörterbuch.
/// </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;
}

Siehe auch

• class DocumentBase
• namensraum Aspose.Words.BuildingBlocks
• Montage Aspose.Words