LayoutEntityType

LayoutEntityType enumeration

布局实体的类型。

[Flags]
public enum LayoutEntityType

价值观

姓名价值描述
None0默认值。
Page1代表文档的页面。 页面可能有Column,HeaderFooter和Comment子实体.
Column2表示页面上的一列文本。 列可能具有与Cell，加上Footnote,Endnote和NoteSeparator实体.
Row8表示表行。 行可能有Cell作为子实体.
Cell10表示一个表格单元格。 单元格可能有Line和Row子实体.
Line20表示文本和内联对象的字符行。 行可能有Span子实体.
Span40表示一行中的一个或多个字符。 这包括特殊字符，例如字段开始/结束标记、书签和注释。 跨度可能没有子实体。
Footnote100表示脚注内容的占位符。 脚注可能有Note子实体.
Endnote200表示尾注内容的占位符。 尾注可能有Note子实体.
Note4000代表笔记内容的占位符。 笔记可能有Line和Row子实体.
HeaderFooter400表示页面上页眉/页脚内容的占位符。 HeaderFooter 可能有Line和Row子实体.
TextBox800表示形状内的文本区域。 文本框可能有Line和Row子实体.
Comment1000代表评论内容的占位符。 评论可能有Line和Row子实体.
NoteSeparator2000表示脚注/尾注分隔符。 NoteSeparator 可能有Line和Row子实体.

例子

显示遍历文档布局实体的方法。

public void LayoutEnumerator()
{
    // 打开包含各种布局实体的文档。
    // 布局实体是页面、单元格、行、线以及 LayoutEntityType 枚举中包含的其他对象。
    // 每个布局实体在文档正文中都有一个占据的矩形空间。
    Document doc = new Document(MyDir + "Layout entities.docx");

    // 创建一个枚举器，可以像树一样遍历这些实体。
    LayoutEnumerator layoutEnumerator = new LayoutEnumerator(doc);

    Assert.AreEqual(doc, layoutEnumerator.Document);

    layoutEnumerator.MoveParent(LayoutEntityType.Page);

    Assert.AreEqual(LayoutEntityType.Page, layoutEnumerator.Type);
    Assert.Throws<InvalidOperationException>(() => Console.WriteLine(layoutEnumerator.Text));

    // 我们可以调用此方法来确保枚举器位于第一个布局实体。
    layoutEnumerator.Reset();

    // 有两个顺序决定布局枚举器如何继续遍历布局实体
    // 当遇到跨多个页面的实体时。
    // 1 - 按视觉顺序：
    // 当在跨多个页面的实体子级之间移动时，
    // 页面布局优先，我们移动到此页面上的其他子元素并避免下一个页面上的子元素。
    Console.WriteLine("Traversing from first to last, elements between pages separated:");
    TraverseLayoutForward(layoutEnumerator, 1);

    // 我们的枚举器现在位于集合的末尾。我们可以向后遍历布局实体以回到开头。
    Console.WriteLine("Traversing from last to first, elements between pages separated:");
    TraverseLayoutBackward(layoutEnumerator, 1);

    // 2 - 按逻辑顺序：
    // 当在跨多个页面的实体子级之间移动时，
    // 枚举器将在页面之间移动以遍历所有子实体。
    Console.WriteLine("Traversing from first to last, elements between pages mixed:");
    TraverseLayoutForwardLogical(layoutEnumerator, 1);

    Console.WriteLine("Traversing from last to first, elements between pages mixed:");
    TraverseLayoutBackwardLogical(layoutEnumerator, 1);
}

/// <summary>
/// 通过layoutEnumerator的布局实体集合从前到后枚举，
/// 以深度优先的方式，并按照“视觉”顺序。
/// </summary>
private static void TraverseLayoutForward(LayoutEnumerator layoutEnumerator, int depth)
{
    do
    {
        PrintCurrentEntity(layoutEnumerator, depth);

        if (layoutEnumerator.MoveFirstChild())
        {
            TraverseLayoutForward(layoutEnumerator, depth + 1);
            layoutEnumerator.MoveParent();
        }
    } while (layoutEnumerator.MoveNext());
}

/// <summary>
/// 通过layoutEnumerator的布局实体集合从后往前枚举，
/// 以深度优先的方式，并按照“视觉”顺序。
/// </summary>
private static void TraverseLayoutBackward(LayoutEnumerator layoutEnumerator, int depth)
{
    do
    {
        PrintCurrentEntity(layoutEnumerator, depth);

        if (layoutEnumerator.MoveLastChild())
        {
            TraverseLayoutBackward(layoutEnumerator, depth + 1);
            layoutEnumerator.MoveParent();
        }
    } while (layoutEnumerator.MovePrevious());
}

/// <summary>
/// 通过layoutEnumerator的布局实体集合从前到后枚举，
/// 以深度优先的方式，并按照“逻辑”顺序。
/// </summary>
private static void TraverseLayoutForwardLogical(LayoutEnumerator layoutEnumerator, int depth)
{
    do
    {
        PrintCurrentEntity(layoutEnumerator, depth);

        if (layoutEnumerator.MoveFirstChild())
        {
            TraverseLayoutForwardLogical(layoutEnumerator, depth + 1);
            layoutEnumerator.MoveParent();
        }
    } while (layoutEnumerator.MoveNextLogical());
}

/// <summary>
/// 通过layoutEnumerator的布局实体集合从后往前枚举，
/// 以深度优先的方式，并按照“逻辑”顺序。
/// </summary>
private static void TraverseLayoutBackwardLogical(LayoutEnumerator layoutEnumerator, int depth)
{
    do
    {
        PrintCurrentEntity(layoutEnumerator, depth);

        if (layoutEnumerator.MoveLastChild())
        {
            TraverseLayoutBackwardLogical(layoutEnumerator, depth + 1);
            layoutEnumerator.MoveParent();
        }
    } while (layoutEnumerator.MovePreviousLogical());
}

/// <summary>
/// 将layoutEnumerator当前实体的信息打印到控制台，同时使用制表符缩进文本
/// 基于其相对于我们在构造函数 LayoutEnumerator 实例中提供的根节点的深度。
/// 我们最后处理的矩形代表实体在文档中占据的区域和位置。
/// </summary>
private static void PrintCurrentEntity(LayoutEnumerator layoutEnumerator, int indent)
{
    string tabs = new string('\t', indent);

    Console.WriteLine(layoutEnumerator.Kind == string.Empty
        ? $"{tabs}-> Entity type: {layoutEnumerator.Type}"
        : $"{tabs}-> Entity type & kind: {layoutEnumerator.Type}, {layoutEnumerator.Kind}");

    // 只有 span 可以包含文本。
    if (layoutEnumerator.Type == LayoutEntityType.Span)
        Console.WriteLine($"{tabs}   Span contents: \"{layoutEnumerator.Text}\"");

    RectangleF leRect = layoutEnumerator.Rectangle;
    Console.WriteLine($"{tabs}   Rectangle dimensions {leRect.Width}x{leRect.Height}, X={leRect.X} Y={leRect.Y}");
    Console.WriteLine($"{tabs}   Page {layoutEnumerator.PageIndex}");
}

也可以看看

LayoutCollector Class LayoutEnumerator Class