ParagraphProperties 类

定义

命名空间:

DocumentFormat.OpenXml.Wordprocessing

程序集:

DocumentFormat.OpenXml.dll

包:

DocumentFormat.OpenXml v3.0.1

段落属性。

此类在 Office 2007 及更高版本中可用。

当对象序列化为 xml 时，其限定名称为 w：pPr。

public class ParagraphProperties : DocumentFormat.OpenXml.OpenXmlCompositeElement

type ParagraphProperties = class
    inherit OpenXmlCompositeElement

Public Class ParagraphProperties
Inherits OpenXmlCompositeElement

继承

Object

OpenXmlElement

OpenXmlCompositeElement

ParagraphProperties

示例

以下示例打开一个现有的字处理文档，搜索一个 Heading1 样式的段落，并在该段落之前插入一个轮廓后代。

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  

注解

[ISO/IEC 29500-1 第 1 版]

pPr (段落属性)

此元素指定一组段落属性，在向文本应用所有样式/编号/表属性后，这些属性应应用于父段落的内容。 这些属性定义为 直接格式设置，因为它们直接应用于段落，并取代样式中的任何格式。

[示例：考虑应具有一组段落格式属性的段落。 此属性集在段落属性中指定，如下所示：

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

pPr 元素指定应用于当前段落的属性 - 在本例中， 使用底部元素的底部段落边框 (§17.3.1.7) ，使用间距元素的段落后间距 (§17.3.1.33) ，对于使用上下文元素 (§17.3.1.9) 的相同样式的上方/下方段落，应忽略该间距。 示例结束]

父元素
p (§17.3.1.22)

子元素	第
adjustRightInd (使用文档网格) 时自动调整右缩进	§17.3.1.1
autoSpaceDE (自动调整拉丁语和东亚文本的间距)	§17.3.1.2
autoSpaceDN (自动调整东亚文本和数字的间距)	§17.3.1.3
bidi (从右到左段落布局)	§17.3.1.6
cnfStyle (段落条件格式)	§17.3.1.8
使用相同样式时，contextualSpacing (忽略上方和下方的间距)	§17.3.1.9
divId (关联的 HTML div ID)	§17.3.1.10
framePr (文本框架属性)	§17.3.1.11
ind (段落缩进)	§17.3.1.12
jc (段落对齐方式)	§17.3.1.13
keepLines (将所有行保留在一页上)	§17.3.1.14
keepNext (将段落与下一段保持)	§17.3.1.15
kinsoku (对每行第一个字符和最后一个字符使用东亚版式规则)	§17.3.1.16
mirrorIndents (使用左/右缩进作为内部/外部缩进)	§17.3.1.18
numPr (编号定义实例引用)	§17.3.1.19
outlineLvl (关联的大纲级别)	§17.3.1.20
overflowPunct (允许标点符号扩展过去的文本范围)	§17.3.1.21
pageBreakBefore (下一页的起始段落)	§17.3.1.23
pBdr (段落边框)	§17.3.1.24
pPrChange（段落属性的修订信息）	§17.13.5.29
pStyle (引用段落样式)	§17.3.1.27
rPr (段落标记) 的运行属性	§17.3.1.29
sectPr (节属性)	§17.6.18
shd (段落底纹)	§17.3.1.31
snapToGrid (将文档网格设置用于 Inter-Line 段落间距)	§17.3.1.32
间距 (行距和段落上方/下段)	§17.3.1.33
suppressAutoHyphens (取消段落) 的断字	§17.3.1.34
suppressLineNumbers (禁止显示段落) 的行号	§17.3.1.35
suppressOverlap (防止文本框架重叠)	§17.3.1.36
选项卡 (自定义制表位集)	§17.3.1.38
textAlignment (行) 上的垂直字符对齐方式	§17.3.1.39
textboxTightWrap (允许周围的段落紧密环绕到文本框内容)	§17.3.1.40
textDirection (段落文本流方向)	§17.3.1.41
topLinePunct (在行开头压缩标点符号)	§17.3.1.43
widowControl (允许在单独的页面上显示第一行/最后一行)	§17.3.1.44
wordWrap (允许在字符级别) 换行	§17.3.1.45

[注意：此元素的内容模型 (CT_PPr) 的 W3C XML 架构定义位于 §A.1 中。 注释结束]

ISO/IEC29500：2008。

构造函数

ParagraphProperties()	初始化 ParagraphProperties 类的新实例。
ParagraphProperties(IEnumerable<OpenXmlElement>)	使用指定的子元素初始化 ParagraphProperties 类的新实例。
ParagraphProperties(OpenXmlElement[])	使用指定的子元素初始化 ParagraphProperties 类的新实例。
ParagraphProperties(String)	从外部 XML 初始化 ParagraphProperties 类的新实例。

属性

AdjustRightIndent	AdjustRightIndent。 表示架构中的以下元素标记：w：adjustRightInd。
AutoSpaceDE	AutoSpaceDE。 表示架构中的以下元素标记：w：autoSpaceDE。
AutoSpaceDN	AutoSpaceDN。 表示架构中的以下元素标记：w：autoSpaceDN。
BiDi	BiDi。 表示架构中的以下元素标记：w：bidi。
ChildElements	获取当前元素的所有子节点。 (继承自 OpenXmlElement)
ConditionalFormatStyle	ConditionalFormatStyle。 表示架构中的以下元素标记：w：cnfStyle。
ContextualSpacing	ContextualSpacing。 表示架构中的以下元素标记：w：contextualSpacing。
DivId	DivId。 表示架构中的以下元素标记：w：divId。
ExtendedAttributes	获取当前元素的架构) 中未定义的所有扩展属性 (属性。 (继承自 OpenXmlElement)
Features	IFeatureCollection获取当前元素的 。 此功能集合将是只读的，但会从其父部件和包继承功能（如果可用）。 (继承自 OpenXmlElement)
FirstChild	获取当前 OpenXmlElement 元素的第一个子元素。 (继承自 OpenXmlCompositeElement)
FrameProperties	FrameProperties。 表示架构中的以下元素标记：w：framePr。
HasAttributes	获取一个值，该值指示当前元素是否具有任何属性。 (继承自 OpenXmlElement)
HasChildren	获取一个值，该值指示当前元素是否具有任何子元素。 (继承自 OpenXmlCompositeElement)
Indentation	压 痕。 表示架构中的以下元素标记：w：ind。
InnerText	获取或设置当前节点及其所有子节点的串联值。 (继承自 OpenXmlCompositeElement)
InnerXml	获取或设置仅表示当前节点的子节点的标记。 (继承自 OpenXmlCompositeElement)
Justification	理由。 表示架构中的以下元素标记：w：jc。
KeepLines	KeepLines。 表示架构中的以下元素标记：w：keepLines。
KeepNext	KeepNext。 表示架构中的以下元素标记：w：keepNext。
Kinsoku	Kinsoku。 表示架构中的以下元素标记：w：kinsoku。
LastChild	获取当前 OpenXmlElement 元素的最后一个子元素。 如果没有这样的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlCompositeElement)
LocalName	获取当前元素的本地名称。 (继承自 OpenXmlElement)
MCAttributes	获取或设置标记兼容性属性。 如果未为当前元素定义标记兼容性属性，则返回 null。 (继承自 OpenXmlElement)
MirrorIndents	MirrorIndents。 表示架构中的以下元素标记：w：mirrorIndents。
NamespaceDeclarations	获取在当前元素中定义的所有命名空间声明。 如果没有命名空间声明，则返回空枚举器。 (继承自 OpenXmlElement)
NamespaceUri	获取当前元素的命名空间 URI。 (继承自 OpenXmlElement)
NumberingProperties	NumberingProperties。 表示架构中的以下元素标记：w：numPr。
OpenXmlElementContext	获取当前元素的 OpenXmlElementContext。 (继承自 OpenXmlElement)
OuterXml	获取表示当前元素及其所有子元素的标记。 (继承自 OpenXmlElement)
OutlineLevel	OutlineLevel。 表示架构中的以下元素标记：w：outlineLvl。
OverflowPunctuation	OverflowPunctuation。 表示架构中的以下元素标记：w：overflowPunct。
PageBreakBefore	PageBreakBefore。 表示架构中的以下元素标记：w：pageBreakBefore。
ParagraphBorders	ParagraphBorders。 表示架构中的以下元素标记：w：pBdr。
ParagraphMarkRunProperties	运行段落标记的属性。 表示架构中的以下元素标记：w：rPr。
ParagraphPropertiesChange	ParagraphPropertiesChange。 表示架构中的以下元素标记：w：pPrChange。
ParagraphStyleId	ParagraphStyleId。 表示架构中的以下元素标记：w：pStyle。
Parent	获取当前元素的父元素。 (继承自 OpenXmlElement)
Prefix	获取当前元素的命名空间前缀。 (继承自 OpenXmlElement)
SectionProperties	节属性。 表示架构中的以下元素标记：w：sectPr。
Shading	底纹。 表示架构中的以下元素标记：w：shd。
SnapToGrid	SnapToGrid。 表示架构中的以下元素标记：w：snapToGrid。
SpacingBetweenLines	SpacingBetweenLines。 表示架构中的以下元素标记：w：spacing。
SuppressAutoHyphens	SuppressAutoHyphens。 表示架构中的以下元素标记：w：suppressAutoHyphens。
SuppressLineNumbers	SuppressLineNumbers。 表示架构中的以下元素标记：w：suppressLineNumbers。
SuppressOverlap	SuppressOverlap。 表示架构中的以下元素标记：w：suppressOverlap。
Tabs	标签。 表示架构中的以下元素标记：w：tabs。
TextAlignment	TextAlignment。 表示架构中的以下元素标记：w：textAlignment。
TextBoxTightWrap	TextBoxTightWrap。 表示架构中的以下元素标记：w：textboxTightWrap。
TextDirection	TextDirection。 表示架构中的以下元素标记：w：textDirection。
TopLinePunctuation	TopLinePunctuation。 表示架构中的以下元素标记：w：topLinePunct。
WidowControl	WidowControl。 表示架构中的以下元素标记：w：widowControl。
WordWrap	WordWrap。 表示架构中的以下元素标记：w：wordWrap。
XmlQualifiedName	获取当前元素的限定名称。 (继承自 OpenXmlElement)
XName	获取当前元素的限定名称。 (继承自 OpenXmlElement)

方法

AddAnnotation(Object)	将 对象添加到当前 OpenXmlElement 元素的批注列表中。 (继承自 OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	如果指定元素是已知的子元素，则将其添加到 元素。 这会根据架构将 元素添加到正确的位置。 (继承自 OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	将命名空间声明添加到当前节点。 (继承自 OpenXmlElement)
Ancestors()	枚举当前元素的所有上级。 (继承自 OpenXmlElement)
Ancestors<T>()	仅枚举具有指定类型的当前元素的上级。 (继承自 OpenXmlElement)
Annotation(Type)	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotation<T>()	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotations(Type)	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Annotations<T>()	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	将元素列表中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
Append(OpenXmlElement[])	将元素数组中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
AppendChild<T>(T)	将指定的元素追加到当前元素的子节点列表的末尾。 (继承自 OpenXmlCompositeElement)
ClearAllAttributes()	清除所有属性，包括已知属性和扩展属性。 (继承自 OpenXmlElement)
Clone()	创建当前节点的副本。 (继承自 OpenXmlElement)
CloneNode(Boolean)	创建此节点的副本。
Descendants()	枚举当前元素的所有后代。 (继承自 OpenXmlElement)
Descendants<T>()	枚举类型为 T 的当前元素的所有后代。 (继承自 OpenXmlElement)
Elements()	枚举当前元素的所有子元素。 (继承自 OpenXmlElement)
Elements<T>()	仅枚举具有指定类型的当前元素的子元素。 (继承自 OpenXmlElement)
ElementsAfter()	枚举与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
ElementsBefore()	枚举当前元素之前且具有与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
GetAttribute(String, String)	获取具有指定标记名称和命名空间 URI 的 Open XML 属性。 (继承自 OpenXmlElement)
GetAttributes()	获取一个列表，该列表包含所有属性的副本。 (继承自 OpenXmlElement)
GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)
GetFirstChild<T>()	查找类型 T 中的第一个子元素。 (继承自 OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	在指定的引用元素之后立即插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	在当前元素之后立即插入指定的元素。 (继承自 OpenXmlElement)
InsertAt<T>(T, Int32)	在当前元素的子元素的指定索引处插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	将指定的元素紧接在指定的引用元素之前。 (继承自 OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	将指定的元素紧接在当前元素的前面。 (继承自 OpenXmlElement)
IsAfter(OpenXmlElement)	确定当前元素是否以文档顺序显示在指定元素之后。 (继承自 OpenXmlElement)
IsBefore(OpenXmlElement)	确定当前元素是否按文档顺序显示在指定元素之前。 (继承自 OpenXmlElement)
LookupNamespace(String)	解析当前节点上下文中的命名空间前缀。 (继承自 OpenXmlElement)
LookupPrefix(String)	查找当前元素范围内命名空间 URI 的相应前缀。 (继承自 OpenXmlElement)
NextSibling()	获取紧跟在当前 OpenXmlElement 元素后面的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
NextSibling<T>()	获取具有当前 OpenXmlElement 元素后面的指定类型的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
PrependChild<T>(T)	在当前元素的子节点列表的开头插入指定的元素。 (继承自 OpenXmlCompositeElement)
PreviousSibling()	获取紧接在当前 OpenXmlElement 元素之前的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic ) 中 Nothing。 (继承自 OpenXmlElement)
PreviousSibling<T>()	获取位于当前 OpenXmlElement 之前的指定类型的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
Remove()	从其父元素中删除当前元素。 (继承自 OpenXmlElement)
RemoveAllChildren()	删除当前元素的所有子元素。 (继承自 OpenXmlCompositeElement)
RemoveAllChildren<T>()	删除类型为 T 的当前元素的所有子元素。 (继承自 OpenXmlElement)
RemoveAnnotations(Type)	从当前 OpenXmlElement 元素中删除指定类型的注释。 (继承自 OpenXmlElement)
RemoveAnnotations<T>()	从当前 OpenXmlElement 元素中删除具有指定类型的批注。 (继承自 OpenXmlElement)
RemoveAttribute(String, String)	从当前元素中删除 属性。 (继承自 OpenXmlElement)
RemoveChild<T>(T)	删除指定的子元素。 (继承自 OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	删除指定前缀的命名空间声明。 如果没有前缀，则不删除任何内容。 (继承自 OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	将当前元素的子元素之一替换为另一个 OpenXmlElement 元素。 (继承自 OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	将特性设置为指定的元素。 如果该属性是已知属性，则设置该特性的值。 如果该属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	设置元素的多个属性。 如果属性是已知属性，则会设置该属性的值。 如果属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
WriteTo(XmlWriter)	将当前节点保存到指定的 XmlWriter。 (继承自 OpenXmlElement)

显式接口实现

IEnumerable.GetEnumerator()	段落属性。 此类在 Office 2007 及更高版本中可用。 当对象序列化为 xml 时，其限定名称为 w：pPr。 (继承自 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)