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

IWorkbook.DocumentProperties Property

Provides access to the document properties associated with a workbook.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v21.2.Core.dll

Declaration

DocumentProperties DocumentProperties { get; }

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

The example below demonstrates how to specify the standard document properties for a workbook using the IWorkbook.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

The following code snippets (auto-collected from DevExpress Examples) contain references to the DocumentProperties property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also