LayoutCollector

LayoutCollector class

此类允许计算文档节点的页码。

public class LayoutCollector

构造函数

姓名 描述
LayoutCollector(Document) 初始化此类的一个实例。

特性

姓名 描述
Document { get; set; } 获取或设置此收集器实例附加到的文档。

方法

姓名 描述
Clear() 清除所有收集的布局数据。手动更新文档或重新构建布局后调用此方法。
GetEndPageIndex(Node) 获取节点结束的页面的从 1 开始的索引。如果节点无法映射到页面,则返回 0。
GetEntity(Node) 返回一个不透明的位置LayoutEnumerator对应于指定的节点。 您可以使用返回值作为参数Current给定正在 枚举的文档和节点的文档相同.
GetNumPagesSpanned(Node) 获取指定节点跨越的页数。如果节点在单个页面内,则为 0。 这与GetEndPageIndex-GetStartPageIndex.
GetStartPageIndex(Node) 获取节点开始的页面的从 1 开始的索引。如果节点无法映射到页面,则返回 0。

评论

当你创建一个LayoutCollector并指定一个Document要附加到的文档对象, 当文档格式化为页面时,收集器将记录文档节点到布局对象的映射。

您将能够通过使用GetStartPageIndex,GetEndPageIndexGetNumPagesSpanned方法。 这些方法自动构建文档的页面布局模型并在需要时更新字段。

当您不再需要收集布局信息时,最好将Document属性为 null 以避免不必要地收集更多布局映射。

例子

显示如何查看节点跨越的页面范围。

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

// 调用“GetNumPagesSpanned”方法来统计我们的文档内容跨越了多少页。
// 由于文档为空,因此当前页数为零。
Assert.AreEqual(doc, layoutCollector.Document);
Assert.AreEqual(0, layoutCollector.GetNumPagesSpanned(doc));

// 用 5 页内容填充文档。
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);

// 在布局收集器之前,我们需要调用“UpdatePageLayout”方法给我们
// 任何与布局相关的指标的准确数字,例如页数。
Assert.AreEqual(0, layoutCollector.GetNumPagesSpanned(doc));

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

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

// 我们可以看到任何节点的起始页和结束页的数量以及它们的总页跨度。
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.");
}

// 我们可以使用 LayoutEnumerator 遍历布局实体。
LayoutEnumerator layoutEnumerator = new LayoutEnumerator(doc);

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

// LayoutEnumerator 可以像树一样遍历布局实体的集合。
// 我们也可以将它应用到任何节点对应的布局实体上。
layoutEnumerator.Current = layoutCollector.GetEntity(doc.GetChild(NodeType.Paragraph, 1, true));

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

也可以看看