Class GroupView

Represents a control that can display a list of items.

Inheritance
System.Object
BaseControl
GroupView
PaletteGroupView
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class GroupView : BaseControl, IThemeProvider, IVisualStyle, IDisposable, IIntegratedScrollClient, IGroupViewDesignerInvoke
Remarks

The GroupView control implements a list type control that can display a set of items where each item is represented by an image and a descriptor. Items are implemented as instances of the GroupViewItem class. The collection of GroupViewItems in the control can be accessed through the GroupViewItems property that returns a reference to the GroupView.GroupViewItemCollection object maintained by the control.

The GroupView control is capable of displaying items with large or small icons in various combinable styles such as the default selectable style, button-type selection, full-item select and an icon-only flowview mode. All styles are available in the regular 3D or a FlatLook mode. The control also implements an IntegratedScrolling option that allows scrolling to be delegated to its parent container.

The GroupView control can be used in conjunction with the Essential Tools GroupBar control to implement composite controls such as the Microsoft OutlookBar and the Visual Studio.NET toolbox window. The latter scenario makes use of the IntegratedScrolling feature supported by the two controls.

Examples

The sample code shows how to create a GroupView control and initialize the Behavior and Appearance properties to resemble the Visual Studio.NET toolbox window. A handler for the GroupView.GroupViewItemSelected event is also shown.

private void InitializeGroupView()
{
	// Create the GroupView control.
	this.gvcWinForms = new Syncfusion.Windows.Forms.Tools.GroupView();

// Set the large and small ImageLists.
this.gvcWinForms.LargeImageList = this.ilGroupBarLarge;
this.gvcWinForms.SmallImageList = this.ilGroupBarSmall;

// Set the GroupView properties to display as a VS.NET tool box type window.
this.gvcWinForms.SmallImageView = true;
this.gvcWinForms.HighlightText = true;
this.gvcWinForms.ButtonView = true;
this.gvcWinForms.FlowView = false;
this.gvcWinForms.FlatLook = false;
this.gvcWinForms.TextWrap = false;

this.gvcWinForms.ImageSpacing = 2;
this.gvcWinForms.ItemXSpacing = 8;
this.gvcWinForms.ItemYSpacing = 1;

this.gvcWinForms.BackColor = SystemColors.Control;
this.gvcWinForms.ForeColor = SystemColors.ControlText;

this.gvcWinForms.HighlightItemColor = SystemColors.Control;
this.gvcWinForms.SelectingItemColor = ControlPaint.Light(SystemColors.ControlLight);
this.gvcWinForms.SelectedItemColor = ControlPaint.Light(SystemColors.ControlLight);
this.gvcWinForms.SelectedHighlightItemColor = SystemColors.Control;

this.gvcWinForms.SelectingTextColor = SystemColors.ControlText;
this.gvcWinForms.SelectedHighlightTextColor = SystemColors.ControlText;																				 

// Create and add the GroupViewItem objects.
this.gvcWinForms.GroupViewItems.AddRange(
	new Syncfusion.Windows.Forms.Tools.GroupViewItem[] {
															   new Syncfusion.Windows.Forms.Tools.GroupViewItem("Pointer", 11),
															   new Syncfusion.Windows.Forms.Tools.GroupViewItem("Label", 12),
															   new Syncfusion.Windows.Forms.Tools.GroupViewItem("LinkLabel", 13)});

// Provide a handler for the GroupView.GroupViewItemSelected event.
this.gvcWinForms.GroupViewItemSelected += new System.EventHandler(this.gvcWinForms_GroupViewItemSelected);																	   



}


// GroupView.GroupViewItemSelected event handler.
private void gvcWinForms_GroupViewItemSelected(object sender, System.EventArgs e)
{
MessageBox.Show(String.Concat("Selected Item Index = ", this.gvcWinForms.SelectedItem.ToString()));
}

Private Sub InitializeGroupView()

	' Create the GroupView control
	Me.gvcWinForms = New Syncfusion.Windows.Forms.Tools.GroupView()

	' Set the large and small ImageLists
	Me.gvcWinForms.LargeImageList = Me.ilGroupBarLarge
	Me.gvcWinForms.SmallImageList = Me.ilGroupBarSmall

	' Set the GroupView properties to display as a VS.NET Toolbox type window
	Me.gvcWinForms.SmallImageView = True
	Me.gvcWinForms.HighlightText = True
	Me.gvcWinForms.ButtonView = True
	Me.gvcWinForms.FlowView = False
	Me.gvcWinForms.FlatLook = False
	Me.gvcWinForms.TextWrap = False

	Me.gvcWinForms.ImageSpacing = 2
	Me.gvcWinForms.ItemXSpacing = 8
	Me.gvcWinForms.ItemYSpacing = 1

	Me.gvcWinForms.BackColor = SystemColors.Control
	Me.gvcWinForms.ForeColor = SystemColors.ControlText

	Me.gvcWinForms.HighlightItemColor = SystemColors.Control
	Me.gvcWinForms.SelectingItemColor = ControlPaint.Light(SystemColors.ControlLight)
	Me.gvcWinForms.SelectedItemColor = ControlPaint.Light(SystemColors.ControlLight)
	Me.gvcWinForms.SelectedHighlightItemColor = SystemColors.Control

	Me.gvcWinForms.SelectingTextColor = SystemColors.ControlText
	Me.gvcWinForms.SelectedHighlightTextColor = SystemColors.ControlText																				 

    ' Create and add the GroupViewItem objects.
    Me.gvcWinForms.GroupViewItems.AddRange(New Syncfusion.Windows.Forms.Tools.GroupViewItem() {New Syncfusion.Windows.Forms.Tools.GroupViewItem("Pointer", 11), New Syncfusion.Windows.Forms.Tools.GroupViewItem("Label", 12), New Syncfusion.Windows.Forms.Tools.GroupViewItem("LinkLabel", 13)})

    ' Handle the GroupView.GroupViewItemSelected event.
    AddHandler Me.gvcWinForms.GroupViewItemSelected, New System.EventHandler(AddressOf gvcWinForms_GroupViewItemSelected)

End Sub

 ' GroupView.GroupViewItemSelected event handler.
Private Sub gvcWinForms_GroupViewItemSelected(ByVal sender As Object, ByVal e As System.EventArgs)

    MessageBox.Show([String].Concat("Selected Item Index = ", Me.gvcWinForms.SelectedItem.ToString()))

End Sub 'gvcWinForms_GroupViewItemSelected

Constructors

GroupView()

Creates a new instance of the GroupView control.

Declaration
public GroupView()

Fields

bAllowDragDrop

Indicates whether drag-and-drop functionality is enabled for the control.

Declaration
protected bool bAllowDragDrop
Field Value
Type
System.Boolean

bButtonView

Indicates whether button view is enabled.

Declaration
protected bool bButtonView
Field Value
Type
System.Boolean

bClipSelectionBounds

Indicates whether selection bounds should be clipped to the control's client area.

Declaration
protected bool bClipSelectionBounds
Field Value
Type
System.Boolean

bDownScrlButton

Indicates whether the down scroll button is currently pressed.

Declaration
protected bool bDownScrlButton
Field Value
Type
System.Boolean

bdrStyle

Border style of the control.

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

bFlatLook

Indicates whether flat look styling is enabled.

Declaration
protected bool bFlatLook
Field Value
Type
System.Boolean

bFlowView

Indicates whether flow view layout is enabled.

Declaration
protected bool bFlowView
Field Value
Type
System.Boolean

bHighlightImage

Indicates whether item images should be highlighted on hover.

Declaration
protected bool bHighlightImage
Field Value
Type
System.Boolean

bHighlightItemSet

Indicates whether a custom highlight brush has been set.

Declaration
protected bool bHighlightItemSet
Field Value
Type
System.Boolean

bHighlightText

Indicates whether item text should be highlighted on hover.

Declaration
protected bool bHighlightText
Field Value
Type
System.Boolean

bHighlightTextSet

Indicates whether a custom highlight text color has been set.

Declaration
protected bool bHighlightTextSet
Field Value
Type
System.Boolean

bIntegratedScrolling

Indicates whether integrated scrolling is enabled.

Declaration
protected bool bIntegratedScrolling
Field Value
Type
System.Boolean

brBackGround

Brush used to paint the background of the control.

Declaration
protected Brush brBackGround
Field Value
Type
System.Drawing.Brush

brHighlightItem

Brush used to highlight an item.

Declaration
protected Brush brHighlightItem
Field Value
Type
System.Drawing.Brush

brSelectedHighlightItem

Brush used to paint an item that is both selected and highlighted.

Declaration
protected Brush brSelectedHighlightItem
Field Value
Type
System.Drawing.Brush

brSelectedItem

Brush used to paint a selected item.

Declaration
protected Brush brSelectedItem
Field Value
Type
System.Drawing.Brush

brSelectingItem

Brush used to paint an item that is in the process of being selected.

Declaration
protected Brush brSelectingItem
Field Value
Type
System.Drawing.Brush

bSelectedHighlightItemSet

Indicates whether a custom selected-highlight brush has been set.

Declaration
protected bool bSelectedHighlightItemSet
Field Value
Type
System.Boolean

bSelectedHighlightTextSet

Indicates whether a custom selected-highlight text color has been set.

Declaration
protected bool bSelectedHighlightTextSet
Field Value
Type
System.Boolean

bSelectedItemSet

Brush used to paint a selected item.

Declaration
protected bool bSelectedItemSet
Field Value
Type
System.Boolean

bSelectedTextSet

Indicates whether a custom selected text color has been set.

Declaration
protected bool bSelectedTextSet
Field Value
Type
System.Boolean

bSelectingItemSet

Indicates whether a custom selecting brush has been set.

Declaration
protected bool bSelectingItemSet
Field Value
Type
System.Boolean

bSelectingTextSet

Indicates whether a custom selecting text color has been set.

Declaration
protected bool bSelectingTextSet
Field Value
Type
System.Boolean

bSmallImageView

Indicates whether small image view is enabled.

Declaration
protected bool bSmallImageView
Field Value
Type
System.Boolean

bTextUnderline

Indicates whether item text should be underlined.

Declaration
protected bool bTextUnderline
Field Value
Type
System.Boolean

bTextWrap

Indicates whether text wrapping is enabled for item labels.

Declaration
protected bool bTextWrap
Field Value
Type
System.Boolean

bThemesEnabled

Indicates whether XP-style themes are enabled.

Declaration
protected bool bThemesEnabled
Field Value
Type
System.Boolean

bUpScrlButton

Indicates whether the up scroll button is currently pressed.

Declaration
protected bool bUpScrlButton
Field Value
Type
System.Boolean

cllnGroupViewItems

Collection of GroupViewItem objects displayed in the control.

Declaration
protected GroupView.GroupViewItemCollection cllnGroupViewItems
Field Value
Type
GroupView.GroupViewItemCollection

clrHighlightText

Text color for highlighted items.

Declaration
protected Color clrHighlightText
Field Value
Type
System.Drawing.Color

clrSelectedHighlightText

Text color for items that are both selected and highlighted.

Declaration
protected Color clrSelectedHighlightText
Field Value
Type
System.Drawing.Color

clrSelectedText

Text color for selected items.

Declaration
protected Color clrSelectedText
Field Value
Type
System.Drawing.Color

clrSelectingText

Text color for items that are in the process of being selected.

Declaration
protected Color clrSelectingText
Field Value
Type
System.Drawing.Color

ctrlTextBox

Text box used for renaming items.

Declaration
protected RenameTextBox ctrlTextBox
Field Value
Type
RenameTextBox

ctrlToolTip

Tooltip form used to display item tooltips.

Declaration
protected ToolTipForm ctrlToolTip
Field Value
Type
ToolTipForm

defLargeImgSize

Default size for large item images.

Declaration
protected readonly Size defLargeImgSize
Field Value
Type
System.Drawing.Size

defSmallImgSize

Default size for small item images.

Declaration
protected readonly Size defSmallImgSize
Field Value
Type
System.Drawing.Size

dfGroupViewItem

Defines the custom data format used for drag-and-drop operations involving GroupViewItem.

Declaration
protected static DataFormats.Format dfGroupViewItem
Field Value
Type
System.Windows.Forms.DataFormats.Format

GroupViewFormatName

Specifies the name of the custom System.Windows.Forms.DataFormats.Format type used for GroupViewItem drag-and-drop.

Declaration
public const string GroupViewFormatName = "GroupViewItemDataFormat"
Field Value
Type
System.String

ilLarge

Image list used for large item icons.

Declaration
protected ImageList ilLarge
Field Value
Type
System.Windows.Forms.ImageList

ilSmall

Image list used for small item icons.

Declaration
protected ImageList ilSmall
Field Value
Type
System.Windows.Forms.ImageList

itemAccessibleObjects

Provides indexed access to the accessible objects associated with each GroupViewItem.

Declaration
protected GroupViewItemAccessibleObjectsIndexer itemAccessibleObjects
Field Value
Type
GroupViewItemAccessibleObjectsIndexer

nContextMenuItem

Index of the item associated with the context menu.

Declaration
protected int nContextMenuItem
Field Value
Type
System.Int32

nDragItem

Index of the item currently being dragged.

Declaration
protected int nDragItem
Field Value
Type
System.Int32

nDropItem

Index of the item where the dragged item will be dropped.

Declaration
protected int nDropItem
Field Value
Type
System.Int32

nHighlightedItem

Index of the currently highlighted item.

Declaration
protected int nHighlightedItem
Field Value
Type
System.Int32

nImageSpacing

Horizontal spacing between text and image.

Declaration
protected int nImageSpacing
Field Value
Type
System.Int32

nItemsPerRow

Number of items displayed per row in flow view.

Declaration
protected int nItemsPerRow
Field Value
Type
System.Int32

nItemXSpacing

Horizontal spacing between items.

Declaration
protected int nItemXSpacing
Field Value
Type
System.Int32

nItemYSpacing

Vertical spacing between items.

Declaration
protected int nItemYSpacing
Field Value
Type
System.Int32

nPrevSelected

Index of the previously selected item.

Declaration
protected int nPrevSelected
Field Value
Type
System.Int32

nRenameItem

Index of the item currently being renamed.

Declaration
protected int nRenameItem
Field Value
Type
System.Int32

nScrllBttnOffset

Right offset including scroll button width.

Declaration
protected const int nScrllBttnOffset = 21
Field Value
Type
System.Int32

nSelectedItem

Index of the currently selected item.

Declaration
protected int nSelectedItem
Field Value
Type
System.Int32

nTextSpacing

Horizontal spacing between text and image.

Declaration
protected int nTextSpacing
Field Value
Type
System.Int32

nTopIndex

Index of the topmost visible item in the view.

Declaration
protected int nTopIndex
Field Value
Type
System.Int32

ptDragStart

Starting point of the drag operation.

Declaration
protected static Point ptDragStart
Field Value
Type
System.Drawing.Point

ptHighlightImageOffset

Offset for the highlighted image.

Declaration
protected Point ptHighlightImageOffset
Field Value
Type
System.Drawing.Point

ptHighlightTextOffset

Offset for the highlighted text.

Declaration
protected Point ptHighlightTextOffset
Field Value
Type
System.Drawing.Point

ptSelectedHighlightImageOffset

Offset for the selected-highlight image.

Declaration
protected Point ptSelectedHighlightImageOffset
Field Value
Type
System.Drawing.Point

ptSelectedHighlightTextOffset

Offset for the selected-highlight text.

Declaration
protected Point ptSelectedHighlightTextOffset
Field Value
Type
System.Drawing.Point

ptSelectedImageOffset

Offset for the selected image.

Declaration
protected Point ptSelectedImageOffset
Field Value
Type
System.Drawing.Point

ptSelectedTextOffset

Offset for the selected text.

Declaration
protected Point ptSelectedTextOffset
Field Value
Type
System.Drawing.Point

ptSelectingImageOffset

Offset for the selecting image.

Declaration
protected Point ptSelectingImageOffset
Field Value
Type
System.Drawing.Point

ptSelectingTextOffset

Offset for the selecting text.

Declaration
protected Point ptSelectingTextOffset
Field Value
Type
System.Drawing.Point

rcHighlightedItem

Bounds of the currently highlighted item.

Declaration
protected Rectangle rcHighlightedItem
Field Value
Type
System.Drawing.Rectangle

rcPrevSelected

Bounds of the previously selected item.

Declaration
protected Rectangle rcPrevSelected
Field Value
Type
System.Drawing.Rectangle

rcSelectedItem

Bounds of the currently selected item.

Declaration
protected Rectangle rcSelectedItem
Field Value
Type
System.Drawing.Rectangle

scrllBtnState

Current visual state of the scroll buttons.

Declaration
protected GroupView.ScrollButtonState scrllBtnState
Field Value
Type
GroupView.ScrollButtonState

tdScrollBar

Themed drawing helper for the scrollbar area.

Declaration
protected ThemedControlDrawing tdScrollBar
Field Value
Type
ThemedControlDrawing

tdToolbar

Themed drawing helper for the toolbar area.

Declaration
protected ThemedControlDrawing tdToolbar
Field Value
Type
ThemedControlDrawing

tmrScrolling

Timer used for auto-scrolling behavior.

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

Properties

AllowDragAnyObject

Gets or sets allow drag any object. For use this property AllowDragDrop must be true.

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

AllowDragDrop

Indicates whether the control supports drag-and-drop of GroupViewItem objects.

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

AllowDrop

Gets a value indicating whether the control supports drop.

Declaration
public override bool AllowDrop { get; set; }
Property Value
Type
System.Boolean

BackGroundBrush

Gets or sets the brush used for drawing the GroupView control background.

Declaration
public Brush BackGroundBrush { get; set; }
Property Value
Type Description
System.Drawing.Brush

A System.Drawing.Brush value.

BeforeTouchSize

Gets/Sets Control size before touch enabled

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

BorderStyle

Gets or sets the border style of the GroupView 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.

ButtonView

Indicates whether items are drawn with a button-type flat look upon selection.

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

True if the button-type selection is set. The default is False.

ClipSelectionBounds

Indicates whether the selection bounds of a GroupViewItem are clipped around its image and text.

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

A Boolean value. The default is False.

ContextMenuItem

Returns the index of GroupViewItem that triggered the ShowContextMenu event.

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

The zero-based index of the item.

CreateParams

Overrides the CreateParams property to customize the window styles based on the specified BorderStyle.

Declaration
protected override CreateParams CreateParams { get; }
Property Value
Type
System.Windows.Forms.CreateParams

DownScrlBtnRect

Gets the bounding rectangle for the down scroll button in the GroupView control.

Declaration
protected virtual Rectangle DownScrlBtnRect { get; }
Property Value
Type
System.Drawing.Rectangle

EnableTouchMode

Gets or Sets the touchmode

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

FlatLook

Indicates whether the GroupView 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.

FlowView

Indicates whether the flow view display mode is set.

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

True if flow view is set. The default is False.
Remarks

In the default display mode, the GroupView control items are arranged top-down in list form. In the flow mode, however, item images are arranged side by side for the full width of the control. Resizing the control will wrap the images. Text will not be displayed in this mode, unless the ShowFlowViewItemText property set to True.

FlowViewItemTextLength

Gets or sets the GroupViewItem's text length in FlowView mode.

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

An integer value.

Font

Gets or sets the System.Drawing.Font value of the GroupView control.

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

GroupViewItems

Gets / sets the collection of GroupViewItem objects in the control.

Declaration
public GroupView.GroupViewItemCollection GroupViewItems { get; set; }
Property Value
Type Description
GroupView.GroupViewItemCollection

An instance of the GroupView.GroupViewItemCollection type.

gviAccessibleObjects

Gets the indexer that provides access to the accessible objects for each GroupViewItem.

Declaration
protected GroupViewItemAccessibleObjectsIndexer gviAccessibleObjects { get; }
Property Value
Type
GroupViewItemAccessibleObjectsIndexer

HighlightedItem

Returns the GroupViewItem over which the mouse cursor is hovering.

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

The zero-based index of the item under the cursor. -1 if no item is being highlighted.

HighlightImage

Gets / sets a value indicating whether the GroupViewItem image is highlighted when the mouse is moved over it.

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

False if image highlighting is disabled. The default is True.

HighlightImageOffset

Gets or sets the distance by which the GroupViewItem image is offset when the mouse is moved over it.

Declaration
public Point HighlightImageOffset { get; set; }
Property Value
Type Description
System.Drawing.Point

A System.Drawing.Point value.

HighlightItemBrush

Gets or sets the brush used for drawing the background of the highlighted GroupViewItem.

Declaration
public Brush HighlightItemBrush { get; set; }
Property Value
Type Description
System.Drawing.Brush

A System.Drawing.Brush value.

HighlightItemColor

Gets or sets the color used for drawing the background of a GroupViewItem when the mouse is moved over it.

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

A System.Drawing.Color value.

HighlightText

Indicates whether the GroupViewItem text is highlighted when the mouse is moved over it.

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

False if text highlighting is disabled. The default is True.

HighlightTextColor

Gets or sets the color used for drawing the GroupViewItem text when the mouse is moved over it.

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

A System.Drawing.Color value.

HighlightTextOffset

Gets or sets the distance by which the GroupViewItem text is offset when the mouse is moved over it.

Declaration
public Point HighlightTextOffset { get; set; }
Property Value
Type Description
System.Drawing.Point

A System.Drawing.Point value.

ImageSpacing

Gets or sets the height between the highlighted edge of a GroupViewItem and the image.

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

An integer value.
Remarks

In FlowView mode, the ImageSpacing value also dictates the horizontal distance between the highlighted edge and the image.

IntegratedScrolling

Indicates whether scrolling should be delegated to the GroupView control's parent.

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 GroupBar control. When this option is set, the GroupView control delegates scrolling behavior to the parent GroupBar control. When IntegratedScrolling is set to False, the control provides its own scroll buttons.

See Also

ItemXSpacing

Gets / sets the horizontal distance between a GroupViewItem and the control's left border.

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

An integer value.
Remarks

This attribute is valid only when SmallImageView is True. In large image view, the items are drawn centered.

ItemYSpacing

Gets / sets the height between adjacent GroupViewItems.

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

An integer value.

LargeImageList

Gets / sets the image list containing the large (32x32) images.

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

An ImageList type.
Remarks

SmallImageList

MetroBorderColor

Gets / sets the color used for drawing the Metro style border GroupViewItem

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

A System.Drawing.Color value.

Office2016ColorScheme

Gets or sets the office2016 colorscheme

Declaration
public GroupViewOffice2016ColorScheme Office2016ColorScheme { get; set; }
Property Value
Type
GroupViewOffice2016ColorScheme

Orientation

Gets or sets GroupViev orientation.

Declaration
public GroupViewOrientation Orientation { get; set; }
Property Value
Type
GroupViewOrientation

SelectedHighlightImageOffset

Gets / sets the distance by which the selected GroupViewItem image is offset when the mouse is moved over it.

Declaration
public Point SelectedHighlightImageOffset { get; set; }
Property Value
Type Description
System.Drawing.Point

A System.Drawing.Point value.

SelectedHighlightItemColor

Gets / sets the color used for drawing the background of the selected GroupViewItem when the mouse is moved over it.

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

A System.Drawing.Color value.

SelectedHighlightTextColor

Gets / sets the color used for drawing the selected GroupViewItem text when the mouse is moved over it.

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

A System.Drawing.Color value.

SelectedHighlightTextOffset

Gets / sets the distance by which the selected GroupViewItem text is offset when the mouse is moved over it.

Declaration
public Point SelectedHighlightTextOffset { get; set; }
Property Value
Type Description
System.Drawing.Point

A System.Drawing.Point value.

SelectedImageOffset

Gets / sets the distance by which the GroupViewItem image is offset when it is selected.

Declaration
public Point SelectedImageOffset { get; set; }
Property Value
Type Description
System.Drawing.Point

A System.Drawing.Point value.

SelectedItem

Gets / sets the index of the currently selected GroupViewItem.

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

The zero-based index of the selected item. -1 if a selected item is not available.

SelectedItemBrush

Gets or sets the brush used for drawing the background of the selected GroupViewItem.

Declaration
public Brush SelectedItemBrush { get; set; }
Property Value
Type Description
System.Drawing.Brush

A System.Drawing.Brush value.

SelectedItemColor

Gets / sets the color used for drawing the background of the selected GroupViewItem.

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

A System.Drawing.Color value.

SelectedItemHighlightBrush

Gets or sets the brush used for drawing the background of the selected GroupViewItem when the mouse is moved over it.

Declaration
public Brush SelectedItemHighlightBrush { get; set; }
Property Value
Type Description
System.Drawing.Brush

A System.Drawing.Brush value.

SelectedTextColor

Gets / sets the color used for drawing the selected GroupViewItem text.

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

A System.Drawing.Color value.

SelectedTextOffset

Gets / sets the distance by which the GroupViewItem text is offset when it is selected.

Declaration
public Point SelectedTextOffset { get; set; }
Property Value
Type Description
System.Drawing.Point

A System.Drawing.Point value.

SelectingImageOffset

Gets / sets the distance by which the GroupViewItem image is offset when it is being selected.

Declaration
public Point SelectingImageOffset { get; set; }
Property Value
Type Description
System.Drawing.Point

A System.Drawing.Point value.

SelectingItemBrush

Gets or sets the brush used for drawing the background of the GroupViewItem being selected.

Declaration
public Brush SelectingItemBrush { get; set; }
Property Value
Type Description
System.Drawing.Brush

A System.Drawing.Brush value.

SelectingItemColor

Gets / sets the color used for drawing the background of the GroupViewItem being selected.

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

A System.Drawing.Color value.

SelectingTextColor

Gets / sets the color used for drawing the GroupViewItem text while it is being selected.

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

A System.Drawing.Color value.

SelectingTextOffset

Gets / sets the distance by which the GroupViewItem text is offset when it is being selected.

Declaration
public Point SelectingTextOffset { get; set; }
Property Value
Type Description
System.Drawing.Point

A System.Drawing.Point value.

ShowFlowViewItemText

Indicates whether control should show GroupViewItem text in FlowView mode.

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

True if should show text. The default is False.

ShowToolTips

Gets or sets whether tooltips for GroupViewItems should be shown or not. Use ToolTip property to get\set ToolTip text.

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

SmallImageList

Gets / sets the image list containing the small (16x16) images.

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

An ImageList type.
Remarks

LargeImageList

SmallImageView

Indicates whether the control displays items using the images in the SmallImageList.

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

True if the small image mode is set. The default is False.

Style

Gets or sets the style

Declaration
public Appearance Style { get; set; }
Property Value
Type
Appearance

TextSpacing

Gets / sets the distance between the GroupViewItem image and the text.

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

An integer value.
Remarks

In large icon mode, this attribute represents the vertical distance between the GroupViewItem image and the text, while in small icon mode, it represents the horizontal distance between the two.

TextUnderline

Indicates whether the GroupViewItem text is underlined when the mouse is moved over it.

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

True if text underlining is enabled. The default is False.

TextWrap

Indicates whether the GroupViewItem text should be wrapped.

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

True to turn on wrapping. The default is False.
Remarks

Text wrapping is available only with the large icon display mode.

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 GroupViewVisualStyle value used to customize the appearance of the GroupView.

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

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

TimerScrollInterval

Gets or sets the interval, in milliseconds, for the scrolling timer.

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

UpScrlBtnRect

Gets the bounding rectangle for the up scroll button in the GroupView control.

Declaration
protected virtual Rectangle UpScrlBtnRect { get; }
Property Value
Type
System.Drawing.Rectangle

Methods

ApplyScaleToControl(Single)

Applies the scaling

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

BringItemIntoView(Int32)

Brings the specified GroupViewItem into the visible area of the GroupView control.

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

The zero-based index of the item.

CalculateItemsPerPage()

Calculates the number of items that can be fully displayed within the control's client area.

Declaration
protected int CalculateItemsPerPage()
Returns
Type
System.Int32

CalculateItemsPerRow()

Calculates and sets the number of items that can fit in a single row based on the control's dimensions, layout orientation, and item display settings.

Declaration
protected void CalculateItemsPerRow()

CancelInplaceRenameItem()

Cancels an inplace renaming that is in progress.

Declaration
public void CancelInplaceRenameItem()
See Also

CreateAccessibilityInstance()

Creates the accessibility object for the group view control.

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

CreateGroupViewItemAccessibilityInstance(Int32)

Creates an accessibility object for a specific GroupViewItem at the given index.

Declaration
protected GroupViewItemAccessibleObject CreateGroupViewItemAccessibilityInstance(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type
GroupViewItemAccessibleObject

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

DoScroll(Boolean, Boolean)

Performs a scroll operation either upward or downward, and optionally starts a scroll timer.

Declaration
protected virtual void DoScroll(bool bscrllup, bool bsettimer)
Parameters
Type Name Description
System.Boolean bscrllup
System.Boolean bsettimer

DrawAllItems(Graphics)

Draws all visible GroupViewItem elements within the control.

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

DrawDragDropFlowInsert(Int32, Int32, GroupView.DragDropInsert, Boolean)

Draws visual indicators for drag-and-drop insertion points in flow view mode.

Declaration
protected virtual void DrawDragDropFlowInsert(int posX, int posY, GroupView.DragDropInsert insert, bool berase)
Parameters
Type Name Description
System.Int32 posX

The X-coordinate of the insertion point.
System.Int32 posY

The Y-coordinate of the insertion point.
GroupView.DragDropInsert insert

The GroupView.DragDropInsert type indicating the insertion location (Upper, Middle, Lower).
System.Boolean berase

true to erase the indicator; false to draw it.

DrawDragDropNonFlowInsert(Int32, GroupView.DragDropInsert, Boolean)

Draws visual indicators for drag-and-drop insertion points in non-flow view mode.

Declaration
protected virtual void DrawDragDropNonFlowInsert(int inspos, GroupView.DragDropInsert insert, bool berase)
Parameters
Type Name Description
System.Int32 inspos

The insertion position coordinate (X or Y depending on orientation).
GroupView.DragDropInsert insert

The GroupView.DragDropInsert type indicating the insertion location (Upper, Middle, Lower).
System.Boolean berase

true to erase the indicator; false to draw it.

DrawFlowScrollButtons(Graphics)

Draws scroll buttons for flow view mode when the total item height exceeds the client area.

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

The System.Drawing.Graphics object used for rendering.

DrawItem(Graphics, Int32, Rectangle, GroupView.ItemState)

Draws a single GroupViewItem at the specified index and location, using the given visual state.

Declaration
protected virtual void DrawItem(Graphics gph, int nindex, Rectangle rc, GroupView.ItemState state)
Parameters
Type Name Description
System.Drawing.Graphics gph
System.Int32 nindex
System.Drawing.Rectangle rc
GroupView.ItemState state

DrawItemHighlight(Graphics, Int32, Rectangle, GroupView.ItemState)

Draws the highlighting of GroupViewitem.

Declaration
protected virtual void DrawItemHighlight(Graphics gph, int nindex, Rectangle rcitem, GroupView.ItemState state)
Parameters
Type Name Description
System.Drawing.Graphics gph

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

The index of the groupViewItem.
System.Drawing.Rectangle rcitem

A System.Drawing.Rectangle value specifying the GroupViewItem bounds.
GroupView.ItemState state

The state of the item.

DrawNonFlowScrollButtons(Graphics)

Calculates item bounds and prepares scroll button rendering for non-flow view mode.

Declaration
protected virtual void DrawNonFlowScrollButtons(Graphics gfxDC)
Parameters
Type Name Description
System.Drawing.Graphics gfxDC

The System.Drawing.Graphics object used for drawing.

DrawText(Graphics, Int32, Rectangle, GroupView.ItemState)

Draws the text label for a GroupViewItem at the specified index and location, using the given visual state.

Declaration
protected virtual void DrawText(Graphics gph, int nindex, Rectangle rc, GroupView.ItemState state)
Parameters
Type Name Description
System.Drawing.Graphics gph

The System.Drawing.Graphics object used for rendering.
System.Int32 nindex

The index of the item in the VisibleItems collection.
System.Drawing.Rectangle rc

The System.Drawing.Rectangle that defines the item's drawing bounds.
GroupView.ItemState state

The GroupView.ItemState representing the visual state of the item (e.g, normal, selected, highlighted).

FireGroupViewItemSelectedEvent(Int32)

Raises the GroupViewItemSelected event for the specified item index.

Declaration
protected void FireGroupViewItemSelectedEvent(int nindex)
Parameters
Type Name Description
System.Int32 nindex

GetAdjustedHighlightBounds(Int32, Rectangle)

Calculates and returns the adjusted highlight bounds for a GroupViewItem based on its index and current visual settings.

Declaration
protected Rectangle GetAdjustedHighlightBounds(int nindex, Rectangle rchighlight)
Parameters
Type Name Description
System.Int32 nindex

The index of the item in the VisibleItems collection.
System.Drawing.Rectangle rchighlight

The original highlight bounds to be adjusted.
Returns
Type
System.Drawing.Rectangle

GetAdjustedTextBounds(Int32, Rectangle)

Calculates and returns the adjusted text bounds for a GroupViewItem based on its index and layout settings.

Declaration
protected virtual Rectangle GetAdjustedTextBounds(int nindex, Rectangle rcItem)
Parameters
Type Name Description
System.Int32 nindex

The index of the item in the VisibleItems collection.
System.Drawing.Rectangle rcItem

The original bounds of the item.
Returns
Type
System.Drawing.Rectangle

GetControlName(String)

Helps to apply the ControlName settings for GroupView.

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

ControlName
Returns
Type
System.String
Overrides

GetGroupViewItemBounds(Int32, String)

Retrieves the bounding rectangle of a specific item in the group view, based on the item index and requested type.

Declaration
protected Rectangle GetGroupViewItemBounds(int nindex, string type)
Parameters
Type Name Description
System.Int32 nindex

The index of the item within the visible items list.
System.String type
Returns
Type
System.Drawing.Rectangle

GetIsMirrored()

Determines whether the control is displayed in a mirrored (right-to-left) layout.

Declaration
protected bool GetIsMirrored()
Returns
Type
System.Boolean

GetItemAt(Point)

Get GroupViewItem which is under mouse pointer

Declaration
public GroupViewItem GetItemAt(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt

Represent mouse pointer
Returns
Type
GroupViewItem

GetItemUnderPoint(Point)

Performs hit testing to determine which item is located under the specified point.

Declaration
public int GetItemUnderPoint(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt
Returns
Type
System.Int32

GroupView_RenameComplete(Object, RenameCompleteEventArgs)

Handles the completion of a rename operation for a GroupViewItem.

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

The source of the event, typically the control initiating the rename.
RenameCompleteEventArgs arg

A RenameCompleteEventArgs containing the new name and related data.

GroupView_TextChanged(Object, EventArgs)

Handles the TextChanged event of the text box used for renaming a GroupViewItem.

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

The source of the event, typically the text box control.
System.EventArgs e

An System.EventArgs that contains the event data.

HandleMouseDown(MouseButtons, Point)

Handles mouse down events within the control, including focus management, scroll button interaction, and tooltip behavior.

Declaration
protected virtual void HandleMouseDown(MouseButtons button, Point pt)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button

The mouse button that was pressed.
System.Drawing.Point pt

The location of the mouse pointer in client coordinates.

HandleMouseUp(MouseButtons, Point)

Handles mouse button release events within the control, including scroll behavior, item selection, context menu invocation, and drag-drop state reset.

Declaration
protected virtual void HandleMouseUp(MouseButtons button, Point pt)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button

The mouse button that was released.
System.Drawing.Point pt

The location of the mouse pointer in client coordinates.

InplaceRenameItem(Int32)

Starts an in-place edit of the specified GroupViewItem 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 populate it with the item text. Editing the textbox contents and selecting ENTER will update the item text. Selecting ESC will cancel the edit.

See Also

IsMouseOverItem(Int32, Rectangle, Point)

Determines whether the mouse pointer is currently over the specified GroupViewItem.

Declaration
protected bool IsMouseOverItem(int nindex, Rectangle rchighlight, Point ptmouse)
Parameters
Type Name Description
System.Int32 nindex

The index of the item in the VisibleItems collection.
System.Drawing.Rectangle rchighlight

The bounding rectangle of the item.
System.Drawing.Point ptmouse

The current mouse position in client coordinates.
Returns
Type
System.Boolean

Layout()

Arranges the layout of visible GroupViewItem elements within the GroupView control.

Declaration
protected virtual void Layout()

MeasureText(Int32, Rectangle)

Measures the size of the text for a GroupViewItem at the specified index within the given bounds.

Declaration
protected SizeF MeasureText(int nindex, Rectangle rc)
Parameters
Type Name Description
System.Int32 nindex

The index of the item in the VisibleItems collection.
System.Drawing.Rectangle rc

The System.Drawing.Rectangle representing the area in which the text will be measured.
Returns
Type
System.Drawing.SizeF

OnBackColorChanged(EventArgs)

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

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

OnClick(EventArgs)

Handles the Click event for the control.

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

An System.EventArgs that contains the event data.

OnDragDrop(DragEventArgs)

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

Declaration
protected override void OnDragDrop(DragEventArgs drgevent)
Parameters
Type Name Description
System.Windows.Forms.DragEventArgs drgevent

OnDragEnter(DragEventArgs)

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

Declaration
protected override void OnDragEnter(DragEventArgs drgevent)
Parameters
Type Name Description
System.Windows.Forms.DragEventArgs drgevent

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 drgevent)
Parameters
Type Name Description
System.Windows.Forms.DragEventArgs drgevent

OnFontChanged(EventArgs)

Font changed

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

OnForeColorChanged(EventArgs)

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

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

OnGroupViewItemDoubleClick(GroupViewItemDoubleClickEventArgs)

Raises the GroupView Item double click event.

Declaration
protected virtual void OnGroupViewItemDoubleClick(GroupViewItemDoubleClickEventArgs arg)
Parameters
Type Name Description
GroupViewItemDoubleClickEventArgs arg

GroupViewItemDoubleClickEventArgs

OnGroupViewItemHighlighted(EventArgs)

Raises the GroupViewItemHighlighted event.

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

A System.EventArgs value that contains the event data.

OnGroupViewItemRenamed(GroupItemRenamedEventArgs)

Raises the GroupViewItemRenamed event.

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

A GroupItemRenamedEventArgs value that contains the event data.

OnGroupViewItemSelected(EventArgs)

Raises the GroupViewItemSelected event.

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

A System.EventArgs value that contains the event data.

OnGroupViewItemsReordered(EventArgs)

Raises the GroupViewItemsReordered event.

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

A System.EventArgs value that contains the event data.

OnLostFocus(EventArgs)

Handles the LostFocus event for the control.

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
Type Name Description
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

OnMouseHover(EventArgs)

Called by the tab control when mouse hovers on the control.

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

The System.EventArgs instance containing the event data.

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

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

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

OnMouseWheel(MouseEventArgs)

Handles the MouseWheel event to scroll through items in the group view.

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

A System.Windows.Forms.MouseEventArgs that contains the mouse wheel 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

OnPaintBackground(PaintEventArgs)

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

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

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)

Size changed

Declaration
protected override void OnSizeChanged(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

PointToItem(Point)

Returns GroupViewItem at the specified point in client coordinates.

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

Point where the GroupViewItem is located.
Returns
Type Description
GroupViewItem

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

PointToItem(Int32, Int32)

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

Declaration
public GroupViewItem 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
GroupViewItem

GroupViewItem, whose area contains specified point; null, if nothing is found.

ProcessCmdKey(ref Message, Keys)

Overrides the default command key processing to enable keyboard navigation within the group view.

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

A System.Windows.Forms.Message representing the Windows message.
System.Windows.Forms.Keys keydata

A System.Windows.Forms.Keys value representing the key that was pressed.
Returns
Type
System.Boolean

ProcessDragDrop(MouseActions, Point)

Handles drag-and-drop visual feedback by drawing or erasing insertion indicators based on the current mouse action and position.

Declaration
protected virtual void ProcessDragDrop(MouseActions action, Point pt)
Parameters
Type Name Description
MouseActions action

The MouseActions representing the type of mouse interaction (e.g., Leave, Move).
System.Drawing.Point pt

The System.Drawing.Point representing the current mouse position in client coordinates.

ProcessMouseOver(Point)

Determines whether the mouse pointer is currently hovering over a GroupViewItem and updates the highlight state accordingly.

Declaration
protected virtual int ProcessMouseOver(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt

The System.Drawing.Point representing the mouse location in client coordinates.
Returns
Type
System.Int32

PropChangedHandler(Object, PropertyChangedEventArgs)

Handles property change notifications for GroupViewItem instances.

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

The object that raised the property change event.
System.ComponentModel.PropertyChangedEventArgs args

The System.ComponentModel.PropertyChangedEventArgs containing the name of the changed property.

ResetHighlightImageOffset()

Resets the HighlightImageOffset property to its default value.

Declaration
public void ResetHighlightImageOffset()

ResetHighlightItemColor()

Resets the HighlightItemColor property to its default value.

Declaration
public void ResetHighlightItemColor()

ResetHighlightTextColor()

Resets the HighlightTextColor property to its default value.

Declaration
public void ResetHighlightTextColor()

ResetHighlightTextOffset()

Resets the HighlightTextOffset property to its default value.

Declaration
public void ResetHighlightTextOffset()

ResetMetroBorderColor()

Resets the MetroBorderColor property to its default value.

Declaration
public void ResetMetroBorderColor()

ResetSelectedHighlightImageOffset()

Resets the SelectedHighlightImageOffset property to its default value.

Declaration
public void ResetSelectedHighlightImageOffset()

ResetSelectedHighlightItemColor()

Resets the SelectedHighlightItemColor property to its default value.

Declaration
public void ResetSelectedHighlightItemColor()

ResetSelectedHighlightTextColor()

Resets the SelectedHighlightTextColor property to its default value.

Declaration
public void ResetSelectedHighlightTextColor()

ResetSelectedHighlightTextOffset()

Resets the SelectedHighlightTextOffset property to its default value.

Declaration
public void ResetSelectedHighlightTextOffset()

ResetSelectedImageOffset()

Resets the SelectedImageOffset property to its default value.

Declaration
public void ResetSelectedImageOffset()

ResetSelectedItemColor()

Resets the SelectedItemColor property to its default value.

Declaration
public void ResetSelectedItemColor()

ResetSelectedTextColor()

Resets the SelectedTextColor property to its default value.

Declaration
public void ResetSelectedTextColor()

ResetSelectedTextOffset()

Resets the SelectedTextOffset property to its default value.

Declaration
public void ResetSelectedTextOffset()

ResetSelectingImageOffset()

Resets the SelectingImageOffset property to its default value.

Declaration
public void ResetSelectingImageOffset()

ResetSelectingItemColor()

Resets the SelectingItemColor property to its default value.

Declaration
public void ResetSelectingItemColor()

ResetSelectingTextColor()

Resets the SelectingTextColor property to its default value.

Declaration
public void ResetSelectingTextColor()

ResetSelectingTextOffset()

Resets the SelectingTextOffset property to its default value.

Declaration
public void ResetSelectingTextOffset()

ScrollButtonsMouseHandler(MouseActions, Point)

Handles mouse interactions with the scroll buttons, updating their visual state and triggering scroll actions.

Declaration
protected virtual void ScrollButtonsMouseHandler(MouseActions action, Point pt)
Parameters
Type Name Description
MouseActions action

The MouseActions representing the type of mouse interaction (e.g., LBtnDown, Move, Leave).
System.Drawing.Point pt

The System.Drawing.Point representing the current mouse position in client coordinates.

ScrollTimerEventHandler(Object, EventArgs)

Handles the timer event for scrolling actions triggered by cursor position.

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

The source of the event. Typically unused in this context.
System.EventArgs args

An System.EventArgs object that contains the event data.

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

SetFlowItemBounds(Int32, ref Rectangle)

Calculates and sets the bounding rectangle for a GroupViewItem in flow view mode at the specified index.

Declaration
protected virtual void SetFlowItemBounds(int nindex, ref Rectangle rchighlight)
Parameters
Type Name Description
System.Int32 nindex

The index of the item in the VisibleItems collection.
System.Drawing.Rectangle rchighlight

A reference to the System.Drawing.Rectangle that will be updated within the item's bounds.

SetNonFlowItemBounds(Int32, ref Rectangle)

Calculates and sets the bounding rectangle for a non-flow view GroupViewItem at the specified index.

Declaration
protected virtual void SetNonFlowItemBounds(int nindex, ref Rectangle rchilight)
Parameters
Type Name Description
System.Int32 nindex

The index of the item in the VisibleItems collection.
System.Drawing.Rectangle rchilight

A reference to the System.Drawing.Rectangle that will be updated with the item's bounds.

ShouldSerializeHighlightImageOffset()

Determines whether the HighlightImageOffset property should be serialized.

Declaration
protected bool ShouldSerializeHighlightImageOffset()
Returns
Type
System.Boolean

ShouldSerializeHighlightItemColor()

Determines whether the HighlightItemSet property should be serialized.

Declaration
protected bool ShouldSerializeHighlightItemColor()
Returns
Type
System.Boolean

ShouldSerializeHighlightTextColor()

Determines whether the HighlightTextSet property should be serialized.

Declaration
protected bool ShouldSerializeHighlightTextColor()
Returns
Type
System.Boolean

ShouldSerializeHighlightTextOffset()

Determines whether the HighlightTextOffset property should be serialized.

Declaration
protected bool ShouldSerializeHighlightTextOffset()
Returns
Type
System.Boolean

ShouldSerializeMetroBorderColor()

Determines whether the MetroBorderColor property should be serialized.

Declaration
protected bool ShouldSerializeMetroBorderColor()
Returns
Type
System.Boolean

ShouldSerializeSelectedHighlightImageOffset()

Determines whether the SelectedHighlightImageOffset property should be serialized.

Declaration
protected bool ShouldSerializeSelectedHighlightImageOffset()
Returns
Type
System.Boolean

ShouldSerializeSelectedHighlightItemColor()

Determines whether the SelectedHighlightItemSet property should be serialized.

Declaration
protected bool ShouldSerializeSelectedHighlightItemColor()
Returns
Type
System.Boolean

ShouldSerializeSelectedHighlightTextColor()

Determines whether the SelectedHighlightTextSet property should be serialized.

Declaration
protected bool ShouldSerializeSelectedHighlightTextColor()
Returns
Type
System.Boolean

ShouldSerializeSelectedHighlightTextOffset()

Determines whether the SelectedHighlightTextOffset property should be serialized.

Declaration
protected bool ShouldSerializeSelectedHighlightTextOffset()
Returns
Type
System.Boolean

ShouldSerializeSelectedImageOffset()

Determines whether the SelectedImgaeOffset property should be serialized.

Declaration
protected bool ShouldSerializeSelectedImageOffset()
Returns
Type
System.Boolean

ShouldSerializeSelectedItemColor()

Determines whether the SelectedItemSet property should be serialized.

Declaration
protected bool ShouldSerializeSelectedItemColor()
Returns
Type
System.Boolean

ShouldSerializeSelectedTextColor()

Determines whether the SelectedTextSet property should be serialized.

Declaration
protected bool ShouldSerializeSelectedTextColor()
Returns
Type
System.Boolean

ShouldSerializeSelectedTextOffset()

Determines whether the SelectedTextOffset property should be serialized.

Declaration
protected bool ShouldSerializeSelectedTextOffset()
Returns
Type
System.Boolean

ShouldSerializeSelectingImageOffset()

Determines whether the SelectingImageOffset property should be serialized.

Declaration
protected bool ShouldSerializeSelectingImageOffset()
Returns
Type
System.Boolean

ShouldSerializeSelectingItemColor()

Determines whether the SelectingItemSet property should be serialized.

Declaration
protected bool ShouldSerializeSelectingItemColor()
Returns
Type
System.Boolean

ShouldSerializeSelectingTextColor()

Determines whether the SelectingTextSet property should be serialized.

Declaration
protected bool ShouldSerializeSelectingTextColor()
Returns
Type
System.Boolean

ShouldSerializeSelectingTextOffset()

Determines whether the SelectingTextOffset property should be serialized.

Declaration
protected bool ShouldSerializeSelectingTextOffset()
Returns
Type
System.Boolean

ShowToolTip(String)

Shows ToolTip

Declaration
protected void ShowToolTip(string text)
Parameters
Type Name Description
System.String text

A string value representing ToolTip's text

StartShowingToolTip(Int32)

Start showing tooltips

Declaration
protected void StartShowingToolTip(int interval)
Parameters
Type Name Description
System.Int32 interval

Representint interval before showing ToolTip

StopShowingToolTip()

Stops showing tooltips

Declaration
protected void StopShowingToolTip()

WndProc(ref Message)

Overrides the window procedure to handle mouse button down messages for tooltip interaction.

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

Events

GroupViewItemDoubleClick

Occurs when a GroupViewItem is double clicked.

Declaration
public event GroupViewItemDoubleClickEventHandler GroupViewItemDoubleClick
Event Type
Type
GroupViewItemDoubleClickEventHandler

GroupViewItemHighlighted

Occurs when a GroupViewItem in the GroupView control is highlighted.

Declaration
public event EventHandler GroupViewItemHighlighted
Event Type
Type
System.EventHandler
Remarks

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

GroupViewItemRenamed

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

Declaration
public event GroupItemRenamedEventHandler GroupViewItemRenamed
Event Type
Type
GroupItemRenamedEventHandler
Remarks

See GroupItemRenamedEventArgs and GroupItemRenamedEventHandler.

See Also

GroupViewItemSelected

Occurs when a GroupViewItem in the GroupView control is selected.

Declaration
public event EventHandler GroupViewItemSelected
Event Type
Type
System.EventHandler
Remarks

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

GroupViewItemsReordered

Occurs after the items in a GroupView control have been reordered by a drag-and-drop operation.

Declaration
public event EventHandler GroupViewItemsReordered
Event Type
Type
System.EventHandler

ShowContextMenu

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

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

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

Explicit Interface Implementations

IGroupViewDesignerInvoke.HandleMouseDown(MouseButtons, Point)

Declaration
void IGroupViewDesignerInvoke.HandleMouseDown(MouseButtons button, Point pt)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button
System.Drawing.Point pt

IGroupViewDesignerInvoke.HandleMouseUp(MouseButtons, Point)

Declaration
void IGroupViewDesignerInvoke.HandleMouseUp(MouseButtons button, Point pt)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button
System.Drawing.Point pt

IIntegratedScrollClient.DownScrollButtonPressed()

Declaration
void IIntegratedScrollClient.DownScrollButtonPressed()

IIntegratedScrollClient.IsDownScrollButtonEnabled()

Declaration
bool IIntegratedScrollClient.IsDownScrollButtonEnabled()
Returns
Type
System.Boolean

IIntegratedScrollClient.IsUpScrollButtonEnabled()

Declaration
bool IIntegratedScrollClient.IsUpScrollButtonEnabled()
Returns
Type
System.Boolean

IIntegratedScrollClient.UpScrollButtonPressed()

Declaration
void IIntegratedScrollClient.UpScrollButtonPressed()

Implements

System.IDisposable

See Also