.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

DocumentProperties.Custom Property

Provides access to the custom document properties associated with a workbook.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v20.1.Core.dll

Declaration

DocumentCustomProperties Custom { get; }
ReadOnly Property Custom As DocumentCustomProperties

Property Value

Type Description
DocumentCustomProperties

A DocumentCustomProperties object that represents all the custom document properties for a workbook.

Remarks

Use the Custom property to specify custom properties for a spreadsheet document. To set a value of the desired custom property, use the DocumentCustomProperties.Item property.

To remove all the user-defined properties from a workbook, use the DocumentCustomProperties.Clear method.

NOTE

Custom properties implementation is based on Standard ECMA-376 Office Open XML File Formats Part 4: Markup Language Reference §7.3 Custom Properties.

Examples

The example below demonstrates how to define the custom document properties for a workbook. Use the DocumentProperties.Custom property to get access to a storage of all user-defined properties specified in a document. To set an individual custom property with the specified name, use the DocumentCustomProperties.Item property.

' Set the custom document properties.
workbook.DocumentProperties.Custom("Revision") = 3
workbook.DocumentProperties.Custom("Completed") = True
workbook.DocumentProperties.Custom("Published") = Date.Now
' Display the specified custom properties in a worksheet.
Dim customPropertiesNames As IEnumerable(Of String) = workbook.DocumentProperties.Custom.Names
Dim rowIndex As Integer = 2
For Each propertyName As String In customPropertiesNames
    worksheet(rowIndex, 1).Value = propertyName
    worksheet(rowIndex, 2).Value = workbook.DocumentProperties.Custom(propertyName)
    If worksheet(rowIndex, 2).Value.IsDateTime Then
        worksheet(rowIndex, 2).NumberFormat = "[$-409]m/d/yyyy h:mm AM/PM"
    End If
    rowIndex += 1
Next propertyName
See Also