DocumentProperties.Custom Property
Provides access to the custom document properties associated with a workbook.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v21.1.Core.dll
NuGet Package: DevExpress.Spreadsheet.Core
Declaration
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.
Example
// Set the custom document properties.
workbook.DocumentProperties.Custom["Revision"] = 3;
workbook.DocumentProperties.Custom["Completed"] = true;
workbook.DocumentProperties.Custom["Published"] = DateTime.Now;
// Display the specified custom properties in a worksheet.
IEnumerable<string> customPropertiesNames = workbook.DocumentProperties.Custom.Names;
int rowIndex = 2;
foreach (string propertyName in customPropertiesNames)
{
worksheet[rowIndex, 1].Value = propertyName;
worksheet[rowIndex, 2].Value = workbook.DocumentProperties.Custom[propertyName];
if (worksheet[rowIndex, 2].Value.IsDateTime)
worksheet[rowIndex, 2].NumberFormat = "[$-409]m/d/yyyy h:mm AM/PM";
rowIndex++;
}