Represents a bar item whose links can display different images when located on toolbars and menus.
public class BarLargeButtonItem : BarButtonItem
Public Class BarLargeButtonItem Inherits BarButtonItem
Related API Members
The following members accept/return BarLargeButtonItem objects:
The BarLargeButtonItem class represents an item type that can be used to create large button links within toolbars and menus. This class is derived from the BarButtonItem and thus inherits all its functionality. The extra functionality provided by large button items is the following:
- You can assign a large image to this item. Use the BarItem.LargeGlyph or BarItem.LargeImageIndex property for this purpose. If such an image is assigned, it is displayed within associated links located on toolbars. If an associated link is located in a sub-menu, it uses the small image. (Small images are assigned via the BarItem.Glyph or BarItem.ImageIndex property.)
- You can specify custom images for the disabled and hot-tracked states of associated links. Please refer to the BarItem.LargeGlyphDisabled, BarItem.LargeImageIndexDisabled, BarLargeButtonItem.LargeGlyphHot and BarLargeButtonItem.LargeImageIndexHot properties description for details.
- You can specify the position of a caption string relative to the specified large image. Use the BarLargeButtonItem.CaptionAlignment property for this purpose.
- You can control the visibility of the caption string within links using the BarLargeButtonItem.ShowCaptionOnBar property.
The image below displays an example of using large button items to create links within a toolbar and a sub-menu. Different images are displayed within different links related to the same item.
If you create Bar Items in code, note that these objects may not function properly without being associated with a BarManager or RibbonControl. To create a Bar Item, use a Bar Item constructor that has the BarManager parameter. When creating a Bar Item in code for use within a RibbonControl, use a Bar Item constructor that has the BarManager parameter, and pass the RibbonControl.Manager object as this parameter.