Comment
Contenido
[
Ocultar
]Comment(DocumentBase)
Inicializa una nueva instancia delComment
clase.
public Comment(DocumentBase doc)
Parámetro | Escribe | Descripción |
---|---|---|
doc | DocumentBase | El documento del propietario. |
Observaciones
CuandoComment
se crea, pertenece al documento especificado, pero aún no es parte del documento yParentNode
esnulo
.
Para anexarComment
al uso del documentoInsertAfter
oInsertBefore
en el párrafo donde desea insertar el comentario.
Después de crear un comentario, no olvides configurar suAuthor
, Initial
yDateTime
propiedades.
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 DocumentBase
- class Comment
- espacio de nombres Aspose.Words
- asamblea Aspose.Words
Comment(DocumentBase, string, string, DateTime)
Inicializa una nueva instancia delComment
clase.
public Comment(DocumentBase doc, string author, string initial, DateTime dateTime)
Parámetro | Escribe | Descripción |
---|---|---|
doc | DocumentBase | El documento del propietario. |
author | String | El nombre del autor del comentario. No puede sernulo . |
initial | String | El autor pone sus iniciales en el comentario. No puede sernulo . |
dateTime | DateTime | La fecha y hora del comentario. |
Ejemplos
Muestra cómo agregar un comentario a un párrafo.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Write("Hello world!");
Comment comment = new Comment(doc, "John Doe", "JD", DateTime.Today);
builder.CurrentParagraph.AppendChild(comment);
builder.MoveTo(comment.AppendChild(new Paragraph(doc)));
builder.Write("Comment text.");
Assert.AreEqual(DateTime.Today, comment.DateTime);
// En Microsoft Word, podemos hacer clic derecho en este comentario en el cuerpo del documento para editarlo o responderle.
doc.Save(ArtifactsDir + "InlineStory.AddComment.docx");
Ver también
- class DocumentBase
- class Comment
- espacio de nombres Aspose.Words
- asamblea Aspose.Words