Back to Devexpress

DocumentProperties.Description Property

officefileapi-devexpress-dot-spreadsheet-dot-documentproperties-e47934a2.md

latest6.0 KB
Original Source

DocumentProperties.Description Property

Gets or sets the explanation of the document content.

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
string Description { get; set; }
vb
Property Description As String

Property Value

TypeDescription
String

A String value that specifies the document’s description.

|

Remarks

The Description property allows you to specify one of the predefined document properties, a full set of which is available by using the IWorkbook.DocumentProperties property. To specify the custom document properties, use the DocumentProperties.Custom property.

To clear the Description property, set it to an empty string.

Important

The Description property string is limited in length to 255 characters.

The following code snippets (auto-collected from DevExpress Examples) contain references to the Description 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.

winforms-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/DocumentPropertiesActions.cs#L31

csharp
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";

wpf-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/DocumentPropertiesActions.cs#L31

csharp
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";

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/SpreadsheetActions/DocumentPropertiesActions.cs#L30

csharp
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";

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/DocumentPropertiesActions.vb#L27

vb
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"

wpf-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/DocumentPropertiesActions.vb#L27

vb
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"

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/DocumentPropertiesActions.vb#L29

vb
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"

See Also

DocumentProperties

Custom

DocumentProperties Interface

DocumentProperties Members

DevExpress.Spreadsheet Namespace