Skip to main content

BaseLayoutItem.CaptionTemplate Property

Gets or sets the template used to visualize the current item’s BaseLayoutItem.Caption.

Namespace: DevExpress.Xpf.Docking

Assembly: DevExpress.Xpf.Docking.v23.1.dll

NuGet Package: DevExpress.Wpf.Docking


public DataTemplate CaptionTemplate { get; set; }

Property Value

Type Description

A DataTemplate object that visualizes the current item’s BaseLayoutItem.Caption.


The BaseLayoutItem.Caption property specifies an item caption.

You can use the CaptionTemplate property to display a non-string BaseLayoutItem.Caption. Use the BaseLayoutItem.CaptionTemplateSelector property to select a template based on custom logic.

If a layout item is displayed as a tab item, the BaseLayoutItem.Caption property determines its tab caption. In this case, the CaptionTemplate is also applied to this tab’s caption.

When you add an element to a CaptionTemplate, you should set the element’s dxdove:DockPane.HitTestType attached property to Content.

The following code sample displays the Open button at the panel header’s right (ControlBoxContentTemplate property) and the X button next to the tab caption (CaptionTemplate property):

<Window ...
                <dxdo:LayoutPanel Caption="Error List">
                            <Button Content="Open" />
                            <StackPanel Orientation="Horizontal">
                                <TextBlock Text="{Binding}" />
                                <Button Content="X" dxdove:DockPane.HitTestType="Content" />
                <dxdo:LayoutPanel Caption="Solution Explorer" />
                <dxdo:LayoutPanel Caption="Find Replace" />

DockLayoutManager - Caption Buttons

See Also