ParagraphProperties Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Paragraph Properties.

This class is available in Office 2007 and above.

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

public class ParagraphProperties : DocumentFormat.OpenXml.OpenXmlCompositeElement

type ParagraphProperties = class
    inherit OpenXmlCompositeElement

Public Class ParagraphProperties
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

ParagraphProperties

Examples

The following example opens an existing word processing document, searches it for a Heading1 styled paragraph, and inserts an outline descendant before that paragraph.

using System;  
using System.Collections.Generic;  
using System.Linq;  
using DocumentFormat.OpenXml;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Wordprocessing;  

namespace ParagraphPropertiesEx  
{  
    class Program  
    {  
        // Search all paragraphs of the specified style and make an outline descendant.  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\Users\Public\Documents\ParagraphPropertiesEx.docx";  
            using (WordprocessingDocument wordprocessingDocument =   
                WordprocessingDocument.Open(fileName, true))  
            {  
                // Get the body element.  
                var body = wordprocessingDocument.MainDocumentPart.Document.Body;  

                //Define a list to store outline Paragraphs  
                var paragraphs = new List<Paragraph>();  

                // Search all Paragraphs that is "Heading1" style.  
                foreach (Paragraph para in body.Descendants<Paragraph>().  
                    Where(e => e.ParagraphProperties != null  
                        && e.ParagraphProperties.ParagraphStyleId != null  
                        && e.ParagraphProperties.ParagraphStyleId.Val == "Heading1"))  
                {  
                    paragraphs.Add(new Paragraph(new Run(new Text(para.InnerText))));  
                }  

                // Need to find whether first child is null, if so, add the paragragh collections to Body.  
                if (body.FirstChild == null)  
                {  
                    body.Append(paragraphs.ToArray());  
                }  

                // Else, get first child and always insert before it.  
                else  
                {  
                    OpenXmlElement first = body.FirstChild;  
                    foreach (Paragraph p in paragraphs)  
                    {  
                        first.InsertBeforeSelf<Paragraph>(p);  
                    }  
                }  
            }  
            Console.WriteLine("All done. Press a key");  
            Console.ReadKey();  
        }  
    }  
}  

Imports System.Collections.Generic  
Imports System.Linq  
Imports DocumentFormat.OpenXml  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Wordprocessing  

Module Module1  
    ' Search all paragraphs of the specified style and make an outline descendant.  
    Sub Main(ByVal args As String())  
        Dim fileName As String = "C:\Users\Public\Documents\ParagraphPropertiesEx.docx"  
        Using wordprocessingDocument As WordprocessingDocument = wordprocessingDocument.Open(fileName, True)  
            ' Get the body element.  
            Dim body = wordprocessingDocument.MainDocumentPart.Document.Body  
            'Define a list to store outline Paragraphs  
            Dim paragraphs = New List(Of Paragraph)()  

            ' Search all Paragraphs that is "Heading1" style.  
            For Each para As Paragraph In body.Descendants(Of Paragraph)().Where(Function(e) e.ParagraphProperties IsNot Nothing AndAlso e.ParagraphProperties.ParagraphStyleId IsNot Nothing AndAlso e.ParagraphProperties.ParagraphStyleId.Val = "Heading1")  
                paragraphs.Add(New Paragraph(New Run(New Text(para.InnerText))))  
            Next  

            ' Need to find whether first child is null, if so, add the paragragh collections to Body.  
            If body.FirstChild Is Nothing Then  
                body.Append(paragraphs.ToArray())  
            Else  
                ' Else, get first child and always insert before it.  
                Dim first As OpenXmlElement = body.FirstChild  
                For Each p As Paragraph In paragraphs  
                    first.InsertBeforeSelf(Of Paragraph)(p)  
                Next  
            End If  
        End Using  
        Console.WriteLine("All done. Press a key")  
        Console.ReadKey()  
    End Sub  
End Module  

Remarks

[ISO/IEC 29500-1 1st Edition]

pPr (Paragraph Properties)

This element specifies a set of paragraph properties which shall be applied to the contents of the parent paragraph after all style/numbering/table properties have been applied to the text. These properties are defined as direct formatting, since they are directly applied to the paragraph and supersede any formatting from styles.

[Example: Consider a paragraph which should have a set of paragraph formatting properties. This set of properties is specified in the paragraph properties as follows:

<w:p>  
  <w:pPr>  
    <w:pBdr>  
      <w:bottom w:val="single" w:sz="8" w:space="4" w:color="4F81BD" />   
    </w:pBdr>  
    <w:spacing w:after="300" />   
    <w:contextualSpacing />   
  </w:pPr>  
</w:p>  

The pPr element specifies the properties which are applied to the current paragraph - in this case, a bottom paragraph border using the bottom element (§17.3.1.7), spacing after the paragraph using the spacing element (§17.3.1.33), and that spacing should be ignored for paragraphs above/below of the same style using the contextualSpacing element (§17.3.1.9). end example]

Parent Elements
p (§17.3.1.22)

Child Elements	Subclause
adjustRightInd (Automatically Adjust Right Indent When Using Document Grid)	§17.3.1.1
autoSpaceDE (Automatically Adjust Spacing of Latin and East Asian Text)	§17.3.1.2
autoSpaceDN (Automatically Adjust Spacing of East Asian Text and Numbers)	§17.3.1.3
bidi (Right to Left Paragraph Layout)	§17.3.1.6
cnfStyle (Paragraph Conditional Formatting)	§17.3.1.8
contextualSpacing (Ignore Spacing Above and Below When Using Identical Styles)	§17.3.1.9
divId (Associated HTML div ID)	§17.3.1.10
framePr (Text Frame Properties)	§17.3.1.11
ind (Paragraph Indentation)	§17.3.1.12
jc (Paragraph Alignment)	§17.3.1.13
keepLines (Keep All Lines On One Page)	§17.3.1.14
keepNext (Keep Paragraph With Next Paragraph)	§17.3.1.15
kinsoku (Use East Asian Typography Rules for First and Last Character per Line)	§17.3.1.16
mirrorIndents (Use Left/Right Indents as Inside/Outside Indents)	§17.3.1.18
numPr (Numbering Definition Instance Reference)	§17.3.1.19
outlineLvl (Associated Outline Level)	§17.3.1.20
overflowPunct (Allow Punctuation to Extend Past Text Extents)	§17.3.1.21
pageBreakBefore (Start Paragraph on Next Page)	§17.3.1.23
pBdr (Paragraph Borders)	§17.3.1.24
pPrChange (Revision Information for Paragraph Properties)	§17.13.5.29
pStyle (Referenced Paragraph Style)	§17.3.1.27
rPr (Run Properties for the Paragraph Mark)	§17.3.1.29
sectPr (Section Properties)	§17.6.18
shd (Paragraph Shading)	§17.3.1.31
snapToGrid (Use Document Grid Settings for Inter-Line Paragraph Spacing)	§17.3.1.32
spacing (Spacing Between Lines and Above/Below Paragraph)	§17.3.1.33
suppressAutoHyphens (Suppress Hyphenation for Paragraph)	§17.3.1.34
suppressLineNumbers (Suppress Line Numbers for Paragraph)	§17.3.1.35
suppressOverlap (Prevent Text Frames From Overlapping)	§17.3.1.36
tabs (Set of Custom Tab Stops)	§17.3.1.38
textAlignment (Vertical Character Alignment on Line)	§17.3.1.39
textboxTightWrap (Allow Surrounding Paragraphs to Tight Wrap to Text Box Contents)	§17.3.1.40
textDirection (Paragraph Text Flow Direction)	§17.3.1.41
topLinePunct (Compress Punctuation at Start of a Line)	§17.3.1.43
widowControl (Allow First/Last Line to Display on a Separate Page)	§17.3.1.44
wordWrap (Allow Line Breaking At Character Level)	§17.3.1.45

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

AdjustRightIndent	AdjustRightIndent. Represents the following element tag in the schema: w:adjustRightInd.
AutoSpaceDE	AutoSpaceDE. Represents the following element tag in the schema: w:autoSpaceDE.
AutoSpaceDN	AutoSpaceDN. Represents the following element tag in the schema: w:autoSpaceDN.
BiDi	BiDi. Represents the following element tag in the schema: w:bidi.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ConditionalFormatStyle	ConditionalFormatStyle. Represents the following element tag in the schema: w:cnfStyle.
ContextualSpacing	ContextualSpacing. Represents the following element tag in the schema: w:contextualSpacing.
DivId	DivId. Represents the following element tag in the schema: w:divId.
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)
FrameProperties	FrameProperties. Represents the following element tag in the schema: w:framePr.
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)
Indentation	Indentation. Represents the following element tag in the schema: w:ind.
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)
Justification	Justification. Represents the following element tag in the schema: w:jc.
KeepLines	KeepLines. Represents the following element tag in the schema: w:keepLines.
KeepNext	KeepNext. Represents the following element tag in the schema: w:keepNext.
Kinsoku	Kinsoku. Represents the following element tag in the schema: w:kinsoku.
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)
MirrorIndents	MirrorIndents. Represents the following element tag in the schema: w:mirrorIndents.
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)
NumberingProperties	NumberingProperties. Represents the following element tag in the schema: w:numPr.
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)
OutlineLevel	OutlineLevel. Represents the following element tag in the schema: w:outlineLvl.
OverflowPunctuation	OverflowPunctuation. Represents the following element tag in the schema: w:overflowPunct.
PageBreakBefore	PageBreakBefore. Represents the following element tag in the schema: w:pageBreakBefore.
ParagraphBorders	ParagraphBorders. Represents the following element tag in the schema: w:pBdr.
ParagraphMarkRunProperties	Run Properties for the Paragraph Mark. Represents the following element tag in the schema: w:rPr.
ParagraphPropertiesChange	ParagraphPropertiesChange. Represents the following element tag in the schema: w:pPrChange.
ParagraphStyleId	ParagraphStyleId. Represents the following element tag in the schema: w:pStyle.
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
SectionProperties	Section Properties. Represents the following element tag in the schema: w:sectPr.
Shading	Shading. Represents the following element tag in the schema: w:shd.
SnapToGrid	SnapToGrid. Represents the following element tag in the schema: w:snapToGrid.
SpacingBetweenLines	SpacingBetweenLines. Represents the following element tag in the schema: w:spacing.
SuppressAutoHyphens	SuppressAutoHyphens. Represents the following element tag in the schema: w:suppressAutoHyphens.
SuppressLineNumbers	SuppressLineNumbers. Represents the following element tag in the schema: w:suppressLineNumbers.
SuppressOverlap	SuppressOverlap. Represents the following element tag in the schema: w:suppressOverlap.
Tabs	Tabs. Represents the following element tag in the schema: w:tabs.
TextAlignment	TextAlignment. Represents the following element tag in the schema: w:textAlignment.
TextBoxTightWrap	TextBoxTightWrap. Represents the following element tag in the schema: w:textboxTightWrap.
TextDirection	TextDirection. Represents the following element tag in the schema: w:textDirection.
TopLinePunctuation	TopLinePunctuation. Represents the following element tag in the schema: w:topLinePunct.
WidowControl	WidowControl. Represents the following element tag in the schema: w:widowControl.
WordWrap	WordWrap. Represents the following element tag in the schema: w:wordWrap.
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)