BaseLayoutItem.Caption Property

Gets or sets the layout item’s caption.

Namespace: DevExpress.Xpf.Docking

Assembly: DevExpress.Xpf.Docking.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Docking, DevExpress.Wpf.Navigation

Declaration

C#

public object Caption { get; set; }

VB.NET

Public Property Caption As Object

Property Value

Type	Description
Object	A string value that specifies the layout item’s caption.

Remarks

The Caption is displayed in the BaseLayoutItem‘s header.

Availability

The Caption is displayed when the item’s ShowCaption inherited property is true.

In Layout Groups

Set the LayoutGroup GroupBorderStyle property to GroupBorderStyle.Group, GroupBorderStyle.GroupBox, or GroupBorderStyle.Tabbed to display the Layout Group’s Caption.

Tabbed Group Captions

When the BaseLayoutItem.IsTabPage is true, the Caption object is duplicated in the tab area. You can set a different tab’s Caption with the BaseLayoutItem.TabCaption property.

The following code sample sets the LayoutPanel‘s Caption and BaseLayoutItem.TabCaption properties.

XAML

<Window ...
    xmlns:dxdo="http://schemas.devexpress.com/winfx/2008/xaml/docking">
    <dxdo:DockLayoutManager>
        <dxdo:LayoutGroup>
            <dxdo:TabbedGroup DestroyOnClosingChildren="True" >
                <dxdo:LayoutPanel
                    Caption="Personal"
                    CaptionLocation="Top"
                    TabCaption="Info">
                    ...
                </dxdo:LayoutPanel>
                <dxdo:LayoutPanel Caption="Position" />
            </dxdo:TabbedGroup>
        </dxdo:LayoutGroup>
    </dxdo:DockLayoutManager>
</Window>

Customize Captions

Property	Description
CaptionImage	Gets or sets the image displayed within the item’s Caption. This is a dependency property.
CaptionFormat	Gets or sets the format string used to format the layout item’s caption. This is a dependency property.
CaptionLocation and CaptionHorizontalAlignment	Specify the item Caption‘s position and horizontal alignment.
CaptionTemplate and CaptionTemplateSelector	Specify the Caption appearance.
CaptionWidth	Gets or sets the width of the item’s Caption area. This is a dependency property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Caption 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

wpf-dock-layout-manager-limit-layout-group-customization-at-runtime/CS/DXDockingForLayoutPurposes/MainWindow.xaml#L25

<dxd:DockLayoutManager>
    <dxd:LayoutGroup Name="generalLayoutGroup" GroupBorderStyle="GroupBox" ShowCaption="True" Caption="General" Orientation="Vertical">
        <dxd:LayoutControlItem Name="incidentNumber" Caption="Incident Number" VerticalAlignment="Top">

wpf-docklayoutmanager-use-services-that-implement-the-idocumentmanagerservice/CS/DXDocumentUIServiceSample/MainWindow.xaml#L20

<dxdo:TabbedGroup>
    <dxdo:LayoutPanel Caption="WindowedDocumentUIService">
        <View:MainView>

wpf-dock-layout-manager-pin-unpin-a-layout-panel/CS/CreateAutoHiddenPanels/Window1.xaml#L6

<dxdo:DocumentGroup x:Name="documentGroup1">
    <dxdo:DocumentPanel x:Name="paneDocument1" Caption="Document 1">
        <Grid>

wpf-docklayoutmanager-create-auto-hidden-panels/CS/CreateAutoHiddenPanels/Window1.xaml#L6

<dxdo:DocumentGroup x:Name="documentGroup1">
    <dxdo:DocumentPanel x:Name="paneDocument1" Caption="Document 1">
        <RichTextBox />

how-to-create-a-pop-up-menu-with-all-docklayoutmanagers-panels-t167144/CS/DockLayoutSelectExample/MainWindow.xaml#L22

<dxdo:AutoHideGroup DockType="Right">
    <dxdo:LayoutPanel x:Name="paneProperties" Caption="Properties"/>
</dxdo:AutoHideGroup>

C#

wpf-dock-layout-manager-add-the-document-panel-at-runtime/CS/SimpleDockingApplication/Window1.xaml.cs#L32

DocumentPanel docPanel = dockManager1.DockController.AddDocumentPanel(documentGroup);  // сreate a panel in the document group
docPanel.Caption = string.Format("Document {0}", ++counter);
this.dockManager1.DockController.Activate(docPanel);

wpf-docklayoutmanager-load-an-external-window-or-usercontrol-into-a-documentpanel/CS/DocumentPanel_Content/MainWindow.xaml.cs#L31

    new Uri(@"CustomWindows\UserControl1.xaml", UriKind.Relative));
panel1.Caption = "Document " + (ctr++).ToString();

how-to-create-a-pop-up-menu-with-all-docklayoutmanagers-panels-t167144/CS/DockLayoutSelectExample/MainWindow.xaml.cs#L35

LayoutPanel randomPanel = new LayoutPanel();
randomPanel.Caption = "Random Panel " + new Random().Next(1, 100);
group.Add(randomPanel);

VB.NET

wpf-dock-layout-manager-add-the-document-panel-at-runtime/VB/SimpleDockingApplication/Window1.xaml.vb#L28

Dim docPanel As DocumentPanel = Me.dockManager1.DockController.AddDocumentPanel(documentGroup) ' сreate a panel in the document group
docPanel.Caption = String.Format("Document {0}", Threading.Interlocked.Increment(counter))
Me.dockManager1.DockController.Activate(docPanel)

wpf-docklayoutmanager-load-an-external-window-or-usercontrol-into-a-documentpanel/VB/DocumentPanel_Content/MainWindow.xaml.vb#L34

panel1 = Me.dockLayoutManager1.DockController.AddDocumentPanel(Me.documentGroup1, New Uri("CustomWindows\UserControl1.xaml", UriKind.Relative))
panel1.Caption = "Document " & Math.Min(Threading.Interlocked.Increment(ctr), ctr - 1).ToString()
Call DocumentPanel.SetMDISize(panel1, New Size(400, 300))

how-to-create-a-pop-up-menu-with-all-docklayoutmanagers-panels-t167144/VB/DockLayoutSelectExample/MainWindow.xaml.vb#L33

Dim randomPanel As New LayoutPanel()
randomPanel.Caption = "Random Panel " & New Random().Next(1, 100)
group.Add(randomPanel)