LayoutEnumerator

LayoutEnumerator class

Énumère les entités de mise en page d’un document. Vous pouvez utiliser cette classe pour parcourir le modèle de mise en page. Les propriétés disponibles sont le type, la géométrie, le texte et l’index de page où l’entité est rendue, ainsi que la structure globale et les relations. Utilisez une combinaison deGetEntity etCurrent déplacer vers l’entité qui correspond à un nœud de document.

public class LayoutEnumerator

Constructeurs

Nom La description
LayoutEnumerator(Document) Initialise la nouvelle instance de cette classe.

Propriétés

Nom La description
Current { get; set; } Obtient ou définit la position actuelle dans le modèle de mise en page. Cette propriété renvoie un objet opaque qui correspond à l’entité de mise en page actuelle.
Document { get; } Obtient le document que cette instance énumère.
Kind { get; } Obtient le genre de l’entité actuelle. Cela peut être une chaîne vide mais jamais null.
PageIndex { get; } Obtient l’index de base 1 d’une page qui contient l’entité actuelle.
Rectangle { get; } Renvoie le rectangle de délimitation de l’entité courante par rapport au coin supérieur gauche de la page (en points).
Text { get; } Obtient le texte de l’entité span actuelle. Jette pour d’autres types d’entités.
Type { get; } Obtient le type de l’entité actuelle.

Méthodes

Nom La description
MoveFirstChild() Passe à la première entité enfant.
MoveLastChild() Passe à la dernière entité enfant.
MoveNext() Passe à l’entité sœur suivante dans l’ordre visuel. Lors de l’itération des lignes d’un paragraphe sur plusieurs pages, cette méthode ne passera pas à la page suivante mais passera plutôt à l’entité suivante sur la même page.
MoveNextLogical() Passe à l’entité sœur suivante dans un ordre logique. Lors de l’itération des lignes d’un paragraphe sur plusieurs pages, cette méthode passera à la ligne suivante même si elle réside sur une autre page.
MoveParent() Passe à l’entité parente.
MoveParent(LayoutEntityType) Passe à l’entité parent du type spécifié.
MovePrevious() Passe à l’entité sœur précédente.
MovePreviousLogical() Passe à l’entité sœur précédente dans un ordre logique. Lors de l’itération des lignes d’un paragraphe sur plusieurs pages, cette méthode se déplacera à la ligne précédente même si elle réside sur une autre page.
Reset() Déplace l’énumérateur vers la première page du document.

Exemples

Montre des manières de parcourir les entités de mise en page d’un document.

public void LayoutEnumerator()
{
    // Ouvre un document qui contient une variété d'entités de mise en page.
    // Les entités de mise en page sont des pages, des cellules, des lignes, des lignes et d'autres objets inclus dans l'énumération LayoutEntityType.
    // Chaque entité de mise en page a un espace rectangulaire qu'elle occupe dans le corps du document.
    Document doc = new Document(MyDir + "Layout entities.docx");

    // Crée un énumérateur qui peut traverser ces entités comme un arbre.
    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));

    // Nous pouvons appeler cette méthode pour nous assurer que l'énumérateur sera à la première entité de mise en page.
    layoutEnumerator.Reset();

    // Il y a deux ordres qui déterminent comment l'énumérateur de mise en page continue à traverser les entités de mise en page
    // lorsqu'il rencontre des entités qui s'étendent sur plusieurs pages.
    // 1 - Dans l'ordre visuel :
    // Lorsque vous parcourez les enfants d'une entité qui s'étendent sur plusieurs pages,
    // la mise en page est prioritaire, et nous passons aux autres éléments enfants de cette page et évitons ceux de la suivante.
    Console.WriteLine("Traversing from first to last, elements between pages separated:");
    TraverseLayoutForward(layoutEnumerator, 1);

    // Notre recenseur est maintenant à la fin de la collecte. Nous pouvons parcourir les entités de mise en page en arrière pour revenir au début.
    Console.WriteLine("Traversing from last to first, elements between pages separated:");
    TraverseLayoutBackward(layoutEnumerator, 1);

    // 2 - Dans l'ordre logique :
    // Lorsque vous parcourez les enfants d'une entité qui s'étendent sur plusieurs pages,
    // l'énumérateur se déplacera entre les pages pour parcourir toutes les entités enfants.
    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>
/// Enumérer à travers la collection d'entités de mise en page de layoutEnumerator d'avant en arrière,
/// en profondeur d'abord, et dans l'ordre "Visuel".
/// </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>
/// Enumérer à travers la collection d'entités de mise en page de layoutEnumerator à l'envers,
/// en profondeur d'abord, et dans l'ordre "Visuel".
/// </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>
/// Enumérer à travers la collection d'entités de mise en page de layoutEnumerator d'avant en arrière,
/// en profondeur d'abord, et dans l'ordre "logique".
/// </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>
/// Enumérer à travers la collection d'entités de mise en page de layoutEnumerator à l'envers,
/// en profondeur d'abord, et dans l'ordre "logique".
/// </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>
/// Affiche des informations sur l'entité actuelle de layoutEnumerator dans la console, tout en indentant le texte avec des caractères de tabulation
/// en fonction de sa profondeur par rapport au nœud racine que nous avons fourni dans l'instance du constructeur LayoutEnumerator.
/// Le rectangle que nous traitons à la fin représente la zone et l'emplacement que l'entité occupe dans le document.
/// </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}");

    // Seuls les spans peuvent contenir du texte.
    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}");
}

Voir également