Lucrul cu comentarii

Aspose.Words permite utilizatorilor să lucreze cu comentarii-comentariile dintr-un document din Aspose.Words sunt reprezentate de clasa Comment. De asemenea, utilizați clasele CommentRangeStart și CommentRangeEnd pentru a specifica regiunea de text care ar trebui asociată cu un comentariu.

Adaugă un comentariu

Aspose.Words vă permite să adăugați comentarii în mai multe moduri:

  1. Folosind clasa Comment
  2. Folosind clasele CommentRangeStart și CommentRangeEnd

Următorul exemplu de cod arată cum să adăugați un comentariu la un paragraf folosind clasa 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");

Următorul exemplu de cod arată cum să adăugați un comentariu la un paragraf folosind o regiune de text și clasele CommentRangeStart și 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");

Extrageți sau eliminați comentariile

Utilizarea comentariilor într-un document Word (în plus față de modificările de urmărire) este o practică obișnuită atunci când revizuiți documente, în special atunci când există mai mulți recenzenți. Pot exista situații în care singurul lucru de care aveți nevoie dintr-un document sunt comentariile. Spuneți că doriți să generați o listă de constatări ale revizuirii sau poate că ați colectat toate informațiile utile din document și pur și simplu doriți să eliminați comentariile inutile. Poate doriți să vizualizați sau să eliminați comentariile unui anumit recenzent.

În acest eșantion, vom analiza câteva metode simple atât pentru colectarea informațiilor din comentariile dintr-un document, cât și pentru eliminarea comentariilor dintr-un document. Mai exact, vom acoperi cum să:

  • Extrageți toate comentariile dintr-un document sau numai cele făcute de un anumit autor.
  • Eliminați toate comentariile dintr-un document sau numai de la un anumit autor.

Cum să extrageți sau să eliminați comentariile

Codul din acest eșantion este destul de simplu și toate metodele se bazează pe aceeași abordare. Un comentariu într-un document Word este reprezentat de un obiect Comment în modelul de obiect document Aspose.Words. Pentru a colecta toate comentariile dintr-un document, utilizați metoda getChildNodes cu primul parametru setat la NodeType.Comment. Asigurați-vă că al doilea parametru al metodei getChildNodes este setat la true: acest lucru forțează getChildNodes să selecteze recursiv din toate nodurile copil, mai degrabă decât să colecteze doar copiii imediati.

Pentru a ilustra modul de extragere și eliminare a comentariilor dintr-un document, vom parcurge următorii pași:

  1. Deschideți un document Word folosind clasa Document
  2. Obțineți toate comentariile din document într-o colecție
  3. Pentru a extrage comentarii:
    1. Treceți prin colecție folosind pentru operator
    2. Extrageți și listați numele autorului, data și ora și textul tuturor comentariilor
    3. Extrageți și listați numele autorului, data și ora și textul comentariilor scrise de un anumit autor, în acest caz, autorul’ks'
  4. Pentru a elimina comentariile:
    1. Mergeți înapoi prin colecție folosind pentru operator
    2. Eliminați comentariile
  5. Salvați modificările.

Vom folosi următorul document Word pentru acest exercițiu:

extract-remove-comments-aspose-words-java-1

După cum puteți vedea, conține mai multe comentarii de la doi autori cu inițialele “pm” și “ks”.

Cum să extrageți toate comentariile

Metoda getChildNodes este foarte utilă și o puteți folosi de fiecare dată când aveți nevoie pentru a obține o listă de noduri de documente de orice tip. Colecția rezultată nu creează o cheltuială imediată, deoarece nodurile sunt selectate în această colecție numai atunci când enumerați sau accesați elemente din ea.

Următorul exemplu de cod arată cum să extrageți numele autorului, data și ora și textul tuturor comentariilor din document:

// 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;

Cum să extrageți comentariile unui autor specificat

După ce ați selectat nodurile de comentarii într-o colecție, tot ce trebuie să faceți este să extrageți informațiile de care aveți nevoie. În acest eșantion, inițialele autorului, data, ora și textul simplu al comentariului sunt combinate într-un singur șir; ați putea alege să îl stocați în alte moduri.

Metoda supraîncărcată care extrage comentariile de la un anumit autor este aproape aceeași, doar verifică numele autorului înainte de a adăuga informațiile în matrice.

Următorul exemplu de cod arată cum să extrageți numele autorului,data și ora și textul comentariilor de către autorul specificat:

// 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 those written by the authorName author.
for (Comment comment : (Iterable<Comment>) comments) {
if (comment.getAuthor().equals(authorName))
collectedComments.add(comment.getAuthor() + " " + comment.getDateTime() + " " + comment.toString(SaveFormat.TEXT));
}
return collectedComments;

Cum să eliminați comentariile

Dacă eliminați toate comentariile, nu este nevoie să treceți prin colecție ștergând comentariile unul câte unul; le puteți elimina apelând clear din colecția de comentarii.

Următorul exemplu de cod arată cum să eliminați toate comentariile din document:

// 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();

Când trebuie să eliminați selectiv comentariile, procesul devine mai asemănător cu codul pe care l-am folosit pentru extragerea comentariilor.

Următorul exemplu de cod arată cum să eliminați comentariile autorului specificat:

// 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);
// Look through all comments and remove those written by the authorName author.
for (int i = comments.getCount() - 1; i >= 0; i--) {
Comment comment = (Comment) comments.get(i);
if (comment.getAuthor().equals(authorName))
comment.remove();
}
}

Principalul punct de evidențiat aici este utilizarea operatorului for. Spre deosebire de extragerea simplă, aici doriți să ștergeți un comentariu. Un truc potrivit este să iterați colecția înapoi de la ultimul comentariu la primul. Motivul pentru aceasta dacă începeți de la sfârșit și vă deplasați înapoi, indexul articolelor precedente rămâne neschimbat și vă puteți întoarce la primul articol din colecție.

Următorul exemplu de cod prezintă metodele de extragere și eliminare a comentariilor:

// 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");

Când este lansat, eșantionul afișează următoarele rezultate. Mai întâi, listează toate comentariile tuturor autorilor, apoi listează numai comentariile autorului selectat. În cele din urmă, codul eliminarea tuturor comentariilor.

extract-remove-comments-aspose-words-java-2

Documentul Word de ieșire are acum Comentarii eliminate din acesta:

extract-remove-comments-aspose-words-java-3

Cum să eliminați textul între CommentRangeStart și CommentRangeEnd

Folosind Aspose.Words de asemenea, puteți elimina comentariile dintre nodurile CommentRangeStart și CommentRangeEnd.

Următorul exemplu de cod arată cum să eliminați textul între CommentRangeStart și 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");

Adăugați sau eliminați răspunsul comentariului

Metoda addReply adaugă un răspuns la acest comentariu. Vă rugăm să rețineți că, din cauza limitărilor existente ale Biroului MS, în document este permis un singur nivel (1) de răspunsuri. O excepție de tip InvalidOperationException va fi ridicată dacă această metodă este apelată la comentariul de răspuns existent.

Puteți utiliza metoda removeReply pentru a elimina răspunsul specificat la acest comentariu.

Următorul exemplu de cod arată cum să adăugați un răspuns la un comentariu și să eliminați răspunsul unui comentariu:

// 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);

Citiți răspunsul comentariului

Aspose.Words suport pentru a citi răspunsul unui comentariu. Proprietatea Replies returnează o colecție de obiecte Comment care sunt copii imediați ai comentariului specificat.

Următorul exemplu de cod arată cum să iterați răspunsurile unui comentariu și să le rezolvați:

// 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);
}
}