Skip to main content

DevExpress v24.1 Update — Your Feedback Matters

Our What's New in v24.1 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

PropertyDescriptionControl Class

The control that displays descriptions for properties being browsed in a PropertyGridControl.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.VerticalGrid

#Declaration

public class PropertyDescriptionControl :
    BaseControl,
    IPanelControlOwner

#Remarks

For an object’s properties, descriptions can be specified via the DescriptionAttribute attribute, The PropertyGridControl doesn’t display property descriptions. To display property descriptions for properties browsed in a PropertyGridControl, use the PropertyDescriptionControl control. Add a PropertyDescriptionControl control to the form, and link it to the Property Grid Control via the PropertyDescriptionControl.PropertyGrid property. Browsing through properties in the Property Grid Control will automatically display property descriptions in the PropertyDescriptionControl.

PropertyDescriptionControl

#Example

The following example combines a PropertyGridControl and PropertyDescriptionControl in a panel. The PropertyDescriptionControl displays property descriptions when you browse through items in the PropertyGridControl.

image

using DevExpress.XtraEditors;
using DevExpress.XtraVerticalGrid;

private void Form1_Load(object sender, EventArgs e) {
    PanelControl panelControl1 = new PanelControl();
    panelControl1.Parent = this;
    panelControl1.Dock = DockStyle.Left;
    panelControl1.Width = 300;

    PropertyGridControl propertyGridControl1 = new PropertyGridControl(); ;
    PropertyDescriptionControl propertyDescriptionControl1 = new PropertyDescriptionControl();

    propertyGridControl1.Parent = panelControl1;
    propertyGridControl1.Dock = System.Windows.Forms.DockStyle.Fill;
    propertyGridControl1.SelectedObject = this;

    propertyDescriptionControl1.Parent = panelControl1;
    propertyDescriptionControl1.AutoHeight = true;
    propertyDescriptionControl1.Dock = DockStyle.Bottom;
    propertyDescriptionControl1.PropertyGrid = propertyGridControl1;
}

#Inheritance

Object
MarshalByRefObject
Component
Control
DevExpress.XtraEditors.XtraControl
ControlBase
BaseControl
PropertyDescriptionControl
See Also