ユーザー設定のドキュメントプロパティ（CustomDocumentProperties プロパティ）

2015/12/07

CustomDocumentProperties プロパティ

ユーザー設定のドキュメントプロパティとは、ブックのプロパティで、ユーザーが任意の項目名を設定することができるものをいいます。CustomDocumentProperties プロパティ を使用すると、ユーザー設定のドキュメントプロパティを表す DocumentProperties コレクション を取得や設定することができます。

【書式】

object.CustomDocumentProperties

引数・戻り値

object ・・・対象となる Workbook オブジェクトを指定します。

CustomDocumentProperties プロパティの主なメソッド

CustomDocumentProperties.Add メソッド

Add メソッド を使用して任意のドキュメントプロパティを追加します。

【書式】

object.CustomDocumentProperties.Add ( name, linktocontent, type, value )

引数・戻り値

object ・・・対象となる Workbook オブジェクトを指定します。
name ・・・プロパティ名を指定します。
linktocontent ・・・プロパティとコンテナドキュメントの内容をリンクさせるかを ブール型（boolean）の値で、設定します。False を指定した場合は、引数 value を設定します。

type ・・・データの種類を表す MsoDocProperties 列挙型 の定数またはその値を指定します。

定数	値	内容
msoPropertyTypeNumber	1	整数型 (Integer) の値
msoPropertyTypeBoolean	2	ブール型 (Boolean) の値
msoPropertyTypeDate	3	日付型 (Date) の値
msoPropertyTypeString	4	文字列型 (String) の値
msoPropertyTypeFloat	5	浮動小数点型 (Floating point) の値

value ・・・プロパティの値を指定します。（引数 LinkToContent に True が指定されている場合、引数 value に指定した値は無視されます。）

CustomDocumentProperties プロパティの主なプロパティ

CustomDocumentProperties.Item (index) プロパティ

引数 index を使用して、DocumentProperties コレクション 内の個別の DocumentPropertyオブジェクト を取得します。

【書式】

object.CustomDocumentProperties [.Item] ( index )

引数・戻り値

object ・・・対象となる Workbook オブジェクトを指定します。
index ・・・取得するドキュメントプロパティの名前（name の値）またはインデックス番号を指定します。

Item は、省略可能です。

ユーザープロパティを削除する例
Delete メソッド を使用します。
　ActiveWorkbook.CustomDocumentProperties.Item(1).Delete

CustomDocumentProperties.Count プロパティ

ユーザー設定のドキュメントプロパティを表す DocumentProperties コレクション 内の項目数を取得します。

【書式】

object.CustomDocumentProperties.Count

引数・戻り値

object ・・・対象となる Workbook オブジェクトを指定します。

CustomDocumentProperties プロパティ使用例

サンプルVBAソース

　
Sub Sample_CustomDocumentProperties()

    Dim i As Integer
    Dim w As Workbook
    Set w = Workbooks.Open("C:\Documents\mybook.xlsx")

    '設定済みのドキュメントプロパティを削除
    For i = 1 To w.CustomDocumentProperties.Count
        
        w.CustomDocumentProperties(i).Delete
    
    Next i
    
    'ユーザー設定のドキュメントプロパティを設定
    w.CustomDocumentProperties.Add Name:="記録者", _
                                   LinkToContent:=False, _
                                   Type:=4, _
                                   Value:="山田太郎"
    
    '設定したドキュメントプロパティを表示
    MsgBox w.CustomDocumentProperties(1).Name & vbCrLf & _
           w.CustomDocumentProperties(1).Value

    w.Close

End Sub