Class GridTableControl

Represents a grid control that displays rows with DisplayElements of a GridTable and allows grouping and filtering of records and editing, deleting, and adding of records.

Inheritance
System.Object
BaseControl
ScrollControl
GridControlBase
GridTableControl
GridNestedTableControl
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridTableControl : GridControlBase, IDisposable, ICancelModeProvider, ISplitterPaneSupport, IScrollBarWrapperContainer, ISupportUpdating, ISupportIntelliMouse, IQueryFocusInside, INonClientPaintingSupport, IThemedControl, ICreateNewWindow, IGridModelSource, IGridWindowlessSite, IGridWindowlessObject, IFindParentForm, IThemeProvider, IVisualStyle, ITableProvider

Constructors

GridTableControl(GridModel)

Initializes a new control.

Declaration
public GridTableControl(GridModel model)
Parameters
Type Name Description
GridModel model

The model for this control.

Properties

CellToolTip

Returns a reference to the ToolTip object used for displaying CellTipText as ToolTips for cells.

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

FilterColName

Gets or sets the filtered column name.

Declaration
public static Dictionary<string, string> FilterColName { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.String>

GroupDropArea

Gets or sets the GridGroupDropArea of the GridGroupingControl.

Declaration
public GridGroupDropArea GroupDropArea { get; set; }
Property Value
Type Description
GridGroupDropArea

GroupingControl

Returns the GridGroupingControl that hosts this control.

Declaration
public GridGroupingControl GroupingControl { get; }
Property Value
Type Description
GridGroupingControl

HasTable

Gets whether the Table property has been assigned.

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

HScrollIncrement

Gets or sets the multiplier for the mouse wheel scrolling.

Declaration
public override int HScrollIncrement { get; set; }
Property Value
Type Description
System.Int32
Overrides

Initialized

Gets whether the Initialize() method was called.

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

InSynchronizeCurrentCellWithRecord

Internal only.

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

InSynchronizeGridWithEngine

Internal only.

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

Model

The model for this view.

Declaration
public GridTableModel Model { get; set; }
Property Value
Type Description
GridTableModel

PaintSelectCells

Used internally.

Declaration
public override IGridPaintSelectCells PaintSelectCells { get; }
Property Value
Type Description
IGridPaintSelectCells
Overrides

PaneDesc

Returns the pane information.

Declaration
public override string PaneDesc { get; }
Property Value
Type Description
System.String
Overrides

Provider

Gets the value of the grouping grid UIA provider

Declaration
public GroupingGridUIAProvider Provider { get; }
Property Value
Type Description
GroupingGridUIAProvider

SelectRecords

Handles the multiple record selection behavior of the control.

Declaration
public GridTableControlSelectRecords SelectRecords { get; }
Property Value
Type Description
GridTableControlSelectRecords

Table

The GridTable that this control is showing.

Declaration
public GridTable Table { get; set; }
Property Value
Type Description
GridTable

TableDescriptor

The GridTableDescriptor that this control is showing.

Declaration
public GridTableDescriptor TableDescriptor { get; }
Property Value
Type Description
GridTableDescriptor

VScrollIncrement

Gets or sets the multiplier for mouse wheel scrolling.

Declaration
public override int VScrollIncrement { get; set; }
Property Value
Type Description
System.Int32
Overrides

WantTabKey

Indicates if the grid control should handle tab keys to move between cells. Set this to False if focus should move to the next control in the form instead.

Declaration
public override bool WantTabKey { get; set; }
Property Value
Type Description
System.Boolean
Overrides

Methods

CreateCellToolTip()

Creates and initializes a ToolTip object. InitialDelay will be 500 and ReshowDelay will be set to 0 by default.

Declaration
protected virtual ToolTip CreateCellToolTip()
Returns
Type Description
System.Windows.Forms.ToolTip

The initialized ToolTip object for this grid.

CreateNewControl(Control, Int32, Int32)

Creates a new table control.

Declaration
public override Control CreateNewControl(Control parent, int row, int column)
Parameters
Type Name Description
System.Windows.Forms.Control parent

The parent control.
System.Int32 row

Row index.
System.Int32 column

Column index.
Returns
Type Description
System.Windows.Forms.Control

The new table control.
Overrides

Dispose(Boolean)

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

DrawErrorIcon(GridDrawCellEventArgs, GridIconPaint)

Overridden to restrict the error icon drawing for nested table on certain condition.

Declaration
protected override void DrawErrorIcon(GridDrawCellEventArgs e, GridIconPaint iconPainter)
Parameters
Type Name Description
GridDrawCellEventArgs e

A GridDrawCellEventArgs that contains the event data.
GridIconPaint iconPainter

The icon painter to draw the error icon.
Overrides

DrawInvertCell(Graphics, Int32, Int32, Rectangle, Boolean)

Declaration
protected override void DrawInvertCell(Graphics g, int rowIndex, int colIndex, Rectangle rectItem, bool inPaint)
Parameters
Type Name Description
System.Drawing.Graphics g
System.Int32 rowIndex
System.Int32 colIndex
System.Drawing.Rectangle rectItem
System.Boolean inPaint
Overrides

ElementToRectangle(Element)

Returns the display area for the specified element.

Declaration
public Rectangle ElementToRectangle(Element element)
Parameters
Type Name Description
Element element

The element
Returns
Type Description
System.Drawing.Rectangle

Rectangle.Empty if element is not visible; otherwise, the display area in client coordinates

ElementToRectangle(Element, GridCellSizeKind)

Returns the display area for the specified element.

Declaration
public Rectangle ElementToRectangle(Element element, GridCellSizeKind sizeKind)
Parameters
Type Name Description
Element element

The elements
GridCellSizeKind sizeKind

Specifies how to handle the the top-most row when pixel scrolling is enabled and cells are only partially visible.
Returns
Type Description
System.Drawing.Rectangle

Rectangle.Empty if element is not visible; otherwise, the display area in client coordinates

Focus()

Sets input focus to the control.

Declaration
public override bool Focus()
Returns
Type Description
System.Boolean

True if the control is focused.
Overrides

GetBackgroundColor()

Gets the background color of the grid.

Declaration
public override Color GetBackgroundColor()
Returns
Type Description
System.Drawing.Color

Grid background color.
Overrides

GetCellRange(Element, String)

Returns the cell coordinates for a given element and field in a record.

Declaration
public GridRangeInfo GetCellRange(Element el, string fieldName)
Parameters
Type Name Description
Element el

The element.
System.String fieldName

The name of the field.
Returns
Type Description
GridRangeInfo

Cell coordinates.

GetCurrentCell()

Returns the GridCurrentCell object.

Declaration
protected override GridCurrentCell GetCurrentCell()
Returns
Type Description
GridCurrentCell

The CurrentCell.
Overrides

GetDefaultMaxStandardValuesSize()

Returns the default maximum size for the drop-down part of a StandardValuesCell.

Declaration
protected override Size GetDefaultMaxStandardValuesSize()
Returns
Type Description
System.Drawing.Size

returns the table size
Overrides

GetHeaderColumnDescriptorAt(Point)

Determines the GridColumnDescriptor displayed at the specified point if it is a header cell.

Declaration
public GridColumnDescriptor GetHeaderColumnDescriptorAt(Point point)
Parameters
Type Name Description
System.Drawing.Point point

The point in device coordinates.
Returns
Type Description
GridColumnDescriptor

The GridColumnDescriptor displayed at the specified point if it is a header cell; NULL otherwise.

GetHScrollPixelWidth()

Gets the total width of the grid for pixel scrolling.

Declaration
public override int GetHScrollPixelWidth()
Returns
Type Description
System.Int32

Total grid width.
Overrides

GetMaximumPossibleTopRow(out Rectangle)

Gets the smallest value to be used as TopRowIndex.

Declaration
public override int GetMaximumPossibleTopRow(out Rectangle rectMove)
Parameters
Type Name Description
System.Drawing.Rectangle rectMove

Returns the rectangle with scroll bounds for the grid.
Returns
Type Description
System.Int32

Maximum top row index.
Overrides

GetNestedCurrentCell()

Returns the CurrentCell object or if the current cell is a nested table, returns the CurrentCell of the GridNestedTableControl.

Declaration
public GridCurrentCell GetNestedCurrentCell()
Returns
Type Description
GridCurrentCell

The most inner GridCurrentCell object.

GetRowHidden(Int32)

Determines if a specified row is hidden in the current grid view.

Declaration
public override bool GetRowHidden(int rowIndex)
Parameters
Type Name Description
System.Int32 rowIndex

The row index.
Returns
Type Description
System.Boolean

True if row should be hidden; False otherwise.
Overrides

GetRowRangeHeight(Int32, Int32, Int32)

Gets the row height for the given range of rows.

Declaration
public override int GetRowRangeHeight(int fromRowIndex, int toRowIndex, int maxSize)
Parameters
Type Name Description
System.Int32 fromRowIndex

The first row.
System.Int32 toRowIndex

The last row.
System.Int32 maxSize

Abort calculation if height is greater than this value.
Returns
Type Description
System.Int32

Returns the row height.
Overrides

GetScrollOutOfViewCurrentCellState(out GridCellRendererBase, out Control, out Rectangle, out Int32, out Int32, GridDirectionType)

Declaration
protected override void GetScrollOutOfViewCurrentCellState(out GridCellRendererBase cellRenderer, out Control cellControl, out Rectangle currentCellBounds, out int currentCellRowIndex, out int currentCellColIndex, GridDirectionType direction)
Parameters
Type Name Description
GridCellRendererBase cellRenderer
System.Windows.Forms.Control cellControl
System.Drawing.Rectangle currentCellBounds
System.Int32 currentCellRowIndex
System.Int32 currentCellColIndex
GridDirectionType direction
Overrides

GetTable()

Used internally.

Declaration
public Table GetTable()
Returns
Type Description
Table

returns the table

GetTableControlWindow()

Returns the parent control that has a window handle.

Declaration
public GridTableControl GetTableControlWindow()
Returns
Type Description
GridTableControl

This control or the parent control that has a window handle if this control is windowless.

GetTableViewStyleInfo(Int32, Int32)

This virtual method is called from GetViewStyleInfo. It creates a temporary GridTableCellStyleInfo object and raises the PrepareViewStyleInfo event to allow custom formatting of a cell by changing its style object just before it is drawn.

Declaration
public virtual GridTableCellStyleInfo GetTableViewStyleInfo(int rowIndex, int colIndex)
Parameters
Type Name Description
System.Int32 rowIndex

The row index.
System.Int32 colIndex

The column index.
Returns
Type Description
GridTableCellStyleInfo

The style object.

GetViewStyleInfo(Int32, Int32, Boolean)

Queries cell information that includes custom formatting with respect to current view state.

Declaration
public override sealed GridStyleInfo GetViewStyleInfo(int rowIndex, int colIndex, bool forceQueryCellInfo)
Parameters
Type Name Description
System.Int32 rowIndex

Row index.
System.Int32 colIndex

Column index.
System.Boolean forceQueryCellInfo

For the QueryCellInfo to be called and not cache the styles.
Returns
Type Description
GridStyleInfo

The GridStyleInfo object that holds cell information.
Overrides

GetVScrollPixelHeight()

Gets the total height of all rows in the grid.

Declaration
public override int GetVScrollPixelHeight()
Returns
Type Description
System.Int32

Total row height.
Overrides

HandleDeleteKey()

Called when Delete key is pressed. Default implementation deletes selected records.

Declaration
public virtual bool HandleDeleteKey()
Returns
Type Description
System.Boolean

true if records were deleted; false if no action was necessary.

HandleEnterKey()

Called when Enter key is pressed grid is validated. Default implementation commits current record changes.

Declaration
public virtual bool HandleEnterKey()
Returns
Type Description
System.Boolean

true if changes were saved; false if no action was necessary.

HandleEscapeKey()

Called when Escape key is pressed. Default implementation discards current record changes.

Declaration
public virtual bool HandleEscapeKey()
Returns
Type Description
System.Boolean

true if changes were discarded; false if no action was necessary.

Initialize()

Initializes the control.

Declaration
public override void Initialize()
Overrides

InitializeMouseControllers()

Declaration
protected override void InitializeMouseControllers()
Overrides

InitLayout()

Declaration
protected override void InitLayout()
Overrides

IntUpdateSelectRange()

Declaration
protected override void IntUpdateSelectRange()
Overrides

Invalidate()

Invalidates the control.

Declaration
public override void Invalidate()
Overrides

Invalidate(Rectangle)

Invalidates the specified area of the control.

Declaration
public override void Invalidate(Rectangle rc)
Parameters
Type Name Description
System.Drawing.Rectangle rc

Area to invalidate.
Overrides

Invalidate(Rectangle, Boolean)

Invalidates the specified region of the control.

Declaration
public override void Invalidate(Rectangle rc, bool invalidateChildren)
Parameters
Type Name Description
System.Drawing.Rectangle rc

Area to invalidate.
System.Boolean invalidateChildren

Specifies if child controls should also be invalidated.
Overrides

InvalidateDeactivatedCurrentCell(Int32, Int32, Rectangle)

Declaration
protected override void InvalidateDeactivatedCurrentCell(int rowIndex, int colIndex, Rectangle savedBounds)
Parameters
Type Name Description
System.Int32 rowIndex
System.Int32 colIndex
System.Drawing.Rectangle savedBounds
Overrides

InvalidateElement(Element)

Invalidates the display area for the specified element.

Declaration
public void InvalidateElement(Element element)
Parameters
Type Name Description
Element element

Element to invalidate.

InvalidateRecordColumn(Record, GridColumnDescriptor)

Invalidates the display area for a given record and column.

Declaration
public void InvalidateRecordColumn(Record record, GridColumnDescriptor column)
Parameters
Type Name Description
Record record

The record
GridColumnDescriptor column

The ColumnDescriptor

InvalidateRecordField(Record, String)

Invalidates the display area for a given record and field.

Declaration
public void InvalidateRecordField(Record record, string fieldName)
Parameters
Type Name Description
Record record

The record
System.String fieldName

The field (FieldDescriptor.Name or ColumnDescriptor.MappingName)

IsElementVisible(Element)

Determines if the specified element is visible and scrolled into view

Declaration
public bool IsElementVisible(Element element)
Parameters
Type Name Description
Element element

The element.
Returns
Type Description
System.Boolean

True if it is visible.

MarkResync()

Forces the grid to synchronize itself with changes in the underlying Table the next time an Idle message is received or any Window message is processed.

Declaration
public void MarkResync()

MarkResync(Boolean)

Forces the grid to synchronize itself with changes in the underlying Table the next time an Idle message is received or any Window message is processed.

Declaration
public void MarkResync(bool resetWidth)
Parameters
Type Name Description
System.Boolean resetWidth

Specifies if the width should be reset.

NotifyCellHighlighted(Int32, Int32, GridStyleInfo)

Notifies the grid about the temporary state of the cell.

Declaration
public override void NotifyCellHighlighted(int rowIndex, int colIndex, GridStyleInfo style)
Parameters
Type Name Description
System.Int32 rowIndex

Row index.
System.Int32 colIndex

Column index.
GridStyleInfo style

Cell style information.
Overrides

NotifyCurrentCellChanged()

Declaration
protected override void NotifyCurrentCellChanged()
Overrides

OnActivateToolTip(GridActivateToolTipEventArgs)

Raises the ActivateToolTip event.

Declaration
protected virtual void OnActivateToolTip(GridActivateToolTipEventArgs e)
Parameters
Type Name Description
GridActivateToolTipEventArgs e

A GridActivateToolTipEventArgs that contains the event data.

OnAutoScrollingChanged(EventArgs)

Raise the OnAutoScrollingChanging method.

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

A System.EventArgs that contains the event data.
Overrides

OnBeforePaint(EventArgs)

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

OnCellButtonClicked(GridCellButtonClickedEventArgs)

Declaration
protected override void OnCellButtonClicked(GridCellButtonClickedEventArgs e)
Parameters
Type Name Description
GridCellButtonClickedEventArgs e
Overrides

OnCellClick(GridCellClickEventArgs)

Declaration
protected override void OnCellClick(GridCellClickEventArgs e)
Parameters
Type Name Description
GridCellClickEventArgs e
Overrides

OnCellDoubleClick(GridCellClickEventArgs)

Declaration
protected override void OnCellDoubleClick(GridCellClickEventArgs e)
Parameters
Type Name Description
GridCellClickEventArgs e
Overrides

OnCellDrawn(GridDrawCellEventArgs)

Declaration
protected override void OnCellDrawn(GridDrawCellEventArgs e)
Parameters
Type Name Description
GridDrawCellEventArgs e
Overrides

OnControlGotFocus()

Declaration
protected override void OnControlGotFocus()
Overrides

OnCurrentCellAcceptedChanges(CancelEventArgs)

Declaration
protected override void OnCurrentCellAcceptedChanges(CancelEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs e
Overrides

OnCurrentCellActivated(EventArgs)

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

OnCurrentCellActivateFailed(GridCurrentCellActivateFailedEventArgs)

Declaration
protected override void OnCurrentCellActivateFailed(GridCurrentCellActivateFailedEventArgs e)
Parameters
Type Name Description
GridCurrentCellActivateFailedEventArgs e
Overrides

OnCurrentCellActivating(GridCurrentCellActivatingEventArgs)

Declaration
protected override void OnCurrentCellActivating(GridCurrentCellActivatingEventArgs e)
Parameters
Type Name Description
GridCurrentCellActivatingEventArgs e
Overrides

OnCurrentCellChanged(EventArgs)

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

OnCurrentCellChanging(CancelEventArgs)

Declaration
protected override void OnCurrentCellChanging(CancelEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs e
Overrides

OnCurrentCellCloseDropDown(PopupClosedEventArgs)

Declaration
protected override void OnCurrentCellCloseDropDown(PopupClosedEventArgs e)
Parameters
Type Name Description
PopupClosedEventArgs e
Overrides

OnCurrentCellConfirmChangesFailed(EventArgs)

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

OnCurrentCellControlGotFocus(ControlEventArgs)

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

OnCurrentCellDeactivateFailed(EventArgs)

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

OnCurrentCellDeactivating(CancelEventArgs)

Declaration
protected override void OnCurrentCellDeactivating(CancelEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs e
Overrides

OnCurrentCellKeyDown(KeyEventArgs)

User pressed key down.

Declaration
public override void OnCurrentCellKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyEventArgs e

A System.Windows.Forms.KeyEventArgs holding the event data.
Overrides

OnCurrentCellKeyPress(KeyPressEventArgs)

Called when user press a key.

Declaration
public override void OnCurrentCellKeyPress(KeyPressEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyPressEventArgs e

A System.Windows.Forms.KeyPressEventArgs holding the event data
Overrides

OnCurrentCellMoved(GridCurrentCellMovedEventArgs)

Declaration
protected override void OnCurrentCellMoved(GridCurrentCellMovedEventArgs e)
Parameters
Type Name Description
GridCurrentCellMovedEventArgs e
Overrides

OnCurrentCellMoveFailed(GridCurrentCellMoveFailedEventArgs)

Declaration
protected override void OnCurrentCellMoveFailed(GridCurrentCellMoveFailedEventArgs e)
Parameters
Type Name Description
GridCurrentCellMoveFailedEventArgs e
Overrides

OnCurrentCellMoving(GridCurrentCellMovingEventArgs)

Declaration
protected override void OnCurrentCellMoving(GridCurrentCellMovingEventArgs e)
Parameters
Type Name Description
GridCurrentCellMovingEventArgs e
Overrides

OnCurrentCellRejectedChanges(EventArgs)

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

OnCurrentCellStartEditing(CancelEventArgs)

Declaration
protected override void OnCurrentCellStartEditing(CancelEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs e
Overrides

OnDrawCell(GridDrawCellEventArgs)

Declaration
protected override void OnDrawCell(GridDrawCellEventArgs e)
Parameters
Type Name Description
GridDrawCellEventArgs e
Overrides

OnDrawCurrentCellBorder(GridDrawCurrentCellBorderEventArgs)

Declaration
protected override void OnDrawCurrentCellBorder(GridDrawCurrentCellBorderEventArgs e)
Parameters
Type Name Description
GridDrawCurrentCellBorderEventArgs e
Overrides

OnEnsurePaintCodeJitted()

Declaration
protected override void OnEnsurePaintCodeJitted()
Overrides

OnGridValidating(CancelEventArgs)

Declaration
protected override void OnGridValidating(CancelEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs e
Overrides

OnHorizontalScroll(ScrollEventArgs)

Determine the hscroll pixel

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

OnHScrollPixelPosChanging(GridScrollPositionChangingEventArgs)

Determine the hscroll position changing.

Declaration
protected override void OnHScrollPixelPosChanging(GridScrollPositionChangingEventArgs e)
Parameters
Type Name Description
GridScrollPositionChangingEventArgs e
Overrides

OnKeyDown(KeyEventArgs)

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

OnLeftColChanged(GridRowColIndexChangedEventArgs)

Declaration
protected override void OnLeftColChanged(GridRowColIndexChangedEventArgs e)
Parameters
Type Name Description
GridRowColIndexChangedEventArgs e
Overrides

OnMouseActivating(CancelEventArgs)

Declaration
protected override void OnMouseActivating(CancelEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs e
Overrides

OnMouseDown(MouseEventArgs)

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

OnMouseLeave(EventArgs)

Occurs when mouse position leaves from the client area of the GridTableControl.

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

event data.
Overrides

OnMouseMove(MouseEventArgs)

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

OnMouseUp(MouseEventArgs)

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

OnMoveCurrentCellDirection(GridMoveCurrentCellDirectionEventArgs)

Declaration
protected override void OnMoveCurrentCellDirection(GridMoveCurrentCellDirectionEventArgs e)
Parameters
Type Name Description
GridMoveCurrentCellDirectionEventArgs e
Overrides

OnPaint(PaintEventArgs)

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

OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)

Declaration
protected override void OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs e)
Parameters
Type Name Description
GridPrepareViewStyleInfoEventArgs e
Overrides

OnPushButtonClick(GridCellPushButtonClickEventArgs)

Declaration
protected override void OnPushButtonClick(GridCellPushButtonClickEventArgs e)
Parameters
Type Name Description
GridCellPushButtonClickEventArgs e
Overrides

OnQueryAllowArrowKeyNavigateTo(GridQueryAllowArrowKeyNavigateToEventArgs)

Raises the QueryAllowArrowKeyNavigateTo event.

Declaration
protected virtual void OnQueryAllowArrowKeyNavigateTo(GridQueryAllowArrowKeyNavigateToEventArgs e)
Parameters
Type Name Description
GridQueryAllowArrowKeyNavigateToEventArgs e

A GridQueryAllowArrowKeyNavigateToEventArgs that contains the event data.

OnQueryAllowDragColumn(GridQueryAllowDragColumnEventArgs)

Raises the OnQueryAllowDragColumn(GridQueryAllowDragColumnEventArgs) event.

Declaration
protected virtual void OnQueryAllowDragColumn(GridQueryAllowDragColumnEventArgs e)
Parameters
Type Name Description
GridQueryAllowDragColumnEventArgs e

A GridQueryAllowDragColumnEventArgs that contains the event data.

OnQueryAllowGroupByColumn(GridQueryAllowGroupByColumnEventArgs)

Raises the OnQueryAllowGroupByColumn(GridQueryAllowGroupByColumnEventArgs) event.

Declaration
protected virtual void OnQueryAllowGroupByColumn(GridQueryAllowGroupByColumnEventArgs e)
Parameters
Type Name Description
GridQueryAllowGroupByColumnEventArgs e

A GridQueryAllowGroupByColumnEventArgs that contains the event data.

OnQueryAllowSortColumn(GridQueryAllowSortColumnEventArgs)

Raises the QueryAllowSortColumn event.

Declaration
protected virtual void OnQueryAllowSortColumn(GridQueryAllowSortColumnEventArgs e)
Parameters
Type Name Description
GridQueryAllowSortColumnEventArgs e

A GridQueryAllowSortColumnEventArgs that contains the event data.

OnQueryNextCurrentCellPosition(GridQueryNextCurrentCellPositionEventArgs)

Declaration
protected override void OnQueryNextCurrentCellPosition(GridQueryNextCurrentCellPositionEventArgs e)
Parameters
Type Name Description
GridQueryNextCurrentCellPositionEventArgs e
Overrides

OnResizingColumns(GridResizingColumnsEventArgs)

Declaration
protected override void OnResizingColumns(GridResizingColumnsEventArgs e)
Parameters
Type Name Description
GridResizingColumnsEventArgs e
Overrides

OnResizingRows(GridResizingRowsEventArgs)

Declaration
protected override void OnResizingRows(GridResizingRowsEventArgs e)
Parameters
Type Name Description
GridResizingRowsEventArgs e
Overrides

OnScrollTipFeedback(ScrollTipFeedbackEventArgs)

Declaration
protected override void OnScrollTipFeedback(ScrollTipFeedbackEventArgs e)
Parameters
Type Name Description
ScrollTipFeedbackEventArgs e
Overrides

OnSizeChanged(EventArgs)

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

OnSplitterPaneClosed(EventArgs)

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

OnTopRowChanged(GridRowColIndexChangedEventArgs)

Declaration
protected override void OnTopRowChanged(GridRowColIndexChangedEventArgs e)
Parameters
Type Name Description
GridRowColIndexChangedEventArgs e
Overrides

OnTopRowChanging(GridRowColIndexChangingEventArgs)

Declaration
protected override void OnTopRowChanging(GridRowColIndexChangingEventArgs e)
Parameters
Type Name Description
GridRowColIndexChangingEventArgs e
Overrides

OnTouchPan(Point, Boolean)

Initialize the touch move operation when touch on scrollable area. Otherwise do the normal mouse move operation.

Declaration
protected override bool OnTouchPan(Point currentTouchPoint, bool isSwipeScroll)
Parameters
Type Name Description
System.Drawing.Point currentTouchPoint

The current touch position
System.Boolean isSwipeScroll

True when do the swipe touch operation
Returns
Type Description
System.Boolean

Returns true when panning operation occurs
Overrides

OnTouchPanBegin(Point)

Initialize the touch panning operation when touch on scrollable area. Otherwise do the normal mouse down operation.

Declaration
protected override bool OnTouchPanBegin(Point touchBeginPoint)
Parameters
Type Name Description
System.Drawing.Point touchBeginPoint

The touch starting point
Returns
Type Description
System.Boolean

Return true when panning operation done
Overrides

OnTouchPanEnd(Point)

Initialize the touch panning operation when touch points is in scrollable area. Otherwise do the normal mouse up operation.

Declaration
protected override bool OnTouchPanEnd(Point touchEndPoint)
Parameters
Type Name Description
System.Drawing.Point touchEndPoint

The touch end position
Returns
Type Description
System.Boolean

Return true when panning operation occurs
Overrides

OnValidating(CancelEventArgs)

Declaration
protected override void OnValidating(CancelEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs e
Overrides

OnVerticalScroll(ScrollEventArgs)

Determine the vertical scroll

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

OnVScrollPixelPosChanging(GridScrollPositionChangingEventArgs)

Declaration
protected override void OnVScrollPixelPosChanging(GridScrollPositionChangingEventArgs e)
Parameters
Type Name Description
GridScrollPositionChangingEventArgs e
Overrides

OnWindowScrolling(ScrollWindowEventArgs)

Declaration
protected override void OnWindowScrolling(ScrollWindowEventArgs e)
Parameters
Type Name Description
ScrollWindowEventArgs e
Overrides

PaintElement(Element, String)

Paints the whole element or only one field of a record to a given Graphics context. If you specify no field the whole rectangle is painted. If you specify a field name (see Fields collection for names) then only the one column in the record is painted. Painting fields works for Records, Summaries and GroupCaptions.

Declaration
public void PaintElement(Element el, string field)
Parameters
Type Name Description
Element el

The element (or record) to be drawn.
System.String field

A field name (matching FieldDescriptor.Name or GridColumnDescriptor.MappingName)

PaintElement(Graphics, Element, String)

Paints the whole element or only one field of a record to a given Graphics context. If you specify no field the whole rectangle is painted. If you specify a field name (see Fields collection for names) then only the one column in the record is painted. Painting fields works for Records, Summaries and GroupCaptions.

Declaration
public void PaintElement(Graphics graphics, Element el, string field)
Parameters
Type Name Description
System.Drawing.Graphics graphics

The graphics object.
Element el

The element (or record) to be drawn.
System.String field

A field name (matching FieldDescriptor.Name or GridColumnDescriptor.MappingName)

PointToNestedDisplayElement(Point)

Determines the nested display element that is shown at the specified point.

Declaration
public Element PointToNestedDisplayElement(Point ptClient)
Parameters
Type Name Description
System.Drawing.Point ptClient

The point in client coordinates
Returns
Type Description
Element

The display element.
Remarks

PointToTableCellStyle(Point) PointToTableCellStyle(Point)

PointToTableCellStyle(Point)

Returns the style information for the cell that is displayed under a mouse position in client coordinates. If cell belongs to a nested table style information is returned for the cell inside the nested table. Good for hit-testing.

Declaration
public GridTableCellStyleInfo PointToTableCellStyle(Point ptClient)
Parameters
Type Name Description
System.Drawing.Point ptClient

The mouse position in client coordinates.
Returns
Type Description
GridTableCellStyleInfo

The style element with identity information for the cell that is displayed at the specified coordinate.
Remarks
This example dumps information about the cell below a mouse cursor while the user is hovering the mouse over the grid. 
private void TableControl_MouseMove(object sender, MouseEventArgs e)
{
    Point ptClient = new Point(e.X, e.Y);
    GridTableControl tableControl = this.groupingGrid1.TableControl;




    GridTableCellStyleInfo style = tableControl.PointToTableCellStyle(ptClient);


    Element displayElement = style.TableCellIdentity.DisplayElement;


    string info = string.Empty;
    if (style != null)
    {
        if (style.TableCellIdentity.Column != null)
            info = style.TableCellIdentity.Column.Name;
        else
            info = style.TableCellIdentity.ToString();
    }


    Console.WriteLine("{0}: {1},{2},{3} ", ptClient, displayElement.ParentChildTable.CategoriesToString(), displayElement.GetType().Name, info);
}
Private Sub TableControl_MouseMove(sender As Object, e As MouseEventArgs)
    Dim ptClient As New Point(e.X, e.Y)
    Dim tableControl As GridTableControl = Me.groupingGrid1.TableControl




    Dim style As GridTableCellStyleInfo = tableControl.PointToTableCellStyle(ptClient)


    Dim displayElement As Element = style.TableCellIdentity.DisplayElement


    Dim info As String = string.Empty
    If Not (style Is Nothing) Then
        If Not (style.TableCellIdentity.Column Is Nothing) Then
            info = style.TableCellIdentity.Column.Name
        Else
            info = style.TableCellIdentity.ToString()
        End If
    End If
    Console.WriteLine("{0}: {1},{2},{3} ", ptClient, displayElement.ParentChildTable.CategoriesToString(), displayElement.GetType().Name, info)
End Sub 'TableControl_MouseMove
 PointToTableCellStyle(Point) PointToNestedDisplayElement(Point)

ProcessDialogKey(Keys)

Processes the dialog key.

Declaration
protected override bool ProcessDialogKey(Keys key)
Parameters
Type Name Description
System.Windows.Forms.Keys key

The key code.
Returns
Type Description
System.Boolean

return boolean value
Overrides

ProcessKeyEventArgs(ref Message)

Determine the process key event.

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

windows message
Returns
Type Description
System.Boolean

boolean value
Overrides

ProcessScrollCellInView(Int32, Int32, Boolean, GridScrollCurrentCellReason)

Called to scroll the specified cell into view.

Declaration
public override bool ProcessScrollCellInView(int rowIndex, int colIndex, bool dontScroll, GridScrollCurrentCellReason reason)
Parameters
Type Name Description
System.Int32 rowIndex

Row index.
System.Int32 colIndex

Column index.
System.Boolean dontScroll

Specified if top row index and left column index should be changed without raising scroll events and without updating the screen.
GridScrollCurrentCellReason reason

The reason for scrolling the current cell into view.
Returns
Type Description
System.Boolean

True if the operation is successful.
Overrides

ProcessSelectedRecordCellDrawn(GridTableControl, GridDrawCellEventArgs)

Used internally.

Declaration
public void ProcessSelectedRecordCellDrawn(GridTableControl tableControl, GridDrawCellEventArgs e)
Parameters
Type Name Description
GridTableControl tableControl
GridDrawCellEventArgs e

ProcessSelectedRecordPrepareViewStyleInfo(GridTableControl, GridPrepareViewStyleInfoEventArgs)

Used internally.

Declaration
public void ProcessSelectedRecordPrepareViewStyleInfo(GridTableControl tableControl, GridPrepareViewStyleInfoEventArgs e)
Parameters
Type Name Description
GridTableControl tableControl
GridPrepareViewStyleInfoEventArgs e

ProcessTableClickCellsCancelMode(GridTableClickCellsEventArgs)

Used internally.

Declaration
public void ProcessTableClickCellsCancelMode(GridTableClickCellsEventArgs e)
Parameters
Type Name Description
GridTableClickCellsEventArgs e

ProcessTableClickCellsMouseDown(GridTableClickCellsEventArgs)

Used internally.

Declaration
public void ProcessTableClickCellsMouseDown(GridTableClickCellsEventArgs e)
Parameters
Type Name Description
GridTableClickCellsEventArgs e

ProcessTableClickCellsMouseMove(GridTableClickCellsEventArgs)

Used internally.

Declaration
public void ProcessTableClickCellsMouseMove(GridTableClickCellsEventArgs e)
Parameters
Type Name Description
GridTableClickCellsEventArgs e

ProcessTableClickCellsMouseUp(GridTableClickCellsEventArgs)

Used internally.

Declaration
public void ProcessTableClickCellsMouseUp(GridTableClickCellsEventArgs e)
Parameters
Type Name Description
GridTableClickCellsEventArgs e

ProcessTableControlMoveCurrentCellDirection(GridTableControlMoveCurrentCellDirectionEventArgs)

Used internally.

Declaration
public void ProcessTableControlMoveCurrentCellDirection(GridTableControlMoveCurrentCellDirectionEventArgs e)
Parameters
Type Name Description
GridTableControlMoveCurrentCellDirectionEventArgs e

RecordColumnToRectangle(Record, GridColumnDescriptor)

Returns the display area for a given column and record.

Declaration
public Rectangle RecordColumnToRectangle(Record record, GridColumnDescriptor column)
Parameters
Type Name Description
Record record

The record
GridColumnDescriptor column

The ColumnDescriptor
Returns
Type Description
System.Drawing.Rectangle

Rectangle.Empty if field or record is not visible; otherwise, the display area in client coordinates

RecordFieldToRectangle(Element, String)

Returns the display area for a given field and record.

Declaration
public Rectangle RecordFieldToRectangle(Element el, string fieldName)
Parameters
Type Name Description
Element el

The record or element
System.String fieldName

The field (FieldDescriptor.Name or ColumnDescriptor.MappingName)
Returns
Type Description
System.Drawing.Rectangle

Rectangle.Empty if field or record is not visible; otherwise, the display area in client coordinates

RecordRowsToRectangle(Record, GridCellSizeKind)

Returns the display area for the specified record. If it has nested tables only the bounding rectangle of the parent rows are returned and nested tables are excluded.

Declaration
public Rectangle RecordRowsToRectangle(Record record, GridCellSizeKind sizeKind)
Parameters
Type Name Description
Record record

The grouping record
GridCellSizeKind sizeKind

Specifies how to handle the the top-most row when pixel scrolling is enabled and cells are only partially visible.
Returns
Type Description
System.Drawing.Rectangle

Rectangle.Empty if record is not visible; otherwise, the display area in client coordinates

Refresh(Boolean)

Declaration
protected override void Refresh(bool fromModel)
Parameters
Type Name Description
System.Boolean fromModel
Overrides

Reinitialize()

Marks the table dirty and forces reinitializing categories, counters, and summaries. The display is refreshed.

Declaration
public void Reinitialize()

RowIndexToVScrollPixelPos(Int32)

Calculates the vertical scroll pixel position for the given row.

Declaration
public override int RowIndexToVScrollPixelPos(int rowIndex)
Parameters
Type Name Description
System.Int32 rowIndex

Row index.
Returns
Type Description
System.Int32

Vertical scroll pixel position.
Overrides

ScrollInView(Element)

Scrolls an element into view.

Declaration
public bool ScrollInView(Element el)
Parameters
Type Name Description
Element el

The element to scroll into view.
Returns
Type Description
System.Boolean

True if scrolled; False if element was already visible or not valid.

ScrollInView(Element, GridScrollCurrentCellReason)

Scrolls an element into view.

Declaration
public bool ScrollInView(Element el, GridScrollCurrentCellReason reason)
Parameters
Type Name Description
Element el

The element to scroll into view.
GridScrollCurrentCellReason reason

Scroll reason
Returns
Type Description
System.Boolean

True if scrolled; False if element was already visible or not valid.

SynchronizeGridWithEngine()

Synchronize the grid display with changes in the underlying Table.

Declaration
public void SynchronizeGridWithEngine()

Table_CurrentRecordContextChange(Object, CurrentRecordContextChangeEventArgs)

Declaration
protected virtual void Table_CurrentRecordContextChange(object sender, CurrentRecordContextChangeEventArgs e)
Parameters
Type Name Description
System.Object sender
CurrentRecordContextChangeEventArgs e

Table_CurrentRecordManagerReset(Object, TableEventArgs)

Triggers when the currentrecordmanager resets.

Declaration
protected virtual void Table_CurrentRecordManagerReset(object sender, TableEventArgs e)
Parameters
Type Name Description
System.Object sender
TableEventArgs e

Table_DisplayElementChanged(Object, DisplayElementChangedEventArgs)

Triggers when the displayelement changes.

Declaration
protected virtual void Table_DisplayElementChanged(object sender, DisplayElementChangedEventArgs e)
Parameters
Type Name Description
System.Object sender
DisplayElementChangedEventArgs e

Table_DisplayElementChanging(Object, DisplayElementChangingEventArgs)

Triggers when the displayelement tends to change.

Declaration
protected virtual void Table_DisplayElementChanging(object sender, DisplayElementChangingEventArgs e)
Parameters
Type Name Description
System.Object sender
DisplayElementChangingEventArgs e

Table_RecordValueChanged(Object, RecordValueChangedEventArgs)

Triggers after the record value changed.

Declaration
protected virtual void Table_RecordValueChanged(object sender, RecordValueChangedEventArgs e)
Parameters
Type Name Description
System.Object sender
RecordValueChangedEventArgs e

Table_SourceListChanged(Object, TableEventArgs)

Triggers when the sourcelist changes.

Declaration
protected virtual void Table_SourceListChanged(object sender, TableEventArgs e)
Parameters
Type Name Description
System.Object sender
TableEventArgs e

Table_SourceListListChanged(Object, TableListChangedEventArgs)

Triggers when change occurs in sourcelist.

Declaration
protected virtual void Table_SourceListListChanged(object sender, TableListChangedEventArgs e)
Parameters
Type Name Description
System.Object sender
TableListChangedEventArgs e

Table_SourceListRecordChanged(Object, RecordChangedEventArgs)

Triggers after the record change reflected in binded source list.

Declaration
protected virtual void Table_SourceListRecordChanged(object sender, RecordChangedEventArgs e)
Parameters
Type Name Description
System.Object sender
RecordChangedEventArgs e

Table_SourceListRecordChanging(Object, RecordChangedEventArgs)

Triggers when the record change reflected in binded source list.

Declaration
protected virtual void Table_SourceListRecordChanging(object sender, RecordChangedEventArgs e)
Parameters
Type Name Description
System.Object sender
RecordChangedEventArgs e

ToString()

Returns a string holding the current object.

Declaration
public override string ToString()
Returns
Type Description
System.String

String representation of the current object.
Overrides

UnwireModel()

Releases listeners for the GridModel.

Declaration
protected override void UnwireModel()
Overrides

Update()

Updates the control.

Declaration
public override void Update()
Overrides

UpdateScrollBars()

Updates the scrollbars with current scroll position and scroll range.

Declaration
public override void UpdateScrollBars()
Overrides

VScrollPixelPosToRowIndex(Int32, out Int32, out Int32)

Determines the row index that is located at the specified vertical pixel scroll position.

Declaration
public override void VScrollPixelPosToRowIndex(int pixelPos, out int rowIndex, out int pixelDelta)
Parameters
Type Name Description
System.Int32 pixelPos

The absolute vertical pixel scroll position.
System.Int32 rowIndex

Returns the resultant row index.
System.Int32 pixelDelta

Returns the number of pixels the top row is above the view area for the scroll position.
Overrides

WireModel()

Sets up listeners for the GridModel and initializes mouse controllers and data object consumers.

Declaration
protected override void WireModel()
Overrides

WndProc(ref Message)

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

Events

ActivateToolTip

Occurs when mouse has moved to a new cell and a ToolTip is initialized for that cell.

Declaration
public event GridActivateToolTipEventHandler ActivateToolTip
Event Type
Type Description
GridActivateToolTipEventHandler
Remarks

You have two options:

  1. Set e.Style.CellTipText

  • Or -

  1. Initalize the ToolTip directly (see CellToolTip property) and then set e.Cancel = True;

DrawDataBarCell

Occurs for every DataBar cells before that grid draws the specified DataBar cell.

Declaration
public event DrawDataBarCellEventHandler DrawDataBarCell
Event Type
Type Description
DrawDataBarCellEventHandler
Remarks

You can customize the databar cell minimum and maximum value using Handled,Minimum and Maximum property. You can avoid default drawing for the DataBar cells by using System.ComponentModel.CancelEventArgs.Cancel

QueryAllowArrowKeyNavigateTo

Occurs when the user navigates though display elements with arrow keys. In your event handler you can determine if the specified display element (e.g. a CaptionRow) can be stepped on or if it should be skipped.

Declaration
public event GridQueryAllowArrowKeyNavigateToEventHandler QueryAllowArrowKeyNavigateTo
Event Type
Type Description
GridQueryAllowArrowKeyNavigateToEventHandler
Remarks

You can set AllowNavigateTo if you want arrow keys to skip over specific display elements (e.g. skip caption rows).

See Also

QueryAllowDragColumn

Occurs when the user hovers the mouse over a column header or clicks on it. In your event handler, you can determine if the selected column can be dragged.

Declaration
public event GridQueryAllowDragColumnEventHandler QueryAllowDragColumn
Event Type
Type Description
GridQueryAllowDragColumnEventHandler
Remarks

You can disallow dragging the column when you assign False to AllowDrag.

See Also

QueryAllowGroupByColumn

Occurs when the user drags a column header over the GroupDropArea. In your event handler, you can determine if the grid can be grouped by the selected column.

Declaration
public event GridQueryAllowGroupByColumnEventHandler QueryAllowGroupByColumn
Event Type
Type Description
GridQueryAllowGroupByColumnEventHandler
Remarks

You can disallow grouping by the column when you assign False to AllowGroupByColumn.

See Also

QueryAllowSortColumn

Occurs when the user hovers the mouse over a column header or clicks on it. In your event handler you can determine if the selected column can be sorted.

Declaration
public event GridQueryAllowSortColumnEventHandler QueryAllowSortColumn
Event Type
Type Description
GridQueryAllowSortColumnEventHandler
Remarks

You can disallow sorting by the column when you assign False to AllowSort.

See Also

Implements

System.IDisposable