Trabalhar com comentários
Experimente online
Pode experimentar esta funcionalidade com o nosso Removedor gratuito em linha outra.
Aspose.Words permite que os usuários trabalhem com comentários-os comentários em um documento em Aspose.Words são representados pela classe Comment. Use também as classes CommentRangeStart e CommentRangeEnd para especificar a região do texto que deve ser associada a um comentário.
Adicionar um comentário
Aspose.Words permite adicionar comentários de várias maneiras:
- Usando a classe Comment
- Usando as classes CommentRangeStart e CommentRangeEnd
O exemplo de código a seguir mostra como adicionar um comentário a um parágrafo usando a classe Comment:
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java | |
String dataDir = Utils.getDataDir(AddComments.class); | |
Document doc = new Document(); | |
DocumentBuilder builder = new DocumentBuilder(doc); | |
builder.write("Some text is added."); | |
Comment comment = new Comment(doc, "Awais Hafeez", "AH", new Date()); | |
builder.getCurrentParagraph().appendChild(comment); | |
comment.getParagraphs().add(new Paragraph(doc)); | |
comment.getFirstParagraph().getRuns().add(new Run(doc, "Comment text.")); | |
doc.save(dataDir + "output.doc"); |
O exemplo de código a seguir mostra como adicionar um comentário a um parágrafo usando uma região de texto e as classes CommentRangeStart e CommentRangeEnd:
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java | |
String dataDir = Utils.getDataDir(AnchorComment.class); | |
Document doc = new Document(); | |
Paragraph para1 = new Paragraph(doc); | |
Run run1 = new Run(doc, "Some "); | |
Run run2 = new Run(doc, "text "); | |
para1.appendChild(run1); | |
para1.appendChild(run2); | |
doc.getFirstSection().getBody().appendChild(para1); | |
Paragraph para2 = new Paragraph(doc); | |
Run run3 = new Run(doc, "is "); | |
Run run4 = new Run(doc, "added "); | |
para2.appendChild(run3); | |
para2.appendChild(run4); | |
doc.getFirstSection().getBody().appendChild(para2); | |
Comment comment = new Comment(doc, "Awais Hafeez", "AH", new Date()); | |
comment.getParagraphs().add(new Paragraph(doc)); | |
comment.getFirstParagraph().getRuns().add(new Run(doc, "Comment text.")); | |
CommentRangeStart commentRangeStart = new CommentRangeStart(doc, comment.getId()); | |
CommentRangeEnd commentRangeEnd = new CommentRangeEnd(doc, comment.getId()); | |
run1.getParentNode().insertAfter(commentRangeStart, run1); | |
run3.getParentNode().insertAfter(commentRangeEnd, run3); | |
commentRangeEnd.getParentNode().insertAfter(comment, commentRangeEnd); | |
doc.save(dataDir + "output.doc"); |
Extrair ou remover comentários
O uso de comentários em um documento do Word (além de rastrear alterações) é uma prática comum ao revisar documentos, especialmente quando há vários revisores. Pode haver situações em que a única coisa que você precisa de um documento são os comentários. Digamos que você queira gerar uma lista de resultados de revisão, ou talvez tenha coletado todas as informações úteis do documento e simplesmente queira remover comentários desnecessários. Você pode querer ver ou remover os comentários de um revisor específico.
Nesta amostra, vamos analisar alguns métodos simples para recolher informações dos comentários de um documento e para remover comentários de um documento. Especificamente, abordaremos como:
- Extraia todos os comentários de um documento ou apenas os feitos por um determinado autor.
- Remova todos os comentários de um documento ou apenas de um autor específico.
Como extrair ou remover comentários
O código desta amostra é bastante simples e todos os métodos baseiam-se na mesma abordagem. Um comentário em um documento do Word é representado por um objeto Comment
no modelo de objeto de Documento Aspose.Words. Para recolher todos os comentários num documento, utilize o método getChildNodes com o primeiro parâmetro definido como NodeType.Comment
. Certifique-se de que o segundo parâmetro do método getChildNodes esteja definido como true: isso força o getChildNodes a selecionar recursivamente de todos os nós filhos, em vez de coletar apenas os filhos imediatos.
Para ilustrar como extrair e remover comentários de um documento, seguiremos as seguintes etapas:
- Abrir um documento do Word utilizando a classe Document
- Obter todos os comentários do documento em uma coleção
- Para extrair comentários:
- Percorra a coleção usando o para o operador
- Extrair e listar o nome do autor, data e hora e o texto de todos os comentários
- Extrair e listar o nome do autor, a data e a hora e o texto dos comentários escritos por um autor específico, neste caso, o autor ‘ks’
- Para remover comentários:
- Retroceda através da recolha utilizando o for the operator
- Remover comentários
- Salve as alterações.
Vamos usar o seguinte documento do Word para este exercício:
Como pode ver, contém vários comentários de dois autores com as iniciais “pm"e " ks”.
Como extrair todos os comentários
O método getChildNodes é muito útil e você pode usá-lo sempre que precisar obter uma lista de nós de documentos de qualquer tipo. A coleção resultante não cria uma sobrecarga imediata porque os nós são selecionados nessa coleção somente quando você enumera ou acessa itens nela.
O exemplo de código a seguir mostra como extrair o nome do autor, data e hora e o texto de todos os comentários no documento:
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java | |
ArrayList collectedComments = new ArrayList(); | |
// Collect all comments in the document | |
NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true); | |
// Look through all comments and gather information about them. | |
for (Comment comment : (Iterable<Comment>) comments) { | |
collectedComments.add(comment.getAuthor() + " " + comment.getDateTime() + " " + comment.toString(SaveFormat.TEXT)); | |
} | |
return collectedComments; |
Como extrair Comentários de um autor especificado
Depois de selecionar os nós de comentário em uma coleção, tudo o que você precisa fazer é extrair as informações necessárias. Neste exemplo, as iniciais do autor, a data, a hora e o texto simples do comentário são combinados numa cadeia de caracteres; em vez disso, pode optar por armazená-lo de outras formas.
O método sobrecarregado que extrai os comentários de um determinado autor é quase o mesmo, apenas verifica o nome do autor antes de adicionar as informações ao array.
O exemplo de código a seguir mostra como extrair o nome do autor, a data e a hora e o texto dos comentários do autor especificado:
Como remover comentários
Se você estiver removendo todos os comentários, não há necessidade de percorrer a coleção excluindo Comentários um por um; você pode removê-los chamando clear na coleção de comentários.
O exemplo de código a seguir mostra como remover todos os comentários no documento:
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java | |
// Collect all comments in the document | |
NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true); | |
// Remove all comments. | |
comments.clear(); |
Quando você precisa remover seletivamente comentários, o processo se torna mais semelhante ao código que usamos para a extração de comentários.
O exemplo de código a seguir mostra como remover comentários do autor especificado:
O principal ponto a destacar aqui é a utilização do operador for. Ao contrário da extração simples, aqui você deseja excluir um comentário. Um truque adequado é iterar a coleção para trás do último comentário para o primeiro. A razão para isso se você começar do final e retroceder, o índice dos itens anteriores permanece inalterado e você pode voltar ao primeiro item da coleção.
O exemplo de código a seguir mostra os métodos para a extração e remoção de comentários:
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java | |
// The path to the documents directory. | |
String dataDir = Utils.getDataDir(ProcessComments.class); | |
// Open the document. | |
Document doc = new Document(dataDir + "TestFile.doc"); | |
for (String comment : (Iterable<String>) extractComments(doc)) | |
System.out.print(comment); | |
// Remove comments by the "pm" author. | |
removeComments(doc, "pm"); | |
System.out.println("Comments from \"pm\" are removed!"); | |
// Extract the information about the comments of the "ks" author. | |
for (String comment : (Iterable<String>) extractComments(doc, "ks")) | |
System.out.print(comment); | |
//Read the comment's reply and resolve them. | |
System.out.println("Read the comment's reply and resolve them."); | |
CommentResolvedandReplies(doc); | |
// Remove all comments. | |
removeComments(doc); | |
System.out.println("All comments are removed!"); | |
// Save the document. | |
doc.save(dataDir + "output.doc"); |
Quando lançada, a amostra apresenta os seguintes resultados. Em primeiro lugar, lista todos os comentários de todos os autores e, em seguida, lista apenas os comentários do autor selecionado. Finalmente, o código de remoção de todos os comentários.
O documento do Word de saída agora tem comentários removidos dele:
Como remover texto entre CommentRangeStart e CommentRangeEnd
Usando Aspose.Words Você também pode remover comentários entre os nós CommentRangeStart e CommentRangeEnd.
O exemplo de código a seguir mostra como remover texto entre CommentRangeStart e CommentRangeEnd:
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java | |
// The path to the documents directory. | |
String dataDir = Utils.getDataDir(RemoveCommentRegionText.class); | |
// Open the document. | |
Document doc = new Document(dataDir + "TestFile.doc"); | |
CommentRangeStart commentStart = (CommentRangeStart) doc.getChild(NodeType.COMMENT_RANGE_START, 0, true); | |
CommentRangeEnd commentEnd = (CommentRangeEnd) doc.getChild(NodeType.COMMENT_RANGE_END, 0, true); | |
Node currentNode = commentStart; | |
Boolean isRemoving = true; | |
while (currentNode != null && isRemoving) { | |
if (currentNode.getNodeType() == NodeType.COMMENT_RANGE_END) | |
isRemoving = false; | |
Node nextNode = currentNode.nextPreOrder(doc); | |
currentNode.remove(); | |
currentNode = nextNode; | |
} | |
doc.save(dataDir + "output.doc"); |
Adicionar ou remover a resposta do comentário
O método addReply adiciona uma resposta a este comentário. Por favor, note que, devido às limitações existentes do MS Office, apenas um (1) Nível de respostas é permitido no documento. Uma exceção do tipo InvalidOperationException será levantada se este método for chamado no Comentário de resposta existente.
Você pode usar o método removeReply para remover a resposta especificada a este comentário.
O exemplo de código a seguir mostra como adicionar uma resposta a um comentário e remover a resposta de um comentário:
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java | |
Document doc = new Document(dataDir + "TestFile.doc"); | |
Comment comment = (Comment) doc.getChild(NodeType.COMMENT, 0, true); | |
//Remove the reply | |
comment.removeReply(comment.getReplies().get(0)); | |
//Add a reply to comment | |
comment.addReply("John Doe", "JD", new Date(), "New reply"); | |
dataDir = dataDir + "TestFile_Out.doc"; | |
// Save the document to disk. | |
doc.save(dataDir); |
Ler a resposta do comentário
Aspose.Words Apoio à leitura da resposta de um comentário. A propriedade Replies retorna uma coleção dos objetos Comment que são filhos imediatos do comentário especificado.
O exemplo de código a seguir mostra como iterar as respostas de um comentário e resolvê-las:
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java | |
static void CommentResolvedandReplies(Document doc) { | |
NodeCollection<Comment> comments = doc.getChildNodes(NodeType.COMMENT, true); | |
Comment parentComment = (Comment) comments.get(0); | |
for (Comment childComment : parentComment.getReplies()) { | |
// Get comment parent and status. | |
System.out.println(childComment.getAncestor().getId()); | |
System.out.println(childComment.getDone()); | |
// And update comment Done mark. | |
childComment.setDone(true); | |
} | |
} |