BaseLayoutItem.Caption Property

Gets or sets the layout item’s caption.

Namespace: DevExpress.Xpf.Docking

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

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

By default, the Caption is displayed in the BaseLayoutItem‘s header and the same object is shown within a tab when the BaseLayoutItem is in a tabbed state. You can set a different tab caption using the BaseLayoutItem.TabCaption property. The following figure illustrates a panel with different Caption and BaseLayoutItem.TabCaption property values.

Generally, you set the Caption as a string value. If you assign any other object to item’s caption, you may need a DataTemplate object to visualize it. Use the BaseLayoutItem.CaptionTemplate property in this case.

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.

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)

C#

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-dock-layout-manager-use-data-contexts-for-layout-items-and-their-child-controls/VB/DataContext_Ex/MainWindow.xaml#L9

<dxd:LayoutGroup Orientation="Vertical">
    <dxd:LayoutPanel x:Name="panelDescription" Caption="Description" ItemHeight="70">
        <dxd:LayoutGroup Orientation="Vertical">

wpf-docklayoutmanager-build-a-layout-ui/VB/LayoutPanel_Content_Ex/Window1.xaml#L11

<dxdo:LayoutGroup Name="Root">
    <dxdo:LayoutPanel Caption="Panel1">
        <dxdo:LayoutGroup Orientation="Vertical">

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>

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>