PropertyGridControl.CustomExpand Event

Enables you to control how properties and categories expand.

Namespace: DevExpress.Xpf.PropertyGrid

Assembly: DevExpress.Xpf.PropertyGrid.v18.2.dll

Declaration

C#

public event CustomExpandEventHandler CustomExpand

VB.NET

Public Event CustomExpand As CustomExpandEventHandler

Event Data

The CustomExpand event's data class is CustomExpandEventArgs. The following properties provide information specific to this event:

Property	Description
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
IsExpanded	Gets or sets whether the item is expanded.
IsInitializing	Gets whether the item is being initialized.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Row	Gets information about an expanding row.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

Handle the CustomExpand event to expand a row (or category). This event fires for each PropertyGridControl item. Set the event arguments’ CustomExpandEventArgs.IsExpanded property to true to expand a processed item.

When the CustomExpandEventArgs.IsExpanded property is set to true, end-users cannot collapse items in the PropertyGridControl. Set the IsExpanded property to true only if the processed item is initializing (CustomExpandEventArgs.IsInitializing is true) to allow end-users to collapse the control items.

The code sample below demonstrates how to expand all the items within the control and allow end-users to collapse them:

C#

void PropertyGridControl_CustomExpand(object sender, CustomExpandEventArgs args) {
    if(args.IsInitializing)
        args.IsExpanded = true;
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomExpand event.

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#

propertygridcontrol-how-to-sort-data-using-custom-rules-t617806/CS/PropertyGrid_Sorting/MainWindow.xaml#L16

<Grid>
    <dxprg:PropertyGridControl CustomExpand="pGrid_CustomExpand"
                               SelectedObject="{Binding Data}"