ColumnBase.HeaderCustomizationAreaTemplate Property

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

Namespace: DevExpress.Xpf.Grid

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Grid.Core, DevExpress.Wpf.Grid.Core

Declaration

C#

public DataTemplate HeaderCustomizationAreaTemplate { get; set; }

VB.NET

Public Property HeaderCustomizationAreaTemplate As DataTemplate

Property Value

Type	Description
DataTemplate	A DataTemplate object that defines the presentation of the header customization area.

Remarks

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

Specify the HeaderCustomizationAreaTemplate property to add an element to a column header’s customization area. Use the DataViewBase.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 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>

Refer to the How to: Display a Check Box within Column Headers example to learn more.

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 snippets (auto-collected from DevExpress Examples) contain references to the HeaderCustomizationAreaTemplate 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-deserialize-custom-properties-using-the-createcontentpropertyvalue-event-t159099/CS/WpfApplication58/MainWindow.xaml#L23

<local:MyGridColumn FieldName="Name" x:Name="nameColumn">
    <local:MyGridColumn.HeaderCustomizationAreaTemplate>
        <DataTemplate>

how-to-use-the-dxserializercreatecollectionitem-event-to-deserialize-a-custom-collection-t163234/CS/WpfApplication58/MainWindow.xaml#L25

<local:MyGridColumn FieldName="Name" x:Name="nameColumn">
    <local:MyGridColumn.HeaderCustomizationAreaTemplate>
        <DataTemplate>

how-to-use-the-dxserializerfindcollectionitem-event-to-deserialize-a-custom-collection-t163250/CS/WpfApplication58/MainWindow.xaml#L25

<local:MyGridColumn FieldName="Name" x:Name="nameColumn">
    <local:MyGridColumn.HeaderCustomizationAreaTemplate>
        <DataTemplate>