Captions クラス

定義

名前空間:

DocumentFormat.OpenXml.Wordprocessing

アセンブリ:

DocumentFormat.OpenXml.dll

パッケージ:

DocumentFormat.OpenXml v3.0.1

キャプション設定。

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

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

public class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Captions = class
    inherit OpenXmlCompositeElement

Public Class Captions
Inherits OpenXmlCompositeElement

継承

Object

OpenXmlElement

OpenXmlCompositeElement

Captions

注釈

[ISO/IEC 29500-1 1st Edition]

captions (Caption Settings)

この要素は、特定の WordprocessingML ドキュメント内のキャプションに関する情報の存在を指定します。 この情報は、次の 2 つのコンポーネントに分かれています。

• 子要素キャプションは、ドキュメントに自動的に追加される 1 種類のキャプションの形式を定義します。

• 子要素 autoCaptions は、キャプション形式が自動的に適用されるオブジェクトの種類を定義します。

この情報は、WordprocessingML ドキュメントに挿入されるときにオブジェクトに自動的に追加されるキャプションを決定するために使用する必要があります。 [注: この設定は通常、アプリケーションの既定のテンプレートで指定されていない限り無視されます。 メモの終了]

[例: キャプションでラベル付けされたテーブルを含む WordprocessingML ドキュメントを示す次の図を考えてみましょう。

9512a3b0-3be8-461e-b333-2dafe873ea54

この図では、WordprocessingML ドキュメントに含まれるテーブルに、文字列 Table の後に 10 進数で構成されるテーブルの下にキャプションを挿入することでラベルが付けられます。 この自動的に挿入キャプション形式は、次の WordprocessingML を使用して指定されます。

<w:captions>  
  <w:caption w:name="Table" w:pos="below" w:numFmt="decimal" />   
</w:captions>  

ここでは、captions 要素は、特定の WordprocessingML ドキュメント内の 1 つ以上のキャプション形式の存在を、その子要素キャプションで指定します。 具体的には、子要素キャプションでは、WordprocessingML ドキュメント内で使用する 1 種類のキャプションを指定します。 例終わり]

キャプションでは、フィールド (§17.16.5) を利用して、次のいずれかを参照してオブジェクトにラベルを付けます。

• 特定のドキュメント内の他のキャプション付きオブジェクト

• 特定の文書内の同じ章内の他のキャプション付きオブジェクト (チャプター番号がキャプション型の chapNum 属性を指定して追加される場合)。 章は、WordprocessingML 文書内のテキストのセクションで、文書内のチャプターを区切るために で指定されたスタイルを持つコンテンツが先行しています。 1 つのキャプションタイプで文書内の章を区切るために使用するスタイルとして指定できるスタイルは 1 つだけです。 チャプターは、チャプターを区切るために使用されるスタイルを持つコンテンツの次のインスタンスのすぐ上で終了します。

[例: 次の図を検討してください。

ca416e21-0d37-4bbe-9fbc-0ad6b52b74da

83cd18d0-32ad-47ac-8475-614beb06001a

この図は、2 つのチャプターを含む WordprocessingML ドキュメントを示しています。それぞれにキャプションでラベル付けされた 2 つのテーブルが含まれています。 章の境界に関連付けられているスタイルは、このドキュメントの 第 1 章から FY02 および 第 2 章 - FY03 の文字列に適用されています。 具体的には、チャプターを区切るために使用されるスタイルは、キャプション形式の WordprocessingML の見出し属性値で指定された、styleID 属性が Heading2 と等しいスタイルです。

<w:caption w:name="Table" w:pos="below" w:chapNum="1" w:heading="2" w:numFmt="upperLetter" w:sep="8212" />   

言い換えると、上記の WordprocessingML を使用して、キャプション アプリケーションによって生成された特定の WordprocessingML ドキュメントに挿入されたオブジェクト (この場合はテーブル) に、文字列 Table に続けて、テーブルが存在するチャプター番号に対応する 10 進数、ハイフン、および指定されたチャプター内のテーブルのインデックスに対応する大文字の英字を指定します。 例終わり]

[注: WordprocessingML は、キャプション要素をアプリケーションと組み合わせて使用して動的キャプションエクスペリエンスを提供できるように設計されています。 つまり、アプリケーションは上の例の WordprocessingML を使用して、文字列 Table で構成されるキャプションを自動的に挿入し、autoCaption 要素 (§17.15.1.7) で定義されている WordprocessingML ドキュメントにテーブルを挿入するときに、テーブルの下にインクリメントする 10 進数フィールドを自動的に挿入できます。 メモの終了]

親の要素
settings (§17.15.1.78)

子要素	Subclause
autoCaptions (自動キャプション設定)	§17.15.1.8
キャプション (シングル キャプションの種類の定義)	§17.15.1.16

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

ISO/IEC29500: 2008。

コンストラクター

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

プロパティ

ChildElements	現在の要素のすべての子ノードを取得します。 (継承元 OpenXmlElement)
ExtendedAttributes	現在の要素のすべての拡張属性 (スキーマで定義されていない属性) を取得します。 (継承元 OpenXmlElement)
Features	現在の要素の を IFeatureCollection 取得します。 この機能コレクションは読み取り専用ですが、使用可能な場合は親パーツとパッケージから機能を継承します。 (継承元 OpenXmlElement)
FirstChild	現在の OpenXmlElement 要素の最初の子を取得します。 (継承元 OpenXmlCompositeElement)
HasAttributes	現在の要素に属性があるかどうかを示す値を取得します。 (継承元 OpenXmlElement)
HasChildren	現在の要素に子要素があるかどうかを示す値を取得します。 (継承元 OpenXmlCompositeElement)
InnerText	現在のノードとそのすべての子の連結値を取得または設定します。 (継承元 OpenXmlCompositeElement)
InnerXml	現在のノードの子ノードのみを表すマークアップを取得または設定します。 (継承元 OpenXmlCompositeElement)
LastChild	現在の OpenXmlElement 要素の最後の子を取得します。 このような OpenXmlElement 要素がない場合は、null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlCompositeElement)
LocalName	現在の要素のローカル名を取得します。 (継承元 OpenXmlElement)
MCAttributes	マークアップ互換性属性を取得または設定します。 現在の要素に対してマークアップ互換性属性が定義されていない場合は null を返します。 (継承元 OpenXmlElement)
NamespaceDeclarations	現在の要素で定義されているすべての名前空間宣言を取得します。 名前空間宣言がない場合は、空の列挙子を返します。 (継承元 OpenXmlElement)
NamespaceUri	現在の要素の名前空間 URI を取得します。 (継承元 OpenXmlElement)
OpenXmlElementContext	現在の要素の OpenXmlElementContext を取得します。 (継承元 OpenXmlElement)
OuterXml	現在の要素とそのすべての子要素を表すマークアップを取得します。 (継承元 OpenXmlElement)
Parent	現在の要素の親要素を取得します。 (継承元 OpenXmlElement)
Prefix	現在の要素の名前空間プレフィックスを取得します。 (継承元 OpenXmlElement)
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:captions です。 (継承元 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	子コレクションを反復処理する列挙子を返します。 (継承元 OpenXmlElement)