wpf-devexpress-dot-xpf-dot-grid-dot-dataviewbase-af4cd73c.md
Occurs when a column header is clicked.
Namespace : DevExpress.Xpf.Grid
Assembly : DevExpress.Xpf.Grid.v25.2.Core.dll
NuGet Package : DevExpress.Wpf.Grid.Core
public event ColumnHeaderClickEventHandler ColumnHeaderClick
Public Event ColumnHeaderClick As ColumnHeaderClickEventHandler
The ColumnHeaderClick event's data class is ColumnHeaderClickEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| AllowSorting | Gets or sets whether it is allowed to sort by the column’s values. |
| Column | Gets a column whose header is clicked. |
| 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. |
| IsCtrl | Gets or sets whether the Ctrl key is pressed. |
| IsShift | Gets whether the Shift key is pressed. |
| 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. |
| 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. |
If column sorting is enabled, the GridControl raises the ColumnHeaderClick event when a user clicks a column header.
Use the following code snippet to ensure data is not sorted when a user clicks a column header:
void TableView_ColumnHeaderClick(object sender, DevExpress.Xpf.Grid.ColumnHeaderClickEventArgs e) {
e.Handled = true;
}
Private Sub TableView_ColumnHeaderClick(ByVal sender As Object, ByVal e As DevExpress.Xpf.Grid.ColumnHeaderClickEventArgs)
e.Handled = True
End Sub
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ColumnHeaderClick 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.
<dxg:GridControl.View>
<dxg:TableView Name="view" ColumnHeaderClick="ColumnHeaderClick" />
</dxg:GridControl.View>
#line 11 "..\..\..\MainWindow.xaml"
this.view.ColumnHeaderClick += new DevExpress.Xpf.Grid.ColumnHeaderClickEventHandler(this.ColumnHeaderClick);
#ExternalSource("..\..\..\MainWindow.xaml",11)
AddHandler Me.view.ColumnHeaderClick, New DevExpress.Xpf.Grid.ColumnHeaderClickEventHandler(AddressOf Me.ColumnHeaderClick)
See Also