GalleryItem Class

Represents an item within a gallery.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v18.1.dll

Declaration

C#

[SmartTagAction(typeof(GalleryItemDesignTimeActionsProvider), "AddItem", "Add Item")]
[SmartTagAction(typeof(GalleryItemDesignTimeActionsProvider), "RemoveItem", "Remove Item", SmartTagActionType.CloseAfterExecute)]
[SmartTagAction(typeof(GalleryItemDesignTimeActionsProvider), "AddGroup", "Add Group")]
[TypeConverter(typeof(UniversalTypeConverterEx))]
public class GalleryItem :
    ICloneable,
    ISupportCommandBinding,
    IAppearanceOwner,
    IDXImageUriClient

VB.NET

<SmartTagAction(GetType(GalleryItemDesignTimeActionsProvider), "RemoveItem", "Remove Item", SmartTagActionType.CloseAfterExecute)>
<SmartTagAction(GetType(GalleryItemDesignTimeActionsProvider), "AddItem", "Add Item")>
<TypeConverter(GetType(UniversalTypeConverterEx))>
<SmartTagAction(GetType(GalleryItemDesignTimeActionsProvider), "AddGroup", "Add Group")>
Public Class GalleryItem
    Implements ICloneable,
               ISupportCommandBinding,
               IAppearanceOwner,
               IDXImageUriClient

Related API Members

The following members accept/return GalleryItem objects:

• BaseGallery.FocusedItem
• BaseGallery.GetCheckedItem()
• BaseGallery.GetItemByCaption(String)
• BaseGallery.GetItemByValue(Object)
• GalleryItem.OriginItem
• GalleryItemCollection.Item[Int32]
• GalleryItemEventArgs.Item
• GalleryItemGroup.GetItemByValue(Object)
• GalleryThumbnailImageEventArgs.Item
• RibbonHitInfo.GalleryItem

Remarks

A gallery consists of groups of gallery items.The GalleryItem class represents a gallery item. To access gallery items that belong to a specific gallery group use the GalleryItemGroup.Items property.

A gallery item is visually represented by an image which is specified by the GalleryItem.Image or GalleryItem.ImageIndex property. The item’s caption and description are specified by the GalleryItem.Caption and GalleryItem.Description properties. To make the item’s caption and description visible, set the BaseGallery.ShowItemText property to true.

See Gallery Items for more information.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GalleryItem class.

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-generate-a-live-report-based-on-gridcontrol-content-t272175/CS/WindowsFormsApplication1/GridReportExtensions/SnapReportFormGenerator.cs#L3944

//
chartControlCommandGalleryItemGroup2DColumn1.Items.AddRange(new DevExpress.XtraBars.Ribbon.GalleryItem[] {
createBarChartItem1,

dragdrop-items-from-one-standalone-gallerycontrol-to-another-one-extended-e3857/CS/DragDropExample/DragDropHelper.cs#L16

private Pen _SelectedPen = new Pen(Color.Indigo, 3);
private GalleryItem targetHighlightItem;
RibbonHitInfo DragItemHitInfo;

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

{
    if (e.Data.GetDataPresent(typeof(GalleryItem)))
        e.Effect = DragDropEffects.Copy;

gallerycontrol-get-selected-item-with-keyboard-navigation-e4335/CS/WindowsFormsApplication40/Form1.cs#L21

GalleryItemGroup Group = new GalleryItemGroup();
Group.Items.Add(new DevExpress.XtraBars.Ribbon.GalleryItem(GetImage("1.jpg"), "1", "1"));
Group.Items.Add(new DevExpress.XtraBars.Ribbon.GalleryItem(GetImage("2.jpg"), "2", "2"));

how-to-set-a-gallerycontrol-as-a-custom-drop-down-for-the-tokenedit-t163559/CS/TokenEditCustomDropDown/CustomDropDown.cs#L18

List<TokenEditToken> tokenList = new List<TokenEditToken>();
GalleryItem clickedItem;

VB.NET

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/VB/WindowsFormsApplication1/GridReportExtensions/SnapReportFormGenerator.vb#L3439

'
chartControlCommandGalleryItemGroup2DColumn1.Items.AddRange(New DevExpress.XtraBars.Ribbon.GalleryItem() {createBarChartItem1, createFullStackedBarChartItem1, createSideBySideFullStackedBarChartItem1, createSideBySideStackedBarChartItem1, createStackedBarChartItem1})
chartControlCommandGalleryItemGroup3DColumn1.Items.AddRange(New DevExpress.XtraBars.Ribbon.GalleryItem() {createBar3DChartItem1, createFullStackedBar3DChartItem1, createManhattanBarChartItem1, createSideBySideFullStackedBar3DChartItem1, createSideBySideStackedBar3DChartItem1, createStackedBar3DChartItem1})

dragdrop-items-from-one-standalone-gallerycontrol-to-another-one-extended-e3857/VB/DragDropExample/DragDropHelper.vb#L15

Private _SelectedPen As New Pen(Color.Indigo, 3)
Private targetHighlightItem As GalleryItem
Private DragItemHitInfo As RibbonHitInfo

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

Private Sub OnTargetGalleryDragOver(ByVal sender As Object, ByVal e As DragEventArgs)
    If e.Data.GetDataPresent(GetType(GalleryItem)) Then
        e.Effect = DragDropEffects.Copy

gallerycontrol-get-selected-item-with-keyboard-navigation-e4335/VB/WindowsFormsApplication40/Form1.vb#L20

Dim Group As New GalleryItemGroup()
Group.Items.Add(New DevExpress.XtraBars.Ribbon.GalleryItem(GetImage("1.jpg"), "1", "1"))
Group.Items.Add(New DevExpress.XtraBars.Ribbon.GalleryItem(GetImage("2.jpg"), "2", "2"))

how-to-set-a-gallerycontrol-as-a-custom-drop-down-for-the-tokenedit-t163559/VB/TokenEditCustomDropDown/CustomDropDown.vb#L19

Private tokenList As New List(Of TokenEditToken)()
Private clickedItem As GalleryItem

Inheritance

Object

GalleryItem