LayoutCollector

LayoutCollector class

Diese Klasse ermöglicht die Berechnung der Seitenzahlen von Dokumentknoten.

Um mehr zu erfahren, besuchen Sie dieKonvertieren in das Festseitenformat Dokumentationsartikel.

public class LayoutCollector

Konstrukteure

NameBeschreibung
LayoutCollector(Document)Initialisiert eine Instanz dieser Klasse.

Eigenschaften

NameBeschreibung
Document { get; set; }Ruft das Dokument ab oder legt es fest, an das diese Collector-Instanz angehängt ist.

Methoden

NameBeschreibung
Clear()Löscht alle erfassten Layoutdaten. Rufen Sie diese Methode auf, nachdem das Dokument manuell aktualisiert oder das Layout neu erstellt wurde.
GetEndPageIndex(Node)Ermittelt den 1-basierten Index der Seite, auf der der Knoten endet. Gibt 0 zurück, wenn der Knoten keiner Seite zugeordnet werden kann.
GetEntity(Node)Gibt eine undurchsichtige Position desLayoutEnumerator der dem angegebenen Knoten entspricht. Sie können den zurückgegebenen Wert als Argument verwenden, umCurrent vorausgesetzt, das aufzuzählende Dokument und das Dokument des Knotens sind identisch.
GetNumPagesSpanned(Node)Ruft die Anzahl der Seiten ab, die der angegebene Knoten umfasst. 0, wenn sich der Knoten innerhalb einer einzelnen Seite befindet. Dies ist dasselbe wieGetEndPageIndex -GetStartPageIndex .
GetStartPageIndex(Node)Ermittelt den 1-basierten Index der Seite, auf der der Knoten beginnt. Gibt 0 zurück, wenn der Knoten keiner Seite zugeordnet werden kann.

Bemerkungen

Wenn Sie eineLayoutCollector und geben Sie einenDocumentDokumentobjekt zum Anhängen, der Collector zeichnet die Zuordnung von Dokumentknoten zu Layoutobjekten auf, wenn das Dokument in Seiten formatiert wird.

Sie können herausfinden, auf welcher Seite sich ein bestimmter Dokumentknoten (z. B. Lauf, Absatz oder Tabellenzelle) befindet , indem Sie dieGetStartPageIndex ,GetEndPageIndex UndGetNumPagesSpanned Methoden. Diese Methoden erstellen automatisch das Seitenlayoutmodell des Dokuments und aktualisieren bei Bedarf Felder.

Wenn Sie keine Layoutinformationen mehr erfassen müssen, setzen Sie am besten dieDocument Eigentum zunull , um die unnötige Sammlung weiterer Layoutzuordnungen zu vermeiden.

Beispiele

Zeigt, wie die Seitenbereiche angezeigt werden, die ein Knoten umfasst.

Document doc = new Document();
LayoutCollector layoutCollector = new LayoutCollector(doc);

// Rufen Sie die Methode „GetNumPagesSpanned“ auf, um zu zählen, wie viele Seiten der Inhalt unseres Dokuments umfasst.
// Da das Dokument leer ist, beträgt die Seitenanzahl derzeit Null.
Assert.AreEqual(doc, layoutCollector.Document);
Assert.AreEqual(0, layoutCollector.GetNumPagesSpanned(doc));

// Füllen Sie das Dokument mit 5 Seiten Inhalt.
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Write("Section 1");
builder.InsertBreak(BreakType.PageBreak);
builder.InsertBreak(BreakType.PageBreak);
builder.InsertBreak(BreakType.SectionBreakEvenPage);
builder.Write("Section 2");
builder.InsertBreak(BreakType.PageBreak);
builder.InsertBreak(BreakType.PageBreak);

// Vor dem Layout-Sammler müssen wir die Methode "UpdatePageLayout" aufrufen, um uns
// eine genaue Zahl für jede layoutbezogene Metrik, wie beispielsweise die Seitenanzahl.
Assert.AreEqual(0, layoutCollector.GetNumPagesSpanned(doc));

layoutCollector.Clear();
doc.UpdatePageLayout();

Assert.AreEqual(5, layoutCollector.GetNumPagesSpanned(doc));

// Wir können die Nummern der Start- und Endseiten jedes Knotens und ihre Gesamtseitenspanne sehen.
NodeCollection nodes = doc.GetChildNodes(NodeType.Any, true);
foreach (Node node in nodes)
{
    Console.WriteLine($"->  NodeType.{node.NodeType}: ");
    Console.WriteLine(
        $"\tStarts on page {layoutCollector.GetStartPageIndex(node)}, ends on page {layoutCollector.GetEndPageIndex(node)}," +
        $" spanning {layoutCollector.GetNumPagesSpanned(node)} pages.");
}

// Wir können die Layout-Entitäten mithilfe eines LayoutEnumerators durchlaufen.
LayoutEnumerator layoutEnumerator = new LayoutEnumerator(doc);

Assert.AreEqual(LayoutEntityType.Page, layoutEnumerator.Type);

// Der LayoutEnumerator kann die Sammlung von Layout-Entitäten wie einen Baum durchlaufen.
// Wir können es auch auf die entsprechende Layout-Entität eines beliebigen Knotens anwenden.
layoutEnumerator.Current = layoutCollector.GetEntity(doc.GetChild(NodeType.Paragraph, 1, true));

Assert.AreEqual(LayoutEntityType.Span, layoutEnumerator.Type);
Assert.AreEqual("¶", layoutEnumerator.Text);

Siehe auch

IPageLayoutCallback Interface LayoutEntityType Enum