Skip to main content

BaseLayoutItem.Caption Property

Gets or sets the layout item's caption.

Namespace: DevExpress.Xpf.Docking

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

#Declaration

[TypeConverter(typeof(StringConverter))]
[XtraSerializableProperty(1)]
public object Caption { get; set; }

#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.

DXDocking Captions and TabCaptions

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.

See Also