RibbonGalleryBarItem Members

A bar item that represents an In-Ribbon gallery.

Constructors

Name	Description
RibbonGalleryBarItem()	Initializes a new instance of the RibbonGalleryBarItem class with the default settings.
RibbonGalleryBarItem(BarManager)	Initializes a new instance of the RibbonGalleryBarItem class with the specified owner.

Properties

Name	Description
AccessibleDescription	Gets or sets the object’s description used by accessibility client applications. Inherited from BarItem.
AccessibleName	Gets or sets the object’s name used by accessibility client applications. Inherited from BarItem.
AccessibleRole	Gets or sets the object’s accessible role. Inherited from BarItem.
ActAsDropDown	Gets or sets whether clicking a bar item link should invoke an associated Dropdown control. This member is not supported by the RibbonGalleryBarItem class.
Alignment	Gets or sets the horizontal alignment of the bar item’s link(s). Inherited from BarItem.
AllowAllUp	Gets or sets whether all the button items in a group can be in the normal (elevated) state at a time. This member is not supported by the RibbonGalleryBarItem class.
AllowDrawArrow	Gets or sets whether an arrow for the pop-up button should be displayed. Inherited from BarButtonItem.
AllowDrawArrowInMenu	Gets or sets whether the drop-down BarButtonItem should display an arrow in menus. Inherited from BarButtonItem.
AllowGlyphSkinning	Gets or sets whether glyphs for this BarItem should be painted using the text foreground color. Inherited from BarItem.
AllowHtmlText	Gets or sets whether the BarItem.Caption and BarItem.Description can be formatted using HTML tags. Inherited from BarItem.
AllowRightClickInMenu	Gets or sets if the current command’s functionality is invoked via the right mouse click when in a sub-menu or popup menu. Inherited from BarItem.
AllowStubGlyph	Gets or sets whether or not this item and all its links should display a stub glyph when it has no custom icon assigned. Inherited from BarItem.
Appearance	Provides access to the appearance settings for the current bar item, applied when the bar item is in the regular state. Inherited from BarItem.
AppearanceDisabled

Provides access to the appearance settings for the current bar item, applied when the bar item is disabled. This property is supported for bar items used within a RibbonControl.

Inherited from BarItem. | | BindingContext | Gets or sets a BindingContext object that manages data bindings for this BarItem. Inherited from BarItem. | | Border | Gets or sets the border style for links that refer to the current item. Inherited from BarItem. | | BorderStyle | Obsolete. This member is not supported. Inherited from BarItem. | | ButtonStyle | Get or sets the button item’s style. This member is not supported by the RibbonGalleryBarItem class. | | CanDown | Gets a value indicating whether the button item has two states (normal and pressed). Inherited from BarBaseButtonItem. | | CanPressDropDownButton | Gets a value indicating whether the Dropdown button of the BarButtonItem component can be pressed. Inherited from BarButtonItem. | | CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. | | Caption | Gets or sets the BarButtonItem‘s caption. Inherited from BarButtonItem. | | Category | Gets or sets a category where the bar item is displayed. Inherited from BarItem. | | CategoryGuid | Gets or sets a globally unique identifier (GUID) that identifies the category where the item is displayed. Inherited from BarItem. | | CategoryIndex | Obsolete. Gets or sets the index of the category to which the current item belongs. Inherited from BarItem. | | CausesValidation | Gets or sets whether data validation is performed on the currently focused control when clicking on the bar item. Inherited from BarItem. | | CloseOwnerMenuOnlyOnClick | Gets or sets whether only the submenu owning the current button is closed on a click, but not precedent submenus. This property is obsolete. Use the CloseSubMenuOnClickMode property instead. Inherited from BarBaseButtonItem. | | CloseRadialMenuOnItemClick | Gets or sets whether clicking the current BarButtonItem‘s link within a RadialMenu should close this menu. Inherited from BarButtonItem. | | CloseSubMenuOnClick | Gets or sets a value indicating whether a submenu which contains the item’s link is closed on a click. This member is not supported by the RibbonGalleryBarItem class. | | CloseSubMenuOnClickMode | Gets or sets whether a click on the button closes the submenu that contains this button. Inherited from BarBaseButtonItem. | | Command | Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. Inherited from BarButtonItem. | | CommandParameter | Gets or sets the parameter that is passed to the command specified by the Command property. Inherited from BarButtonItem. | | Container | Gets the IContainer that contains the Component. Inherited from Component. | | ContentHorizontalAlignment | Gets or sets the horizontal alignment mode for this BarItem‘s content. Inherited from BarItem. | | DataBindings | Provides access to the collection of data bindings for the BarItem. Inherited from BarItem. | | DefaultDropDownLink | Assigns all core settings of a target link (caption, image, click event handler, and others) to this Bar Button Item. Inherited from BarButtonItem. | | Description | Gets or sets the BarButtonItem‘s description. Inherited from BarButtonItem. | | DescriptionMaxWidth | Gets or sets the maximum width of this item’s description. Bar Items display their descriptions in Customization Forms, and inside submenus with the LargeImagesTextDescription draw mode. Inherited from BarItem. | | DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. | | Down | Gets or sets a value indicating whether the button item is pressed down. This member is not supported by the RibbonGalleryBarItem class. | | DropDownControl | Gets or sets the item’s Dropdown control. This member is not supported by the RibbonGalleryBarItem class. | | DropDownEnabled | Gets or sets whether the item’s Dropdown control is enabled. This member is not supported by the RibbonGalleryBarItem class. | | DropDownSuperTip | Gets or sets a SuperToolTip object that is displayed when the current item displays a separate dropdown arrow and this arrow is hot-tracked. Inherited from BarItem. | | Enabled | Determines whether the current BarItem is active. Inherited from BarItem. | | Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. | | Font | Gets the font to display links of the current item. Inherited from BarItem. | | Gallery | Gets the InRibbonGallery gallery associated with the item. | | GalleryDropDown | Gets or sets the GalleryDropDown object, which is a control displaying a dropdown gallery. | | Glyph | . Gets or sets the item’s image. This member is not supported by the RibbonGalleryBarItem class | | GlyphDisabled | Gets or sets the image corresponding to the item’s disabled state. This member is not supported by the RibbonGalleryBarItem class. | | GroupIndex | Gets or sets the item’s group index. This member is not supported by the RibbonGalleryBarItem class. | | Hint | Specifies the bar item’s regular hint. Inherited from BarButtonItem. | | Id | Uniquely identifies the current BarItem. Inherited from BarItem. | | ImageIndex | Gets or sets the index of the item’s small image. This member is not supported by the RibbonGalleryBarItem class. | | ImageIndexDisabled | Gets or sets the index of the image displayed within the corresponding links when they are disabled. This member is not supported by the RibbonGalleryBarItem class. | | ImageOptions | Provides access to properties that affect this button’s icon. Inherited from BarButtonItem. | | Images | Gets the object which contains images that can be displayed within the current item. Inherited from BarItem. | | ImageToTextAlignment | Specifies whether the bar item image should go before or after this item caption. Inherited from BarBaseButtonItem. | | ImageUri |

Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current item. A specific version of the addressed image is automatically chosen, based on the app context (the current skin and required image size).

Inherited from BarButtonItem. | | IsAllowHtmlText | Gets whether HTML tags can be used to format bar item captions. Inherited from BarItem. | | IsImageExist | Gets whether an image which is associated with the bar item actually exists. Inherited from BarItem. | | IsLargeImageExist | Gets whether a large image which is associated with the bar item actually exists. Inherited from BarItem. | | ItemAppearance | Specifies appearance settings for this item in different states. Inherited from BarItem. | | ItemClickFireMode | Gets or sets when the Click events for the bar item fire, immediately or asynchronously, after all events in the system event queue are processed. Inherited from BarItem. | | ItemInMenuAppearance | Specifies appearance settings for this item when it is displayed in a sub-menu or pop-up menu. Inherited from BarItem. | | ItemShortcut | Gets or sets the shortcut used to access associated links using the keyboard. This property is not supported by the RibbonGalleryBarItem class. | | LargeGlyph | Gets or sets the item’s large image. This member is not supported by the RibbonGalleryBarItem class. | | LargeGlyphDisabled | Gets or sets the item’s large image that is used when the item is disabled. This member is not supported by the RibbonGalleryBarItem class. | | LargeImageIndex | Gets or sets the index of the item’s large image. This member is not supported by the RibbonGalleryBarItem class. | | LargeImageIndexDisabled | Gets or sets the index of the item’s large image that is used when the item is disabled. This member is not supported by the RibbonGalleryBarItem class. | | LargeImages | Gets the source of large images. Inherited from BarItem. | | LargeWidth | This member is not supported by the RibbonGalleryBarItem object. | | Links | Gets the collection of links to the bar item. Inherited from BarItem. | | Manager | Specifies the BarManager responsible for managing the current item. Inherited from BarItem. | | MergeOrder | Defines the visual position of the bar item after merging bars on a parent MDI form. Inherited from BarItem. | | MergeType | Gets or sets how the item behaves during merge operations in MDI applications. Inherited from BarItem. | | Name | Gets or sets the BarItem‘s name. Inherited from BarItem. | | OwnFont | Obsolete. Specifies the font used to display the captions of links corresponding to this item. Inherited from BarItem. | | PaintStyle | Gets or sets the item’s paint style. This member is not supported by the RibbonGalleryBarItem class. | | RememberLastCommand | Gets or sets whether the current Split Button should repeat the last selected command from its drop-down when clicked. Inherited from BarButtonItem. | | RibbonStyle | Gets or sets the options that specify the item’s possible states within a RibbonControl. This member is not supported by the RibbonGalleryBarItem class. | | SearchTags | Gets or sets a comma-separated list of keywords by which this bar item can be found using the ribbon search menu. Inherited from BarItem. | | ShortCut | Obsolete. Specifies the shortcut key combination for the current item. Inherited from BarItem. | | ShortcutKeyDisplayString | Gets or sets a custom display string for the shortcut assigned to the item via the BarItem.ItemShortcut property. Inherited from BarItem. | | ShowInCustomizationForm | Use the BarItem.Visibility property to control bar item visibility in the Customization Window. Inherited from BarItem. | | ShowItemShortcut | Gets or sets whether this BarItem should display its shortcut in sub-menus and pop-up menus. Inherited from BarItem. | | ShowToolTip | Gets or sets whether this item should display its hint when hovered. Inherited from BarItem. | | Site | Gets or sets the ISite of the Component. Inherited from Component. | | Size | Gets or sets the BarItem‘s size. Not supported in Ribbon UI. Inherited from BarItem. | | SmallWithoutTextWidth | This member is not supported by the RibbonGalleryBarItem object. | | SmallWithTextWidth | This member is not supported by the RibbonGalleryBarItem object. | | SuperTip | Gets or sets the Super Tip for the current BarButtonItem. Inherited from BarButtonItem. | | Tag | Gets or sets an object that contains data on the current item. Inherited from BarItem. | | UseOwnFont | Obsolete. Gets or sets whether the item’s links are painted using the item’s own font ( Appearance.Font ). Inherited from BarItem. | | Visibility | Specifies when the item is visible. Inherited from BarItem. | | VisibleInSearchMenu | Gets or sets whether the bar item can be found using the ribbon search menu. Inherited from BarItem. | | VisibleWhenVertical | Determines whether an item is visible when the bar is vertically oriented . Inherited from BarItem. | | Width | When overridden in a derived class, this property specifies the current item width. Inherited from BarItem. |

Methods

Name	Description
BeginUpdate()	Locks the BarItem object by preventing visual updates until the EndUpdate method is called. Inherited from BarItem.
BindCommand(Expression<Action>, Object, Func<Object>)	Uses the command selector to find an appropriate parameterized command in the source and bind it to this BarButtonItem. Inherited from BarButtonItem.
BindCommand(Object, Func<Object>)	Binds the specific parameterized command to this BarButtonItem. Inherited from BarButtonItem.
BindCommand<T>(Expression<Action<T>>, Object, Func<T>)	Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this BarButtonItem. Inherited from BarButtonItem.
CancelUpdate()	Unlocks the object after it has been locked by the BarItem.BeginUpdate method, without causing an immediate visual update. Inherited from BarItem.
ContainsItem(BarItem)	Indicates whether the item contains the item specified. Inherited from BarItem.
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.
Dispose()	Releases all resources used by the Component. Inherited from Component.
EndUpdate()	Unlocks the BarItem object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BarItem.
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.
GetBarLinkInfoProvider()	This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BarItem.
GetHashCode()	Serves as the default hash function. Inherited from Object.
GetLifetimeService()	Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
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.
GetVisibleLinks()	Returns the list of all currently visible links to this BarItem. Inherited from BarItem.
InitializeLifetimeService()	Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
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.
PerformClick()	Fires the ItemClick events for the current bar item. Inherited from BarItem.
PerformClick(BarItemLink)	Fires the ItemClick events for the current bar item and its link. Inherited from BarItem.
ReferenceEquals(Object, Object) static	Determines whether the specified Object instances are the same instance. Inherited from Object.
Refresh()	Forces the controls that contain the bar item’s links to invalidate their client area. Inherited from BarItem.
Reset()	Resets the current BarItem to the original state. Inherited from BarItem.
ResetDropDownSuperTip()	Clears the SuperTip that has been assigned to the BarItem.DropDownSuperTip property. Inherited from BarItem.
ResetSuperTip()	Removes the SuperToolTip object that has been assigned to the current bar item. Inherited from BarItem.
Toggle()	Toggles the button item’s state. Inherited from BarBaseButtonItem.
Toggle(BarItemLink)	Toggles the button item’s (link’s) state. Inherited from BarBaseButtonItem.
ToString()	Returns this BarItem‘s caption (the BarItem.Caption property value). Inherited from BarItem.
UpdateBindings(BindingContext)	Updates data bindings used by this BarItem. Inherited from BarItem.

Events

Name	Description
CommandCanExecuteChanged	Occurs when the CanExecute(Object) status of the Command has changed. Inherited from BarButtonItem.
CommandChanged	Occurs after the value of the Command property has changed. Inherited from BarButtonItem.
CommandParameterChanged	Occurs after the value of the Command property has changed. Inherited from BarButtonItem.
DefaultDropDownLinkChanged	Raises when the value of the DefaultDropDownLink property changes. Inherited from BarButtonItem.
Disposed	Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DownChanged	Occurs after the item’s pressed state has been changed. Inherited from BarBaseButtonItem.
GalleryCustomDrawItemImage	Enables images of gallery items to be painted manually.
GalleryCustomDrawItemText	Enables the text of gallery items to be painted manually.
GalleryFilterMenuItemClick	Fires when a filter menu item is clicked.
GalleryFilterMenuPopup	Fires when an end-user invokes the filter menu.
GalleryInitDropDownGallery	Enables a gallery, when displayed as a dropdown window, to be customized.
GalleryItemCheckedChanged	Fires whenever a gallery item’s check (selected) state is changed.
GalleryItemClick	Fires when a gallery item is clicked.
GalleryItemDoubleClick	Fires after a gallery item has been double-clicked.
GalleryItemHover	Fires when the mouse pointer hovers over a Gallery item.
GalleryItemLeave	Fires when the mouse pointer leaves a Gallery item.
GalleryPopupClose	Fires when a popup window containing a gallery is closed.
HyperlinkClick	Occurs each time an end-user clicks a hyperlink within the current BarItem. Inherited from BarItem.
ItemClick	Occurs when the current item is clicked. Inherited from BarItem.
ItemDoubleClick	Fires when a link to an item is double-clicked. Inherited from BarItem.
ItemPress	Fires immediately after a link associated with an item has been pressed. Inherited from BarItem.
ItemRightClick	Occurs when a user right-clicks the BarItem. Inherited from BarItem.
MarqueeSelectionCompleted	Fires when a user has finished selecting gallery items using marquee selection.