VBAのCustomDocumentPropertiesプロパティ

こちらでは、エクセルVBAのCustomDocumentPropertiesプロパティの解説になります。

プロパティとはオブジェクトの属性を指します。属性とは、そのオブジェクトの情報そのものです。プロパティはその値を取得したり、設定することもできます。プロパティを利用するにはオブジェクト名とプロパティ名の間に「.(ピリオド)」で結んで記述します。

オブジェクト名.プロパティ名

また、プロパティを設定する場合は以下のように「=(イコール)」を記述し設定値を代入します。

オブジェクト名.プロパティ名 = 設定値

CustomDocumentPropertiesプロパティ

CustomDocumentPropertiesプロパティは、指定されたブックにあるすべてのユーザー設定のドキュメントプロパティを表す DocumentProperties コレクションを返します。

expression.CustomDocumentProperties
expression 必ず指定します。対象となるオブジェクトへの参照を返すオブジェクト式を指定します。
このプロパティは、すべてのユーザー設定のドキュメントプロパティのコレクションを返します。コレクションの単一のメンバー (DocumentProperty オブジェクト) を返すには、プロパティ名またはインデックス番号を指定した Item メソッドを使用します。Item メソッドは、DocumentProperties コレクションに対する既定のメソッドです。次の 2 つのステートメントでは、同じ結果が得られます。


CustomDocumentProperties.Item("Complete")
CustomDocumentProperties("Complete")

組み込みのドキュメントプロパティのコレクションを返すには、BuiltinDocumentProperties プロパティを使います。次の使用例は、ユーザー設定のドキュメントプロパティの名前と値のリストを、ワークシート 1 に作成します。


rw = 1
Worksheets(1).Activate
For Each p In ActiveWorkbook.CustomDocumentProperties
    Cells(rw, 1).Value = p.Name
    Cells(rw, 2).Value = p.Value
    rw = rw + 1
Next