BaseLayoutItem.CaptionImage Property

Gets or sets the image displayed within the item’s caption. This is a dependency property.

Namespace: DevExpress.Xpf.Docking

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

Declaration

C#

public ImageSource CaptionImage { get; set; }

VB.NET

Public Property CaptionImage As ImageSource

Property Value

Type	Description
ImageSource	An ImageSource object that specifies the image displayed within the item’s caption.

Example

This example demonstrates how to use raster and vector icons in dock panel headers.

The vector icon is defined in XAML resources.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-use-vector-icons-in-dock-panel-headers-e2761.

XAMLIcon.xaml

<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:PresentationOptions="http://schemas.microsoft.com/winfx/2006/xaml/presentation/options"
                    >
    <DrawingImage x:Key="xamlIcon" PresentationOptions:Freeze="true">
        <DrawingImage.Drawing>
            <GeometryDrawing>
                <GeometryDrawing.Geometry>
                    <GeometryGroup>
                        <EllipseGeometry Center="10,10" RadiusX="9" RadiusY="4" />
                        <EllipseGeometry Center="10,10" RadiusX="4" RadiusY="9" />
                    </GeometryGroup>
                </GeometryDrawing.Geometry>
                <GeometryDrawing.Brush>
                    <LinearGradientBrush>
                        <GradientStop Offset="0.0" Color="Blue" />
                        <GradientStop Offset="1.0" Color="#CCCCFF" />
                    </LinearGradientBrush>
                </GeometryDrawing.Brush>
                <GeometryDrawing.Pen>
                    <Pen Thickness="2" Brush="Black" />
                </GeometryDrawing.Pen>
            </GeometryDrawing>
        </DrawingImage.Drawing>
    </DrawingImage>
</ResourceDictionary>

MainWindow.xaml.cs

using DevExpress.Xpf.Core;

namespace XAMLIcons {
    public partial class MainWindow : DXWindow {
        public MainWindow() {
            InitializeComponent();
        }
    }
}

MainWindow.xaml

<dx:DXWindow x:Class="XAMLIcons.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
        xmlns:dxdo="http://schemas.devexpress.com/winfx/2008/xaml/docking"
        Title="DXWpfApplication" Height="600" Width="800"
        dx:ThemeManager.ThemeName="Office2007Blue"
    >
    <dx:DXWindow.Resources>
        <ResourceDictionary>
            <ResourceDictionary.MergedDictionaries>
                <ResourceDictionary Source="Images/XAMLIcon.xaml" />
            </ResourceDictionary.MergedDictionaries>
        </ResourceDictionary>
    </dx:DXWindow.Resources>
    <dxdo:DockLayoutManager>
        <dxdo:LayoutGroup>
            <dxdo:LayoutPanel Caption="Panel with vector icon" CaptionImage="{StaticResource xamlIcon}">
                <TextBox BorderThickness="0" />
            </dxdo:LayoutPanel>
            <dxdo:LayoutPanel Caption="Panel with raster icon" CaptionImage="Images/RasterIcon.png" ItemHeight="3*">
                <TextBox BorderThickness="0" />
            </dxdo:LayoutPanel>
        </dxdo:LayoutGroup>
    </dxdo:DockLayoutManager>
</dx:DXWindow>

Application.xaml.vb

Imports System
Imports System.Collections.Generic
Imports System.Configuration
Imports System.Data
Imports System.Linq
Imports System.Windows

Namespace DX_WPF_Application2
    ''' <summary>
    ''' Interaction logic for App.xaml
    ''' </summary>
    Partial Public Class App
        Inherits Application

    End Class
End Namespace

Application.xaml

<Application x:Class="DX_WPF_Application2.App"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             StartupUri="MainWindow.xaml">
    <Application.Resources>

    </Application.Resources>
</Application>

MainWindow.xaml.vb

Imports DevExpress.Xpf.Core

Namespace XAMLIcons
    Partial Public Class MainWindow
        Inherits DXWindow

        Public Sub New()
            InitializeComponent()
        End Sub
    End Class
End Namespace

Related GitHub Examples

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

C#

wpf-dock-layout-manager-serialize-a-particular-panels-layout/CS/DX WPF Application10/MainWindow.xaml#L24

<dxd:LayoutGroup x:Name="group1" Orientation="Vertical" ItemWidth="3*">
    <dxd:LayoutPanel x:Name="targetPanel" Caption="MainView" ItemHeight="3*" CaptionImage="Images/Icons/MainView.png">
        <dxg:GridControl AutoPopulateColumns="True" ShowBorder="False">

wpf-dock-layout-manager-serialize-custom-panels-and-their-properties/CS/DX WPF Application10/MainWindow.xaml#L24

<dxd:LayoutGroup  x:Name="group1" Orientation="Vertical" ItemWidth="3*">
    <local:MyCustomPanel  x:Name="panel2" Caption="MainView" ItemHeight="3*" CaptionImage="Images/Icons/MainView.png">
        <dxg:GridControl AutoPopulateColumns="True" ShowBorder="False">

howto-implement-resizing-the-navbarcontrols-width-with-thenavigationpaneview-by-dragging-e2572/VB/MainWindow.xaml#L109

<dxd:DocumentGroup ItemHeight="3*">
    <dxd:DocumentPanel Caption="Document1" CaptionImage="Images/Icons/MainView.png" ItemHeight="3*">
        <TextBox BorderThickness="0" />

wpf-docklayoutmanager-use-imvvmdockingproperties-to-build-dock-ui-with-mvvm/CS/App.xaml#L11

    <Setter Property="Caption" Value="{Binding Caption}" />
    <Setter Property="CaptionImage" Value="{Binding Glyph}" />
</Style>

wpf-dock-layout-manager-pin-unpin-layout-panels-in-mvvm/CS/App.xaml#L11

    <Setter Property="Caption" Value="{Binding Caption}" />
    <Setter Property="CaptionImage" Value="{Binding Glyph}" />
</Style>