Back to Devexpress

KanbanGroup.Caption Property

windowsforms-devexpress-dot-xtragrid-dot-views-dot-tile-dot-kanbangroup-b7733ae7.md

latest3.0 KB
Original Source

KanbanGroup.Caption Property

Gets or sets the group’s display caption.

Namespace : DevExpress.XtraGrid.Views.Tile

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

csharp
[DefaultValue("")]
[DXCategory("Options")]
[XtraSerializableProperty]
public string Caption { get; set; }
vb
<DXCategory("Options")>
<XtraSerializableProperty>
<DefaultValue("")>
Public Property Caption As String

Property Value

TypeDefaultDescription
StringString.Empty

The group’s display caption.

|

Remarks

If the Caption property is set to an empty string, the display caption is automatically generated based on the group value (KanbanGroup.GroupValue). You can obtain this caption via the KanbanGroup.GetCaption property.

HTML-inspired formatting

You can use a set of HTML tags to format group captions. An example and its result are demonstrated below.

csharp
tileView.OptionsKanban.Groups.Add(new KanbanGroup() { 
    GroupValue = TaskStatus.Backlog, 
    Caption= "<size=+2>Backlog
<r><size=-2>User stories" 
});
vb
tileView.OptionsKanban.Groups.Add(New KanbanGroup() With {
                                  .GroupValue = TaskStatus.Backlog,
                                  .Caption = "<size=+2>Backlog
<r><size=-2>User stories"
                                  })

Dynamic text

The ColumnView.CustomColumnDisplayText event allows you to dynamically provide text to display in group captions. For instance, you can display the number of the child tile count for each group (as shown in Tile View Kanban Board module in the XtraGrid MainDemo).

See Also

GroupValue

KanbanGroup Class

KanbanGroup Members

DevExpress.XtraGrid.Views.Tile Namespace