GalleryItem.Caption Property

Gets or sets the item’s caption.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Description
String	A string that specifies the item’s caption.

Remarks

This property specifies the gallery item’s caption. The item’s description which is displayed below the caption is specified by the GalleryItem.Description property.

The visibility of the item’s caption and description is specified by the BaseGallery.ShowItemText property.

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 snippets (auto-collected from DevExpress Examples) contain references 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-use-documentselector-feature-e2760/CS/DocumentSelectorApp/MainForm.cs#L51

    e.Item.FooterText = (string)e.Item.Page.MdiChild.Tag;
    e.Item.HeaderText = string.Format("Photo Category: {0}", e.Item.Caption);
}

how-to-implement-tree-view-style-including-the-paint-style-and-the-capability-to-collapse-t141633/CS/WindowsApplication1/Skin Helper/CustomSkinHelper.cs#L31

foreach (var skin in skinsToHide) {
    if (String.Equals(item.Caption, skin)) {
        item.Visible = false;

VB.NET

how-to-use-documentselector-feature-e2760/VB/DocumentSelectorApp/MainForm.vb#L53

    e.Item.FooterText = CStr(e.Item.Page.MdiChild.Tag)
    e.Item.HeaderText = String.Format("Photo Category: {0}", e.Item.Caption)
End Sub

how-to-implement-tree-view-style-including-the-paint-style-and-the-capability-to-collapse-t141633/VB/WindowsApplication1/Skin Helper/CustomSkinHelper.vb#L31

For Each skin In skinsToHide
    If String.Equals(item.Caption, skin) Then
        item.Visible = False