WorkbookBase.CustomDocumentProperties Property

Definition

Gets a Microsoft.Office.Core.DocumentProperties collection that represents all the custom document properties for the workbook.

public:
 property System::Object ^ CustomDocumentProperties { System::Object ^ get(); };
public object CustomDocumentProperties { get; }
member this.CustomDocumentProperties : obj
Public ReadOnly Property CustomDocumentProperties As Object

Property Value

A Microsoft.Office.Core.DocumentProperties collection that represents all the custom document properties for the workbook.

Examples

The following code example uses the CustomDocumentProperties property to display all of the custom document properties for the current workbook in column A of worksheet Sheet1.

This example is for a document-level customization.

private void DisplayCustomDocumentProperties()
{
    Office.DocumentProperties properties =
        (Office.DocumentProperties)this.CustomDocumentProperties;

    for (int i = 1; i <= properties.Count; i++)
    {
        Globals.Sheet1.Range["A" + i].Value2 =
            properties[i].Name;
    }
}
Private Sub DisplayCustomDocumentProperties()
    Dim properties As Office.DocumentProperties = _
        CType(Me.CustomDocumentProperties, Office.DocumentProperties)

    Dim i As Integer
    For i = 1 To properties.Count
        Globals.Sheet1.Range("A" & i).Value2 = properties(i).Name
    Next i
End Sub

Remarks

This property returns the entire collection of custom document properties. Use the Microsoft.Office.Core.DocumentProperties.Item(System.Object) property to return a single member of the collection (a Microsoft.Office.Core.DocumentProperties object) by specifying either the name of the property or the collection index (as a number).

Use the BuiltinDocumentProperties property to return the collection of built-in document properties.

Applies to