Class GridDataBoundGrid

Provides support for displaying ADO.NET data and other data sources in a grid. Data will be loaded from the given data source and changes will be written back to the data source.

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

To display a table in the GridDataBoundGrid at run-time, set the DataSource and DataMember properties to a valid data source. The following data sources are valid: DataTable DataView DataSet A single dimension array Any component that implements the IListSource interface Any component that implements the IList interface.

Constructors

GridDataBoundGrid()

Initializes a new instance of GridDataBoundGrid.

Declaration
public GridDataBoundGrid()

GridDataBoundGrid(GridDataBoundGridModel)

Initializes a new instance of GridDataBoundGrid and attaches it to a GridDataBoundGridModel.

Declaration
public GridDataBoundGrid(GridDataBoundGridModel model)
Parameters
Type Name Description
GridDataBoundGridModel model

Grid model.

Properties

ActivateCurrentCellBehavior

See ActivateCurrentCellBehavior in the GridModel class for information.

Declaration
public GridCellActivateAction ActivateCurrentCellBehavior { get; set; }
Property Value
Type Description
GridCellActivateAction
Examples

This example shows how to use the ActivateCurrentCellBehavior property.

// Sets the current cell activation on double-clicking the cell.
this.gridDataBoundGrid1.ActivateCurrentCellBehavior = GridCellActivateAction.DblClickOnCell;
' Sets the current cell activation on double-clicking the cell.
Me.gridDataBoundGrid1.ActivateCurrentCellBehavior = GridCellActivateAction.DblClickOnCell

AllowDragSelectedCols

See AllowDragSelectedCols in the GridModel class for information.

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

AllowResizeToFit

Gets or sets a value indicating whether the grid should automatically resize columns to fit cell contents on first display of the data.

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

AllowSelection

See AllowSelection in the GridModel class for information.

Declaration
public GridSelectionFlags AllowSelection { get; set; }
Property Value
Type Description
GridSelectionFlags
Examples

This example shows how to use the AllowSelection property.

// Allows the selection of rows.
this.gridDataBoundGrid1.AllowSelection = GridSelectionFlags.Row;
// Disables the selection.
this.gridDataBoundGrid1.AllowSelection = GridSelectionFlags.None;
' Allows the selection of rows.
Me.gridDataBoundGrid1.AllowSelection = GridSelectionFlags.Row
' Disables the selection.
Me.gridDataBoundGrid1.AllowSelection = GridSelectionFlags.None

AlphaBlendSelectionColor

See AlphaBlendSelectionColor in the GridModel class for information.

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

This example shows how to use the AlphaBlendSelectionColor property.

// Assigns a specific color for alpha-blend selection color
this.gridDataBoundGrid1.AlphaBlendSelectionColor = Color.SteelBlue;
' Assigns a specific color for alpha-blend selection color
Me.gridDataBoundGrid1.AlphaBlendSelectionColor = Color.SteelBlue

ApplyVisualStyles

Enable or Disable the Legacy styles in the Table Model Value should be false to apply ColorStyles

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

BackgroundImage

Gets or sets the background image used for the control.

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

BaseStylesMap

See BaseStylesMap in the GridModel class for information.

Declaration
public GridBaseStylesMap BaseStylesMap { get; set; }
Property Value
Type Description
GridBaseStylesMap

Binder

Gets a reference to the GridModelDataBinder that manages the underlying data source.

Declaration
public GridModelDataBinder Binder { get; }
Property Value
Type Description
GridModelDataBinder
Examples

This example shows how to use the Binder property.

// Creates a column to be added to the collection.
GridBoundColumnsCollection myColumn1 = (GridBoundColumnsCollection)this.gridDataBoundGrid1.Binder.InternalColumns.Clone();
GridBoundColumn Column1 = new GridBoundColumn();
Column1.HeaderText = "NewColumn";
myColumn1.Add(Column1);    
// Binds the created column to the grid bound columns.
this.gridDataBoundGrid1.Binder.GridBoundColumns = myColumn1;
' Creates a column to be added to the collection.
Dim myColumn1 As GridBoundColumnsCollection = CType(Me.gridDataBoundGrid1.Binder.InternalColumns.Clone(), GridBoundColumnsCollection)
Dim Column1 As New GridBoundColumn()
Column1.HeaderText = "NewColumn"
myColumn1.Add(Column1)
' Binds the created column to the grid bound columns.
Me.gridDataBoundGrid1.Binder.GridBoundColumns = myColumn1

BrowseOnly

To specify the browse only state of the Grid

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

ColorStyles

[Deprecated] Gets or sets the VisualStyles (skins) like Office2010, Office2007, Office2003

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

ControllerOptions

See ControllerOptionsChanged in the GridModel class for information.

Declaration
public GridControllerOptions ControllerOptions { get; set; }
Property Value
Type Description
GridControllerOptions

DataBoundGridModel

Gets the GridDataBoundGridModel that manages data to be displayed in the grid.

Declaration
public GridDataBoundGridModel DataBoundGridModel { get; }
Property Value
Type Description
GridDataBoundGridModel
Remarks

You can replace the GridDataBoundGridModel at run-time. The GridControlBase will release and establish links to the previous model and establish new relationships with the new model and then redraw itself.

DataMember

Gets or sets the specific list in a DataSource for which the GridDataBoundGrid control displays a gridModel.

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

DataSource

Gets or sets the datasource that the gridModel is displaying data for.

Declaration
public virtual object DataSource { get; set; }
Property Value
Type Description
System.Object
Examples

This example shows how to use the DataSource property.

// Creates the data source.
DataTable dataTable = new DataTable();
// Assigns the data source to be displayed in the grid
this.gridDataBoundGrid1.DataSource = dataTable;
' Creates the data source.
Dim dataTable As New DataTable()
' Assigns the data source to be displayed in the grid
Me.gridDataBoundGrid1.DataSource = dataTable

DefaultGridBorderStyle

Gets or sets the GridBorderStyle value to be used as default for cell borders.

Declaration
public GridBorderStyle DefaultGridBorderStyle { get; set; }
Property Value
Type Description
GridBorderStyle
Examples

This example shows how to use the DefaultGridBorderStyle property.

// Sets the border line style
this.gridDataBoundGrid1.DefaultGridBorderStyle = GridBorderStyle.Solid;
' Sets the border line style
Me.gridDataBoundGrid1.DefaultGridBorderStyle = GridBorderStyle.Solid

DisplayHorizontalLines

Gets or sets a value indicating whether horizontal lines should be displayed.

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

DisplayVerticalLines

Gets or sets a value indicating whether vertical lines should be displayed.

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

DrawIndividualSpannedCellBorders

Gets or sets a value indicating whether Individual borders need to be drawn for spanned cells when they get focus. Ensure UseRightToLeftCompatibleTextBox is set to False to ensure the borders are shown properly such that the actual textbox is not edited directly.

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

EnableAddNew

Gets or sets a value indicating whether the grid supports adding new records if the underlying datasource allows adding new records. See AllowAddNew.

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

EnableEdit

Gets or sets a value indicating whether the grid supports editing records if the underlying datasource allows editing records. See AllowEdit.

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

EnableRemove

Gets or sets a value indicating whether the grid supports removing records if the underlying datasource allows it. See AllowRemove.

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

EnableTouchMode

gets or sets the touchmode

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

ExcelLikeCurrentCell

See ExcelLikeCurrentCell in the GridModel class for information.

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

ExcelLikeSelectionFrame

See ExcelLikeSelectionFrame in the GridModel class for information.

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

Font

Specifies the font used to display text in the control.

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

ForceUpdateAfterListChangedEvent

Gets or sets a value indicating whether the grid should call Control.Update after each IBindindList.ListChanged event. This property only has any effect if UseListChangedEvent has been set to True.

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

Set this property to False if you want to manually call Update. Manually calling Update can have better performance because you can then batch several datatable modifications into one operation and then only call update when changes are done.

GridBoundColumns

Gets or sets the columns to be displayed in the GridDataBoundGrid.

Declaration
public virtual GridBoundColumnsCollection GridBoundColumns { get; set; }
Property Value
Type Description
GridBoundColumnsCollection

GridLineColor

Gets or sets the color of grid lines.

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

This example shows how to use the GridLineColor property.

// Sets the color of grid lines.
this.gridDataBoundGrid1.GridLineColor = Color.Red;
' Sets the color of grid lines.
Me.gridDataBoundGrid1.GridLineColor = Color.Red

GridVisualStyles

Gets or sets the VisualStyles (skins) like Office2010, Office2007, Office2003.

Declaration
public GridVisualStyles GridVisualStyles { get; set; }
Property Value
Type Description
GridVisualStyles
Examples

This example shows how to use the GridVisualStyles property.

// To apply visual styles the themes enabled property should be set to true.
// Otherwise the default SystemTheme is applied.
this.gridDataBoundGrid1.ThemesEnabled = true;
// Applies the metro style to the grid.
this.gridDataBoundGrid1.GridVisualStyles = GridVisualStyles.Metro;
' Otherwise the default SystemTheme is applied.
' To apply visual styles the themes enabled property should be set to True
Me.gridDataBoundGrid1.ThemesEnabled = True
' Applies the metro style to the grid.
Me.gridDataBoundGrid1.GridVisualStyles = GridVisualStyles.Metro

GridVisualStylesDrawing

Gets or sets the VisualStylesDrawing object

Declaration
public IVisualStylesDrawing GridVisualStylesDrawing { get; set; }
Property Value
Type Description
IVisualStylesDrawing

HighlightCurrentColumnHeader

Gets or sets a value indicating whether the column header for the current cell should be highlighted.

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

Highlighting the column header will help users identify quickly in which level they are in a hierarchy.

If you want to customize the look of the highlighted header you should handle the PrepareViewStyleInfo event and check IsMarkedHeader(Int32, Int32) and set System.ComponentModel.CancelEventArgs.Cancel to True.

IndentHierarchies

Gets or sets a value indicating whether to show hierarchical levels indented without treelines.

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

Initializing

Gets a value indicating whether BeginInit() was called.

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

IsFilterBarWired

Determine is the filterbar is wired to grid.

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

Item[Int32, Int32]

See Item[Int32, Int32] in the GridModel class for information.

Declaration
public GridStyleInfo this[int rowIndex, int colIndex] { get; set; }
Parameters
Type Name Description
System.Int32 rowIndex
System.Int32 colIndex
Property Value
Type Description
GridStyleInfo

ListBoxSelectionMode

Gets or sets the method in which items are selected in the GridListControl .

Declaration
public virtual SelectionMode ListBoxSelectionMode { get; set; }
Property Value
Type Description
System.Windows.Forms.SelectionMode
Examples

This example shows how to use the ListBoxSelectionMode property.

// Sets the selection mode of the control.
this.gridDataBoundGrid1.ListBoxSelectionMode = SelectionMode.MultiExtended;
' Sets the selection mode of the control.
Me.gridDataBoundGrid1.ListBoxSelectionMode = SelectionMode.MultiExtended

MinResizeColSize

See MinResizeColSize in the GridModel class for information.

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

MinResizeRowSize

See MinResizeRowSize in the GridModel class for information.

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

PrintColumnHeader

Gets or sets a value indicating whether column headers should be printed when printing the grid.

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

PrintHorizontalLines

Gets or sets a value indicating whether the grid should draw horizontal lines when printing.

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

PrintRowHeader

Gets or sets a value indicating whether row headers should be printed when printing the grid.

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

PrintVerticalLines

Gets or sets a value indicating whether the grid should draw vertical lines when printing.

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

Properties

See Properties in the GridModel class for information.

Declaration
public GridProperties Properties { get; set; }
Property Value
Type Description
GridProperties

Provider

Assigns the new UIAProvider for Accessibility.

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

ResizeColsBehavior

See ResizeColsBehavior in the GridModel class for information.

Declaration
public GridResizeCellsBehavior ResizeColsBehavior { get; set; }
Property Value
Type Description
GridResizeCellsBehavior
Examples

This example shows how to use the ResizeColsBehavior property.

 // Only resizes the selected column or range.
 this.gridDataBoundGrid1.ResizeColsBehavior = GridResizeCellsBehavior.ResizeSingle;
 // Restrict resizing columns and the divider doesn't appear.
 this.gridDataBoundGrid1.ResizeColsBehavior = GridResizeCellsBehavior.None;
' Only resizes the selected column or range.
Me.gridDataBoundGrid1.ResizeColsBehavior = GridResizeCellsBehavior.ResizeSingle
' Restrict resizing columns and the divider doesn't appear.
Me.gridDataBoundGrid1.ResizeColsBehavior = GridResizeCellsBehavior.None

ResizeRowsBehavior

See ResizeRowsBehavior in the GridModel class for information.

Declaration
public GridResizeCellsBehavior ResizeRowsBehavior { get; set; }
Property Value
Type Description
GridResizeCellsBehavior

ShowColumnHeaders

Gets or sets a value indicating whether the grid should be display column headers.

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

ShowCurrentCellBorderBehavior

See ShowCurrentCellBorderBehavior in the GridModel class for information.

Declaration
public GridShowCurrentCellBorder ShowCurrentCellBorderBehavior { get; set; }
Property Value
Type Description
GridShowCurrentCellBorder
Examples

This example shows ho to use the ShowCurrentCellBorderBehavior property.

// Shows the cell border like active current cell all the time.
this.gridDataBoundGrid1.ShowCurrentCellBorderBehavior = GridShowCurrentCellBorder.AlwaysVisible;
// Shows gray color border when the grid is not active. 
this.gridDataBoundGrid1.ShowCurrentCellBorderBehavior = GridShowCurrentCellBorder.GrayWhenLostFocus;
' Shows the cell border like active current cell all the time.
Me.gridDataBoundGrid1.ShowCurrentCellBorderBehavior = GridShowCurrentCellBorder.AlwaysVisible
' Shows gray color border when the grid is not active. 
Me.gridDataBoundGrid1.ShowCurrentCellBorderBehavior = GridShowCurrentCellBorder.GrayWhenLostFocus

ShowRowHeaders

Gets or sets a value indicating whether row headers should be displayed or hidden. (Might be better to use HideCols[0] = false) instead.

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

ShowTreeLines

Gets or sets a value indicating whether to enable or disable tree-like expand / collapse for row header cells in a hierarchical grid.

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

Site

Gets or sets the site of the control.

Declaration
public override ISite Site { get; set; }
Property Value
Type Description
System.ComponentModel.ISite

SmoothControlResize

See SmoothControlResize in the GridModel class for information.

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

SortBehavior

Gets or sets the sort behavior if databound grid should sort a column if user clicks on it.

Declaration
public GridSortBehavior SortBehavior { get; set; }
Property Value
Type Description
GridSortBehavior
Examples

This example shows how to use the SortBehavior property.

// Sets the sorting behavior
this.gridDataBoundGrid1.SortBehavior = GridSortBehavior.DoubleClick;
' Sets the sorting behavior
Me.gridDataBoundGrid1.SortBehavior = GridSortBehavior.DoubleClick

TableStyle

Gets or sets the table style.

Declaration
public GridStyleInfo TableStyle { get; set; }
Property Value
Type Description
GridStyleInfo

TransparentBackground

See TransparentBackground in the GridModel class for information.

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

UseComplexBinding

Gets or sets the bool value of UseComplexBinding

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

UseListChangedEvent

Gets or sets a value indicating whether the grid should listen to IBindindList.ListChanged events or if it should only handle currency manager events.

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

This property is set to false by default to ensure backward compatibility with earlier versions. But if you drop a GridDataBoundGrid onto a form in the designer, the property will be set True as default (using UseListChangedEvent gives better performance that are listening to currency manager events.)

UseRightToLeftCompatibleTextBox

Gets or sets a value indicating whether to control the kind of textbox control that is created for TextBox cells. In general the original text box behaves better than the richtext box with Hebrew and arabic languages. By default the grid uses the RichTextBox control for cell editing, but if you set UseRightToLeftCompatibleTextBox to true then the grid will do editing with original TextBox controls instead.

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

Methods

AdjustColHeader(GridCurrentCellMovingEventArgs)

Allows you to adjust the current cell position before the CurrentCellMoving event handler proceeds.

Declaration
protected virtual void AdjustColHeader(GridCurrentCellMovingEventArgs e)
Parameters
Type Name Description
GridCurrentCellMovingEventArgs e

The GridCurrentCellMovingEventArgs with event data.
Remarks

The default implementation will check if the current cell is about to be moved onto a column header.

If this is the case, the row index will be changed so that the current cell moves onto the first row in the column.

AdjustRowHeader(GridCurrentCellMovingEventArgs)

Allows you to adjust the current cell position before the CurrentCellMoving event handler proceeds.

Declaration
protected virtual void AdjustRowHeader(GridCurrentCellMovingEventArgs e)
Parameters
Type Name Description
GridCurrentCellMovingEventArgs e

The GridCurrentCellMovingEventArgs with event data.
Remarks

The default implementation will check if the current cell is about to be moved onto a row header.

If this is the case, the column index will be changed so that the current cell moves onto the first column in the row.

ApplyScaleToControl(Single)

applies the scaling

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

Represents the floating value

BeginInit()

Implements System.ComponentModel.ISupportInitialize.BeginInit of the System.ComponentModel.ISupportInitialize interface.

Declaration
public void BeginInit()

CollapseAll()

Collapses all nodes in the grid.

Declaration
public void CollapseAll()
Remarks

Collapsing all nodes can be a lengthy process. The grid will give feedback through a OperationFeedback object about the progress of the operation and gives the user the option to abort.

CollapseAtRowIndex(Int32)

Expands the relation at the specified row in the grid. Before the records are collapsed, a cancelable RowCollapsing event is raised. After the operation has completed a RowCollapsed event is raised.

Declaration
public void CollapseAtRowIndex(int rowIndex)
Parameters
Type Name Description
System.Int32 rowIndex

The absolute row index.

CommitChanges()

Validates the current object and saves any pending changed in the current record.

Declaration
public bool CommitChanges()
Returns
Type Description
System.Boolean

True if object is valid and changes could be saved; False otherwise.

CreateAccessibilityInstance()

Creates a new accessibility object for the control.

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

A new System.Windows.Forms.AccessibleObject for the control.
Overrides

CreateBinder()

Creates an instance of the GridModelDataBinder object.

Declaration
protected virtual GridModelDataBinder CreateBinder()
Returns
Type Description
GridModelDataBinder

The GridModelDataBinder object that provides plumbing to the datasource for this grid.

CreateNewControl(Control, Int32, Int32)

Creates a new databound grid.

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

A parent control.
System.Int32 row

Row index.
System.Int32 column

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

The new grid.
Overrides

DeleteRecordsAtRowIndex(Int32, Int32)

Removes the records at the specified rows from the datasource. Before the rows are deleted, a cancelable RowsDeleting event is raised. After the operation is complete, a RowsDeleted event is raised.

Declaration
public void DeleteRecordsAtRowIndex(int top, int bottom)
Parameters
Type Name Description
System.Int32 top

The first row to delete.
System.Int32 bottom

The last row to delete.
Examples

This example shows how to delete the records from a specific row index to a desired row index.

// Deletes the records to a specific range.
this.gridDataBoundGrid1.DeleteRecordsAtRowIndex(5,10);
' Deletes the records to a specific range.
Me.gridDataBoundGrid1.DeleteRecordsAtRowIndex(5,10)

Dispose(Boolean)

Releases all resources used by the System.ComponentModel.Component.

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

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
Remarks

See the documentation for the System.ComponentModel.Component class and its Dispose member.

EndInit()

Implements System.ComponentModel.ISupportInitialize.EndInit of the System.ComponentModel.ISupportInitialize interface.

Declaration
public void EndInit()

ExpandAll()

Expands all nodes in the grid.

Declaration
public void ExpandAll()
Remarks

Expanding all nodes can be a lengthy process. The grid will give feedback through a OperationFeedback object about the progress of the operation and gives the user the option to abort.

ExpandAtRowIndex(Int32)

Expands the relation at the specified row in the grid. Before the records are expanded a cancelable RowExpanding event is raised. After the operation is complete, a RowExpanded event is raised.

Declaration
public void ExpandAtRowIndex(int rowIndex)
Parameters
Type Name Description
System.Int32 rowIndex

The absolute row index.

HandleBoundCurrentCellKeyDown(KeyEventArgs)

Raises the System.Windows.Forms.Control.KeyDown event.

Declaration
protected virtual void HandleBoundCurrentCellKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyEventArgs e

The System.Windows.Forms.KeyEventArgsthat contains event data.

InitLayout()

Overridden. Calls Initialize() when the control is added to the parent forms System.Windows.Forms.Control.Controls collection.

Declaration
protected override void InitLayout()
Overrides

IsExpandedAtRowIndex(Int32)

Checks if relation is expanded at the specified row in the grid.

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

The absolute row index.
Returns
Type Description
System.Boolean

True if it is expanded at the specified row.

IsMarkedHeader(Int32, Int32)

Determines if the column header at the specified row and column index should be outlined.

Declaration
public bool IsMarkedHeader(int rowIndex, int colIndex)
Parameters
Type Name Description
System.Int32 rowIndex

The row index.
System.Int32 colIndex

The column index.
Returns
Type Description
System.Boolean

True if header should be outlined; False otherwise.

IsShowCurrentRow(Int32)

Determines if the current cell is shown at the specified row.

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

Row index.
Returns
Type Description
System.Boolean

True if it is shown at the given row.
Overrides

NameToColIndex(String)

Returns the column index for a column that matches a given name.

Declaration
public int NameToColIndex(string name)
Parameters
Type Name Description
System.String name

The name of the field to be matched.
Returns
Type Description
System.Int32

The column index in the grid; -1 if not found.

OnBindingContextChanged(EventArgs)

Raises the System.Windows.Forms.Control.BindingContextChanged event.

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

The System.EventArgsthat contains event data.

OnCellButtonClicked(GridCellButtonClickedEventArgs)

Raises the CellButtonClicked event.

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

A GridCellButtonClickedEventArgs that contains the event data.
Overrides

OnCellClick(GridCellClickEventArgs)

Raises the cancelable CellClick event.

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

A GridCellClickEventArgs that contains the event data.
Overrides

OnCellDoubleClick(GridCellClickEventArgs)

Raises the cancelable CellClick event.

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

A GridCellClickEventArgs that contains the event data.
Overrides

OnClientSizeChanged(EventArgs)

Raises the System.Windows.Forms.Control.ClientSizeChanged event.

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

The System.EventArgsthat contains event data.
Overrides

OnControlGotFocus()

Raises the System.Windows.Forms.Control.GotFocus event.

Declaration
protected override void OnControlGotFocus()
Overrides

OnCurrentCellAcceptedChanges(CancelEventArgs)

Raises the cancelable CurrentCellAcceptedChanges event.

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

The System.EventArgsthat contains event data.
Overrides

OnCurrentCellActivated(EventArgs)

Raises the CurrentCellActivated event.

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

A System.EventArgs that contains the event data.
Overrides

OnCurrentCellActivating(GridCurrentCellActivatingEventArgs)

Raises the CurrentCellActivating event.

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

A GridCurrentCellActivatingEventArgs that contains the event data.
Overrides

OnCurrentCellChanged(EventArgs)

Raises the CurrentCellChanged event.

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

The System.EventArgsthat contains event data.
Overrides

OnCurrentCellChanging(CancelEventArgs)

Raises the CurrentCellChanging event.

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

A System.ComponentModel.CancelEventArgs that contains the event data.
Overrides

OnCurrentCellConfirmChangesFailed(EventArgs)

Raises the CurrentCellConfirmChangesFailed event.

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

The System.EventArgsthat contains event data.
Overrides

OnCurrentCellControlGotFocus(ControlEventArgs)

Raises the CurrentCellControlGotFocus event.

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

A System.Windows.Forms.Control.ControlEventArgs that contains the event data.
Overrides

OnCurrentCellDeactivated(GridCurrentCellDeactivatedEventArgs)

Raises the CurrentCellDeactivated event.

Declaration
protected override void OnCurrentCellDeactivated(GridCurrentCellDeactivatedEventArgs e)
Parameters
Type Name Description
GridCurrentCellDeactivatedEventArgs e

The GridCurrentCellDeactivatedEventArgs that contains the event data.
Overrides

OnCurrentCellDeactivateFailed(EventArgs)

Raises the CurrentCellDeactivateFailed event.

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

An System.EventArgs that contains the event data.
Overrides

OnCurrentCellDeactivating(CancelEventArgs)

Raises the OnCurrentCellDeactivating(CancelEventArgs) event.

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

The GridCurrentCellMovingEventArgsthat contains event data.
Overrides

OnCurrentCellKeyDown(KeyEventArgs)

User pressed key down.

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

The System.Windows.Forms.KeyEventArgsthat contains event data.
Overrides

OnCurrentCellMoveFailed(GridCurrentCellMoveFailedEventArgs)

Raises the CurrentCellMoveFailed event.

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

A GridCurrentCellMoveFailedEventArgs that contains the event data.
Overrides

OnCurrentCellMoving(GridCurrentCellMovingEventArgs)

Raises the OnCurrentCellMoving(GridCurrentCellMovingEventArgs) event.

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

The GridCurrentCellMovingEventArgsthat contains event data.
Overrides

OnCurrentCellRejectedChanges(EventArgs)

Raises the CurrentCellRejectedChanges event.

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

The System.EventArgsthat contains event data.
Overrides

OnCurrentCellStartEditing(CancelEventArgs)

Raises the CurrentCellStartEditing event.

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

The System.ComponentModel.CancelEventArgsthat contains event data.
Overrides

OnEnter(EventArgs)

Occurs when OnEnter(EventArgs) is called on GridControlBase.

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

OnFieldChooserClosed(FieldChooserClosedEventArgs)

Raises the FieldChooserClosed Event.

Declaration
public virtual void OnFieldChooserClosed(FieldChooserClosedEventArgs e)
Parameters
Type Name Description
FieldChooserClosedEventArgs e

The FieldChooserClosedEventArgsthat contains event data.

OnFieldChooserClosing(FieldChooserClosingEventArgs)

Raises the FieldChooserClosing Event.

Declaration
public virtual void OnFieldChooserClosing(FieldChooserClosingEventArgs e)
Parameters
Type Name Description
FieldChooserClosingEventArgs e

The FieldChooserClosingEventArgsthat contains event data.

OnFieldChooserShowing(FieldChooserShowingEventArgs)

Raises the FieldChooserShowing Event.

Declaration
public void OnFieldChooserShowing(FieldChooserShowingEventArgs e)
Parameters
Type Name Description
FieldChooserShowingEventArgs e

The FieldChooserShowingEventArgsthat contains event data.

OnFieldChooserShown(FieldChooserShownEventArgs)

Raises the FieldChooserShown Event.

Declaration
public virtual void OnFieldChooserShown(FieldChooserShownEventArgs e)
Parameters
Type Name Description
FieldChooserShownEventArgs e

The FieldChooserShownEventArgsthat contains event data.

OnFontChanged(EventArgs)

Used to Change the behavior of the FontChanged event.

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

The System.EventArgsthat contains event data.

OnGridValidating(CancelEventArgs)

overridden to change the OnGridValidating event .

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

The System.ComponentModel.CancelEventArgsthat contains event data.
Overrides

OnKeyDown(KeyEventArgs)

Raises the System.Windows.Forms.Control.KeyDown event.

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

The System.Windows.Forms.KeyEventArgsthat contains event data.
Overrides

OnLeave(EventArgs)

This event occurs when focus leave from control.

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

The System.ComponentModel.CancelEventArgsthat contains event data.
Overrides

OnMouseDown(MouseEventArgs)

This is called from GridClickCellsMouseController or GridSelectCellsMouseController when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the user has pressed a mouse button.

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

A System.Windows.Forms.MouseEventArgs with event data.
Overrides

OnPaint(PaintEventArgs)

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

OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)

Raises the PrepareViewStyleInfo event.

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

A GridPrepareViewStyleInfoEventArgs that contains the event data.
Overrides

OnResizingColumns(GridResizingColumnsEventArgs)

overridden to change the onResizingClumns behavior.

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

The GridResizingColumnsEventArgsthat contains event data.
Overrides

OnRowCollapsed(GridRowEventArgs)

Raises the RowCollapsed event.

Declaration
protected virtual void OnRowCollapsed(GridRowEventArgs e)
Parameters
Type Name Description
GridRowEventArgs e

A GridRowEventArgs that contains the event data.

OnRowCollapsing(GridRowEventArgs)

Raises the RowCollapsing event.

Declaration
protected virtual void OnRowCollapsing(GridRowEventArgs e)
Parameters
Type Name Description
GridRowEventArgs e

A GridRowEventArgs that contains the event data.

OnRowEditing(GridRowEventArgs)

Raises the RowEditing event.

Declaration
protected virtual void OnRowEditing(GridRowEventArgs e)
Parameters
Type Name Description
GridRowEventArgs e

A GridRowEventArgs that contains the event data.

OnRowEnter(GridRowEventArgs)

Raises the RowEnter event.

Declaration
protected virtual void OnRowEnter(GridRowEventArgs e)
Parameters
Type Name Description
GridRowEventArgs e

The System.ComponentModel.CancelEventArgsthat contains event data.

OnRowExpanded(GridRowEventArgs)

Raises the RowExpanded event.

Declaration
protected virtual void OnRowExpanded(GridRowEventArgs e)
Parameters
Type Name Description
GridRowEventArgs e

A GridRowEventArgs that contains the event data.

OnRowExpanding(GridRowEventArgs)

Raises the RowExpanding event.

Declaration
protected virtual void OnRowExpanding(GridRowEventArgs e)
Parameters
Type Name Description
GridRowEventArgs e

A GridRowEventArgs that contains the event data.

OnRowLeave(GridRowEventArgs)

Raises the RowLeave event.

Declaration
protected virtual void OnRowLeave(GridRowEventArgs e)
Parameters
Type Name Description
GridRowEventArgs e

The System.ComponentModel.CancelEventArgsthat contains event data.

OnRowSaved(GridRowEventArgs)

Raises the RowSaved event.

Declaration
protected virtual void OnRowSaved(GridRowEventArgs e)
Parameters
Type Name Description
GridRowEventArgs e

A System.EventArgs that contains the event data.

OnRowsDeleted(GridRowRangeEventArgs)

Raises the RowsDeleted event.

Declaration
protected virtual void OnRowsDeleted(GridRowRangeEventArgs e)
Parameters
Type Name Description
GridRowRangeEventArgs e

A GridRowRangeEventArgs that contains the event data.

OnRowsDeleting(GridRowRangeEventArgs)

Raises the RowsDeleting event.

Declaration
protected virtual void OnRowsDeleting(GridRowRangeEventArgs e)
Parameters
Type Name Description
GridRowRangeEventArgs e

A GridRowRangeEventArgs that contains the event data.

OnSizeChanged(EventArgs)

Used to change the behavior of the SizeChanged event.

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

The System.EventArgsthat contains event data.
Overrides

OnSplitterPaneClosing(EventArgs)

Raises the Syncfusion.Windows.Forms.ScrollControl.SplitterPaneClosing event

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

The System.EventArgsthat contains event data.
Overrides

OnUpdatingChanged(EventArgs)

Raises the UpdatingChanged event.

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

The System.EventArgsthat contains event data.
Overrides

OnValidateFailed(GridValidateFailedEventArgs)

Raises the ValidateFailed event.

Declaration
protected virtual void OnValidateFailed(GridValidateFailedEventArgs e)
Parameters
Type Name Description
GridValidateFailedEventArgs e

A System.EventArgs that contains the event data.
Examples
        private void gridDataBoundGrid3_ValidateFailed(object sender, GridValidateFailedEventArgs e)
        {
            TraceUtil.TraceCurrentMethodInfo(e);
            GridCurrentCell cc = this.gridDataBoundGrid3.CurrentCell;
            cc.Grid.CancelUpdate();
            MessageBox.Show("My Error:" + cc.ErrorMessage);
            cc.RejectChanges();
            cc.ResetError();
        }

OnValidating(CancelEventArgs)

overridden to change the OnValidating event .

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

The System.ComponentModel.CancelEventArgsthat contains event data.
Overrides

OnVisibleChanged(EventArgs)

Raises the System.Windows.Forms.Control.VisibleChanged event.

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

The System.EventArgsthat contains event data.
Overrides

ResetAlphaBlendSelectionColor()

Resets the AlphaBlendSelectionColor property.

Declaration
public void ResetAlphaBlendSelectionColor()

ResetBaseStylesMap()

Resets the BaseStylesMap property.

Declaration
public void ResetBaseStylesMap()

ResetProperties()

Resets the Properties object to its default state.

Declaration
public void ResetProperties()

ResetTableStyle()

Resets the TableStyle property.

Declaration
public void ResetTableStyle()

SetMetroStyle(GridMetroColors)

set the colors of metro theme for Grid

Declaration
public void SetMetroStyle(GridMetroColors metroColors)
Parameters
Type Name Description
GridMetroColors metroColors

Collection of metro color

SetOffice2016ThemeStyle(GridVisualStyles, GridOffice2016ThemeColors)

Sets the custom colors for the Office2016 theme.

Declaration
public void SetOffice2016ThemeStyle(GridVisualStyles visualStyle, GridOffice2016ThemeColors office2016ThemeColors)
Parameters
Type Name Description
GridVisualStyles visualStyle
GridOffice2016ThemeColors office2016ThemeColors

ShouldDeleteKeyClearCells()

Shoulds the delete key clear cells.

Declaration
protected virtual bool ShouldDeleteKeyClearCells()
Returns
Type Description
System.Boolean

returns boolean value

SortColumn(Int32)

Sorts the grid by the specified column.

Declaration
public virtual void SortColumn(int colIndex)
Parameters
Type Name Description
System.Int32 colIndex

The column to use as a key for sorting the data in the grid.
Remarks

If you sort the same column again, the sort order will be reversed.

WireNewControl(GridDataBoundGrid)

Helper method to CreateNewControl to initialize new grid based on current grid settings.

Declaration
protected void WireNewControl(GridDataBoundGrid grid)
Parameters
Type Name Description
GridDataBoundGrid grid

Grid created with CreateNewControl.
Remarks

You should call this method from the overridden CreateNewControl method in your derived GridDataBoundGrid. Overriding CreateNewControl is required if you want your derived grid to be contained in a TabBarSplitterControl or a GridRecordNavigationControl.

Examples
public override Control CreateNewControl(Control parent, int row, int column)
{
MyGridDataBoundGrid grid = new MyGridDataBoundGrid((GridDataBoundGridModel) this.Model);
this.WireNewControl(grid);
return grid;
}

WndProc(ref Message)

This method is overridden to process windows messaged.

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

Events

FieldChooserClosed

Occurs immediately after the FieldChooser dialog is Closed.

Declaration
public event FieldChooserClosedEventHandler FieldChooserClosed
Event Type
Type Description
FieldChooserClosedEventHandler

FieldChooserClosing

Occurs immediately before the FieldChooser dialog is Closed.

Declaration
public event FieldChooserClosingEventHandler FieldChooserClosing
Event Type
Type Description
FieldChooserClosingEventHandler

FieldChooserShowing

Occurs when the FieldChooser dialog is being displayed.

Declaration
public event FieldChooserShowingEventHandler FieldChooserShowing
Event Type
Type Description
FieldChooserShowingEventHandler

FieldChooserShown

Occurs immediately after the FieldChooser dialog is displayed.

Declaration
public event FieldChooserShownEventHandler FieldChooserShown
Event Type
Type Description
FieldChooserShownEventHandler

RowCollapsed

Occurs after the record at the specified row has been expanded to show details of a child relation. Check GetRecordStateAtRowIndex(Int32) of the Binder object for information about the affected record.

Declaration
public event GridRowEventHandler RowCollapsed
Event Type
Type Description
GridRowEventHandler

RowCollapsing

Occurs before the record at the specified row is expanded to show details of a child relation. Check GetRecordStateAtRowIndex(Int32) of the Binder object for information about the affected record.

Declaration
public event GridRowEventHandler RowCollapsing
Event Type
Type Description
GridRowEventHandler

RowEditing

Occurs before the current row is edited. Check GetRecordStateAtRowIndex(Int32) of the Binder object for information about the affected record.

Declaration
public event GridRowEventHandler RowEditing
Event Type
Type Description
GridRowEventHandler

RowEnter

Occurs before the current cell is activated in a new row. Check GetRecordStateAtRowIndex(Int32) of the Binder object for information about the affected record.

Declaration
public event GridRowEventHandler RowEnter
Event Type
Type Description
GridRowEventHandler

RowExpanded

Occurs after the record at the specified row has been expanded to show details of a child relation. Check GetRecordStateAtRowIndex(Int32) of the Binder object for information about the affected record.

Declaration
public event GridRowEventHandler RowExpanded
Event Type
Type Description
GridRowEventHandler

RowExpanding

Occurs before the record at the specified row is being expanded to show details of a child relation. Check GetRecordStateAtRowIndex(Int32) of the Binder object for information about the affected record.

Declaration
public event GridRowEventHandler RowExpanding
Event Type
Type Description
GridRowEventHandler

RowLeave

Occurs after the current cell's changes have been saved and before it is deactivated and the changes in the current row are saved to the underlying data table. Check GetRecordStateAtRowIndex(Int32) of the Binder object for information about the affected record.

Declaration
public event GridRowEventHandler RowLeave
Event Type
Type Description
GridRowEventHandler

RowSaved

Occurs after the changes in the current row have been saved. Check GetRecordStateAtRowIndex(Int32) of the Binder object for information about the affected record.

Declaration
public event GridRowEventHandler RowSaved
Event Type
Type Description
GridRowEventHandler

RowsDeleted

Occurs after the grid deleted a number of records from the datasource.

Declaration
public event GridRowRangeEventHandler RowsDeleted
Event Type
Type Description
GridRowRangeEventHandler

RowsDeleting

Occurs before the grid deletes a number of records from the datasource.

Declaration
public event GridRowRangeEventHandler RowsDeleting
Event Type
Type Description
GridRowRangeEventHandler

ValidateFailed

Occurs when validation of the current record or current cell fails.

Declaration
public event GridValidateFailedEventHandler ValidateFailed
Event Type
Type Description
GridValidateFailedEventHandler
Remarks

You can display a message box or correct cell values in this event.

Explicit Interface Implementations

IVisualStyle.VisualTheme

Declaration
string IVisualStyle.VisualTheme { get; set; }
Returns
Type Description
System.String

Implements

System.IDisposable
System.ComponentModel.ISupportInitialize