Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Expand]Controls and Libraries
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Charts.Designer
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.UI.Interactivity
  [Expand]DevExpress.Mvvm.UI.ModuleInjection
  [Expand]DevExpress.Xpf.Accordion
  [Expand]DevExpress.Xpf.Bars
  [Expand]DevExpress.Xpf.Carousel
  [Expand]DevExpress.Xpf.Charts
  [Expand]DevExpress.Xpf.Charts.Localization
  [Expand]DevExpress.Xpf.Charts.RangeControlClient
  [Expand]DevExpress.Xpf.ChunkList
  [Expand]DevExpress.Xpf.Controls
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Core.ConditionalFormatting
  [Expand]DevExpress.Xpf.Core.DataSources
  [Expand]DevExpress.Xpf.Core.ServerMode
  [Expand]DevExpress.Xpf.Data
  [Expand]DevExpress.Xpf.DataAccess
  [Expand]DevExpress.Xpf.DataAccess.DataSourceWizard
  [Expand]DevExpress.Xpf.Diagram
  [Collapse]DevExpress.Xpf.Docking
   [Expand]AutoHideGroup Class
   [Expand]AutoHideGroupCollection Class
    AutoHideType Enumeration
   [Collapse]BaseLayoutItem Class
     BaseLayoutItem Members
    [Collapse]BaseLayoutItem Properties
      ActualCaption Property
      ActualCaptionWidth Property
      ActualMargin Property
      ActualMaxSize Property
      ActualMinSize Property
      ActualPadding Property
      ActualTabCaption Property
      AllowActivate Property
      AllowClose Property
      AllowContextMenu Property
      AllowDock Property
      AllowDockToCurrentItem Property
      AllowDrag Property
      AllowFloat Property
      AllowHide Property
      AllowMaximize Property
      AllowMinimize Property
      AllowMove Property
      AllowRename Property
      AllowRestore Property
      AllowSelection Property
      AllowSizing Property
      Appearance Property
      Background Property
      BindableName Property
      Caption Property
      CaptionAlignMode Property
      CaptionFormat Property
      CaptionHorizontalAlignment Property
      CaptionImage Property
      CaptionImageLocation Property
      CaptionLocation Property
      CaptionTemplate Property
      CaptionTemplateSelector Property
      CaptionVerticalAlignment Property
      CaptionWidth Property
      CloseCommand Property
      CloseCommandParameter Property
      Closed Property
      ClosingBehavior Property
      ControlBoxContent Property
      ControlBoxContentTemplate Property
      CustomizationCaption Property
      Description Property
      DesiredCaptionWidth Property
      FloatOnDoubleClick Property
      FloatSize Property
      FooterDescription Property
      HasCaption Property
      HasCaptionTemplate Property
      HasDesiredCaptionWidth Property
      HasImage Property
      HasTabCaption Property
      HeaderBarContainerControlAllowDrop Property
      HeaderBarContainerControlName Property
      ImageToTextDistance Property
      IsActive Property
      IsAutoHidden Property
      IsCaptionImageVisible Property
      IsCaptionVisible Property
      IsCloseButtonVisible Property
      IsClosed Property
      IsControlBoxVisible Property
      IsControlItemsHost Property
      IsFloating Property
      IsFloatingRootItem Property
      IsHidden Property
      IsInitializing Property
      IsSelected Property
      IsSelectedItem Property
      IsTabPage Property
      ItemHeight Property
      ItemType Property
      ItemWidth Property
      LayoutSize Property
      LogicalParent Property
      Margin Property
      Padding Property
      Parent Property
      ParentCollectionName Property
      ParentName Property
      SerializableDockSituation Property
      SerializationInfo Property
      ShowCaption Property
      ShowCaptionImage Property
      ShowCloseButton Property
      ShowControlBox Property
      TabCaption Property
      TabCaptionFormat Property
      TabCaptionWidth Property
      TextTrimming Property
      TextWrapping Property
      ToolTip Property
      TypeName Property
    [Expand]BaseLayoutItem Methods
   [Expand]BaseLayoutItemCollection Class
    CaptionAlignMode Enumeration
    CaptionLocation Enumeration
   [Expand]ClosedPanelCollection Class
    ClosePageButtonShowMode Enumeration
    ClosingBehavior Enumeration
   [Expand]ContentItem Class
   [Expand]DefaultMenuItemNames Class
   [Expand]DockController Class
   [Expand]DockControllerBase Class
   [Expand]DockingDocumentUIService Class
    DockingStyle Enumeration
   [Expand]DockLayoutManager Class
    DockOperation Enumeration
   [Expand]DocumentGroup Class
   [Expand]DocumentPanel Class
   [Expand]EmptySpaceItem Class
   [Expand]FixedItem Class
    FixedItemStyle Enumeration
   [Expand]FloatGroup Class
   [Expand]FloatGroupCollection Class
    FloatingMode Enumeration
    GroupBorderStyle Enumeration
    ImageLocation Enumeration
   [Expand]LabelItem Class
   [Expand]LayoutControlItem Class
   [Expand]LayoutController Class
   [Expand]LayoutGroup Class
   [Expand]LayoutPanel Class
   [Expand]LayoutSplitter Class
    MDIState Enumeration
    MDIStyle Enumeration
   [Expand]RestoreLayoutOptions Class
   [Expand]SeparatorItem Class
   [Expand]TabbedDocumentUIService Class
   [Expand]TabbedGroup Class
  [Expand]DevExpress.Xpf.Docking.Base
  [Expand]DevExpress.Xpf.DocumentViewer
  [Expand]DevExpress.Xpf.DXBinding
  [Expand]DevExpress.Xpf.Editors
  [Expand]DevExpress.Xpf.Editors.DateNavigator
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor.Native
  [Expand]DevExpress.Xpf.Editors.Filtering
  [Expand]DevExpress.Xpf.Editors.Flyout
  [Expand]DevExpress.Xpf.Editors.Flyout.Native
  [Expand]DevExpress.Xpf.Editors.Helpers
  [Expand]DevExpress.Xpf.Editors.Popups
  [Expand]DevExpress.Xpf.Editors.RangeControl
  [Expand]DevExpress.Xpf.Editors.Settings
  [Expand]DevExpress.Xpf.Editors.Validation
  [Expand]DevExpress.Xpf.ExpressionEditor
  [Expand]DevExpress.Xpf.Gauges
  [Expand]DevExpress.Xpf.Gauges.Localization
  [Expand]DevExpress.Xpf.Grid
  [Expand]DevExpress.Xpf.Grid.ConditionalFormatting
  [Expand]DevExpress.Xpf.Grid.LookUp
  [Expand]DevExpress.Xpf.Grid.TreeList
  [Expand]DevExpress.Xpf.Layout.Core
  [Expand]DevExpress.Xpf.LayoutControl
  [Expand]DevExpress.Xpf.Map
  [Expand]DevExpress.Xpf.NavBar
  [Expand]DevExpress.Xpf.Navigation
  [Expand]DevExpress.Xpf.PdfViewer
  [Expand]DevExpress.Xpf.PivotGrid
  [Expand]DevExpress.Xpf.PivotGrid.Printing
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpf.Printing.Parameters
  [Expand]DevExpress.Xpf.Printing.Parameters.Models
  [Expand]DevExpress.Xpf.Printing.PreviewControl
  [Expand]DevExpress.Xpf.Printing.PreviewControl.Bars
  [Expand]DevExpress.Xpf.Prism
  [Expand]DevExpress.Xpf.PropertyGrid
  [Expand]DevExpress.Xpf.Reports.UserDesigner
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Extensions
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Localization
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages
  [Expand]DevExpress.Xpf.Ribbon
  [Expand]DevExpress.Xpf.RichEdit
  [Expand]DevExpress.Xpf.RichEdit.Menu
  [Expand]DevExpress.Xpf.Scheduler
  [Expand]DevExpress.Xpf.Scheduler.Drawing
  [Expand]DevExpress.Xpf.Scheduler.Menu
  [Expand]DevExpress.Xpf.Scheduler.Reporting
  [Expand]DevExpress.Xpf.Scheduler.UI
  [Expand]DevExpress.Xpf.Scheduling
  [Expand]DevExpress.Xpf.Scheduling.Editors
  [Expand]DevExpress.Xpf.Scheduling.Reporting
  [Expand]DevExpress.Xpf.Scheduling.Visual
  [Expand]DevExpress.Xpf.SpellChecker
  [Expand]DevExpress.Xpf.Spreadsheet
  [Expand]DevExpress.Xpf.Spreadsheet.Menu
  [Expand]DevExpress.Xpf.TreeMap
  [Expand]DevExpress.Xpf.Utils.Themes
  [Expand]DevExpress.Xpf.WindowsUI
  [Expand]DevExpress.Xpf.WindowsUI.Internal
  [Expand]DevExpress.Xpf.WindowsUI.Navigation
  [Expand]DevExpress.XtraRichEdit
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

BaseLayoutItem.CaptionFormat Property

Gets or sets the format string used to format the layout item's caption. This is a dependency property.

Namespace:DevExpress.Xpf.Docking
Assembly:DevExpress.Xpf.Docking.v17.2.dll

Expanded Syntax

Property value

Type: String
A string that specifies the caption format.

Expanded Remarks

The format specified by the CaptionFormat property must follow the Composite Formatting rules. Typically, the format string contains the "{0}" string plus custom text. The "{0}" string is a placeholder for the item's caption, specified by the Caption property. To learn more about formatting, see Composite Formatting in MSDN.

The following code shows how to create a format string that adds a colon after an item's caption:

Expanded See Also

How would you rate this topic?​​​​​​​