Paragraph Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the Paragraph Class.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is w:p.

public class Paragraph : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Paragraph = class
    inherit OpenXmlCompositeElement

Public Class Paragraph
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

Paragraph

Examples

The following code example opens an existing word-processing file and writes text to it.

using System;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Wordprocessing;  

namespace ParagraphEx  
{  
    class Program  
    {  
        // Open an existing file and add text to it.  
        static void Main(string[] args)  
        {  
           string fileName = @"C:\Users\Public\Documents\ParagraphEx.docx";  

           // Open the file for editing.  
           using (WordprocessingDocument wordprocessingDocument =  
               WordprocessingDocument.Open(fileName, true))  
           {  
                    // Get document element of the Package.  
                    Document document =   
                        wordprocessingDocument.MainDocumentPart.Document;  

                    // Add new text to the file.   
                    document.Append(new Body  
                        (new Paragraph  
                            (new Run  
                                (new Text  
                                    ("This is the inserted text by the example.")))));  
                    Console.WriteLine("All done. Press a key.");  
                    Console.ReadKey();  
           }  
        }  
    }  
}  

Imports System  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Wordprocessing  

Module Module1  

    ' Open an existing file and add text to it.  
    Sub Main()  
        Dim fileName As String = "C:\Users\Public\Documents\ParagraphEx.docx"  

        ' Open the file for editing.  
        Using wordprocessingDocument As WordprocessingDocument = wordprocessingDocument.Open(fileName, True)  
            ' Get document element of the Package.  
            Dim document As Document = wordprocessingDocument.MainDocumentPart.Document  

            ' Add new text to the file.   
            document.Append(New Body _  
                            (New Paragraph _  
                             (New Run _  
                              (New Text _  
                               ("This is the inserted text by the example.")))))  
            Console.WriteLine("All done. Press a key.")  
            Console.ReadKey()  
        End Using  
    End Sub  
End Module  

Remarks

[ISO/IEC 29500-1 1st Edition]

p (Paragraph)

This element specifies a paragraph of content in the document.

The contents of a paragraph in a WordprocessingML document shall consist of any combination of the following four kinds of content:

• Paragraph properties

• Annotations (bookmarks, comments, revisions)

• Custom markup

• Run level content (fields, hyperlinks, runs)

[Example: Consider a basic WordprocessingML document with a single paragraph. This paragraph would be expressed as follows:

<w:document>  
  <w:body>  
    <w:p>  
      <w:r>  
        <w:t>Text</w:t>  
      </w:r>  
      <w:fldSimple w:instr="AUTHOR">  
        <w:r>  
          <w:t>Author Name</w:t>  
        </w:r>  
      </w:fldSimple>  
    </w:p>  
  </w:body>  
</w:document>  

The p element is the container for all of the content in the paragraph, which in this example includes both a text run and a simple field. end example]

Parent Elements
body (§17.2.2); comment (§17.13.4.2); customXml (§17.5.1.6); docPartBody (§17.12.6); endnote (§17.11.2); footnote (§17.11.10); ftr (§17.10.3); hdr (§17.10.4); sdtContent (§17.5.2.34); tc (§17.4.66)

Child Elements	Subclause
bdo (Bidirectional Override)	§17.3.2.3
bookmarkEnd (Bookmark End)	§17.13.6.1
bookmarkStart (Bookmark Start)	§17.13.6.2
commentRangeEnd (Comment Anchor Range End)	§17.13.4.3
commentRangeStart (Comment Anchor Range Start)	§17.13.4.4
customXml (Inline-Level Custom XML Element)	§17.5.1.3
customXmlDelRangeEnd (Custom XML Markup Deletion End)	§17.13.5.4
customXmlDelRangeStart (Custom XML Markup Deletion Start)	§17.13.5.5
customXmlInsRangeEnd (Custom XML Markup Insertion End)	§17.13.5.6
customXmlInsRangeStart (Custom XML Markup Insertion Start)	§17.13.5.7
customXmlMoveFromRangeEnd (Custom XML Markup Move Source End)	§17.13.5.8
customXmlMoveFromRangeStart (Custom XML Markup Move Source Start)	§17.13.5.9
customXmlMoveToRangeEnd (Custom XML Markup Move Destination Location End)	§17.13.5.10
customXmlMoveToRangeStart (Custom XML Markup Move Destination Location Start)	§17.13.5.11
del (Deleted Run Content)	§17.13.5.14
dir (Bidirectional Embedding Level)	§17.3.2.8
fldSimple (Simple Field)	§17.16.19
hyperlink (Hyperlink)	§17.16.22
ins (Inserted Run Content)	§17.13.5.18
moveFrom (Move Source Run Content)	§17.13.5.22
moveFromRangeEnd (Move Source Location Container - End)	§17.13.5.23
moveFromRangeStart (Move Source Location Container - Start)	§17.13.5.24
moveTo (Move Destination Run Content)	§17.13.5.25
moveToRangeEnd (Move Destination Location Container - End)	§17.13.5.27
moveToRangeStart (Move Destination Location Container - Start)	§17.13.5.28
oMath (Office Math)	§22.1.2.77
oMathPara (Office Math Paragraph)	§22.1.2.78
permEnd (Range Permission End)	§17.13.7.1
permStart (Range Permission Start)	§17.13.7.2
pPr (Paragraph Properties)	§17.3.1.26
proofErr (Proofing Error Anchor)	§17.13.8.1
r (Text Run)	§17.3.2.25
sdt (Inline-Level Structured Document Tag)	§17.5.2.31
smartTag (Inline-Level Smart Tag)	§17.5.1.9
subDoc (Anchor for Subdocument Location)	§17.17.1.1

Attributes	Description
rsidDel (Revision Identifier for Paragraph Deletion)	Specifies a unique identifier used to track the editing session when the paragraph was deleted from the main document. All rsid* attributes throughout this document with the same value, if present, shall indicate that those regions were modified during the same editing session (time between subsequent save actions). A producer can choose to increment the revision save ID value to indicate subsequent editing sessions to indicate the order of the modifications relative to other modifications in this document. The possible values for this attribute are defined by the ST_LongHexNumber simple type (§17.18.50).
rsidP (Revision Identifier for Paragraph Properties)	This attribute specifies a unique identifier used to track the editing session when the paragraph's properties were last modified in this document. All rsid* attributes throughout this document with the same value, if present, shall indicate that those regions were modified during the same editing session (time between subsequent save actions). A producer can choose to increment the revision save ID value to indicate subsequent editing sessions to indicate the order of the modifications relative to other modifications in this document. The possible values for this attribute are defined by the ST_LongHexNumber simple type (§17.18.50).
rsidR (Revision Identifier for Paragraph)	This attribute specifies a unique identifier used to track the editing session when the paragraph was added to the main document. All rsid* attributes throughout this document with the same value, if present, shall indicate that those regions were modified during the same editing session (time between subsequent save actions). A producer can choose to increment the revision save ID value to indicate subsequent editing sessions to indicate the order of the modifications relative to other modifications in this document. The possible values for this attribute are defined by the ST_LongHexNumber simple type (§17.18.50).
rsidRDefault (Default Revision Identifier for Runs)	This attribute specifies a unique identifier used for all runs in this paragraph which do not explicitly declare an rsidR attribute. This attribute allows consumers to optimize the locations where rsid* values are written in this document. All rsid* attributes throughout this document with the same value, if present, shall indicate that those regions were modified during the same editing session (time between subsequent save actions). A producer can choose to increment the revision save ID value to indicate subsequent editing sessions to indicate the order of the modifications relative to other modifications in this document. The possible values for this attribute are defined by the ST_LongHexNumber simple type (§17.18.50).
rsidRPr (Revision Identifier for Paragraph Glyph Formatting)	This attribute specifies a unique identifier used to track the editing session when the glyph character representing the paragraph mark was last modified in the main document. All rsid* attributes throughout this document with the same value, if present, shall indicate that those regions were modified during the same editing session (time between subsequent save actions). A producer can choose to increment the revision save ID value to indicate subsequent editing sessions to indicate the order of the modifications relative to other modifications in this document. The possible values for this attribute are defined by the ST_LongHexNumber simple type (§17.18.50).

[Note: The W3C XML Schema definition of this element’s content model (CT_P) is located in §A.1. end note]

� ISO/IEC29500: 2008.

Constructors

Paragraph()	Initializes a new instance of the Paragraph class.
Paragraph(IEnumerable<OpenXmlElement>)	Initializes a new instance of the Paragraph class with the specified child elements.
Paragraph(OpenXmlElement[])	Initializes a new instance of the Paragraph class with the specified child elements.
Paragraph(String)	Initializes a new instance of the Paragraph class from outer XML.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
NoSpellError	noSpellErr, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w14:noSpellErr
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
ParagraphId	paraId, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w14:paraId
ParagraphProperties	Paragraph Properties. Represents the following element tag in the schema: w:pPr.
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
RsidParagraphAddition	Revision Identifier for Paragraph Represents the following attribute in the schema: w:rsidR
RsidParagraphDeletion	Revision Identifier for Paragraph Deletion Represents the following attribute in the schema: w:rsidDel
RsidParagraphMarkRevision	Revision Identifier for Paragraph Glyph Formatting Represents the following attribute in the schema: w:rsidRPr
RsidParagraphProperties	Revision Identifier for Paragraph Properties Represents the following attribute in the schema: w:rsidP
RsidRunAdditionDefault	Default Revision Identifier for Runs Represents the following attribute in the schema: w:rsidRDefault
TextId	textId, this property is only available in Office 2010 and later. Represents the following attribute in the schema: w14:textId
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)