InRibbonGallery Members
An In-Ribbon gallery.Constructors
| Name | Description |
|---|---|
| InRibbonGallery(RibbonGalleryBarItem) | Initializes a new instance of the InRibbonGallery class. |
Properties
| Name | Description |
|---|---|
| AllowAllUp | Gets or sets whether or not all gallery items can simultaneously be in a normal (elevated) state. Inherited from BaseGallery. |
| AllowGlyphSkinning | Gets or sets whether items within this gallery should colorize their icons using foreground colors. Inherited from BaseGallery. |
| AllowHoverAnimation static | Gets or sets whether or not hovering over gallery items is accompanied with animation effects. Inherited from BaseGallery. |
| AllowHoverImages | Gets or sets whether the hover images feature is enabled. Inherited from BaseGallery. |
| AllowHtmlText | Gets or sets whether captions for items and groups in this gallery can be formatted using HTML tags. Inherited from BaseGallery. |
| AllowItemDrag | Gets or sets whether gallery items can be dragged-and-dropped. Inherited from BaseGallery. |
| 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. Inherited from BaseGallery. |
| Appearance | Gets the appearances that are used to paint gallery elements. Inherited from BaseGallery. |
| CanAnimate | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BaseGallery. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| CheckDrawMode | Gets or sets how gallery items are painted when in the checked state. Inherited from BaseGallery. |
| CheckSelectedItemViaKeyboard | Gets or sets whether the gallery item currently selected via the keyboard should be immediately checked. Inherited from BaseGallery. |
| ClearSelectionOnClickEmptySpace | Gets or sets whether the current selection is cleared when clicking the empty space. Inherited from BaseGallery. |
| ColumnCount | Gets or sets the (maximum) number of columns in the gallery. Inherited from BaseGallery. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| DistanceBetweenItems | Gets or sets the distance between Gallery items. Inherited from BaseGallery. |
| DistanceItemCaptionToDescription | Gets or sets the distance between an item’s caption and its description. Inherited from BaseGallery. |
| DistanceItemImageToText | Gets or sets the distance between an item’s image and its text. Inherited from BaseGallery. |
| DrawImageBackground | Gets or sets whether the background of the Gallery item’s image is displayed. Inherited from BaseGallery. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| 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. Inherited from BaseGallery. |
| 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 BaseGallery.FirstItemVertAlignment is set to Custom. Inherited from BaseGallery. |
| FixedHoverImageSize | Gets or sets whether hover images are displayed with the same size. Inherited from BaseGallery. |
| FixedImageSize | This property is not supported by this class. |
| FocusedItem | Gets a currently focused GalleryItem in this gallery. Inherited from BaseGallery. |
| GalleryDropDown | Gets or sets the GalleryDropDown control associated with the bar item that owns the current In-Ribbon gallery. |
| GroupContentMargin | Gets or sets margins of a gallery group’s content. Inherited from BaseGallery. |
| Groups | Gets a collection of groups owned by the gallery. Inherited from BaseGallery. |
| HoverImages | Gets or sets the source of hover images. Inherited from BaseGallery. |
| HoverImageSize | Gets or sets the size of hover images. Inherited from BaseGallery. |
| HtmlImages | Gets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag. Inherited from BaseGallery. |
| Images | Gets or sets the source of images that can be displayed within gallery items. Inherited from BaseGallery. |
| ImageSize | Gets or sets the display size of gallery item images. Inherited from BaseGallery. |
| ItemAutoSizeMode | Gets or sets the auto-size mode of gallery items. Inherited from BaseGallery. |
| ItemCheckMode | Gets or sets whether item checking (selection) is enabled, and how the items can be checked (selected). Inherited from BaseGallery. |
| ItemClickFireMode | Gets or sets whether clicks on gallery items are handled synchronously or asynchronously. Inherited from BaseGallery. |
| ItemImageLayout | Gets or sets how a gallery item’s image is displayed within the item’s image area. Inherited from BaseGallery. |
| ItemImageLocation | Gets or sets the location of images within gallery items, relative to the items’ text. Inherited from BaseGallery. |
| ItemImagePadding | Gets or sets the amount of space, in pixels, between the Gallery item’s image and its borders. Inherited from BaseGallery. |
| 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. Inherited from BaseGallery. |
| ItemTextPadding | Gets or sets the amount of space, in pixels, between the Gallery item’s text and its borders. Inherited from BaseGallery. |
| 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. Inherited from BaseGallery. |
| 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 BaseGallery.LastItemVertAlignment is set to Custom. Inherited from BaseGallery. |
| MaxItemWidth | Gets or sets an item’s maximum width in GalleryItemAutoSizeMode.Default auto-size mode. Inherited from BaseGallery. |
| MinimumColumnCount | Gets or sets the minimum number of columns allowed in the InRibbonGallery. |
| OptionsImageLoad | Provides access to the set of properties that manage image loading options for items in this gallery. Inherited from BaseGallery. |
| OwnerControl | Gets a control that owns this BaseGallery. Inherited from BaseGallery. |
| OwnerItem | Gets or sets the bar item which owns the In-Ribbon Gallery. |
| RowCount | Gets or sets the number of rows in a gallery when the gallery is displayed within a dropdown window. Inherited from BaseGallery. |
| ScaleImages | Gets or sets whether gallery items are automatically stretched to match the current DPI settings of the user’s monitor. Inherited from BaseGallery. |
| ScrollMode | Gets or sets how the gallery is scrolled when the BaseGallery.ScrollTo method is called. Inherited from BaseGallery. |
| ScrollSpeed | Gets or sets how fast the gallery is scrolled when calling the BaseGallery.ScrollTo method. Inherited from BaseGallery. |
| ShowGroupCaption | Gets or sets whether group captions are displayed. Inherited from BaseGallery. |
| ShowItemImage | Gets or sets whether Gallery items display their images. Inherited from BaseGallery. |
| ShowItemText | Gets or sets whether Gallery items display their caption and description. Inherited from BaseGallery. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| Tag | Gets or sets an object that contains data on the current BaseGallery object. Inherited from BaseGallery. |
| UseMaxImageSize | Gets or sets whether gallery item images have the same display size as the biggest image. Inherited from BaseGallery. |
Methods
| Name | Description |
|---|---|
| AddAnimation(ImageLoadInfo) | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| Assign(BaseGallery) | Assigns all GalleryItems, displayed within the specific BaseGallery to the current BaseGallery. Inherited from BaseGallery. |
| BeginUpdate() | Locks the BaseGallery, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. Inherited from BaseGallery. |
| CancelUpdate() | Unlocks the BaseGallery object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseGallery. |
| ClearHoverImagePopupForms() static | Inherited from BaseGallery. |
| CreateFrom(BaseGallery) | Copies contents and settings from the specified gallery to the current gallery. Inherited from BaseGallery. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| Destroy() | Destroys gallery items and clears gallery group collection. Inherited from BaseGallery. |
| DestroyItems() | Destroys gallery items that belong to the current gallery. Inherited from BaseGallery. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| EndUpdate() | Unlocks the BaseGallery object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseGallery. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| ForceItemRefresh(ImageLoadInfo) | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| GetAllItems() | Returns a list containing all gallery items that belong to the current gallery. Inherited from BaseGallery. |
| GetAllowHoverAnimation() static | Returns whether animation on hovering gallery items is actually enabled. Inherited from BaseGallery. |
| GetCheckedItem() | Returns the checked (selected) gallery item (if only one item is selected). Inherited from BaseGallery. |
| GetCheckedItems() | Returns a list containing the currently checked (selected) gallery items. Inherited from BaseGallery. |
| GetCheckedItemsCount() | Returns the total number of currently checked gallery items. Inherited from BaseGallery. |
| GetDesignTimeManager() | Gets a BaseDesignTimeManager object associated with the current InRibbonGallery. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetItemByCaption(String) | Returns an item that has the specified caption. Inherited from BaseGallery. |
| GetItemByValue(Object) | Gets a GalleryItem that matches the specific value. Inherited from BaseGallery. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetRibbon() | Gets a RibbonControl that owns the current InRibbonGallery. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| GetVisibleItems() | Returns a list containing visible gallery items. Inherited from BaseGallery. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| Invalidate() | Invalidates the region occupied by the gallery. |
| Invalidate(GalleryItem) | Invalidates the region occupied by the specified gallery item. |
| Invalidate(Rectangle) | Invaldates the specified region of the current InRibbonGallery object. |
| LayoutChanged() | Recalculates all the graphical information of the gallery. Inherited from BaseGallery. |
| MakeVisible(GalleryItem) | Makes the specified gallery item visible onscreen, if it’s hidden due to scrolling. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| RaiseGetLoadingImage(GetLoadingImageEventArgs) | Raises the BaseGallery.GetLoadingImage event with specific arguments. Inherited from BaseGallery. |
| RaiseGetThumbnailImage(ThumbnailImageEventArgs) | Raises the BaseGallery.GetThumbnailImage event with specific arguments. Inherited from BaseGallery. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RefreshGallery() | Recalculates all the graphical information of the In-Ribbon Gallery. |
| Scale(ScaleHelper) | Inherited from BaseGallery. |
| ScrollTo(GalleryItem, Boolean, VertAlignment) | Scrolls the gallery (with or without an animation effect) making the specified gallery item visible at a specific position. Inherited from BaseGallery. |
| ScrollTo(GalleryItem, Boolean) | Scrolls the gallery (with or without an animation effect) making the specified item visible. Inherited from BaseGallery. |
| ScrollTo(GalleryItemGroup, Boolean, VertAlignment) | Scrolls the gallery (with or without an animation effect) making the specified gallery group visible at a specific position. Inherited from BaseGallery. |
| ScrollTo(GalleryItemGroup, Boolean) | Scrolls the gallery (with or without an animation effect) making the specified gallery group visible. Inherited from BaseGallery. |
| SetItemCheck(GalleryItem, Boolean, Boolean) | Checks or unchecks the specified item, while allowing you to specify whether the previously checked items should be unchecked. Inherited from BaseGallery. |
| SetItemCheck(GalleryItem, Boolean) | Checks or unchecks the specified item. If multiple item checking is enabled and the CTRL or SHIFT key is currently pressed, the SetItemCheck method doesn’t uncheck the previously checked items. Otherwise, these items are unchecked. Inherited from BaseGallery. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
Events
| Name | Description |
|---|---|
| CustomDraw | Allows you to draw the gallery manually. Inherited from BaseGallery. |
| CustomDrawEmptyBackground | Allows you to manually paint the background of this Gallery when it has no items. Inherited from BaseGallery. |
| CustomDrawItemImage | Enables the Gallery item’s image to be painted manually. Inherited from BaseGallery. |
| CustomDrawItemText | Enables the Gallery item’s text to be painted manually. Inherited from BaseGallery. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| EndScroll | Fires after gallery scrolling stops. Inherited from BaseGallery. |
| FilterMenuItemClick | Fires when a standard item of a gallery’s Group Filter menu is clicked. Inherited from BaseGallery. |
| FilterMenuPopup | Fires when an end-user invokes the Group Filter menu. Inherited from BaseGallery. |
| GalleryItemHover | Fires when the mouse pointer hovers over a Gallery item. Inherited from BaseGallery. |
| GalleryItemLeave | Fires when the mouse pointer leaves a Gallery item. Inherited from BaseGallery. |
| GetLoadingImage | Allows you to set the custom loading indicator. Inherited from BaseGallery. |
| GetThumbnailImage | Occurs each time the gallery needs to display an item whose image is loaded asynchronously. Inherited from BaseGallery. |
| InitDropDownGallery | Enables the gallery, when it’s displayed as a dropdown window, to be customized. |
| ItemCheckedChanged | Fires whenever an item’s check (selected) state is changed. Inherited from BaseGallery. |
| ItemClick | Fires when a Gallery item is clicked. Inherited from BaseGallery. |
| ItemDoubleClick | Fires after a gallery item has been double-clicked. Inherited from BaseGallery. |
| MarqueeSelectionCompleted | Fires when a user has finished selecting gallery items using marquee selection. Inherited from BaseGallery. |
| PopupClose | Fires when a popup window which contains the current gallery is closed. |
See Also