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 1st Edition]

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) を使用する下の段落罫線、spacing 要素 (§17.3.1.33) を使用する段落の後の間隔、その間隔は、contextualSpacing 要素 (§17.3.1.9) を使用して同じスタイルの上/下の段落では無視する必要があります。 例終わり]

親の要素
p (§17.3.1.22)

子要素	Subclause
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 (すべての行を 1 ページに保持)	§17.3.1.14
keepNext (次の段落で段落を保持)	§17.3.1.15
kinsoku (1 行あたりの先頭文字と最後の文字に東アジア文字体裁規則を使用)	§17.3.1.16
mirrorIndents (内側/外側インデントとして左/右インデントを使用)	§17.3.1.18
numPr (Numbering Definition Instance Reference)	§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
spacing (行間と段落の上/下の間隔)	§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

[注: この要素のコンテンツ モデル (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)	現在の要素の子要素の 1 つを別の 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)