Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Collapse]DevExpress.XtraBars.Ribbon.Gallery
   [Collapse]BaseGallery Class
     BaseGallery Members
     BaseGallery Constructor
    [Expand]BaseGallery Properties
    [Expand]BaseGallery Events
    [Expand]BaseGallery Methods
    CheckDrawMode Enumeration
   [Expand]GalleryControlGallery Class
    GalleryItemAlignment Enumeration
    GalleryItemAutoSizeMode Enumeration
   [Expand]GalleryOptionsImageLoad Class
    GalleryScrollMode Enumeration
   [Expand]GalleryThumbnailImageEventArgs Class
    GalleryThumbnailImageEventHandler Delegate
   [Expand]InDropDownGallery Class
   [Expand]InRibbonGallery Class
    ItemCheckMode Enumeration
    ShowScrollBar Enumeration
   [Expand]StandaloneGallery Class
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

BaseGallery Members

Represents a base class for galleries.

Expanded Public Constructors

Show: Inherited
  Name Description
Public method BaseGallery Initializes a new instance of the BaseGallery class with the default settings.
Top

Expanded Public Properties

Show: Inherited
  Name Description
Public property AllowAllUp Gets or sets whether or not all gallery items can simultaneously be in a normal (elevated) state.
Public property AllowGlyphSkinning Gets or sets whether items within this gallery should colorize their icons using foreground colors.
Public propertyStatic member AllowHoverAnimation Gets or sets whether or not hovering over gallery items is accompanied with animation effects.
Public property AllowHoverImages Gets or sets whether the hover images feature is enabled.
Public property AllowHtmlText Gets or sets whether captions for items and groups in this gallery can be formatted using HTML tags.
Public property AllowMarqueeSelection Gets or sets whether the marquee selection feature is enabled, which allows gallery items to be selected by dragging over items with the mouse.
Public property Appearance Gets the appearances that are used to paint gallery elements.
Public property CanAnimate This member supports the internal infrastructure, and is not intended to be used directly from your code.
Public property CheckDrawMode Gets or sets how gallery items are painted when in the checked state.
Public property CheckSelectedItemViaKeyboard Gets or sets whether the gallery item currently selected via the keyboard should be immediately checked.
Public property ClearSelectionOnClickEmptySpace Gets or sets whether the current selection is cleared when clicking the empty space.
Public property ColumnCount Gets or sets the (maximum) number of columns in the gallery.
Public property Container Gets the System.ComponentModel.IContainer that contains the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property DistanceBetweenItems Gets or sets the distance between Gallery items.
Public property DistanceItemCaptionToDescription Gets or sets the distance between an item's caption and its description.
Public property DistanceItemImageToText Gets or sets the distance between an item's image and its text.
Public property DrawImageBackground Gets or sets whether the background of the Gallery item's image is displayed.
Public property FirstItemVertAlignment Gets or sets the first gallery item's vertical position beyond which this item cannot be moved when scrolling backwards. (When the gallery is horizontally oriented (see GalleryControlGallery.Orientation), the FirstItemVertAlignment property defines the first item's horizontal position.
Public property FirstItemVertIndent Gets or sets a custom indent of the first gallery item from the gallery's top or left edge (depending on the gallery's orientation). The property is in effect when FirstItemVertAlignment is set to Custom.
Public property FixedHoverImageSize Gets or sets whether hover images are displayed with the same size.
Public property FixedImageSize Gets or sets whether gallery item images have the same display size, as specified by the ImageSize property.
Public property FocusedItem Gets a currently focused GalleryItem in this gallery.
Public property GroupContentMargin Gets or sets margins of a gallery group's content.
Public property Groups Gets a collection of groups owned by the gallery.
Public property HoverImages Gets or sets the source of hover images.
Public property HoverImageSize Gets or sets the size of hover images.
Public property Images Gets or sets the source of images that can be displayed within gallery items.
Public property ImageSize Gets or sets the display size of gallery item images.
Public property ItemAutoSizeMode Gets or sets the auto-size mode of gallery items.
Public property ItemCheckMode Gets or sets whether item checking (selection) is enabled, and how the items can be checked (selected).
Public property ItemImageLayout Gets or sets how a gallery item's image is displayed within the item's image area.
Public property ItemImageLocation Gets or sets the location of images within gallery items, relative to the items' text.
Public property ItemImagePadding Gets or sets the amount of space, in pixels, between the Gallery item's image and its borders.
Public property ItemSize Gets or sets the size of gallery items when item auto-sizing is disabled. The Width attribute is also in effect when the auto-height feature is enabled.
Public property ItemTextPadding Gets or sets the amount of space, in pixels, between the Gallery item's text and its borders.
Public property LastItemVertAlignment Gets or sets the last gallery item's vertical position, beyond which this item cannot be moved when scrolling forwards. (When the gallery is horizontally oriented (see GalleryControlGallery.Orientation), the LastItemVertAlignment property defines the last item's horizontal position.
Public property LastItemVertIndent Gets or sets a custom indent of the last gallery item from the gallery's bottom or right edge (depending on the gallery's orientation). The property is in effect when LastItemVertAlignment is set to Custom.
Public property MaxItemWidth Gets or sets an item's maximum width in GalleryItemAutoSizeMode.Default auto-size mode.
Public property OptionsImageLoad Provides access to the set of properties that manage image loading options for items in this gallery.
Public property OwnerControl Gets a control that owns this BaseGallery.
Public property RowCount Gets or sets the number of rows in a gallery when the gallery is displayed within a dropdown window.
Public property ScaleImages Gets or sets whether gallery items are automatically stretched to match the current DPI settings of the user's monitor.
Public property ScrollMode Gets or sets how the gallery is scrolled when the ScrollTo method is called.
Public property ScrollSpeed Gets or sets how fast the gallery is scrolled when calling the ScrollTo method.
Public property ShowGroupCaption Gets or sets whether group captions are displayed.
Public property ShowItemImage Gets or sets whether Gallery items display their images.
Public property ShowItemText Gets or sets whether Gallery items display their caption and description.
Public property Site Gets or sets the System.ComponentModel.ISite of the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property Tag Gets or sets an object that contains data on the current BaseGallery object.
Public property UseMaxImageSize Gets or sets whether gallery item images have the same display size as the biggest image.
Top

Expanded Public Methods

Show: Inherited
  Name Description
Public method AddAnimation This member supports the internal infrastructure, and is not intended to be used directly from your code.
Public method Assign Assigns all GalleryItems, displayed within the specific BaseGallery to the current BaseGallery.
Public method BeginUpdate Locks the BaseGallery, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called.
Public method CancelUpdate Unlocks the BaseGallery object after it has been locked by the BeginUpdate method, without causing an immediate visual update.
Public method CreateFrom Copies contents and settings from the specified gallery to the current gallery.
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public method Destroy Destroys gallery items and clears gallery group collection.
Public method DestroyItems Destroys gallery items that belong to the current gallery.
Public method Dispose Releases all resources used by the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public method EndUpdate Unlocks the BaseGallery object after a call to the BeginUpdate method and causes an immediate visual update.
Public method Equals Determines whether the specified System.Object is equal to the current System.Object. (Inherited from System.Object)
Public methodStatic member Equals Determines whether the specified System.Object instances are considered equal. (Inherited from System.Object)
Public method ForceItemRefresh This member supports the internal infrastructure, and is not intended to be used directly from your code.
Public method GetAllItems Returns a list containing all gallery items that belong to the current gallery.
Public methodStatic member GetAllowHoverAnimation Returns whether animation on hovering gallery items is actually enabled.
Public method GetCheckedItem Returns the checked (selected) gallery item (if only one item is selected).
Public method GetCheckedItems Returns a list containing the currently checked (selected) gallery items.
Public method GetCheckedItemsCount Returns the total number of currently checked gallery items.
Public method GetHashCode Serves as a hash function for a particular type. System.Object.GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from System.Object)
Public method GetItemByCaption Returns an item that has the specified caption.
Public method GetItemByValue Gets a GalleryItem that matches the specific value.
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method GetType Gets the System.Type of the current instance. (Inherited from System.Object)
Public method GetVisibleItems Returns a list containing visible gallery items.
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method Invalidate Overloaded. Invalidates the region which is occupied by the specified Gallery item.
Public method LayoutChanged Recalculates all the graphical information of the gallery.
Public method MakeVisible Makes the specified gallery item visible onscreen, if it's hidden due to scrolling.
Public method RaiseGetLoadingImage Raises the GetLoadingImage event with specific arguments.
Public method RaiseGetThumbnailImage Raises the GetThumbnailImage event with specific arguments.
Public methodStatic member ReferenceEquals Determines whether the specified System.Object instances are the same instance. (Inherited from System.Object)
Public method RefreshGallery Recalculates all the graphical information of the gallery.
Public method ScrollTo Overloaded. Scrolls the gallery (with or without an animation effect) making the specified item visible.
Public method SetItemCheck Overloaded. Checks or unchecks the specified item, while allowing you to specify whether the previously checked items should be unchecked.
Public method ToString Returns a System.String containing the name of the System.ComponentModel.Component, if any. This method should not be overridden. (Inherited from System.ComponentModel.Component)
Top

Expanded Public Events

Show: Inherited
  Name Description
Public event CustomDrawItemImage Enables the Gallery item's image to be painted manually.
Public event CustomDrawItemText Enables the Gallery item's text to be painted manually.
Public event Disposed Occurs when the component is disposed by a call to the System.ComponentModel.Component.Dispose method. (Inherited from System.ComponentModel.Component)
Public event EndScroll Fires after gallery scrolling stops.
Public event FilterMenuItemClick Fires when a standard item of a gallery's Group Filter menu is clicked.
Public event FilterMenuPopup Fires when an end-user invokes the Group Filter menu.
Public event GalleryItemHover Fires when the mouse pointer hovers over a Gallery item.
Public event GalleryItemLeave Fires when the mouse pointer leaves a Gallery item.
Public event GetLoadingImage Allows you to set the custom loading indicator.
Public event GetThumbnailImage Occurs each time the gallery needs to display an item whose image is loaded asynchronously.
Public event ItemCheckedChanged Fires whenever an item's check (selected) state is changed.
Public event ItemClick Fires when a Gallery item is clicked.
Public event ItemDoubleClick Fires after a gallery item has been double-clicked.
Public event MarqueeSelectionCompleted Fires when a user has finished selecting gallery items using marquee selection.
Top

Expanded See Also

How would you rate this topic?​​​​​​​