GalleryItemGroup.Caption Property

Specifies the caption of the GalleryItemGroup object.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v18.2.dll

Declaration

C#

[SmartTagProperty("Caption", "Appearance", SmartTagActionType.RefreshAfterExecute)]
public string Caption { get; set; }

VB.NET

<SmartTagProperty("Caption", "Appearance", SmartTagActionType.RefreshAfterExecute)>
Public Property Caption As String

Property Value

Type	Description
String	A string which specifies the caption of the GalleryItemGroup object.

Remarks

The visibility of group captions is controlled by the BaseGallery.ShowGroupCaption property. To access the gallery which owns the current group, use the GalleryItemGroup.Gallery property.

Instead of text, you can display a custom control within a group caption. See GalleryItemGroup.CaptionControl.

If the BaseGallery.AllowHtmlText property is set to true, you can use HTML tags to format the GalleryItem.Caption and GalleryItemGroup.Caption. For detailed information see HTML Text Formatting.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.

C#

how-to-drag-and-drop-an-item-from-one-standalone-gallerycontrol-to-another-one-e2925/CS/WindowsFormsApplication19/DragDropHelper.cs#L75

int groupIndex = galControl.Gallery.Groups.Add(new GalleryItemGroup());
galControl.Gallery.Groups[groupIndex].Caption = draggedItem.GalleryGroup.Caption;
galControl.Gallery.Groups[groupIndex].Items.Add((GalleryItem)draggedItem.Clone());

VB.NET

how-to-drag-and-drop-an-item-from-one-standalone-gallerycontrol-to-another-one-e2925/VB/WindowsFormsApplication19/DragDropHelper.vb#L68

Dim groupIndex As Integer = galControl.Gallery.Groups.Add(New GalleryItemGroup())
galControl.Gallery.Groups(groupIndex).Caption = draggedItem.GalleryGroup.Caption
galControl.Gallery.Groups(groupIndex).Items.Add(CType(draggedItem.Clone(), GalleryItem))