Workbook.DocumentProperties Property
Provides access to the document properties associated with a workbook.
You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Docs.v24.2.dll
NuGet Package: DevExpress.Document.Processor
Declaration
Property Value
| Type | Description |
|---|---|
| DocumentProperties | A DocumentProperties object containing information about a workbook. |
Remarks
Use the DocumentProperties property to specify the built-in document properties that contain basic information about the spreadsheet document (such as DocumentProperties.Title, DocumentProperties.Author, DocumentProperties.Subject, DocumentProperties.Description etc.). You can also create your own custom document properties using the DocumentProperties.Custom property.
Example
This example demonstrates how to specify the standard document properties for a workbook using the Workbook.DocumentProperties property.
// Set the built-in document properties.
workbook.DocumentProperties.Title = "Spreadsheet API: document properties example";
workbook.DocumentProperties.Description = "How to manage document properties using the Spreadsheet API";
workbook.DocumentProperties.Keywords = "Spreadsheet, API, properties, OLEProps";
workbook.DocumentProperties.Company = "Developer Express Inc.";
// Display the specified built-in properties in a worksheet.
worksheet["B3"].Value = "Title";
worksheet["C3"].Value = workbook.DocumentProperties.Title;
worksheet["B4"].Value = "Description";
worksheet["C4"].Value = workbook.DocumentProperties.Description;
worksheet["B5"].Value = "Keywords";
worksheet["C5"].Value = workbook.DocumentProperties.Keywords;
worksheet["B6"].Value = "Company";
worksheet["C6"].Value = workbook.DocumentProperties.Company;