Style クラス

定義

名前空間:

DocumentFormat.OpenXml.Wordprocessing

アセンブリ:

DocumentFormat.OpenXml.dll

パッケージ:

DocumentFormat.OpenXml v3.0.1

スタイル定義。

このクラスは、Office 2007 以降で使用できます。

オブジェクトを xml としてシリアル化されるときに、修飾名は w:style です。

public class Style : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Style = class
    inherit OpenXmlCompositeElement

Public Class Style
Inherits OpenXmlCompositeElement

継承

Object

OpenXmlElement

OpenXmlCompositeElement

Style

例

次のコード例では、テキストを含むワープロ ファイルを開き、スタイル "見出し 1" を最初の段落に適用します。

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

namespace StyleEx  
{  
    class Program  
    {  
        // Apply the Heading 1 style to a paragraph.  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\users\public\documents\StyleEx.docx";  

            using (WordprocessingDocument document =   
                WordprocessingDocument.Open(fileName, true))  
            {  
                // Get the first paragraph.  
                Paragraph p =  
                    document.MainDocumentPart.Document.Body.Elements<Paragraph>().First();  

                // If the paragraph has no ParagraphProperties objects, create a new one for it.  
                if (p.Elements<ParagraphProperties>().Count() == 0)  
                {  
                    p.PrependChild<ParagraphProperties>(new ParagraphProperties());  
                }  

                // Get the paragraph properties element of the paragraph.  
                ParagraphProperties pPr = p.Elements<ParagraphProperties>().First();  

                // Set the paragraph style ID to "Heading1".  
                pPr.ParagraphStyleId = new ParagraphStyleId() { Val = "Heading1" };                
            }  
        }  
    }  
}  

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

Module Module1  
    ' Apply the Heading 1 style to a paragraph.  
    Sub Main()  
        Dim fileName As String = "C:\Users\Public\Documents\StyleEx.docx"  

        Using doc As WordprocessingDocument = _  
            WordprocessingDocument.Open(fileName, True)  
            ' Get the first paragraph.  
            Dim p As Paragraph = doc.MainDocumentPart.Document.Body.Elements _  
                (Of Paragraph).First()  

            ' If the paragraph has no ParagraphProperties objects, create a new one for it.  
            If p.Elements(Of ParagraphProperties).Count() = 0 Then  
                p.PrependChild(Of ParagraphProperties)(New ParagraphProperties())  
            End If  

            ' Get the paragraph properties element of the paragraph.  
            Dim pPr As ParagraphProperties = p.Elements(Of ParagraphProperties).First()  

            ' Set the paragraph style ID to "Heading1".  
            pPr.ParagraphStyleId = New ParagraphStyleId() With {.Val = "Heading1"}  
        End Using  
    End Sub  
End Module  

注釈

[ISO/IEC 29500-1 1st Edition]

style (スタイル定義)

この要素は、WordprocessingML ドキュメント内の 1 つのスタイルの定義を指定します。 スタイルは、ドキュメント内の領域に適用できる、テーブル、段落、および/または文字のプロパティの定義済みのセットです。

任意のスタイル定義のスタイル定義は、次の 3 つのセグメントに分割できます。

• 一般的なスタイル プロパティ

• スタイルの種類

• スタイルの種類固有のプロパティ

一般的なスタイル プロパティ は、スタイルの種類に関係なく使用できるプロパティのセットを指します。たとえば、スタイル名、スタイルの追加エイリアス、スタイル ID (スタイルを参照するためにドキュメント コンテンツによって使用されます)、スタイルが非表示の場合、スタイルがロックされている場合などです。

[例: 次のように、ドキュメントの見出しというスタイルを検討してください。

<w:style w:type="paragraph" w:styleId="Heading1">  
  <w:name w:val="Heading 1"/>  
  <w:basedOn w:val="Normal"/>  
  <w:next w:val="Normal"/>  
  <w:link w:val="Heading1Char"/>  
  <w:uiPriority w:val="1"/>  
  <w:qformat/>  
  <w:rsid w:val="00F303CE"/>  
  …</w:style>  

このスタイルの種類に固有の書式設定情報の上には、すべてのスタイル型で共有される情報を定義する一般的なスタイル プロパティのセットがあります。 例終わり]

スタイルの種類とは、このスタイル定義で作成されるスタイルの種類を定義する、スタイルに関するプロパティのことです。 WordprocessingML では、スタイル定義の type 属性の値によって、次の 6 種類のスタイル定義をサポートしています。

• 段落スタイル

• 文字スタイル

• リンクされたスタイル (段落 + 文字) [メモ: link 要素 (§17.7.4.6) により実現。 メモ終了]

• 表スタイル

• 番号付けスタイル

• 既定の段落 + 文字プロパティ

[例: 次のように、ドキュメントの見出しというスタイルを検討してください。

<w:style w:type="paragraph" w:styleId="Heading1">  
  <w:name w:val="heading 1"/>  
  <w:basedOn w:val="Normal"/>  
  <w:next w:val="Normal"/>  
  <w:link w:val="Heading1Char"/>  
  <w:uiPriority w:val="1"/>  
  <w:qformat/>  
  <w:rsid w:val="00F303CE"/>  
  …</w:style>  

type 属性には paragraph の値があり、次のスタイル定義が段落スタイルであることを示します。 例終わり]

スタイル型固有のプロパティ は、スタイルのペイロードを指します。その書式設定情報と、そのスタイル型にのみ適用されるプロパティです。

[例: プライマリ名 Normal Table が次のように定義されているテーブル スタイルを検討してください。

<w:style w:type="table" w:default="1" w:styleId="TableNormal">  
  <w:name w:val="Normal Table"/>  
  …  <w:tblPr>  
    <w:tblInd w:w="0" w:type="dxa"/>  
    <w:tblCellMar>  
      <w:top w:w="0" w:type="dxa"/>  
      <w:left w:w="108" w:type="dxa"/>  
      <w:bottom w:w="0" w:type="dxa"/>  
      <w:right w:w="108" w:type="dxa"/>  
    </w:tblCellMar>  
  </w:tblPr>  
</w:style>  

tblPr 要素には、このテーブル スタイルの書式設定ペイロードが含まれています。これはテーブル スタイルにのみ適用されます。 例終わり]

親の要素
styles (§17.7.4.18)

子要素	Subclause
エイリアス (代替スタイル名)	§17.7.4.1
autoRedefine (ユーザー書式をスタイル定義に自動的にマージ)	§17.7.4.2
basedOn (親スタイル ID)	§17.7.4.3
hidden (ユーザー インターフェイスからスタイルを非表示にする)	§17.7.4.4
link (リンク スタイル リファレンス)	§17.7.4.6
locked (スタイルを適用できません)	§17.7.4.7
name (プライマリ スタイル名)	§17.7.4.9
next (次の段落のスタイル)	§17.7.4.10
personal (電子メール メッセージ テキスト スタイル)	§17.7.4.11
personalCompose (電子メール メッセージ合成スタイル)	§17.7.4.12
personalReply (電子メール メッセージの返信スタイル)	§17.7.4.13
pPr (スタイル段落プロパティ)	§17.7.8.2
qFormat (プライマリ スタイル)	§17.7.4.14
rPr (実行プロパティ)	§17.7.9.1
rsid (スタイル定義のリビジョン識別子)	§17.7.4.15
semiHidden (メイン ユーザー インターフェイスからスタイルを非表示にする)	§17.7.4.16
tblPr (スタイル テーブルのプロパティ)	§17.7.6.4
tblStylePr (スタイル条件付きテーブルの書式設定プロパティ)	§17.7.6.6
tcPr (スタイル テーブル セルのプロパティ)	§17.7.6.9
trPr (スタイル テーブル行プロパティ)	§17.7.6.11
uiPriority (省略可能なユーザー インターフェイスの並べ替え順序)	§17.7.4.19
unhideWhenUsed (スタイルが使用されている場合 Semi-Hidden プロパティを削除)	§17.7.4.20

[注: この要素のコンテンツ モデル (CT_Style) の W3C XML スキーマ定義は§A.1 にあります。 メモの終了]

ISO/IEC29500: 2008。

コンストラクター

Style()	Style クラスの新しいインスタンスを初期化します。
Style(IEnumerable<OpenXmlElement>)	指定した子要素を使用して Style クラスの新しいインスタンスを初期化します。
Style(OpenXmlElement[])	指定した子要素を使用して Style クラスの新しいインスタンスを初期化します。
Style(String)	外側の XML から Style クラスの新しいインスタンスを初期化します。

プロパティ

Aliases	代替スタイル名。 スキーマ内の次の要素タグを表します: w:aliases。
AutoRedefine	ユーザーの書式設定をスタイル定義に自動的にマージします。 スキーマ内の次の要素タグを表します: w:autoRedefine。
BasedOn	親スタイル ID。 スキーマ内の次の要素タグを表します: w:basedOn。
ChildElements	現在の要素のすべての子ノードを取得します。 (継承元 OpenXmlElement)
CustomStyle	User-Defined スタイル スキーマ内の次の属性を表します。 w:customStyle
Default	既定のスタイル スキーマ内の次の属性を表します。 w:default
ExtendedAttributes	現在の要素のすべての拡張属性 (スキーマで定義されていない属性) を取得します。 (継承元 OpenXmlElement)
Features	現在の要素の を IFeatureCollection 取得します。 この機能コレクションは読み取り専用ですが、使用可能な場合は親パーツとパッケージから機能を継承します。 (継承元 OpenXmlElement)
FirstChild	現在の OpenXmlElement 要素の最初の子を取得します。 (継承元 OpenXmlCompositeElement)
HasAttributes	現在の要素に属性があるかどうかを示す値を取得します。 (継承元 OpenXmlElement)
HasChildren	現在の要素に子要素があるかどうかを示す値を取得します。 (継承元 OpenXmlCompositeElement)
InnerText	現在のノードとそのすべての子の連結値を取得または設定します。 (継承元 OpenXmlCompositeElement)
InnerXml	現在のノードの子ノードのみを表すマークアップを取得または設定します。 (継承元 OpenXmlCompositeElement)
LastChild	現在の OpenXmlElement 要素の最後の子を取得します。 このような OpenXmlElement 要素がない場合は、null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlCompositeElement)
LinkedStyle	リンクされたスタイル参照。 スキーマ内の次の要素タグを表します: w:link。
LocalName	現在の要素のローカル名を取得します。 (継承元 OpenXmlElement)
Locked	スタイルを適用できません。 スキーマ内の次の要素タグを表します。w:locked です。
MCAttributes	マークアップ互換性属性を取得または設定します。 現在の要素に対してマークアップ互換性属性が定義されていない場合は null を返します。 (継承元 OpenXmlElement)
NamespaceDeclarations	現在の要素で定義されているすべての名前空間宣言を取得します。 名前空間宣言がない場合は、空の列挙子を返します。 (継承元 OpenXmlElement)
NamespaceUri	現在の要素の名前空間 URI を取得します。 (継承元 OpenXmlElement)
NextParagraphStyle	次の段落のスタイル。 スキーマ内の次の要素タグを表します: w:next。
OpenXmlElementContext	現在の要素の OpenXmlElementContext を取得します。 (継承元 OpenXmlElement)
OuterXml	現在の要素とそのすべての子要素を表すマークアップを取得します。 (継承元 OpenXmlElement)
Parent	現在の要素の親要素を取得します。 (継承元 OpenXmlElement)
Personal	電子メール メッセージのテキスト スタイル。 スキーマ内の次の要素タグを表します: w:personal。
PersonalCompose	電子メール メッセージの構成スタイル。 スキーマ内の次の要素タグを表します。 w:personalCompose。
PersonalReply	電子メール メッセージの返信スタイル。 スキーマ内の次の要素タグを表します:w:personalReply。
Prefix	現在の要素の名前空間プレフィックスを取得します。 (継承元 OpenXmlElement)
PrimaryStyle	プライマリ スタイル。 スキーマ内の次の要素タグを表します: w:qFormat。
Rsid	スタイル定義のリビジョン識別子。 スキーマ内の次の要素タグを表します: w:rsid。
SemiHidden	メイン ユーザー インターフェイスからスタイルを非表示にします。 スキーマ内の次の要素タグを表します。 w:semiHidden。
StyleHidden	ユーザー インターフェイスからスタイルを非表示にします。 スキーマ内の次の要素タグを表します:w:hidden。
StyleId	スタイル ID スキーマ内の次の属性を表します: w:styleId
StyleName	プライマリ スタイル名。 スキーマ内の次の要素タグを表します: w:name。
StyleParagraphProperties	スタイル段落プロパティ。 スキーマ内の次の要素タグを表します: w:pPr。
StyleRunProperties	プロパティを実行します。 スキーマ内の次の要素タグを表します: w:rPr。
StyleTableCellProperties	[スタイル テーブル] セルのプロパティ。 スキーマ内の次の要素タグを表します: w:tcPr。
StyleTableProperties	スタイル テーブルのプロパティ。 スキーマ内の次の要素タグを表します: w:tblPr。
TableStyleConditionalFormattingTableRowProperties	スタイル テーブル行のプロパティ。 スキーマ内の次の要素タグを表します: w:trPr。
Type	スタイルの種類 スキーマ内の次の属性を表します: w:type
UIPriority	オプションのユーザー インターフェイスの並べ替え順序。 スキーマ内の次の要素タグを表します: w:uiPriority。
UnhideWhenUsed	スタイルを使用する場合 Semi-Hidden プロパティを削除します。 スキーマ内の次の要素タグを表します。 w:unhideWhenUsed。
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:style です。 (継承元 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	子コレクションを反復処理する列挙子を返します。 (継承元 OpenXmlElement)