CustomDocumentProperty クラス

定義

名前空間:

DocumentFormat.OpenXml.CustomProperties

アセンブリ:

DocumentFormat.OpenXml.dll

パッケージ:

DocumentFormat.OpenXml v3.0.1

カスタム ファイル プロパティ。

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

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

public class CustomDocumentProperty : DocumentFormat.OpenXml.OpenXmlCompositeElement

type CustomDocumentProperty = class
    inherit OpenXmlCompositeElement

Public Class CustomDocumentProperty
Inherits OpenXmlCompositeElement

継承

Object

OpenXmlElement

OpenXmlCompositeElement

CustomDocumentProperty

注釈

[ISO/IEC 29500-1 1st Edition]

property (カスタム ファイル プロパティ)

この要素は、1 つのカスタム ファイル プロパティを指定します。 カスタム ファイル プロパティの種類は、ファイル プロパティバリアント型名前空間の子要素を使用して定義されます。 カスタム ファイル プロパティの値は、適切なバリアント型の子要素の値を設定することで設定できます。

親の要素
プロパティ (§22.3.2.1)

子要素	Subclause
array (Array)	§22.4.2.1
BLOB (バイナリ BLOB)	§22.4.2.2
bool (Boolean)	§22.4.2.3
bstr (Basic String)	§22.4.2.4
clsid (クラス ID)	§22.4.2.5
cy (通貨)	§22.4.2.6
date (日付と時刻)	§22.4.2.7
decimal (Decimal)	§22.4.2.8
empty (Empty)	§22.4.2.9
error (エラー 状態コード)	§22.4.2.10
filetime (ファイル時刻)	§22.4.2.11
i1 (1 バイト符号付き整数)	§22.4.2.12
i2 (2 バイト符号付き整数)	§22.4.2.13
i4 (4 バイト符号付き整数)	§22.4.2.14
i8 (8 バイト符号付き整数)	§22.4.2.15
int (Integer)	§22.4.2.16
lpstr (LPSTR)	§22.4.2.17
lpwstr (LPWSTR)	§22.4.2.18
null (Null)	§22.4.2.19
oblob (バイナリ BLOB オブジェクト)	§22.4.2.20
ostorage (バイナリ ストレージ オブジェクト)	§22.4.2.21
ostream (バイナリ ストリーム オブジェクト)	§22.4.2.22
r4 (4 バイト実数)	§22.4.2.23
r8 (8 バイト実数)	§22.4.2.24
storage (Binary Storage)	§22.4.2.25
stream (Binary Stream)	§22.4.2.26
ui1 (1 バイト符号なし整数)	§22.4.2.27
ui2 (2 バイト符号なし整数)	§22.4.2.28
ui4 (4 バイト符号なし整数)	§22.4.2.29
ui8 (8 バイト符号なし整数)	§22.4.2.30
uint (Unsigned Integer)	§22.4.2.31
vector (Vector)	§22.4.2.33
vstream (バイナリ バージョン管理ストリーム)	§22.4.2.34

属性	説明
fmtid (形式 ID)	カスタム プロパティを OLE プロパティと一意に関連付けます。 この属性の値は、{HHHHHHHHHHHH-HHHH-HHHH-HHHH-HHHHHHHHHHHHHHHHHHHHH} という形式のグローバル一意識別子です。各 H は 16 進数です。 この属性に使用できる値は、 ST_Guid 単純型 (§22.9.2.4) によって定義されます。
linkTarget (ブックマーク リンク ターゲット)	現在の文書のブックマークの名前 (WordprocessingML の場合)、またはこのカスタム ドキュメント プロパティの値を抽出するテーブルまたは名前付きセル (SpreadsheetML の場合) を指定します。 この属性が存在する場合、この要素の下の値はキャッシュと見なされ、保存時にこのブックマークの値 (存在する場合) に置き換えられます。 ブックマークが存在しない場合、このリンクは壊れていると見なされ、キャッシュされた値は保持されます。 この属性で使用できる値は、W3C XML スキーマの string データ型で定義されています。
name (カスタム ファイル プロパティ名)	このカスタム ファイル プロパティの名前を指定します。 この属性で使用できる値は、W3C XML スキーマの string データ型で定義されています。
pid (プロパティ ID)	カスタム プロパティを OLE プロパティと一意に関連付けます。 この属性に使用できる値は、W3C XML スキーマ int データ型によって定義されます。

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

ISO/IEC29500: 2008。

コンストラクター

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

プロパティ

ChildElements	現在の要素のすべての子ノードを取得します。 (継承元 OpenXmlElement)
ExtendedAttributes	現在の要素のすべての拡張属性 (スキーマで定義されていない属性) を取得します。 (継承元 OpenXmlElement)
Features	現在の要素の を IFeatureCollection 取得します。 この機能コレクションは読み取り専用ですが、使用可能な場合は親パーツとパッケージから機能を継承します。 (継承元 OpenXmlElement)
FirstChild	現在の OpenXmlElement 要素の最初の子を取得します。 (継承元 OpenXmlCompositeElement)
FormatId	形式 ID スキーマ内の次の属性を表します: fmtid
HasAttributes	現在の要素に属性があるかどうかを示す値を取得します。 (継承元 OpenXmlElement)
HasChildren	現在の要素に子要素があるかどうかを示す値を取得します。 (継承元 OpenXmlCompositeElement)
InnerText	現在のノードとそのすべての子の連結値を取得または設定します。 (継承元 OpenXmlCompositeElement)
InnerXml	現在のノードの子ノードのみを表すマークアップを取得または設定します。 (継承元 OpenXmlCompositeElement)
LastChild	現在の OpenXmlElement 要素の最後の子を取得します。 このような OpenXmlElement 要素がない場合は、null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlCompositeElement)
LinkTarget	ブックマーク リンク ターゲット スキーマ内の次の属性を表します: linkTarget
LocalName	現在の要素のローカル名を取得します。 (継承元 OpenXmlElement)
MCAttributes	マークアップ互換性属性を取得または設定します。 現在の要素に対してマークアップ互換性属性が定義されていない場合は null を返します。 (継承元 OpenXmlElement)
Name	カスタム ファイル プロパティ名 スキーマ内の次の属性を表します。
NamespaceDeclarations	現在の要素で定義されているすべての名前空間宣言を取得します。 名前空間宣言がない場合は、空の列挙子を返します。 (継承元 OpenXmlElement)
NamespaceUri	現在の要素の名前空間 URI を取得します。 (継承元 OpenXmlElement)
OpenXmlElementContext	現在の要素の OpenXmlElementContext を取得します。 (継承元 OpenXmlElement)
OuterXml	現在の要素とそのすべての子要素を表すマークアップを取得します。 (継承元 OpenXmlElement)
Parent	現在の要素の親要素を取得します。 (継承元 OpenXmlElement)
Prefix	現在の要素の名前空間プレフィックスを取得します。 (継承元 OpenXmlElement)
PropertyId	プロパティ ID スキーマ内の次の属性を表します。 pid
VTArray	配列。 スキーマの vt:array という要素タグを表します。
VTBlob	バイナリ BLOB。 スキーマ内の次の要素タグ vt:blob を表します。
VTBool	ブール。 スキーマ内の次の要素タグを表します: vt:bool。
VTBString	Basic String。 スキーマ内の次の要素タグを表します: vt:bstr。
VTByte	1 バイト符号付き整数。 スキーマ内の次の要素タグ vt:i1 を表します。
VTClassId	クラス ID。 スキーマ内の次の要素タグを表します: vt:clsid。
VTClipboardData	クリップボード データ。 スキーマ内の次の要素タグ vt:cf を表します。
VTCurrency	通貨 スキーマ内の要素タグ vt:cy を表します。
VTDate	日付と時刻。 スキーマ内の次の要素タグ vt:date を表します。
VTDecimal	小数点型 スキーマの vt:decimal 要素タグを表します。
VTDouble	8 バイト実数。 スキーマ内の要素タグ vt:r8 を表します。
VTEmpty	空。 スキーマ内の次の要素タグ vt:empty を表します。
VTError	エラー状態コード。 スキーマ内の次の要素タグ vt:error を表します。
VTFileTime	ファイル時刻。 スキーマ内の次の要素タグ vt:filetime を表します。
VTFloat	4 バイト実数。 スキーマ内の次の要素タグ vt:r4 を表します。
VTInt32	4 バイト符号付き整数。 スキーマ内の次の要素タグ vt:i4 を表します。
VTInt64	8 バイト符号付き整数。 スキーマ内の次の要素タグ vt:i8 を表します。
VTInteger	整数型 スキーマの vt:int という要素タグを表します。
VTLPSTR	Lpstr。 スキーマ内の次の要素タグを表します: vt:lpstr。
VTLPWSTR	Lpwstr。 スキーマの vt:lpwstr 要素タグを表します。
VTNull	Null。 スキーマ内の次の要素タグ vt:null を表します。
VTOBlob	バイナリ BLOB オブジェクト。 スキーマ内の次の要素タグを表します: vt:oblob。
VTOStorage	バイナリ ストレージ オブジェクト。 スキーマ内の要素タグ vt:ostorage を表します。
VTOStreamData	バイナリ ストリーム オブジェクト。 スキーマの vt:ostream 要素タグを表します。
VTShort	2 バイト符号付き整数。 スキーマ内の次の要素タグ vt:i2 を表します。
VTStorage	バイナリ ストレージ。 スキーマ内の次の要素タグ vt:storage を表します。
VTStreamData	バイナリ ストリーム。 スキーマ内の次の要素タグ vt:stream を表します。
VTUnsignedByte	1 バイト符号なし整数。 スキーマの要素タグ vt:ui1 を表します。
VTUnsignedInt32	4 バイト符号なし整数。 スキーマ内の要素タグ vt:ui4 を表します。
VTUnsignedInt64	8 バイト符号なし整数。 スキーマ内の次の要素タグ vt:ui8 を表します。
VTUnsignedInteger	符号なし整数。 スキーマ内の次の要素タグを表します: vt:uint。
VTUnsignedShort	2 バイト符号なし整数。 スキーマの要素タグ vt:ui2 を表します。
VTVector	ベクトル。 スキーマ内の要素タグ vt:vector を表します。
VTVStreamData	バイナリ バージョン管理ストリーム。 スキーマ内の要素タグ vt:vstream を表します。
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 としてシリアル化されるときに、修飾名は op:property です。 (継承元 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	子コレクションを反復処理する列挙子を返します。 (継承元 OpenXmlElement)