DataViewBase.ColumnHeaderCustomizationAreaTemplate Property

Gets or sets the template that defines the presentation of the customization area displayed within column headers. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v22.2.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public DataTemplate ColumnHeaderCustomizationAreaTemplate { get; set; }

VB.NET

Public Property ColumnHeaderCustomizationAreaTemplate As DataTemplate

Property Value

Type	Description
DataTemplate	A DataTemplate object that defines the presentation of the customization area displayed within column headers.

Remarks

The image below shows a grid column header’s customization area containing a checkbox:

Specify the ColumnBase.HeaderCustomizationAreaTemplate property to add an element to a column header’s customization area. Use the ColumnHeaderCustomizationAreaTemplate property to display the customization area’s content within all column headers in the current GridControl’s view. The data context (binding source) for these templates is the ColumnBase class.

The following code sample demonstrates how to add a checkbox to the column header using the ColumnBase.HeaderCustomizationAreaTemplate property:

XAML

<dxg:GridColumn FieldName="CategoryName">
   <dxg:GridColumn.HeaderCustomizationAreaTemplate>
      <DataTemplate>
         <dxe:CheckEdit IsChecked="{Binding Column.ReadOnly, Mode=TwoWay}" />
      </DataTemplate>
   </dxg:GridColumn.HeaderCustomizationAreaTemplate>
</dxg:GridColumn>

View Example: Display a Check Box in Column Headers

Use the ColumnBase.ActualHeaderCustomizationAreaTemplateSelector property to obtain the actual template selector.

If you have more than one template for rendering a customization area, specify the ColumnBase.HeaderCustomizationAreaTemplateSelector property to implement custom logic for selecting the required template.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ColumnHeaderCustomizationAreaTemplate 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.

XAML

how-to-add-a-custom-button-to-a-column-header-e1838/CS/Window1.xaml#L15

<dxg:TableView Name="view" ShowGridMenu="TableView_ShowGridMenu">
    <dxg:TableView.ColumnHeaderCustomizationAreaTemplate>
        <DataTemplate>