Welcome to the DevPower Web Site
  home   |  support   |  shop   |  downloads   |  about devpower 

DevPower Button Bar .NET Version 1.2.0 (02-Dec-02)

Copyright © 2002 - 2009 Steve Robbins All Rights Reserved.

Documentation

The full version of the component comes with complete detailed documentation integrated into the Visual Studio .NET environment with both C# and VB code examples - see purchase information for details.

Overview

The Groups collection holds all the Group objects that are assigned to the ButtonBar control. Each Group contains a collection of Item objects that are displayed within the scrollable Item Area when the group is selected. Each Group can display items as Large or Small Icons by setting the View property (typically these sizes are 32x32 or 16x16 pixels respectively, but with version 1.2.0 and above, these can be any size specified by the relevant image list).

You can display images for each Item by assigning a Large and Small ImageList objects to the LargeImageList and SmallImageList properties of the ButtonBar, and referencing the index value of an Image in the ImageList to assign that Image. Set the Item.LargeImageIndex and Item.SmallImageIndex properties to the index value of the Image that you want to display.

You can change the appearance of the ButtonBar control by setting some of its display and style properties. Setting Style to one of the ButtonBarStyle values instantly changes the look and feel of the ButtonBar. The Colors, Cursors and Font used by the control can all be changed and properties such as ItemsMoveWithClick and ItemsStayDownWithClick change the behavior of the control. The user can navigate around the Groups by clicking on the Group header button or use a MouseWheel whilst holding down the Control Key. To navigate around Items shown within the group, the user clicks the scroll arrows or can use a MouseWheel without holding any keys down.

ButtonBar Class

Public Instance Constructors

public constructorButtonBar Constructor Initializes a new instance of the ButtonBar control.

Public Instance Properties

public propertyBackColor Gets or sets the default background color for Group item areas.
public propertyBackColorTo Gets or sets the default background fade-to color for Group item areas.
public propertyBackFillStyle Gets or sets the default background background fill style for Group item areas.
public propertyDarkShadowColor Gets or sets the color of dark shadow lines.
public propertyGroupAlignment Gets or sets the horizontal alignment of text for Groups.
public propertyGroupBackColor Gets or sets the background color for groups.
public propertyGroupBackColorTo Gets or sets the background fade-to color for groups.
public propertyGroupBackFillStyle Gets or sets the background fill style for groups.
public propertyGroupClickSound Gets or sets the name of a WAV file to play when a group is clicked.
public propertyGroupContextMenu Gets or sets the shortcut menu associated with groups.
public propertyGroupCursor Gets or sets the cursor that is displayed when the mouse pointer is over a group.
public propertyGroupDownBackColor Gets or sets the background color for groups when the mouse is held down on them.
public propertyGroupDownBackColorTo Gets or sets the background fade-to color for groups when the mouse is held down on them.
public propertyGroupDownBackFillStyle Gets or sets the background fill style for groups when the mouse is held down on them.
public propertyGroupDownForeColor Gets or sets the foreground color for groups when the mouse is held down on them.
public propertyGroupFlashBackColor Gets or sets the background color for groups while attacting user attention with Group.Flash().
public propertyGroupFlashBackColorTo Gets or sets the background fade-to color for groups while attacting user attention with Group.Flash().
public propertyGroupFlashBackFillStyle Gets or sets the background fill style for groups while attacting user attention with Group.Flash().
public propertyGroupFlashForeColor Gets or sets the foreground color for groups while attacting user attention with Group.Flash().
public propertyGroupFlashTime Gets or sets the time (in MilliSeconds) between flashes when attracting user attention with Group.Flash().
public propertyGroupFont Gets or sets the font for Group header buttons.
public propertyGroupForeColor Gets or sets the foreground color for groups.
public propertyGroupHeight Gets the current height of Groups.
public propertyGroupHoverBackColor Gets or sets the background color for groups when the mouse is held over them.
public propertyGroupHoverBackColorTo Gets or sets the background fade-to color for groups when the mouse is held over them.
public propertyGroupHoverBackFillStyle Gets or sets the background fill style for groups when the mouse is held over them.
public propertyGroupHoverForeColor Gets or sets the foreground color for groups when the mouse is held over them.
public propertyGroupLineAlignment Gets or sets the vertical alignment of text for Groups.
public propertyGroupTrimming Gets or sets the horizontal trimming of text for Groups.
public propertyGroups Gets the collection of Group objects assigned to the buttonbar control.
public propertyHighlightColor Gets or sets the color of highlight lines.
public propertyItemBackColor Gets or sets the background color of items.
public propertyItemBackColorTo Gets or sets the background fade-to color for items.
public propertyItemBackFillStyle Gets or sets the background fill style for items.
public propertyItemBorder Gets or sets the border style for items.
public propertyItemClickSound Gets or sets the name of a WAV file to play when an item is clicked.
public propertyItemContextMenu Gets or sets the shortcut menu associated with items.
public propertyItemCursor Gets or sets the cursor that is displayed when the mouse pointer is over an item.
public propertyItemDownBackColor Gets or sets the background color of items when the mouse is held down.
public propertyItemDownBackColorTo Gets or sets the background fade-to color for items when the mouse is held down on them.
public propertyItemDownBackFillStyle Gets or sets the background fill style for items when the mouse is held down on them.
public propertyItemDownForeColor Gets or sets the color of item text when the mouse is held down.
public propertyItemFont Gets or sets the font for Items.
public propertyItemForeColor Gets or sets the default foreground color of item text.
public propertyItemHighlightColor Gets or sets the highlight color for item borders.
public propertyItemHoverBackColor Gets or sets the background color of items when the mouse hovers over.
public propertyItemHoverBackColorTo Gets or sets the background fade-to color for items when the mouse is held Hover on them.
public propertyItemHoverBackFillStyle Gets or sets the background fill style for items when the mouse is held Hover on them.
public propertyItemHoverForeColor Gets or sets the color of item text when the mouse hovers over.
public propertyItemsRaiseWithHover Gets or sets a value indicating whether item images raise when the mouse hovers over.
public propertyItemShadowColor Gets or sets the shadow color for item borders.
public propertyItemsMoveWithClick Gets or sets a value indicating whether holding the mouse down on items forces them to move diagonally down and to the right as a button would.
public propertyItemsStayDownWithClick Gets or sets a value indicating whether clicking an item makes it stay in a 'checked' state until a different item is clicked.
public propertyLargeImageList Gets or sets the collection of large images available to the buttonbar item controls.
public propertyLargeItemAlignment Gets or sets the horizontal alignment of text for Items in Large Icons view.
public propertyLargeItemImageAlignment Gets or sets the horizontal alignment of images for Items in Large Icons view.
public propertyLargeItemMaxLines Gets or sets the maximum number of horizontal lines of text in Large Icons view. Setting to 0 means no text, -1 means no limit on lines.
public propertyLargeItemTrimming Gets or sets the horizontal trimming of text for Items in Large Icons view.
public propertyPlaySounds Gets or sets a value indicating whether the control should make sounds when groups or items are clicked.
public propertyScrollBackColor Gets or sets the background color for scroll buttons.
public propertyScrollBackColorTo Gets or sets the background fade-to color for scroll buttons.
public propertyScrollBackFillStyle Gets or sets the background color for scroll buttons.
public propertyScrollForeColor Gets or sets the foreground color for scroll buttons.
public propertySelectedGroup Gets or sets the currently selected Group.
public propertyShadowColor Gets or sets the color of shadow lines.
public propertyShowSingleGroup Gets or sets a value indicating whether the control shows a single group. Setting this to false will hide single groups, giving the appearence used in Microsoft® Project™.
public propertySmallImageList Gets or sets the collection of small images available to the buttonbar item controls.
public propertySmallItemAlignment Gets or sets the horizontal alignment of text for Items in Small Icons view.
public propertySmallItemImageAlignment Gets or sets the horizontal alignment of images for Items in Small Icons view.
public propertySmallItemMaxLines Gets or sets the maximum number of horizontal lines of text in Small Icons view. Setting to 0 means no text, -1 means no limit on lines.
public propertySmallItemTrimming Gets or sets the horizontal trimming of text for Items in Small Icons view.
public propertySmoothSlide Gets or sets a value indicating whether groups and items slide smoothly when the selection changes.
public propertyStyle Gets or sets a value indicating the visual style for the buttonbar, also setting default colors when custom values have not been chosen.
public propertyTextRenderingHint Gets or sets the rendering mode for text in the control.
public propertyUseThemes Gets or sets a value indicating whether groups and items are drawn using the current Windows XP theme (if available).
public propertyVersion Gets the component version number.
public propertyXml Gets or sets XML serialization of the control contents.

Public Instance Methods

public methodAbout Displays copyright and version information for the component.
public methodGetNearestItem Attempts to get the nearest item above or below the coordinate given.
public methodGetFirstVisible Gets the first visible item within the control.
public methodHitTest Gets the group or item at the specified location within the control.

Public Instance Events

public eventGroupClick Occurs when a group is clicked.
public eventGroupDragDrop Occurs when a drag-and-drop operation is completed over a group.
public eventGroupDragOver Occurs when an object is dragged over a group.
public eventGroupDragStart Occurs when the user begins dragging a group.
public eventGroupMouseDown Occurs when the mouse button is pressed over a group.
public eventGroupMouseMove Occurs when the mouse moves over a group.
public eventGroupMouseUp Occurs when the mouse button is released over a group.
public eventGroupRenamed Occurs when a group is renamed.
public eventGroupScrolled Occurs when items are scrolled within a group.
public eventItemClick Occurs when an item is clicked.
public eventItemDragDrop Occurs when a drag-and-drop operation is completed over an item.
public eventItemDragOver Occurs when an object is dragged over an item.
public eventItemDragStart Occurs when the user begins dragging an item.
public eventItemMouseDown Occurs when the mouse button is pressed over an item.
public eventItemMouseMove Occurs when the mouse moves over an item.
public eventItemMouseUp Occurs when the mouse button is released over an item.
public eventItemRenamed Occurs when an item is renamed.
public eventSyncToolTip Occurs when the control tool tip should be updated.

Public Delegates

public eventGroupDragEventHandler The delegate for Group drag events.
public eventGroupDragStartEventHandler The delegate for the GroupDragStart event.
public delegateGroupEventHandler The delegate for simple Group events.
public delegateGroupMouseEventHandler The delegate for Group mouse events.
public delegateGroupRenamedEventHandler The delegate for Group renamed event.
public delegateGroupScrollEventHandler The delegate for Group scroll events.
public eventItemDragEventHandler The delegate for Item drag events.
public eventItemDragStartEventHandler The delegate for the ItemDragStart event.
public delegateItemEventHandler The delegate for simple Item events.
public delegateItemMouseEventHandler The delegate for Item mouse events.
public delegateItemRenamedEventHandler The delegate for Item renamed event.
public eventSyncToolTipEventHandler The delegate for the SyncToolTip event.

ButtonBar.Group Class

Public Instance Properties

public propertyBackColor Gets or sets the background color that is shown behind the items in a group.
public propertyBackColorTo Gets or sets the background fade-to color that is shown behind the items in a group.
public propertyBackFillStyle Gets or sets the background fill style for a group.
public propertyBackgroundImage Gets or sets the background image that is shown behind the items in a group.
public propertyChildControl Gets or sets the control to display in the group instead of items.
public propertyEnabled Gets or sets a value indicating whether the group is enabled.
public propertyItems Gets the collection of items that the group contains.
public propertyParent Gets the buttonbar control that the group is assigned to.
public propertySelected Gets or sets a value indicating whether the group is currently selected and showing it's content.
public propertySelectedItem Gets or sets the currently selected item within the group.
public propertyTag Gets or sets the object that contains data about the group.
public propertyText Gets or sets the text displayed on the group header button.
public propertyToolTipText Gets or sets the tooltip displayed for the group.
public propertyView Gets or sets a value specifying the ButtonBarView for the group.
public propertyVisible Gets or sets a value indicating whether the group is visible.
public propertyXml Gets or sets the XML serialization of the group and its contents.

Public Instance Methods

public methodBeginEdit Places the Group text into edit mode to allow a user to change the text.
public methodClone Creates an identical copy of the group.
public methodFlash Starts or stops flashing of the Group header to attract user attention.

ButtonBar.Item Class

Public Instance Properties

public propertyBold Gets or sets a value indicating whether the Item is shown with bold text.
public propertyEnabled Gets or sets a value indicating whether the Item is enabled.
public propertyForeColor Gets or sets the foreground color of the Item's text.
public propertyLargeImageIndex Gets or sets the index value of the large image assigned to the Item.
public propertySmallImageIndex Gets or sets the index value of the small image assigned to the Item.
public propertyParent Gets the Group that the Item is assigned to.
public propertySelected Gets or sets a value indicating whether the Item is currently selected.
public propertyTag Gets or sets the object that contains data about the Item.
public propertyText Gets or sets the text displayed for the Item.
public propertyToolTipText Gets or sets the tooltip displayed for the Item.
public propertyVisible Gets or sets a value indicating whether the Item is visible.

Public Instance Methods

public methodBeginEdit Places the Item text into edit mode to allow a user to change the text.
public methodClone Creates an identical copy of the item.
public methodEnsureVisible Ensures that the item is visible within the control, scrolling the contents of the parent Group if necessary.