ParagraphProperties Class

Paragraph Properties.When the object is serialized out as xml, its qualified name is w:pPr.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Wordprocessing.ParagraphProperties

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(Shading))> _
<ChildElementInfoAttribute(GetType(SnapToGrid))> _
<ChildElementInfoAttribute(GetType(SpacingBetweenLines))> _
<ChildElementInfoAttribute(GetType(MirrorIndents))> _
<ChildElementInfoAttribute(GetType(SuppressOverlap))> _
<ChildElementInfoAttribute(GetType(ContextualSpacing))> _
<ChildElementInfoAttribute(GetType(AdjustRightIndent))> _
<ChildElementInfoAttribute(GetType(AutoSpaceDE))> _
<ChildElementInfoAttribute(GetType(AutoSpaceDN))> _
<ChildElementInfoAttribute(GetType(ParagraphStyleId))> _
<ChildElementInfoAttribute(GetType(KeepNext))> _
<ChildElementInfoAttribute(GetType(KeepLines))> _
<ChildElementInfoAttribute(GetType(PageBreakBefore))> _
<ChildElementInfoAttribute(GetType(FrameProperties))> _
<ChildElementInfoAttribute(GetType(WidowControl))> _
<ChildElementInfoAttribute(GetType(NumberingProperties))> _
<ChildElementInfoAttribute(GetType(SuppressLineNumbers))> _
<ChildElementInfoAttribute(GetType(ParagraphBorders))> _
<ChildElementInfoAttribute(GetType(Tabs))> _
<ChildElementInfoAttribute(GetType(SuppressAutoHyphens))> _
<ChildElementInfoAttribute(GetType(Kinsoku))> _
<ChildElementInfoAttribute(GetType(WordWrap))> _
<ChildElementInfoAttribute(GetType(OverflowPunctuation))> _
<ChildElementInfoAttribute(GetType(TopLinePunctuation))> _
<ChildElementInfoAttribute(GetType(BiDi))> _
<ChildElementInfoAttribute(GetType(Indentation))> _
<ChildElementInfoAttribute(GetType(Justification))> _
<ChildElementInfoAttribute(GetType(TextDirection))> _
<ChildElementInfoAttribute(GetType(TextAlignment))> _
<ChildElementInfoAttribute(GetType(TextBoxTightWrap))> _
<ChildElementInfoAttribute(GetType(OutlineLevel))> _
<ChildElementInfoAttribute(GetType(DivId))> _
<ChildElementInfoAttribute(GetType(ConditionalFormatStyle))> _
<ChildElementInfoAttribute(GetType(ParagraphMarkRunProperties))> _
<ChildElementInfoAttribute(GetType(SectionProperties))> _
<ChildElementInfoAttribute(GetType(ParagraphPropertiesChange))> _
Public Class ParagraphProperties _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As ParagraphProperties

[ChildElementInfoAttribute(typeof(Shading))]
[ChildElementInfoAttribute(typeof(SnapToGrid))]
[ChildElementInfoAttribute(typeof(SpacingBetweenLines))]
[ChildElementInfoAttribute(typeof(MirrorIndents))]
[ChildElementInfoAttribute(typeof(SuppressOverlap))]
[ChildElementInfoAttribute(typeof(ContextualSpacing))]
[ChildElementInfoAttribute(typeof(AdjustRightIndent))]
[ChildElementInfoAttribute(typeof(AutoSpaceDE))]
[ChildElementInfoAttribute(typeof(AutoSpaceDN))]
[ChildElementInfoAttribute(typeof(ParagraphStyleId))]
[ChildElementInfoAttribute(typeof(KeepNext))]
[ChildElementInfoAttribute(typeof(KeepLines))]
[ChildElementInfoAttribute(typeof(PageBreakBefore))]
[ChildElementInfoAttribute(typeof(FrameProperties))]
[ChildElementInfoAttribute(typeof(WidowControl))]
[ChildElementInfoAttribute(typeof(NumberingProperties))]
[ChildElementInfoAttribute(typeof(SuppressLineNumbers))]
[ChildElementInfoAttribute(typeof(ParagraphBorders))]
[ChildElementInfoAttribute(typeof(Tabs))]
[ChildElementInfoAttribute(typeof(SuppressAutoHyphens))]
[ChildElementInfoAttribute(typeof(Kinsoku))]
[ChildElementInfoAttribute(typeof(WordWrap))]
[ChildElementInfoAttribute(typeof(OverflowPunctuation))]
[ChildElementInfoAttribute(typeof(TopLinePunctuation))]
[ChildElementInfoAttribute(typeof(BiDi))]
[ChildElementInfoAttribute(typeof(Indentation))]
[ChildElementInfoAttribute(typeof(Justification))]
[ChildElementInfoAttribute(typeof(TextDirection))]
[ChildElementInfoAttribute(typeof(TextAlignment))]
[ChildElementInfoAttribute(typeof(TextBoxTightWrap))]
[ChildElementInfoAttribute(typeof(OutlineLevel))]
[ChildElementInfoAttribute(typeof(DivId))]
[ChildElementInfoAttribute(typeof(ConditionalFormatStyle))]
[ChildElementInfoAttribute(typeof(ParagraphMarkRunProperties))]
[ChildElementInfoAttribute(typeof(SectionProperties))]
[ChildElementInfoAttribute(typeof(ParagraphPropertiesChange))]
public class ParagraphProperties : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

[ISO/IEC 29500-1 1st Edition]

17.3.1.26 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]

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

• ParagraphStyleId <w:pStyle>

• KeepNext <w:keepNext>

• KeepLines <w:keepLines>

• PageBreakBefore <w:pageBreakBefore>

• FrameProperties <w:framePr>

• WidowControl <w:widowControl>

• NumberingProperties <w:numPr>

• SuppressLineNumbers <w:suppressLineNumbers>

• ParagraphBorders <w:pBdr>

• Shading <w:shd>

• Tabs <w:tabs>

• SuppressAutoHyphens <w:suppressAutoHyphens>

• Kinsoku <w:kinsoku>

• WordWrap <w:wordWrap>

• OverflowPunctuation <w:overflowPunct>

• TopLinePunctuation <w:topLinePunct>

• AutoSpaceDE <w:autoSpaceDE>

• AutoSpaceDN <w:autoSpaceDN>

• BiDi <w:bidi>

• AdjustRightIndent <w:adjustRightInd>

• SnapToGrid <w:snapToGrid>

• SpacingBetweenLines <w:spacing>

• Indentation <w:ind>

• ContextualSpacing <w:contextualSpacing>

• MirrorIndents <w:mirrorIndents>

• SuppressOverlap <w:suppressOverlap>

• Justification <w:jc>

• TextDirection <w:textDirection>

• TextAlignment <w:textAlignment>

• TextBoxTightWrap <w:textboxTightWrap>

• OutlineLevel <w:outlineLvl>

• DivId <w:divId>

• ConditionalFormatStyle <w:cnfStyle>

• ParagraphMarkRunProperties <w:rPr>

• SectionProperties <w:sectPr>

• ParagraphPropertiesChange <w:pPrChange>

© ISO/IEC29500: 2008.

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

ParagraphProperties Members

DocumentFormat.OpenXml.Wordprocessing Namespace