Paragraph class
Paragraph class
Represents a paragraph of text. To learn more, visit the Working with Paragraphs documentation article.
Remarks
Paragraph is a block-level node and can be a child of classes derived from Story or InlineStory.
Paragraph can contain any number of inline-level nodes and bookmarks.
The complete list of child nodes that can occur inside a paragraph consists of BookmarkStart, BookmarkEnd, FieldStart, FieldSeparator, FieldEnd, FormField, Comment, Footnote, Run, SpecialChar, Shape, GroupShape, SmartTag.
A valid paragraph in Microsoft Word always ends with a paragraph break character and a minimal valid paragraph consists just of a paragraph break. The Paragraph class automatically appends the appropriate paragraph break character at the end and this character is not part of the child nodes of the Paragraph, therefore a Paragraph can be empty.
Do not include the end of paragraph Aspose.Words.ControlChar.ParagraphBreak or end of cell Aspose.Words.ControlChar.Cell characters inside the text of the paragraph as it might make the paragraph invalid when the document is opened in Microsoft Word.
Inheritance: Paragraph → CompositeNode → Node
Constructors
| Name | Description |
|---|---|
| Paragraph(doc) | Initializes a new instance of the Paragraph class. |
Properties
| Name | Description |
|---|---|
| breakIsStyleSeparator | True if this paragraph break is a Style Separator. A style separator allows one paragraph to consist of parts that have different paragraph styles. |
| count | Gets the number of immediate children of this node. (Inherited from CompositeNode) |
| customNodeId | Specifies custom node identifier. (Inherited from Node) |
| document | Gets the document to which this node belongs. (Inherited from Node) |
| firstChild | Gets the first child of the node. (Inherited from CompositeNode) |
| frameFormat | Provides access to the frame formatting properties. |
| hasChildNodes | Returns true if this node has any child nodes.(Inherited from CompositeNode) |
| isComposite | Returns true if this node can contain other nodes.(Inherited from Node) |
| isDeleteRevision | Returns true if this object was deleted in Microsoft Word while change tracking was enabled. |
| isEndOfCell | True if this paragraph is the last paragraph in a Cell; false otherwise. |
| isEndOfDocument | True if this paragraph is the last paragraph in the last section of the document. |
| isEndOfHeaderFooter | True if this paragraph is the last paragraph in the HeaderFooter (main text story) of a Section; false otherwise. |
| isEndOfSection | True if this paragraph is the last paragraph in the Body (main text story) of a Section; false otherwise. |
| isFormatRevision | Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled. |
| isInCell | True if this paragraph is an immediate child of Cell; false otherwise. |
| isInsertRevision | Returns true if this object was inserted in Microsoft Word while change tracking was enabled. |
| isListItem | True when the paragraph is an item in a bulleted or numbered list in original revision. |
| isMoveFromRevision | Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled. |
| isMoveToRevision | Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled. |
| lastChild | Gets the last child of the node. (Inherited from CompositeNode) |
| listFormat | Provides access to the list formatting properties of the paragraph. |
| listLabel | Gets a Paragraph.listLabel object that provides access to list numbering value and formatting for this paragraph. |
| nextSibling | Gets the node immediately following this node. (Inherited from Node) |
| nodeType | Returns NodeType.Paragraph. |
| paragraphBreakFont | Provides access to the font formatting of the paragraph break character. |
| paragraphFormat | Provides access to the paragraph formatting properties. |
| parentNode | Gets the immediate parent of this node. (Inherited from Node) |
| parentSection | Retrieves the parent Section of the paragraph. |
| parentStory | Retrieves the parent section-level story that can be Body or HeaderFooter. |
| previousSibling | Gets the node immediately preceding this node. (Inherited from Node) |
| range | Returns a Range object that represents the portion of a document that is contained in this node. (Inherited from Node) |
| runs | Provides access to the typed collection of pieces of text inside the paragraph. |
Methods
| Name | Description |
|---|---|
| appendChild(newChild) | Adds the specified node to the end of the list of child nodes for this node. (Inherited from CompositeNode) |
| appendField(fieldType, updateField) | Appends a field to this paragraph. |
| appendField(fieldCode) | Appends a field to this paragraph. |
| appendField(fieldCode, fieldValue) | Appends a field to this paragraph. |
| asBody() | Cast node to Body. (Inherited from Node) |
| asBookmarkEnd() | Cast node to BookmarkEnd. (Inherited from Node) |
| asBookmarkStart() | Cast node to BookmarkStart. (Inherited from Node) |
| asBuildingBlock() | Cast node to BuildingBlock. (Inherited from Node) |
| asCell() | Cast node to Cell. (Inherited from Node) |
| asComment() | Cast node to Comment. (Inherited from Node) |
| asCommentRangeEnd() | Cast node to CommentRangeEnd. (Inherited from Node) |
| asCommentRangeStart() | Cast node to CommentRangeStart. (Inherited from Node) |
| asCompositeNode() | Cast node to CompositeNode. (Inherited from Node) |
| asDocument() | Cast node to Node.document. (Inherited from Node) |
| asEditableRangeEnd() | Cast node to EditableRangeEnd. (Inherited from Node) |
| asEditableRangeStart() | Cast node to EditableRangeStart. (Inherited from Node) |
| asFieldEnd() | Cast node to FieldEnd. (Inherited from Node) |
| asFieldSeparator() | Cast node to FieldSeparator. (Inherited from Node) |
| asFieldStart() | Cast node to FieldStart. (Inherited from Node) |
| asFootnote() | Cast node to Footnote. (Inherited from Node) |
| asFormField() | Cast node to FormField. (Inherited from Node) |
| asGlossaryDocument() | Cast node to GlossaryDocument. (Inherited from Node) |
| asGroupShape() | Cast node to GroupShape. (Inherited from Node) |
| asHeaderFooter() | Cast node to HeaderFooter. (Inherited from Node) |
| asOfficeMath() | Cast node to OfficeMath. (Inherited from Node) |
| asParagraph() | Cast node to Paragraph. (Inherited from Node) |
| asRow() | Cast node to Row. (Inherited from Node) |
| asRun() | Cast node to Run. (Inherited from Node) |
| asSection() | Cast node to Section. (Inherited from Node) |
| asShape() | Cast node to Shape. (Inherited from Node) |
| asSmartTag() | Cast node to SmartTag. (Inherited from Node) |
| asSpecialChar() | Cast node to SpecialChar. (Inherited from Node) |
| asStructuredDocumentTag() | Cast node to StructuredDocumentTag. (Inherited from Node) |
| asStructuredDocumentTagRangeEnd() | Cast node to StructuredDocumentTagRangeEnd. (Inherited from Node) |
| asStructuredDocumentTagRangeStart() | Cast node to StructuredDocumentTagRangeStart. (Inherited from Node) |
| asSubDocument() | Cast node to SubDocument. (Inherited from Node) |
| asTable() | Cast node to Table. (Inherited from Node) |
| clone(isCloneChildren) | Creates a duplicate of the node. (Inherited from Node) |
| getAncestor(ancestorType) | Gets the first ancestor of the specified NodeType. (Inherited from Node) |
| getBuildingBlock(index, isDeep) | Returns an Nth child BuildingBlock node. (Inherited from CompositeNode) |
| getChild(nodeType, index, isDeep) | Returns an Nth child node that matches the specified type. (Inherited from CompositeNode) |
| getChildNodes(nodeType, isDeep) | Returns a live collection of child nodes that match the specified type. (Inherited from CompositeNode) |
| getComment(index, isDeep) | Returns an Nth child Comment node. (Inherited from CompositeNode) |
| getEditableRangeStart(index, isDeep) | Returns an Nth child EditableRangeStart node. (Inherited from CompositeNode) |
| getEffectiveTabStops() | Returns array of all tab stops applied to this paragraph, including applied indirectly by styles or lists. |
| getFootnote(index, isDeep) | Returns an Nth child Footnote node. (Inherited from CompositeNode) |
| getGroupShape(index, isDeep) | Returns an Nth child GroupShape node. (Inherited from CompositeNode) |
| getOfficeMath(index, isDeep) | Returns an Nth child OfficeMath node. (Inherited from CompositeNode) |
| getParagraph(index, isDeep) | Returns an Nth child Paragraph node. (Inherited from CompositeNode) |
| getRun(index, isDeep) | Returns an Nth child Run node. (Inherited from CompositeNode) |
| getSdt(index, isDeep) | Returns an Nth child StructuredDocumentTag node. (Inherited from CompositeNode) |
| getSdtRangeEnd(index, isDeep) | Returns an Nth child StructuredDocumentTagRangeEnd node. (Inherited from CompositeNode) |
| getSdtRangeStart(index, isDeep) | Returns an Nth child StructuredDocumentTagRangeStart node. (Inherited from CompositeNode) |
| getShape(index, isDeep) | Returns an Nth child Shape node. (Inherited from CompositeNode) |
| getSmartTag(index, isDeep) | Returns an Nth child SmartTag node. (Inherited from CompositeNode) |
| getTable(index, isDeep) | Returns an Nth child Table node. (Inherited from CompositeNode) |
| getText() | Gets the text of this paragraph including the end of paragraph character. |
| indexOf(child) | Returns the index of the specified child node in the child node array. (Inherited from CompositeNode) |
| insertAfter(newChild, refChild) | Inserts the specified node immediately after the specified reference node. (Inherited from CompositeNode) |
| insertBefore(newChild, refChild) | Inserts the specified node immediately before the specified reference node. (Inherited from CompositeNode) |
| insertField(fieldType, updateField, refNode, isAfter) | Inserts a field into this paragraph. |
| insertField(fieldCode, refNode, isAfter) | Inserts a field into this paragraph. |
| insertField(fieldCode, fieldValue, refNode, isAfter) | Inserts a field into this paragraph. |
| joinRunsWithSameFormatting() | Joins runs with the same formatting in the paragraph. |
| nextPreOrder(rootNode) | Gets next node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| nodeTypeToString(nodeType) | A utility method that converts a node type enum value into a user friendly string. (Inherited from Node) |
| prependChild(newChild) | Adds the specified node to the beginning of the list of child nodes for this node. (Inherited from CompositeNode) |
| previousPreOrder(rootNode) | Gets the previous node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| referenceEquals(other) | (Inherited from Node) |
| remove() | Removes itself from the parent. (Inherited from Node) |
| removeAllChildren() | Removes all the child nodes of the current node. (Inherited from CompositeNode) |
| removeChild(oldChild) | Removes the specified child node. (Inherited from CompositeNode) |
| removeSmartTags() | Removes all SmartTag descendant nodes of the current node. (Inherited from CompositeNode) |
| selectNodes(xpath) | Selects a list of nodes matching the XPath expression. (Inherited from CompositeNode) |
| selectSingleNode(xpath) | Selects the first Node that matches the XPath expression. (Inherited from CompositeNode) |
| toString(saveFormat) | Exports the content of the node into a string in the specified format. (Inherited from Node) |
| toString(saveOptions) | Exports the content of the node into a string using the specified save options. (Inherited from Node) |
Examples
Shows how to construct an Aspose.words document by hand.
let doc = new aw.Document();
// A blank document contains one section, one body and one paragraph.
// Call the "RemoveAllChildren" method to remove all those nodes,
// and end up with a document node with no children.
doc.removeAllChildren();
// This document now has no composite child nodes that we can add content to.
// If we wish to edit it, we will need to repopulate its node collection.
// First, create a new section, and then append it as a child to the root document node.
let section = new aw.Section(doc);
doc.appendChild(section);
// Set some page setup properties for the section.
section.pageSetup.sectionStart = aw.SectionStart.NewPage;
section.pageSetup.paperSize = aw.PaperSize.Letter;
// A section needs a body, which will contain and display all its contents
// on the page between the section's header and footer.
let body = new aw.Body(doc);
section.appendChild(body);
// Create a paragraph, set some formatting properties, and then append it as a child to the body.
let para = new aw.Paragraph(doc);
para.paragraphFormat.styleName = "Heading 1";
para.paragraphFormat.alignment = aw.ParagraphAlignment.Center;
body.appendChild(para);
// Finally, add some content to do the document. Create a run,
// set its appearance and contents, and then append it as a child to the paragraph.
let run = new aw.Run(doc);
run.text = "Hello World!";
run.font.color = "#FF0000";
para.appendChild(run);
expect(doc.getText().trim()).toEqual("Hello World!");
doc.save(base.artifactsDir + "Section.CreateManually.docx");
See Also
- module Aspose.Words
- class CompositeNode