Class GroupBar

Displays a set of related controls as selectable groups or tabs.

Inheritance
System.Object
BaseControl
ScrollControl
GroupBar
PaletteGroupBar
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class GroupBar : ScrollControl, IThemeProvider, IDisposable, IVisualStyle, ICancelModeProvider, ISplitterPaneSupport, IScrollBarWrapperContainer, ISupportUpdating, ISupportIntelliMouse, IQueryFocusInside, INonClientPaintingSupport, IIntegratedScrollContainer, IGroupBarDesignerInvoke, ISupportInitialize
Remarks

The GroupBar class implements a container that can serve as a host for other controls. The control is functionally similar to the Windows Forms System.Windows.Forms.TabControl and provides a tab user-interface that will display only one control, the SelectedItem, at any given time.

Each control in the GroupBar is associated with a GroupBarItem and the various GroupBarItems are arranged in a vertical stack. Clicking on a GroupBarItem will make it the current selected item and the client control tied to that item will be displayed within the GroupBar's client region. The collection of GroupBarItems in the control is implemented as an instance of the GroupBar.GroupBarItemCollection type and can be accessed and manipulated through the GroupBarItems property.

The GroupBar can be used in combination with the Syncfusion GroupView control to implement composite controls with user interfaces similar to the Outlook Bar in Microsoft Outlook and the toolbox window present in the Visual Studio.NET development environment.

Examples

The sample code shows how to create a GroupBar, create and add two GroupBarBarItems, and assign client controls to each of the GroupBarItems.

private void InitializeGroupBar()
{
	// Create the GroupBar control.
	this.gbOutlook = new Syncfusion.Windows.Forms.Tools.GroupBar();

// Create and initialize the GroupBarItems that belong to this GroupBar.
this.gbiPersonal = new Syncfusion.Windows.Forms.Tools.GroupBarItem();			
// Assign the gvcPersonal client control to this GroupBarItem.
this.gbiPersonal.Client = this.gvcPersonal;
this.gbiPersonal.Text = "Personal";

this.gbiWork = new Syncfusion.Windows.Forms.Tools.GroupBarItem();
// Assign the gvcWork client control to this GroupBarItem.
this.gbiWork.Client = this.gvcWork;
this.gbiWork.Text = "Work";		

// Add the GroupBarItems to the GroupBar.
this.gbOutlook.GroupBarItems.Add(this.gbiPersonal);
this.gbOutlook.GroupBarItems.Add(this.gbiWork);

// Set the GroupBar's initially selected index.
this.gbOutlook.SelectedItem = 1;



}

 Private Sub InitializeGroupBar()

    ' Create the GroupBar control.
    Me.gbOutlook = New Syncfusion.Windows.Forms.Tools.GroupBar()

    ' Create and initialize the GroupBarItems that belong to this GroupBar.
    Me.gbiPersonal = New Syncfusion.Windows.Forms.Tools.GroupBarItem()
    ' Assign the gvcPersonal client control to this GroupBarItem.
    Me.gbiPersonal.Client = Me.gvcPersonal
    Me.gbiPersonal.Text = "Personal"

    Me.gbiWork = New Syncfusion.Windows.Forms.Tools.GroupBarItem()
    ' Assign the gvcWork client control to this GroupBarItem.
    Me.gbiWork.Client = Me.gvcWork
    Me.gbiWork.Text = "Work"

    ' Add the GroupBarItems to the GroupBar.
    Me.gbOutlook.GroupBarItems.Add(Me.gbiPersonal)
    Me.gbOutlook.GroupBarItems.Add(Me.gbiWork)

    ' Set the GroupBar's initially selected index.
    Me.gbOutlook.SelectedItem = 1

End Sub

Constructors

GroupBar()

Creates a new instance of the GroupBar class.

Declaration
public GroupBar()

Fields

activeItemsList

Declaration
protected ArrayList activeItemsList
Field Value
Type Description
System.Collections.ArrayList

alNavPaneItems

Declaration
protected ArrayList alNavPaneItems
Field Value
Type Description
System.Collections.ArrayList

bAnimation

Declaration
protected bool bAnimation
Field Value
Type Description
System.Boolean

bBarHighlight

Declaration
protected bool bBarHighlight
Field Value
Type Description
System.Boolean

bDrawClientBorder

Declaration
protected bool bDrawClientBorder
Field Value
Type Description
System.Boolean

bdrStyle

Declaration
protected BorderStyle bdrStyle
Field Value
Type Description
System.Windows.Forms.BorderStyle

bFlatLook

Declaration
protected bool bFlatLook
Field Value
Type Description
System.Boolean

bHighlight

Declaration
protected bool bHighlight
Field Value
Type Description
System.Boolean

bIntegratedScrolling

Declaration
protected bool bIntegratedScrolling
Field Value
Type Description
System.Boolean

bShowChevron

Indicates whether to show the chevron button on the Navigation Panel in the stacked GroupBar.

Declaration
protected bool bShowChevron
Field Value
Type Description
System.Boolean

bStackedMode

Declaration
protected bool bStackedMode
Field Value
Type Description
System.Boolean

bThemesEnabled

Declaration
protected bool bThemesEnabled
Field Value
Type Description
System.Boolean

c_nIconSize

Declaration
protected int c_nIconSize
Field Value
Type Description
System.Int32

cllnGroupBarItems

Declaration
protected GroupBar.GroupBarItemCollection cllnGroupBarItems
Field Value
Type Description
GroupBar.GroupBarItemCollection

compToolTip

Declaration
protected ToolTip compToolTip
Field Value
Type Description
System.Windows.Forms.ToolTip

ctrlRename

Declaration
protected RenameTextBox ctrlRename
Field Value
Type Description
RenameTextBox

eButtonsState

Declaration
protected ButtonsState eButtonsState
Field Value
Type Description
ButtonsState

eInScroll

Declaration
protected ButtonsState eInScroll
Field Value
Type Description
ButtonsState

gbiAccesibleObjects

Declaration
protected GroupBarItemAccessibleObjectsIndexer gbiAccesibleObjects
Field Value
Type Description
GroupBarItemAccessibleObjectsIndexer

gDefaultCursor

Declaration
protected Cursor gDefaultCursor
Field Value
Type Description
System.Windows.Forms.Cursor

hdrBackColor

Declaration
protected Color hdrBackColor
Field Value
Type Description
System.Drawing.Color

hdrFont

Declaration
protected Font hdrFont
Field Value
Type Description
System.Drawing.Font

hdrForeColor

Declaration
protected Color hdrForeColor
Field Value
Type Description
System.Drawing.Color

itemCursor

Declaration
protected Cursor itemCursor
Field Value
Type Description
System.Windows.Forms.Cursor

m_bShowImageInHeader

Declaration
protected bool m_bShowImageInHeader
Field Value
Type Description
System.Boolean

m_office2007Theme

Declaration
protected Office2007Theme m_office2007Theme
Field Value
Type Description
Office2007Theme

m_office2010Theme

Declaration
protected Office2010Theme m_office2010Theme
Field Value
Type Description
Office2010Theme

m_sfmtHeaderTextFormat

Declaration
protected readonly StringFormat m_sfmtHeaderTextFormat
Field Value
Type Description
System.Drawing.StringFormat

m_sfmtTextFormat

Declaration
protected readonly StringFormat m_sfmtTextFormat
Field Value
Type Description
System.Drawing.StringFormat

menuProvider

Declaration
protected IContextMenuProvider menuProvider
Field Value
Type Description
IContextMenuProvider

nAlignment

Declaration
protected TextAlignment nAlignment
Field Value
Type Description
TextAlignment

nContextMenuItem

Declaration
protected int nContextMenuItem
Field Value
Type Description
System.Int32

nDropdownButtonModifiedWidth

Declaration
protected int nDropdownButtonModifiedWidth
Field Value
Type Description
System.Int32

nDropdownButtonWidth

Declaration
protected int nDropdownButtonWidth
Field Value
Type Description
System.Int32

nHeaderHeight

Declaration
protected int nHeaderHeight
Field Value
Type Description
System.Int32

nHighlightItem

Declaration
protected int nHighlightItem
Field Value
Type Description
System.Int32

nItemHeight

Declaration
protected int nItemHeight
Field Value
Type Description
System.Int32

nLayout

Declaration
protected GroupLayout nLayout
Field Value
Type Description
GroupLayout

nNavigationButtonWidth

Declaration
protected int nNavigationButtonWidth
Field Value
Type Description
System.Int32

nNavigationPaneHeight

Declaration
protected int nNavigationPaneHeight
Field Value
Type Description
System.Int32

nRenameItem

Declaration
protected int nRenameItem
Field Value
Type Description
System.Int32

nScrollThumbWidth

Declaration
protected int nScrollThumbWidth
Field Value
Type Description
System.Int32

nSelectedItem

Declaration
protected int nSelectedItem
Field Value
Type Description
System.Int32

nSplitterHeight

Declaration
protected int nSplitterHeight
Field Value
Type Description
System.Int32

nStartTick

Declaration
protected static int nStartTick
Field Value
Type Description
System.Int32

nTxtOffset

Declaration
protected int nTxtOffset
Field Value
Type Description
System.Int32

prev_hdrBackColor

Declaration
protected Color prev_hdrBackColor
Field Value
Type Description
System.Drawing.Color

prev_hdrForeColor

Declaration
protected Color prev_hdrForeColor
Field Value
Type Description
System.Drawing.Color

ptSplitterDragStart

Declaration
protected Point ptSplitterDragStart
Field Value
Type Description
System.Drawing.Point

rcClient

Declaration
protected Rectangle rcClient
Field Value
Type Description
System.Drawing.Rectangle

rcScrollDown

Declaration
protected Rectangle rcScrollDown
Field Value
Type Description
System.Drawing.Rectangle

rcScrollUp

Declaration
protected Rectangle rcScrollUp
Field Value
Type Description
System.Drawing.Rectangle

s_ilNavPaneItems

Declaration
protected static ImageList s_ilNavPaneItems
Field Value
Type Description
System.Windows.Forms.ImageList

s_sDropDownToolTip

Declaration
protected static string s_sDropDownToolTip
Field Value
Type Description
System.String

tdButton

Declaration
protected ThemedControlDrawing tdButton
Field Value
Type Description
ThemedControlDrawing

tdScrollBar

Declaration
protected ThemedControlDrawing tdScrollBar
Field Value
Type Description
ThemedControlDrawing

tmrScrolling

Declaration
protected Timer tmrScrolling
Field Value
Type Description
System.Windows.Forms.Timer

vStyle

Declaration
protected VisualStyle vStyle
Field Value
Type Description
VisualStyle

Properties

AllowCollapse

Gets or sets a value indicating whether GroupBar can be collapsed.

Declaration
public bool AllowCollapse { get; set; }
Property Value
Type Description
System.Boolean
See Also

AnimatedSelection

Indicates whether switching between different GroupBarItems is animated.

Declaration
public bool AnimatedSelection { get; set; }
Property Value
Type Description
System.Boolean

True if animated selection is enabled. The default is True.

ApplyDefaultVisualStyleColor

Indicates whether applying the default forecolor for GroupBar as per the visual style

Declaration
public bool ApplyDefaultVisualStyleColor { get; set; }
Property Value
Type Description
System.Boolean

True if highlighting is enabled. The default is True.

BackgroundImage

Declaration
public override Image BackgroundImage { get; set; }
Property Value
Type Description
System.Drawing.Image

BackgroundImageLayout

Declaration
public override ImageLayout BackgroundImageLayout { get; set; }
Property Value
Type Description
System.Windows.Forms.ImageLayout

BarHighlight

Indicates whether moving the mouse cursor over a GroupBarItem will highlight it.

Declaration
public bool BarHighlight { get; set; }
Property Value
Type Description
System.Boolean

True if highlighting is enabled. The default is True.

BeforeTouchSize

Gets/Sets Control size before touch enabled

Declaration
public Size BeforeTouchSize { get; set; }
Property Value
Type Description
System.Drawing.Size

BorderColor

Indicates the color of the 2D border.

Declaration
public Color BorderColor { get; set; }
Property Value
Type Description
System.Drawing.Color

BorderStyle

Gets / sets the border style of the GroupBar control.

Declaration
public BorderStyle BorderStyle { get; set; }
Property Value
Type Description
System.Windows.Forms.BorderStyle

A System.Windows.Forms.BorderStyle value. The default is BorderStyle.Fixed3D.

Collapsed

Gets or sets a value indicating whether this GroupBar is collapsed.

Declaration
public bool Collapsed { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Works only GroupBar is in stacked mode.

See Also

CollapsedText

Gets or sets the text shown in collapsed client area of GroupBar.

Declaration
public string CollapsedText { get; set; }
Property Value
Type Description
System.String

CollapsedWidth

Gets or sets the width of the collapsed GroupBar.

Declaration
public int CollapsedWidth { get; set; }
Property Value
Type Description
System.Int32

CollapseImage

Gets or sets the image of the collapse button in expanded state.

Declaration
public Image CollapseImage { get; set; }
Property Value
Type Description
System.Drawing.Image

ContextMenuItem

Returns the index of the GroupBarItem that triggered the ShowContextMenu event.

Declaration
public int ContextMenuItem { get; }
Property Value
Type Description
System.Int32

The zero-based index of the item.

ContextMenuProvider

Gets / sets the menu provider object that will implement the GroupBar's contextmenu.

Declaration
public IContextMenuProvider ContextMenuProvider { get; set; }
Property Value
Type Description
IContextMenuProvider

A IContextMenuProvider implementation; the default is StandardMenusProvider.
Remarks

The GroupBar control automatically initializes this property depending on the presence of the Syncfusion Essential Tools library. If Essential Tools is available, then the menu provider object will be an instance of the ContextMenuProvider type. If not, the StandardMenusProvider class is used for implementing the standard .NET context menu.

The GroupBar's automatic initialization should suffice for most applications and you should explicitly set this property only when you want to override the default menu provider assignment.

Cursor

Gets / sets the cursor that is displayed when the mouse pointer is over the control.

Declaration
public Cursor Cursor { get; set; }
Property Value
Type Description
System.Windows.Forms.Cursor

A System.Windows.Forms.Cursor object.

DefaultSize

Declaration
protected override Size DefaultSize { get; }
Property Value
Type Description
System.Drawing.Size

DrawClientBorder

Indicates whether a border is drawn around the GroupBar's client window.

Declaration
public bool DrawClientBorder { get; set; }
Property Value
Type Description
System.Boolean

A boolean value; the default is False.
Remarks

The border colors for each GroupBarItem can be individually specified using the ClientBorderColors property.

EnableSplittercolorCustomization

Declaration
public bool EnableSplittercolorCustomization { get; set; }
Property Value
Type Description
System.Boolean

EnableTouchMode

Gets or Sets the touchmode

Declaration
public bool EnableTouchMode { get; set; }
Property Value
Type Description
System.Boolean

ExpandButtonToolTip

Gets or sets the tooltip for collapse button, when control is collapsed.

Declaration
public string ExpandButtonToolTip { get; set; }
Property Value
Type Description
System.String

ExpandedWidth

Declaration
public int ExpandedWidth { get; set; }
Property Value
Type Description
System.Int32

ExpandImage

Gets or sets the image of the collapse button in collapsed state.

Declaration
public Image ExpandImage { get; set; }
Property Value
Type Description
System.Drawing.Image

FlatLook

Indicates whether the GroupBar control is displayed with a flat look.

Declaration
public bool FlatLook { get; set; }
Property Value
Type Description
System.Boolean

True to display in flat mode. The default is False.

GroupBarDropDownToolTip

Gets or sets the tooltip for GroupBarDropDownToolTip.

Declaration
public string GroupBarDropDownToolTip { get; set; }
Property Value
Type Description
System.String

GroupBarItemCursor

Gets / sets the cursor that is displayed when the mouse pointer is over the GroupBarItems.

Declaration
public Cursor GroupBarItemCursor { get; set; }
Property Value
Type Description
System.Windows.Forms.Cursor

A System.Windows.Forms.Cursor object.

GroupBarItemHeight

Gets / sets the GroupBarItem height.

Declaration
public int GroupBarItemHeight { get; set; }
Property Value
Type Description
System.Int32

An integer value that specifies the item height.

GroupBarItems

Returns the collection of GroupBarItems in the control.

Declaration
public GroupBar.GroupBarItemCollection GroupBarItems { get; }
Property Value
Type Description
GroupBar.GroupBarItemCollection

An instance of the GroupBar.GroupBarItemCollection type.

HeaderBackColor

Gets / sets the backcolor for the GroupBar header.

Declaration
public Color HeaderBackColor { get; set; }
Property Value
Type Description
System.Drawing.Color

A System.Drawing.Color value.
Remarks

The GroupBar header is shown only when the StackedMode property is set.

HeaderFont

Gets / sets the font of the text displayed in the GroupBar header.

Declaration
public Font HeaderFont { get; set; }
Property Value
Type Description
System.Drawing.Font

A System.Drawing.Font value.
Remarks

The GroupBar header is shown only when the StackedMode property is set.

HeaderForeColor

Gets / sets the forecolor for the GroupBar header.

Declaration
public Color HeaderForeColor { get; set; }
Property Value
Type Description
System.Drawing.Color

A System.Drawing.Color value.
Remarks

The GroupBar header is shown only when the StackedMode property is set.

HeaderHeight

Gets / sets the height of the GroupBar header.

Declaration
public int HeaderHeight { get; set; }
Property Value
Type Description
System.Int32

An integer value that specifies the header height.
Remarks

The GroupBar header is shown only when the StackedMode property is set.

HeaderStringFormat

Returns the string format object for header drawing.

Declaration
protected StringFormat HeaderStringFormat { get; }
Property Value
Type Description
System.Drawing.StringFormat

HighlightItem

Returns the index of the GroupBarItem that is currently under the mouse cursor.

Declaration
public int HighlightItem { get; }
Property Value
Type Description
System.Int32

An integer value that specifies the zero-based index of the GroupBarItem.

IconRenderingMode

Specifies the type of rendering done to icons

Declaration
public IconRenderingMode IconRenderingMode { get; set; }
Property Value
Type Description
IconRenderingMode

IndexOnVisibleItems

Gets or Sets a value indicating whether selection logic includes visible items alone for SelectedItem calculation.

Declaration
public bool IndexOnVisibleItems { get; set; }
Property Value
Type Description
System.Boolean

IntegratedScrolling

Indicates whether integrated scroll buttons are to be used.

Declaration
public bool IntegratedScrolling { get; set; }
Property Value
Type Description
System.Boolean

True to enable integrated scrolling. The default is False.
Remarks

This option is primarily intended for use with the Syncfusion GroupView control. When this flag is set, the GroupBar provides the scroll buttons for the current selected GroupView control and interacts with it to achieve seamless scrolling behavior.

See Also

IsClientSetting

Indicates, if process of setting client for GroupBarItem is in progress.

Declaration
protected bool IsClientSetting { get; set; }
Property Value
Type Description
System.Boolean

IsInitializing

Get is control initializing.

Declaration
public bool IsInitializing { get; }
Property Value
Type Description
System.Boolean

ItemAccessibleObjects

Declaration
protected GroupBarItemAccessibleObjectsIndexer ItemAccessibleObjects { get; }
Property Value
Type Description
GroupBarItemAccessibleObjectsIndexer

MinimizeButtonToolTip

Gets or sets the tooltip for collapse button, when control is expanded.

Declaration
public string MinimizeButtonToolTip { get; set; }
Property Value
Type Description
System.String

NavigationPaneButtonWidth

Gets / sets the width of the GroupBarItems shown in the navigation pane.

Declaration
public int NavigationPaneButtonWidth { get; set; }
Property Value
Type Description
System.Int32

An integer value that specifies the GroupBarItem width.
Remarks

The navigation pane is shown only when the StackedMode property is set.

NavigationPaneHeight

Gets / sets the height of the GroupBar navigation pane.

Declaration
public int NavigationPaneHeight { get; set; }
Property Value
Type Description
System.Int32

An integer value that specifies the height.
Remarks

The navigation pane is shown only when the StackedMode property is set.

NavigationPaneTooltip

Gets or sets the navigation pane's tooltip.

Declaration
public string NavigationPaneTooltip { get; set; }
Property Value
Type Description
System.String

Office2007Theme

Indicates the Office2007 theme used for drawing the control.

Declaration
public Office2007Theme Office2007Theme { get; set; }
Property Value
Type Description
Office2007Theme

Office2010Theme

Indicates the Office2010 theme used for drawing the control.

Declaration
public Office2010Theme Office2010Theme { get; set; }
Property Value
Type Description
Office2010Theme

PopupAutoClose

Gets or sets a value indicating whether popup is closed after clicking on item.

Declaration
public bool PopupAutoClose { get; set; }
Property Value
Type Description
System.Boolean

PopupClientSize

Gets or sets the initial size of the popup for GroupBarItem client.

Declaration
public Size PopupClientSize { get; set; }
Property Value
Type Description
System.Drawing.Size

PopupResizeMode

Gets or sets the popup's resize mode.

Declaration
public PopupResizeMode PopupResizeMode { get; set; }
Property Value
Type Description
PopupResizeMode

PopupRightToLeft

Declaration
public bool PopupRightToLeft { get; set; }
Property Value
Type Description
System.Boolean

ScrollTimerInterval

Declaration
public int ScrollTimerInterval { get; set; }
Property Value
Type Description
System.Int32

SelectedItem

Gets / sets an integer that represents the index of the current selected GroupBarItem.

Declaration
public int SelectedItem { get; set; }
Property Value
Type Description
System.Int32

An integer value that specifies the zero-based index of the GroupBarItem.

ShowChevron

Indicates whether the Chevron button on the
Navigation Panel is shown in the Stacked GroupBar.

Declaration
public bool ShowChevron { get; set; }
Property Value
Type Description
System.Boolean
Remarks

The navigation pane is shown only when the StackedMode property is set.

ShowItemImageInHeader

Indicates whether the selected item's image is shown in header in the Stacked GroupBar.

Declaration
public bool ShowItemImageInHeader { get; set; }
Property Value
Type Description
System.Boolean

ShowNavigationPane

Declaration
public bool ShowNavigationPane { get; set; }
Property Value
Type Description
System.Boolean

ShowPopupGripper

Gets or sets a value indicating whether to show GroupBarItem popup's gripper.

Declaration
public bool ShowPopupGripper { get; set; }
Property Value
Type Description
System.Boolean

Splittercolor

Declaration
public Color Splittercolor { get; set; }
Property Value
Type Description
System.Drawing.Color

StackedMode

Indicates whether the GroupBarItems are displayed in a stack.

Declaration
public bool StackedMode { get; set; }
Property Value
Type Description
System.Boolean

True to set the stacked mode. The default is False.
Remarks

When the StackedMode property is set, the GroupBarItems are stacked at the bottom of the GroupBar control on top of a navigation pane. The stack size can be increased or decreased by moving items to and from the navigation pane.

NOTE: The StackedMode interface is similar to the Navigation Pane in Microsoft Outlook 2003.

TextAlign

Gets / sets the alignment of the text displayed on the GroupBarItem.

Declaration
public TextAlignment TextAlign { get; set; }
Property Value
Type Description
TextAlignment

A TextAlignment value. The default value is TextAlignment.Center.

TextStringFormat

Returns the String format for text drawing.

Declaration
protected StringFormat TextStringFormat { get; }
Property Value
Type Description
System.Drawing.StringFormat

ThemesEnabled

Indicates whether XP Themes (visual styles) should be used for drawing the control.

Declaration
public bool ThemesEnabled { get; set; }
Property Value
Type Description
System.Boolean

True to turn on themes; the default is False.

ThemeStyle

Gets or sets the GroupBarVisualStyle value used to customize the appearance of the GroupView.

Declaration
public GroupBarVisualStyle ThemeStyle { get; set; }
Property Value
Type Description
GroupBarVisualStyle
Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

VisibleGroupBarItems

Returns the collection of visible group bar items.

Declaration
public GroupBar.VisibleGroupBarItemsCollection VisibleGroupBarItems { get; }
Property Value
Type Description
GroupBar.VisibleGroupBarItemsCollection

VisualStyle

Indicates the style to be used for drawing the GroupBar control.

Declaration
public VisualStyle VisualStyle { get; set; }
Property Value
Type Description
VisualStyle

A VisualStyle value; the default is VisualStyle.OfficeXP.

Methods

ActivateSelection(Int32, Int32)

Declaration
protected virtual void ActivateSelection(int newselected, int oldselected)
Parameters
Type Name Description
System.Int32 newselected
System.Int32 oldselected

ApplyScaleToControl(Single)

Applies the scaling

Declaration
public void ApplyScaleToControl(float scaleFactor)
Parameters
Type Name Description
System.Single scaleFactor

BeginInit()

Signals the object that initialization is starting.

Declaration
public void BeginInit()

CalcTextRect(Graphics, GroupBarItem, Rectangle)

Declaration
protected Rectangle CalcTextRect(Graphics gph, GroupBarItem group, Rectangle rcbar)
Parameters
Type Name Description
System.Drawing.Graphics gph
GroupBarItem group
System.Drawing.Rectangle rcbar
Returns
Type Description
System.Drawing.Rectangle

CalcTextRectForIcon(Graphics, GroupBarItem, Rectangle)

Declaration
protected Rectangle CalcTextRectForIcon(Graphics gph, GroupBarItem group, Rectangle rcbar)
Parameters
Type Name Description
System.Drawing.Graphics gph
GroupBarItem group
System.Drawing.Rectangle rcbar
Returns
Type Description
System.Drawing.Rectangle

CancelInplaceRenameItem()

Cancels an in-place edit that is in progress.

Declaration
public virtual void CancelInplaceRenameItem()
See Also

CorrectRectForScrollThumbWidth(ref Rectangle)

Declaration
protected void CorrectRectForScrollThumbWidth(ref Rectangle rRect)
Parameters
Type Name Description
System.Drawing.Rectangle rRect

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type Description
System.Windows.Forms.AccessibleObject

CreateGroupBarItemAccessibilityInstance(Int32)

Declaration
protected GroupBarItemAccessibleObject CreateGroupBarItemAccessibilityInstance(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
GroupBarItemAccessibleObject

Dispose(Boolean)

Overridden. See System.Windows.Forms.Control.Dispose(System.Boolean).

Declaration
protected override void Dispose(bool bdispose)
Parameters
Type Name Description
System.Boolean bdispose
Overrides

DoScroll(Boolean)

Declaration
protected void DoScroll(bool bupscrllbttn)
Parameters
Type Name Description
System.Boolean bupscrllbttn

DrawDropdownButton(Graphics, Rectangle, Boolean)

Draws the drop down button.

Declaration
protected virtual void DrawDropdownButton(Graphics gph, Rectangle rcbutton, bool bIsMirrored)
Parameters
Type Name Description
System.Drawing.Graphics gph

A System.Drawing.Graphics object.
System.Drawing.Rectangle rcbutton

A System.Drawing.Rectangle value specifying the GroupBarItem bounds.
System.Boolean bIsMirrored

If set to true button is mirrored for RTL.

DrawGroupBarIcon(Graphics, Int32, Rectangle)

Draws the GroupBarItem icon.

Declaration
protected virtual void DrawGroupBarIcon(Graphics gph, int nindex, Rectangle rcbar)
Parameters
Type Name Description
System.Drawing.Graphics gph

A System.Drawing.Graphics object.
System.Int32 nindex

The zero-based index of the GroupBarItem for which the icon is drawn.
System.Drawing.Rectangle rcbar

A System.Drawing.Rectangle value specifying the GroupBarItem bounds.
Remarks

The GroupBar control calls this method to paint the specified GroupBarItem's icon. Override this method to customize the GroupBar drawing.

DrawGroupBarImage(Graphics, Int32, Rectangle)

Draws the GroupBarItem icon.

Declaration
protected virtual void DrawGroupBarImage(Graphics gph, int nindex, Rectangle rcbar)
Parameters
Type Name Description
System.Drawing.Graphics gph

A System.Drawing.Graphics object.
System.Int32 nindex

The zero-based index of the GroupBarItem for which the icon is drawn.
System.Drawing.Rectangle rcbar

A System.Drawing.Rectangle value specifying the GroupBarItem bounds.
Remarks

The GroupBar control calls this method to paint the specified GroupBarItem's icon. Override this method to customize the GroupBar drawing.

DrawGroupBarItem(Graphics, Int32, Rectangle)

Draws the GroupBarItem object.

Declaration
protected virtual void DrawGroupBarItem(Graphics gfxTarget, int nindex, Rectangle rcbar)
Parameters
Type Name Description
System.Drawing.Graphics gfxTarget

A System.Drawing.Graphics object.
System.Int32 nindex

The zero-based index of the GroupBarItem to be drawn.
System.Drawing.Rectangle rcbar

A System.Drawing.Rectangle value specifying the GroupBarItem bounds.
Remarks

The GroupBar control calls this method to paint the specified GroupBarItem. Override this method to customize the GroupBar drawing.

DrawGroupBarText(Graphics, Int32, Rectangle)

Draws the GroupBarItem text.

Declaration
protected virtual void DrawGroupBarText(Graphics gph, int nindex, Rectangle rcbar)
Parameters
Type Name Description
System.Drawing.Graphics gph

A System.Drawing.Graphics object.
System.Int32 nindex

The zero-based index of the GroupBarItem for which the text is drawn.
System.Drawing.Rectangle rcbar

A System.Drawing.Rectangle value specifying the GroupBarItem bounds.
Remarks

The GroupBar control calls this method to paint the specified GroupBarItem's text. Override this method to customize the GroupBar drawing.

DrawHeader(Graphics)

Draws the Header for GroupBar.

Declaration
protected virtual void DrawHeader(Graphics gph)
Parameters
Type Name Description
System.Drawing.Graphics gph

A System.Drawing.Graphics object.
Remarks

The GroupBar control calls this method to paint the specified GroupBar Header. Override this method to customize the GroupBar Header drawing.

DrawIconStateHelper(Graphics, Icon, Rectangle, Boolean, GroupBarItem)

Declaration
protected void DrawIconStateHelper(Graphics gph, Icon icon, Rectangle rcicon, bool benabled, GroupBarItem item)
Parameters
Type Name Description
System.Drawing.Graphics gph
System.Drawing.Icon icon
System.Drawing.Rectangle rcicon
System.Boolean benabled
GroupBarItem item

DrawImageStateHelper(Graphics, Image, Rectangle, RectangleF, Boolean)

Declaration
protected void DrawImageStateHelper(Graphics gph, Image image, Rectangle destRect, RectangleF srcRect, bool bEnabled)
Parameters
Type Name Description
System.Drawing.Graphics gph
System.Drawing.Image image
System.Drawing.Rectangle destRect
System.Drawing.RectangleF srcRect
System.Boolean bEnabled

DrawNavigationPane(Graphics)

Declaration
protected virtual void DrawNavigationPane(Graphics gph)
Parameters
Type Name Description
System.Drawing.Graphics gph

DrawNavigationPaneOffice2003(Graphics, Rectangle)

Declaration
protected virtual void DrawNavigationPaneOffice2003(Graphics gph, Rectangle rcbounds)
Parameters
Type Name Description
System.Drawing.Graphics gph
System.Drawing.Rectangle rcbounds

DrawNavigationPaneOffice2007(Graphics, Rectangle)

Declaration
protected virtual void DrawNavigationPaneOffice2007(Graphics gph, Rectangle rcbounds)
Parameters
Type Name Description
System.Drawing.Graphics gph
System.Drawing.Rectangle rcbounds

DrawNavigationPaneOffice2010(Graphics, Rectangle)

Declaration
protected virtual void DrawNavigationPaneOffice2010(Graphics gph, Rectangle rcbounds)
Parameters
Type Name Description
System.Drawing.Graphics gph
System.Drawing.Rectangle rcbounds

DrawNavigationPaneOfficeXP(Graphics, Rectangle)

Declaration
protected virtual void DrawNavigationPaneOfficeXP(Graphics gph, Rectangle rcbounds)
Parameters
Type Name Description
System.Drawing.Graphics gph
System.Drawing.Rectangle rcbounds

DrawNavigationPaneThemed(Graphics, Rectangle)

Declaration
protected virtual void DrawNavigationPaneThemed(Graphics gph, Rectangle rcbounds)
Parameters
Type Name Description
System.Drawing.Graphics gph
System.Drawing.Rectangle rcbounds

DrawNevigationItemIcon(Graphics, GroupBarItem, Rectangle)

Draws icon\image in navigation panel.

Declaration
protected virtual void DrawNevigationItemIcon(Graphics gph, GroupBarItem item, Rectangle rcbutton)
Parameters
Type Name Description
System.Drawing.Graphics gph
GroupBarItem item
System.Drawing.Rectangle rcbutton

DrawRegularGroupBar(Graphics)

Draws the group bar control.

Declaration
protected virtual void DrawRegularGroupBar(Graphics gph)
Parameters
Type Name Description
System.Drawing.Graphics gph

A System.Drawing.Graphics object.

DrawScrollThumb(Graphics, Boolean, Rectangle)

Declaration
protected virtual void DrawScrollThumb(Graphics gfxTarget, bool bscrollup, Rectangle rectScroll)
Parameters
Type Name Description
System.Drawing.Graphics gfxTarget
System.Boolean bscrollup
System.Drawing.Rectangle rectScroll

DrawSelectedGroupClientBorder(Graphics, Rectangle)

Draws a border around the selected client control.

Declaration
protected virtual void DrawSelectedGroupClientBorder(Graphics gph, Rectangle rcclient)
Parameters
Type Name Description
System.Drawing.Graphics gph

A System.Drawing.Graphics object.
System.Drawing.Rectangle rcclient

A System.Drawing.Rectangle value specifying the client control bounds.
Remarks

The GroupBar control calls this method to paint a border around the the current selected client control. Override this method to customize the GroupBar drawing.

DrawStackedGroupBar(Graphics)

Draws the stacked group bar.

Declaration
protected virtual void DrawStackedGroupBar(Graphics gph)
Parameters
Type Name Description
System.Drawing.Graphics gph

The GPH.

EndInit()

Signals the object that initialization is complete.

Declaration
public void EndInit()

FireGroupBarItemAddedEvent(GroupBarItem)

Declaration
protected void FireGroupBarItemAddedEvent(GroupBarItem item)
Parameters
Type Name Description
GroupBarItem item

FireGroupBarItemRemovedEvent(GroupBarItem)

Declaration
protected void FireGroupBarItemRemovedEvent(GroupBarItem item)
Parameters
Type Name Description
GroupBarItem item

GetBoundedRectangle()

Declaration
protected Rectangle GetBoundedRectangle()
Returns
Type Description
System.Drawing.Rectangle

GetControlName(String)

Helps to apply the ControlName settings for GroupBar.

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName
Returns
Type Description
System.String
Overrides

GetDropDownButtonRectangle()

Declaration
public Rectangle GetDropDownButtonRectangle()
Returns
Type Description
System.Drawing.Rectangle

GetGroupBarItemBounds(Int32)

Declaration
protected Rectangle GetGroupBarItemBounds(int nitem)
Parameters
Type Name Description
System.Int32 nitem
Returns
Type Description
System.Drawing.Rectangle

GetItemFromPoint(Point)

Gets the GroupBarItem from the corresponding mouse point.

Declaration
protected int GetItemFromPoint(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt
Returns
Type Description
System.Int32

GetItemIndex(Int32)

Declaration
protected int GetItemIndex(int virtualSelctedItem)
Parameters
Type Name Description
System.Int32 virtualSelctedItem

Index of selected item is VisibleGroupBarItems
Returns
Type Description
System.Int32

Index of selected item is GroupBarItems collection

GetNavPaneRectangle()

Declaration
protected Rectangle GetNavPaneRectangle()
Returns
Type Description
System.Drawing.Rectangle

GroupBar_RenameComplete(Object, RenameCompleteEventArgs)

Declaration
protected virtual void GroupBar_RenameComplete(object sender, RenameCompleteEventArgs arg)
Parameters
Type Name Description
System.Object sender
RenameCompleteEventArgs arg

GroupExists(Int32)

Declaration
protected bool GroupExists(int ngroup)
Parameters
Type Name Description
System.Int32 ngroup
Returns
Type Description
System.Boolean

HandleMouseLButtonDown(Point)

Declaration
protected int HandleMouseLButtonDown(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt
Returns
Type Description
System.Int32

HandleMouseLButtonUp(Point)

Declaration
protected int HandleMouseLButtonUp(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt
Returns
Type Description
System.Int32

HandleMouseMove(Point)

Declaration
protected int HandleMouseMove(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt
Returns
Type Description
System.Int32

HidePopup()

Hides the GroupBarItem's popup.

Declaration
public void HidePopup()

InitializeNavigationButtonMenu(IContextMenuProvider)

Initializes the navigation button menu.

Declaration
protected virtual void InitializeNavigationButtonMenu(IContextMenuProvider menu)
Parameters
Type Name Description
IContextMenuProvider menu

The context menu provider used to create the menus.

InplaceRenameItem(Int32)

Starts an in-place edit of the specified GroupBarItem text.

Declaration
public virtual void InplaceRenameItem(int nindex)
Parameters
Type Name Description
System.Int32 nindex

The zero-based index of the item to be renamed.
Remarks

Invoking this method will create an editable text box and and populates it with the item text. Editing the text box contents and selecting ENTER will update the GroupBarItem text. Selecting ESC will cancel the edit.

See Also

IsDownScrollButtonEnabled()

Declaration
protected bool IsDownScrollButtonEnabled()
Returns
Type Description
System.Boolean

IsUpScrollButtonEnabled()

Declaration
protected bool IsUpScrollButtonEnabled()
Returns
Type Description
System.Boolean

NotifyGroupBarOfItemRemoval(GroupBarItem)

Declaration
protected void NotifyGroupBarOfItemRemoval(GroupBarItem item)
Parameters
Type Name Description
GroupBarItem item

OnControlAdded(ControlEventArgs)

Overridden. See System.Windows.Forms.Control.OnControlAdded(System.Windows.Forms.ControlEventArgs).

Declaration
protected override void OnControlAdded(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e
Overrides

OnControlRemoved(ControlEventArgs)

Overridden. See System.Windows.Forms.Control.OnControlRemoved(System.Windows.Forms.ControlEventArgs).

Declaration
protected override void OnControlRemoved(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e
Overrides

OnDragLeave(EventArgs)

Overridden. See System.Windows.Forms.Control.OnDragLeave(System.EventArgs).

Declaration
protected override void OnDragLeave(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnDragOver(DragEventArgs)

Overridden. See System.Windows.Forms.Control.OnDragOver(System.Windows.Forms.DragEventArgs).

Declaration
protected override void OnDragOver(DragEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.DragEventArgs e
Overrides

OnFewerButtons_Click(Object, EventArgs)

Called when fewer buttons menuitem is clicked.

Declaration
protected void OnFewerButtons_Click(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender
System.EventArgs e

An System.EventArgs that contains the event data.

OnFontChanged(EventArgs)

Font changed

Declaration
protected override void OnFontChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnGroupBarItemAdded(GroupBarItemEventArgs)

Raises the GroupBarItemAdded event.

Declaration
protected virtual void OnGroupBarItemAdded(GroupBarItemEventArgs arg)
Parameters
Type Name Description
GroupBarItemEventArgs arg

A GroupBarItemEventArgs value that contains the event data.

OnGroupBarItemRemoved(GroupBarItemEventArgs)

Raises the GroupBarItemRemoved event.

Declaration
protected virtual void OnGroupBarItemRemoved(GroupBarItemEventArgs arg)
Parameters
Type Name Description
GroupBarItemEventArgs arg

A GroupBarItemEventArgs value that contains the event data.

OnGroupBarItemRenamed(GroupItemRenamedEventArgs)

Raises the GroupBarItemRenamed event.

Declaration
protected virtual void OnGroupBarItemRenamed(GroupItemRenamedEventArgs arg)
Parameters
Type Name Description
GroupItemRenamedEventArgs arg

An GroupItemRenamedEventArgs value that contains the event data.

OnGroupBarItemSelected(EventArgs)

Raises the GroupBarItemSelected event.

Declaration
protected virtual void OnGroupBarItemSelected(EventArgs arg)
Parameters
Type Name Description
System.EventArgs arg

A System.EventArgs value that contains the event data.

OnGroupBarItemSelectionChanging(GroupBarItemSelectionChangingEventArgs)

Raises the GroupBarItemSelectionChanging event.

Declaration
protected virtual void OnGroupBarItemSelectionChanging(GroupBarItemSelectionChangingEventArgs arg)
Parameters
Type Name Description
GroupBarItemSelectionChangingEventArgs arg

A GroupBarItemSelectionChangingEventArgs value that contains the event data.

OnMoreButtons_Click(Object, EventArgs)

Called when more buttons menuitem is clicked.

Declaration
protected void OnMoreButtons_Click(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender
System.EventArgs e

An System.EventArgs that contains the event data.

OnMouseDown(MouseEventArgs)

Overridden. See System.Windows.Forms.Control.OnMouseDown(System.Windows.Forms.MouseEventArgs).

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e
Overrides

OnMouseLeave(EventArgs)

Overridden. See System.Windows.Forms.Control.OnMouseLeave(System.EventArgs).

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

OnMouseMove(MouseEventArgs)

Overridden. See System.Windows.Forms.Control.OnMouseMove(System.Windows.Forms.MouseEventArgs).

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e
Overrides

OnMouseUp(MouseEventArgs)

Overridden. See System.Windows.Forms.Control.OnMouseUp(System.Windows.Forms.MouseEventArgs).

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e
Overrides

OnMouseWheel(MouseEventArgs)

Overrides the MouseWheel event

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e
Overrides

OnNavigationPaneButtonClick(NavigationPaneDropDownClickEventArgs)

Raises the navigation pane button click event.

Declaration
protected void OnNavigationPaneButtonClick(NavigationPaneDropDownClickEventArgs e)
Parameters
Type Name Description
NavigationPaneDropDownClickEventArgs e

An NavigationPaneDropDownClickEventArgs that contains the event data.

OnPaint(PaintEventArgs)

Overridden. See System.Windows.Forms.Control.OnPaint(System.Windows.Forms.PaintEventArgs).

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e
Overrides

OnProvideGroupBarItemBrush(ProvideGroupBarItemBrushEventArgs)

Raises the ProvideGroupBarItemBrush event.

Declaration
protected virtual void OnProvideGroupBarItemBrush(ProvideGroupBarItemBrushEventArgs arg)
Parameters
Type Name Description
ProvideGroupBarItemBrushEventArgs arg

A ProvideGroupBarItemBrushEventArgs value that contains the event data.

OnShowContextMenu(EventArgs)

Raises the ShowContextMenu event.

Declaration
protected virtual void OnShowContextMenu(EventArgs arg)
Parameters
Type Name Description
System.EventArgs arg

A System.EventArgs value that contains the event data.

OnSizeChanged(EventArgs)

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

OnSystemColorsChanged(EventArgs)

Overridden. See System.Windows.Forms.Control.OnSystemColorsChanged(System.EventArgs).

Declaration
protected override void OnSystemColorsChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnThemeNameChanged(String)

Helps to apply the ThemeName settings for the GroupView.

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

ThemeName
Overrides

OnVisibleChanged(EventArgs)

Overridden. See System.Windows.Forms.Control.OnVisibleChanged(System.EventArgs).

Declaration
protected override void OnVisibleChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

PointToItem(Point)

Returns GroupBarItem at specified point in client coordinates.

Declaration
public GroupBarItem PointToItem(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt

Point to search GroupBarItem at.
Returns
Type Description
GroupBarItem

GroupBarItem, whose area contains the specified point; Null, if nothing is found.

PointToItem(Int32, Int32)

Overloaded. Returns the GroupBarItem at the specified point in client coordinates.

Declaration
public GroupBarItem PointToItem(int x, int y)
Parameters
Type Name Description
System.Int32 x

X - coordinate of the item.
System.Int32 y

Y - coordinate of the item.
Returns
Type Description
GroupBarItem

GroupBarItem, whose area contains the specified point; Null, if nothing is found.

ProcessCmdKey(ref Message, Keys)

Declaration
protected override bool ProcessCmdKey(ref Message msg, Keys keydata)
Parameters
Type Name Description
System.Windows.Forms.Message msg
System.Windows.Forms.Keys keydata
Returns
Type Description
System.Boolean

PropChangedHandler(Object, PropertyChangedEventArgs)

Declaration
protected void PropChangedHandler(object obj, PropertyChangedEventArgs args)
Parameters
Type Name Description
System.Object obj
System.ComponentModel.PropertyChangedEventArgs args

RecalculateGroupBarLayout()

Declaration
protected void RecalculateGroupBarLayout()

ResetApplyDefaultVisualStyleColor()

Resets the ApplyDefaultVisualStyleColor property to its default value.

Declaration
protected void ResetApplyDefaultVisualStyleColor()

ResetCollapsedText()

Resets the CollapsedText property to its default value.

Declaration
protected void ResetCollapsedText()

ResetCollapseImage()

Resets the CollapseImage property to its default value.

Declaration
protected void ResetCollapseImage()

ResetEnableSplittercolorCustomization()

Resets the EnableSplittercolorCustomization

Declaration
public void ResetEnableSplittercolorCustomization()

ResetExpandButtonToolTip()

Resets the ExpandButtonToolTip property to its default value.

Declaration
protected void ResetExpandButtonToolTip()

ResetExpandImage()

Resets the CollapseImage property to its default value.

Declaration
protected void ResetExpandImage()

ResetGroupBarDropDownToolTip()

Resets the GroupBarDropDownToolTip property to its default value.

Declaration
public void ResetGroupBarDropDownToolTip()

ResetGroupBarItemCursor()

Declaration
public void ResetGroupBarItemCursor()

ResetHeaderBackColor()

Resets the HeaderBackColor property to its default value.

Declaration
public void ResetHeaderBackColor()

ResetHeaderFont()

Resets the HeaderFont property to its default value.

Declaration
public void ResetHeaderFont()

ResetHeaderForeColor()

Resets the HeaderForeColor property to its default value.

Declaration
public void ResetHeaderForeColor()

ResetMinimizeButtonToolTip()

Resets the MinimizeButtonToolTip property to its default value.

Declaration
protected void ResetMinimizeButtonToolTip()

ResetNavigationPaneTooltip()

Resets the NavigationPaneTooltip property to its default value.

Declaration
protected void ResetNavigationPaneTooltip()

ResetSplittercolor()

Resets the Splittercolor

Declaration
public void ResetSplittercolor()

ScrollTimerEventHandler(Object, EventArgs)

Declaration
protected void ScrollTimerEventHandler(object obj, EventArgs args)
Parameters
Type Name Description
System.Object obj
System.EventArgs args

SelectItem(Int32, Int32)

Declaration
protected virtual int SelectItem(int newselected, int oldselected)
Parameters
Type Name Description
System.Int32 newselected
System.Int32 oldselected
Returns
Type Description
System.Int32

SetActiveClientBounds()

Declaration
protected void SetActiveClientBounds()

SetActiveClientBounds(GroupBarItem, Rectangle, Rectangle, Boolean)

Declaration
protected void SetActiveClientBounds(GroupBarItem group, Rectangle rc1, Rectangle rc2, bool bscrlldown)
Parameters
Type Name Description
GroupBarItem group
System.Drawing.Rectangle rc1
System.Drawing.Rectangle rc2
System.Boolean bscrlldown

SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)

Overridden. See System.Windows.Forms.Control.SetBoundsCore(System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Forms.BoundsSpecified).

Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
System.Int32 width
System.Int32 height
System.Windows.Forms.BoundsSpecified specified

SetScrollButtonState(Boolean, ButtonsState)

Declaration
protected void SetScrollButtonState(bool bupscroll, ButtonsState state)
Parameters
Type Name Description
System.Boolean bupscroll
ButtonsState state

ShouldSerializeCollapsedText()

Indicates whether CollapsedText property should be serialized.

Declaration
protected bool ShouldSerializeCollapsedText()
Returns
Type Description
System.Boolean

ShouldSerializeCollapseImage()

Indicates whether CollapseImage property should be serialized.

Declaration
protected bool ShouldSerializeCollapseImage()
Returns
Type Description
System.Boolean

ShouldSerializeExpandButtonToolTip()

Indicates whether ExpandButtonToolTip property should be serialized.

Declaration
protected bool ShouldSerializeExpandButtonToolTip()
Returns
Type Description
System.Boolean

ShouldSerializeExpandImage()

Indicates whether CollapseImage property should be serialized.

Declaration
protected bool ShouldSerializeExpandImage()
Returns
Type Description
System.Boolean

ShouldSerializeGroupBarDropDownToolTip()

Indicates whether GroupBarDropDownToolTip property should be serialized.

Declaration
protected bool ShouldSerializeGroupBarDropDownToolTip()
Returns
Type Description
System.Boolean

ShouldSerializeGroupBarItemCursor()

Declaration
protected bool ShouldSerializeGroupBarItemCursor()
Returns
Type Description
System.Boolean

ShouldSerializeHeaderBackColor()

Declaration
protected bool ShouldSerializeHeaderBackColor()
Returns
Type Description
System.Boolean

ShouldSerializeHeaderFont()

Declaration
protected bool ShouldSerializeHeaderFont()
Returns
Type Description
System.Boolean

ShouldSerializeHeaderForeColor()

Declaration
protected bool ShouldSerializeHeaderForeColor()
Returns
Type Description
System.Boolean

ShouldSerializeMinimizeButtonToolTip()

Indicates whether MinimizeButtonToolTip property should be serialized.

Declaration
protected bool ShouldSerializeMinimizeButtonToolTip()
Returns
Type Description
System.Boolean

ShouldSerializeNavigationPaneTooltip()

Indicates whether MinimizeButtonToolTip property should be serialized.

Declaration
protected bool ShouldSerializeNavigationPaneTooltip()
Returns
Type Description
System.Boolean

ShoulSerailizeApplyDefaultVisualStyleColor()

Indicates whether ApplyDefaultVisualStyleColor property should be serialized.

Declaration
protected bool ShoulSerailizeApplyDefaultVisualStyleColor()
Returns
Type Description
System.Boolean

ShowDropDownMenu()

Creates and displays the drop-down button context menu.

Declaration
protected void ShowDropDownMenu()

ShowItemPopup(GroupBarItem)

Shows the item popup when the Group bar is Collapsed

Declaration
public void ShowItemPopup(GroupBarItem barItem)
Parameters
Type Name Description
GroupBarItem barItem

GroupBar Item for which Popup to be shown

WndProc(ref Message)

Declaration
protected override void WndProc(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m
Overrides

Events

BeforePopup

Occurs when before GroupBarItem's popup is shown.

Declaration
public event GroupBar.BeforePopupEventHandler BeforePopup
Event Type
Type Description
GroupBar.BeforePopupEventHandler
Remarks

Can cancel popup showing.

GroupBarItemAdded

Occurs after a GroupBarItem has been added to the GroupBarItems collection.

Declaration
public event GroupBarItemEventHandler GroupBarItemAdded
Event Type
Type Description
GroupBarItemEventHandler

GroupBarItemRemoved

Occurs after a GroupBarItem has been removed from the GroupBarItems collection.

Declaration
public event GroupBarItemEventHandler GroupBarItemRemoved
Event Type
Type Description
GroupBarItemEventHandler

GroupBarItemRenamed

Occurs after a GroupBarItem has been renamed by an in-place edit operation.

Declaration
public event GroupItemRenamedEventHandler GroupBarItemRenamed
Event Type
Type Description
GroupItemRenamedEventHandler
See Also

GroupBarItemSelected

Occurs when a GroupBarItem in the GroupBar control is selected.

Declaration
public event EventHandler GroupBarItemSelected
Event Type
Type Description
System.EventHandler
Remarks

Use the SelectedItem property to get the index of the newly selected item.

GroupBarItemSelectionChanging

Occurs when a GroupBarItem in the GroupBar control is being selected.

Declaration
public event GroupBarItemSelectionChangingEventHandler GroupBarItemSelectionChanging
Event Type
Type Description
GroupBarItemSelectionChangingEventHandler

NavigationPaneDropDownClick

Occurs when the user clicks on the GroupBar control's navigation pane drop-down button.

Declaration
public event NavigationPaneDropDownClickEventHandler NavigationPaneDropDownClick
Event Type
Type Description
NavigationPaneDropDownClickEventHandler
Remarks

This GroupBar control displays the navigation pane only when the StackedMode property is set.

ProvideGroupBarItemBrush

Occurs when a GroupBarItem is about to be drawn.

Declaration
public event ProvideGroupBarItemBrushEventHandler ProvideGroupBarItemBrush
Event Type
Type Description
ProvideGroupBarItemBrushEventHandler
Remarks

Handle this event to provide a custom brush for painting the GroupBarItem background.

ShowContextMenu

Occurs when the right mouse button is clicked over the GroupBar control.

Declaration
public event EventHandler ShowContextMenu
Event Type
Type Description
System.EventHandler
Remarks

The ContextMenuItem property will provide the index of the GroupBarItem over which the mouse was clicked.

StateChanged

Occurs when Collapsed property is changed.

Declaration
public event EventHandler StateChanged
Event Type
Type Description
System.EventHandler

StateChanging

Occurs when Collapsed property is about to be changed.

Declaration
public event CancelEventHandler StateChanging
Event Type
Type Description
System.ComponentModel.CancelEventHandler
Remarks

Can cancel state changing.

Explicit Interface Implementations

IGroupBarDesignerInvoke.GetGroupAtLocation(Point)

Declaration
int IGroupBarDesignerInvoke.GetGroupAtLocation(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt
Returns
Type Description
System.Int32

IIntegratedScrollContainer.HandleScrollButtonDown(Point)

Declaration
bool IIntegratedScrollContainer.HandleScrollButtonDown(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt
Returns
Type Description
System.Boolean

IIntegratedScrollContainer.HandleScrollButtonUp(Point)

Declaration
bool IIntegratedScrollContainer.HandleScrollButtonUp(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt
Returns
Type Description
System.Boolean

IIntegratedScrollContainer.InvalidateDownScrollButton()

Declaration
void IIntegratedScrollContainer.InvalidateDownScrollButton()

IIntegratedScrollContainer.InvalidateUpScrollButton()

Declaration
void IIntegratedScrollContainer.InvalidateUpScrollButton()

Implements

System.IDisposable
System.ComponentModel.ISupportInitialize

See Also