Back to Devexpress

CustomPropertyDescriptorsEventArgs.Properties Property

windowsforms-devexpress-dot-xtraverticalgrid-dot-events-dot-custompropertydescriptorseventargs.md

latest5.2 KB
Original Source

CustomPropertyDescriptorsEventArgs.Properties Property

Gets or sets the collection of PropertyDescriptor objects that identify properties to be displayed in the control.

Namespace : DevExpress.XtraVerticalGrid.Events

Assembly : DevExpress.XtraVerticalGrid.v25.2.dll

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

Declaration

csharp
public PropertyDescriptorCollection Properties { get; set; }
vb
Public Property Properties As PropertyDescriptorCollection

Property Value

TypeDescription
PropertyDescriptorCollection

A PropertyDescriptorCollection object that specifies the collection of PropertyDescriptor objects.

|

Remarks

You can modify the current Properties collection or assign a new collection of PropertyDescriptor objects.

Use the CustomPropertyDescriptorsEventArgs.Source property to identify the object whose properties need to be provided. To get additional information, use CustomPropertyDescriptorsEventArgs.Context.

The following code snippets (auto-collected from DevExpress Examples) contain references to the Properties 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-propertygrid-filter-object-properties/CS/Form1.cs#L24

csharp
PropertyDescriptorCollection filteredCollection = new PropertyDescriptorCollection(null);
AddIfPropertyExist(e.Properties, filteredCollection, "Dock");
AddIfPropertyExist(e.Properties, filteredCollection, "Size");

winforms-property-grid-unbound-rows/CS/DXApplication3/CustomDescriptor/UnboundRowHelper.cs#L31

csharp
{
    PropertyDescriptorCollection properties = e.Properties;
    ArrayList list = new ArrayList(properties);

winforms-property-grid-custom-sorting/CS/Form1.cs#L24

csharp
if(allowCustomSorting && e.Context.PropertyDescriptor == null) {
    e.Properties = e.Properties.Sort(new string[] { "Property5", "Property4", "Property3", "Property2", "Property1" });
}

winforms-propertygrid-filter-object-properties/VB/Form1.vb#L22

vb
Dim filteredCollection As PropertyDescriptorCollection = New PropertyDescriptorCollection(Nothing)
AddIfPropertyExist(e.Properties, filteredCollection, "Dock")
AddIfPropertyExist(e.Properties, filteredCollection, "Size")

winforms-property-grid-unbound-rows/VB/DXApplication3/CustomDescriptor/UnboundRowHelper.vb#L23

vb
If TryCast(sender, PropertyGridControl).SelectedObject Is e.Source Then
    Dim properties As PropertyDescriptorCollection = e.Properties
    Dim list As ArrayList = New ArrayList(properties)

winforms-property-grid-custom-sorting/VB/Form1.vb#L21

vb
If allowCustomSorting AndAlso e.Context.PropertyDescriptor Is Nothing Then
    e.Properties = e.Properties.Sort(New String() {"Property5", "Property4", "Property3", "Property2", "Property1"})
End If

See Also

CustomPropertyDescriptorsEventArgs Class

CustomPropertyDescriptorsEventArgs Members

DevExpress.XtraVerticalGrid.Events Namespace