CustomDocumentProperty クラス

リファレンス

定義

名前空間:: DocumentFormat.OpenXml.CustomProperties

アセンブリ:: DocumentFormat.OpenXml.dll

アセンブリ:: DocumentFormat.OpenXml.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ファイルのカスタムプロパティです。オブジェクトを xml としてシリアル化されるときに、修飾名は、op: プロパティです。

[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTVector))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTArray))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTBlob))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTOBlob))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTEmpty))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTNull))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTByte))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTShort))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTInt32))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTInt64))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTInteger))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTUnsignedByte))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTUnsignedShort))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTUnsignedInt32))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTUnsignedInt64))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTUnsignedInteger))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTFloat))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTDouble))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTDecimal))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTLPSTR))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTLPWSTR))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTBString))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTDate))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTFileTime))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTBool))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTCurrency))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTError))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTStreamData))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTOStreamData))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTStorage))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTOStorage))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTVStreamData))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTClassId))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.VariantTypes.VTClipboardData))]
public class CustomDocumentProperty : DocumentFormat.OpenXml.OpenXmlCompositeElement

type CustomDocumentProperty = class
    inherit OpenXmlCompositeElement

Public Class CustomDocumentProperty
Inherits OpenXmlCompositeElement

継承: Object

OpenXmlElement

OpenXmlCompositeElement
CustomDocumentProperty

属性: ChildElementInfoAttribute

注釈

[ISO/IEC 29500-1 1st Edition]

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

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

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

子要素	句
配列 (配列)	§22.4.2.1
blob (バイナリ Blob)	§22.4.2.2
ブール値 (ブール値)	§22.4.2.3
bstr (基本文字列)	§22.4.2.4
clsid (クラス ID)	§22.4.2.5
cy (通貨)	§22.4.2.6
日付 (日付と時刻)	§22.4.2.7
10 進数 (10 進)	§22.4.2.8
(空) を空にします。	§22.4.2.9
エラー (エラーステータスコード)	§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 型 (整数)	§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
ストレージ (バイナリストレージ)	§22.4.2.25
ストリーム (バイナリストリーム)	§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 (符号なし整数)	§22.4.2.31
ベクトル (ベクトル)	§22.4.2.33
vstream (バイナリストリームのバージョン)	§22.4.2.34

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

[注: この要素のコンテンツモデル (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)
FirstChild	現在の OpenXmlElement 要素の最初の子を取得します。 (継承元 OpenXmlCompositeElement)
FormatId	形式の id。スキーマでは、次の属性を表します fmtid。
HasAttributes	現在の要素に属性が含されているかどうかを示すブール値を取得します。 (継承元 OpenXmlElement)
HasChildren	現在の要素に子要素が含されているかどうかを示す値を取得します。 (継承元 OpenXmlCompositeElement)
InnerText	現在のノードとそのすべての子の連結値を取得または設定します。 (継承元 OpenXmlCompositeElement)
InnerXml	現在のノードの子ノードのみを表すマークアップを取得または設定します。 (継承元 OpenXmlCompositeElement)
LastChild	現在の OpenXmlElement 要素の最後の子を取得します。このような OpenXmlElement 要素がないVisual Basic null (Nothing in Visual Basic) を返します。 (継承元 OpenXmlCompositeElement)
LinkTarget	スキーマの属性の次のリンクの Target.Represents のブックマーク: linkTarget
LocalName	要素のローカル名を取得します。
MCAttributes	マークアップの互換性属性を設定します。現在の要素に対してマークアップ互換性属性が定義されていない場合は null を返します。 (継承元 OpenXmlElement)
Name	次の属性がスキーマにカスタムファイルプロパティの Name.Represents: 名前
NamespaceDeclarations	現在の要素で定義されている名前空間宣言を取得します。名前空間宣言がない場合は、空の列挙子を返します。 (継承元 OpenXmlElement)
NamespaceUri	現在の要素の名前空間 URI を取得します。 (継承元 OpenXmlElement)
OpenXmlElementContext	現在の要素の OpenXmlEementContext を取得します。 (継承元 OpenXmlElement)
OuterXml	現在の要素とそのすべての子要素を表すマークアップを取得します。 (継承元 OpenXmlElement)
Parent	現在の要素の親要素を取得します。 (継承元 OpenXmlElement)
Prefix	現在の要素の名前空間プレフィックスを取得します。 (継承元 OpenXmlElement)
PropertyId	プロパティの id。スキーマでは、次の属性を表します: pid
VTArray	Array。スキーマでは、次の要素タグを表します vt:array。
VTBlob	バイナリ Blob です。スキーマでは、次の要素タグを表します vt:blob。
VTBool	ブール値です。スキーマでは、次の要素タグを表します vt:bool。
VTBString	基本的な文字列です。スキーマでは、次の要素タグを表します 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)
AddNamespaceDeclaration(String, String)	現在のノードに namepace 宣言を追加します。 (継承元 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 要素がないVisual Basic null (Nothing in Visual Basic) を返します。 (継承元 OpenXmlElement)
NextSibling<T>()	現在の OpenXmlElement 要素に続く、指定した型を持つ OpenXmlElement 要素を取得します。次の OpenXmlElement がないVisual Basic null (Nothing in Visual Basic) を返します。 (継承元 OpenXmlElement)
PrependChild<T>(T)	現在の要素の子ノードのリストの先頭に指定した要素を挿入します。 (継承元 OpenXmlCompositeElement)
PreviousSibling()	現在の OpenXmlElement 要素の直前にある OpenXmlElement 要素を取得します。前の OpenXmlElement 要素がないVisual Basic null ( Nothing in Visual Basic ) を返します。 (継承元 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()

(継承元 OpenXmlElement)

適用対象