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

Примеры

В следующем примере открывается существующий текстовый документ, выполняется поиск абзаца в стиле Заголовок1 и вставка потомка структуры перед этим абзацем.

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), и этот интервал следует игнорировать для абзацев выше или ниже того же стиля с помощью элемента contextualSpacing (§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 (связанный идентификатор DIV HTML)	§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
tabs (набор настраиваемых остановок табуляции)	§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

[Примечание. Определение xml-схемы W3C для модели содержимого этого элемента (CT_PPr) находится в §A.1. конечная заметка]

ISO/IEC29500: 2008.

Конструкторы

ParagraphProperties()	Инициализирует новый экземпляр класса ParagraphProperties.
ParagraphProperties(IEnumerable<OpenXmlElement>)	Инициализирует новый экземпляр класса ParagraphProperties указанными дочерними элементами.
ParagraphProperties(OpenXmlElement[])	Инициализирует новый экземпляр класса ParagraphProperties указанными дочерними элементами.
ParagraphProperties(String)	Инициализирует новый экземпляр класса ParagraphProperties из внешнего XML- кода.

Свойства

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	Кинсоку. Представляет следующий тег элемента в схеме: w:kinsoku.
LastChild	Возвращает последний дочерний элемент текущего элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от OpenXmlCompositeElement)
LocalName	Возвращает локальное имя текущего элемента. (Унаследовано от OpenXmlElement)
MCAttributes	Возвращает или задает атрибуты совместимости разметки. Возвращает значение NULL, если для текущего элемента не определены атрибуты совместимости разметки. (Унаследовано от OpenXmlElement)
MirrorIndents	MirrorIndents. Представляет следующий тег элемента в схеме: w:mirrorIndents.
NamespaceDeclarations	Возвращает все объявления пространства имен, определенные в текущем элементе. Возвращает пустой перечислитель, если нет объявления пространства имен. (Унаследовано от OpenXmlElement)
NamespaceUri	Возвращает универсальный код ресурса (URI) пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
NumberingProperties	НумерацииСвойства. Представляет следующий тег элемента в схеме: w:numPr.
OpenXmlElementContext	Возвращает openXmlElementContext текущего элемента. (Унаследовано от OpenXmlElement)
OuterXml	Возвращает разметку, представляющую текущий элемент и все его дочерние элементы. (Унаследовано от OpenXmlElement)
OutlineLevel	OutlineLevel. Представляет следующий тег элемента в схеме: w:outlineLvl.
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)	Возвращает атрибут Open XML с указанным именем тега и URI пространства имен. (Унаследовано от 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. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
NextSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который следует за текущим элементом OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего OpenXmlElement. (Унаследовано от OpenXmlElement)
PrependChild<T>(T)	Вставляет указанный элемент в начало списка дочерних узлов текущего элемента. (Унаследовано от OpenXmlCompositeElement)
PreviousSibling()	Возвращает элемент OpenXmlElement, который непосредственно предшествует текущему элементу OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
PreviousSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который предшествует текущему объекту OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от 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)