[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Collapse]Controls and Libraries
   Reporting
  [Expand]Data Grid
  [Expand]Ribbon, Bars and Menu
  [Expand]Charts Suite
  [Expand]Pivot Grid
  [Expand]Scheduler
  [Expand]Spreadsheet
  [Expand]Rich Text Editor
  [Expand]Tree List
  [Expand]Gauge Controls
  [Expand]Map Control
  [Expand]Layout Management
  [Expand]Windows Modern UI
  [Expand]Printing-Exporting
  [Expand]Data Editors
  [Expand]Navigation Controls
  [Expand]Spell Checker
  [Collapse]Property Grid
    Overview
   [Expand]Getting Started
   [Expand]Property Definitions
    Property Attributes
    Property Categories
    Descriptions
    Expandability Customization
    Property Menu
   [Expand]Visual Elements
    Appearance Customization
  [Expand]PDF Viewer
  [Expand]TreeMap Control
  [Expand]Gantt Control
  [Expand]Diagram Control
  [Expand]Windows and Utility Controls
   Dialogs, Notifications and Panels
  [Expand]Scheduler (legacy)
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Descriptions

Expanded Overview

The PropertyGrid control can display extra information about the properties of a bound object in the form of property descriptions. You can specify property descriptions in the following ways.

Depending on the PropertyGridControl.ShowDescriptionIn property value, the property grid displays property descriptions in the following ways.

ShowDescriptionIn

property value

Property descriptions position

None

Descriptions are disabled.

Panel

The description panel.

ToolTip

A description tooltip.

ToolTipAndPanel

Both the description panel and description tooltip.

Expanded Specifying Property Descriptions at the Control Level

The PropertyGrid control allows you to specify a custom description for each of the following elements.

  • Properties
  • Collections
  • Category rows

Descriptions are specified for individual definitions by the PropertyDefinitionBase.Description property. This approach allows you to assign property descriptions by using the association criteria described in the Property Definitions topic.

The example below demonstrates a property grid configured in the following way.

  • Both the description panel and the tooltip display the description text.
  • All string properties have similar description specified.
  • Nested Address property definitions override the description text.
Note

To learn more about nested properties, refer to the Nested properties section of the Property Definitions topic.

Expanded Specifying Property Descriptions at the Model Level

To specify property descriptions at the model level, use the Description attribute.

The Description attribute allows you to specify descriptions for the following elements.

  • Properties
  • Collections
Note

Descriptions specified by the PropertyDefinitionBase.Description property override the description attribute values.

Note

To learn more about the property attributes supported by the PropertyGrid control, see Property Attributes.

The following example demonstrates the property descriptions defined with the Description attribute.

Expanded See Also

Is this topic helpful?​​​​​​​