CommentRangeEnd

CommentRangeEnd class

Indica el final de una región de texto que tiene un comentario asociado.

Para obtener más información, visite elTrabajar con comentarios artículo de documentación.

public sealed class CommentRangeEnd : Node

Constructores

Nombre	Descripción
CommentRangeEnd(DocumentBase, int)	Inicializa una nueva instancia de esta clase.

Propiedades

Nombre	Descripción
CustomNodeId { get; set; }	Especifica el identificador de nodo personalizado.
virtual Document { get; }	Obtiene el documento al que pertenece este nodo.
Id { get; set; }	Especifica el identificador del comentario al que está vinculada esta región.
virtual IsComposite { get; }	Devoluciones`verdadero` si este nodo puede contener otros nodos.
NextSibling { get; }	Obtiene el nodo que sigue inmediatamente a este nodo.
override NodeType { get; }	DevolucionesCommentRangeEnd .
ParentNode { get; }	Obtiene el padre inmediato de este nodo.
PreviousSibling { get; }	Obtiene el nodo inmediatamente anterior a este nodo.
Range { get; }	Devuelve un`Range` objeto que representa la parte de un documento contenido en este nodo.

Métodos

Nombre	Descripción
override Accept(DocumentVisitor)	Acepta un visitante.
Clone(bool)	Crea un duplicado del nodo.
GetAncestor(NodeType)	Obtiene el primer ancestro del especificado`NodeType` .
GetAncestor(Type)	Obtiene el primer antepasado del tipo de objeto especificado.
virtual GetText()	Obtiene el texto de este nodo y de todos sus hijos.
NextPreOrder(Node)	Obtiene el siguiente nodo según el algoritmo transversal del árbol de pedidos anticipados.
PreviousPreOrder(Node)	Obtiene el nodo anterior según el algoritmo transversal del árbol de pedidos anticipados.
Remove()	Se elimina del padre.
ToString(SaveFormat)	Exporta el contenido del nodo a una cadena en el formato especificado.
ToString(SaveOptions)	Exporta el contenido del nodo a una cadena usando las opciones de guardado especificadas.

Observaciones

Para crear un comentario anclado a una región de texto, necesita crear unComment and luego creaCommentRangeStart yCommentRangeEnd establecer sus identificadores al mismoId valor.

CommentRangeEnd es un nodo de nivel en línea y sólo puede ser hijo deParagraph.

Ejemplos

Muestra cómo imprimir el contenido de todos los comentarios y sus rangos de comentarios utilizando un visitante de documentos.

public void CreateCommentsAndPrintAllInfo()
{
    Document doc = new Document();

    Comment newComment = new Comment(doc)
    {
        Author = "VDeryushev",
        Initial = "VD",
        DateTime = DateTime.Now
    };

    newComment.SetText("Comment regarding text.");

    // Agrega texto al documento, deformalo en un rango de comentarios y luego agrega tu comentario.
    Paragraph para = doc.FirstSection.Body.FirstParagraph;
    para.AppendChild(new CommentRangeStart(doc, newComment.Id));
    para.AppendChild(new Run(doc, "Commented text."));
    para.AppendChild(new CommentRangeEnd(doc, newComment.Id));
    para.AppendChild(newComment); 

    // Agrega dos respuestas al comentario.
    newComment.AddReply("John Doe", "JD", DateTime.Now, "New reply.");
    newComment.AddReply("John Doe", "JD", DateTime.Now, "Another reply.");

    PrintAllCommentInfo(doc.GetChildNodes(NodeType.Comment, true));
}

/// <summary>
/// Itera sobre cada comentario de nivel superior e imprime su rango de comentarios, contenidos y respuestas.
/// </summary>
private static void PrintAllCommentInfo(NodeCollection comments)
{
    CommentInfoPrinter commentVisitor = new CommentInfoPrinter();

    // Iterar sobre todos los comentarios de nivel superior. A diferencia de los comentarios de tipo respuesta, los comentarios de nivel superior no tienen antepasados.
    foreach (Comment comment in comments.Where(c => ((Comment)c).Ancestor == null))
    {
        // Primero, visita el inicio del rango de comentarios.
        CommentRangeStart commentRangeStart = (CommentRangeStart)comment.PreviousSibling.PreviousSibling.PreviousSibling;
        commentRangeStart.Accept(commentVisitor);

        // Luego, visita el comentario y las respuestas que pueda tener.
        comment.Accept(commentVisitor);

        foreach (Comment reply in comment.Replies)
            reply.Accept(commentVisitor);

        // Finalmente, visite el final del rango de comentarios y luego imprima el contenido del texto del visitante.
        CommentRangeEnd commentRangeEnd = (CommentRangeEnd)comment.PreviousSibling;
        commentRangeEnd.Accept(commentVisitor);

        Console.WriteLine(commentVisitor.GetText());
    }
}

/// <summary>
/// Imprime la información y el contenido de todos los comentarios y rangos de comentarios encontrados en el documento.
/// </summary>
public class CommentInfoPrinter : DocumentVisitor
{
    public CommentInfoPrinter()
    {
        mBuilder = new StringBuilder();
        mVisitorIsInsideComment = false;
    }

    /// <summary>
    /// Obtiene el texto sin formato del documento acumulado por el visitante.
    /// </summary>
    public string GetText()
    {
        return mBuilder.ToString();
    }

    /// <summary>
    /// Se llama cuando se encuentra un nodo Ejecutar en el documento.
    /// </summary>
    public override VisitorAction VisitRun(Run run)
    {
        if (mVisitorIsInsideComment) IndentAndAppendLine("[Run] \"" + run.Text + "\"");

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Se llama cuando se encuentra un nodo CommentRangeStart en el documento.
    /// </summary>
    public override VisitorAction VisitCommentRangeStart(CommentRangeStart commentRangeStart)
    {
        IndentAndAppendLine("[Comment range start] ID: " + commentRangeStart.Id);
        mDocTraversalDepth++;
        mVisitorIsInsideComment = true;

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Se llama cuando se encuentra un nodo CommentRangeEnd en el documento.
    /// </summary>
    public override VisitorAction VisitCommentRangeEnd(CommentRangeEnd commentRangeEnd)
    {
        mDocTraversalDepth--;
        IndentAndAppendLine("[Comment range end] ID: " + commentRangeEnd.Id + "\n");
        mVisitorIsInsideComment = false;

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Se llama cuando se encuentra un nodo Comentario en el documento.
    /// </summary>
    public override VisitorAction VisitCommentStart(Comment comment)
    {
        IndentAndAppendLine(
            $"[Comment start] For comment range ID {comment.Id}, By {comment.Author} on {comment.DateTime}");
        mDocTraversalDepth++;
        mVisitorIsInsideComment = true;

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Se llama cuando finaliza la visita de un nodo Comentario en el documento.
    /// </summary>
    public override VisitorAction VisitCommentEnd(Comment comment)
    {
        mDocTraversalDepth--;
        IndentAndAppendLine("[Comment end]");
        mVisitorIsInsideComment = false;

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Agrega una línea al StringBuilder y sangra dependiendo de qué tan profundo esté el visitante en el árbol del documento.
    /// </summary>
    /// <param nombre="texto"></param>
    private void IndentAndAppendLine(string text)
    {
        for (int i = 0; i < mDocTraversalDepth; i++)
        {
            mBuilder.Append("|  ");
        }

        mBuilder.AppendLine(text);
    }

    private bool mVisitorIsInsideComment;
    private int mDocTraversalDepth;
    private readonly StringBuilder mBuilder;
}

Ver también

class Node
espacio de nombres Aspose.Words
asamblea Aspose.Words

CommentCollection Class CommentRangeStart Class