ParagraphCollection class
ParagraphCollection class
Provides typed access to a collection of Paragraph nodes. To learn more, visit the Working with Paragraphs documentation article.
Inheritance: ParagraphCollection → NodeCollection
Properties
| Name | Description |
|---|---|
| count | Gets the number of nodes in the collection. (Inherited from NodeCollection) |
| this[] | (Inherited from NodeCollection) |
Methods
| Name | Description |
|---|---|
| add(node) | Adds a node to the end of the collection. (Inherited from NodeCollection) |
| clear() | Removes all nodes from this collection and from the document. (Inherited from NodeCollection) |
| contains(node) | Determines whether a node is in the collection. (Inherited from NodeCollection) |
| indexOf(node) | Returns the zero-based index of the specified node. (Inherited from NodeCollection) |
| insert(index, node) | Inserts a node into the collection at the specified index. (Inherited from NodeCollection) |
| remove(node) | Removes the node from the collection and from the document. (Inherited from NodeCollection) |
| removeAt(index) | Removes the node at the specified index from the collection and from the document. (Inherited from NodeCollection) |
| toArray() | Copies all paragraphs from the collection to a new array of paragraphs. |
Examples
Shows how to check whether a paragraph is a move revision.
let doc = new aw.Document(base.myDir + "Revisions.docx");
// This document contains "Move" revisions, which appear when we highlight text with the cursor,
// and then drag it to move it to another location
// while tracking revisions in Microsoft Word via "Review" -> "Track changes".
expect(Array.from(doc.revisions).filter(r => r.revisionType == aw.RevisionType.Moving).length).toEqual(6);
let paragraphs = doc.firstSection.body.paragraphs;
// Move revisions consist of pairs of "Move from", and "Move to" revisions.
// These revisions are potential changes to the document that we can either accept or reject.
// Before we accept/reject a move revision, the document
// must keep track of both the departure and arrival destinations of the text.
// The second and the fourth paragraph define one such revision, and thus both have the same contents.
expect(paragraphs.at(3).getText()).toEqual(paragraphs.at(1).getText());
// The "Move from" revision is the paragraph where we dragged the text from.
// If we accept the revision, this paragraph will disappear,
// and the other will remain and no longer be a revision.
expect(paragraphs.at(1).isMoveFromRevision).toEqual(true);
// The "Move to" revision is the paragraph where we dragged the text to.
// If we reject the revision, this paragraph instead will disappear, and the other will remain.
expect(paragraphs.at(3).isMoveToRevision).toEqual(true);
See Also
- module Aspose.Words
- class NodeCollection