DocumentProperties.Description Property

Gets or sets the explanation of the document’s content (abstract, table of contents, reference to a graphical representation of content etc.).

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v20.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

string Description { get; set; }

VB.NET

Property Description As String

Property Value

Type	Description
String	A string of text.

Remarks

The Description property allows you to specify one of the core document properties, a full set of which is available with the Document.DocumentProperties property. To specify a custom document property, use the Document.CustomProperties property.

End-users can edit the Description value in the Document Properties Dialog.

Use the COMMENTS field to insert the Description value in the document.

Note

The Description property is not supported in HTML documents.

Related GitHub Examples

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.

C#

word-document-api-examples/CS/CodeExamples/DocumentPropertiesActions.cs#L23

document.DocumentProperties.Category = "TestDoc";
document.DocumentProperties.Description = "This code demonstrates API to modify and display standard document properties.";

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/DocumentPropertiesActions.cs#L21

document.DocumentProperties.Category = "TestDoc";
document.DocumentProperties.Description = "This code demonstrates API to modify and display standard document properties.";

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/DocumentProperties.cs#L18

document.DocumentProperties.Category = "TestDoc";
document.DocumentProperties.Description = "This code demonstrates API to modify and display standard document properties.";

VB.NET

word-document-api-examples/VB/CodeExamples/DocumentPropertiesActions.vb#L21

document.DocumentProperties.Category = "TestDoc"
document.DocumentProperties.Description = "This code demonstrates API to modify and display standard document properties."
document.Fields.Create(document.AppendText(CStr((Global.Microsoft.VisualBasic.Constants.vbLf & "AUTHOR: "))).[End], "AUTHOR")

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/DocumentPropertiesActions.vb#L18

document.DocumentProperties.Category = "TestDoc"
document.DocumentProperties.Description = "This code demonstrates API to modify and display standard document properties."

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/DocumentProperties.vb#L18

document.DocumentProperties.Category = "TestDoc"
document.DocumentProperties.Description = "This code demonstrates API to modify and display standard document properties."
document.Fields.Create(document.AppendText(CStr((Global.Microsoft.VisualBasic.Constants.vbLf & "AUTHOR: "))).[End], "AUTHOR")