Class GridControl

GridControl provides a simplified way to use a grid control and model in one place.

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

GridControl implements methods from GridControlBase and also implements all methods and events that are defined in GridModel. GridControl hides the implementation details that the underlying functionality is implemented in a separate model and view class and provides a one-stop interface to perform all grid operations in one place.

GridControl also adds support for customizing the grid in a visual designer and lets you drop the grid control in a Windows Forms dialog at design-time.

The GridModel can be attached and replaced with another object at run-time. The GridControl class will remove any dependencies on the old model and set up a relationship with the new model.

Constructors

GridControl()

Initializes a new GridControl object with default settings.

Declaration
public GridControl()

GridControl(GridModel)

Initializes a new GridControl and binds it to the specified GridModel.

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

The grid model.

Properties

ActivateCurrentCellBehavior

See ActivateCurrentCellBehavior in the GridModel class for information.

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

This example shows how to use ActivateCurrentCellBehavior property.

       
// Current cell will be activated when clicking on a cell.
this.gridControl1.ActivateCurrentCellBehavior = GridCellActivateAction.ClickOnCell;
' Current cell will be activated when clicking on a cell.
Me.gridControl1.ActivateCurrentCellBehavior = GridCellActivateAction.ClickOnCell

ActiveGridView

See ActiveGridView in the GridModel class for information.

Declaration
public GridControlBase ActiveGridView { get; set; }
Property Value
Type
GridControlBase

AllowDragSelectedCols

See AllowDragSelectedCols in the GridModel class for information.

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

AllowDragSelectedRows

See AllowDragSelectedRows in the GridModel class for information.

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

AllowScrollCurrentCellInView

See AllowScrollCurrentCellInView in the GridModel class for information.

Declaration
public GridScrollCurrentCellReason AllowScrollCurrentCellInView { get; set; }
Property Value
Type
GridScrollCurrentCellReason

AllowSelection

See AllowSelection in the GridModel class for information.

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

AllowThumbTrack

See AllowThumbTrack in the GridModel class for information.

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

AlphaBlendSelectionColor

See AlphaBlendSelectionColor in the GridModel class for information.

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

ApplyVisualStyles

Gets or Sets the Legacy styles in the Table Model Value should be false to apply ColorStyles

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

BanneredRanges

See BanneredRanges in the GridModel class for information.

Declaration
public GridModelBanneredRanges BanneredRanges { get; }
Property Value
Type
GridModelBanneredRanges

BaseStylesMap

See BaseStylesMap in the GridModel class for information.

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

This example shows how to use BaseStylesMap property.

       
// TextColor for all the grid cells will be changed to Blue
this.gridControl1.BaseStylesMap["Standard"].StyleInfo.TextColor = Color.Blue;
// Backcolor for all the header cells (Row and Column) will be changed as "Red"
this.gridControl1.BaseStylesMap["Header"].StyleInfo.BackColor = Color.Red;
' TextColor for all the grid cells will be changed to Blue
Me.gridControl1.BaseStylesMap["Standard"].StyleInfo.TextColor = Color.Blue
' Backcolor for all the header cells (Row and Column) will be changed as "Red"
Me.gridControl1.BaseStylesMap["Header"].StyleInfo.BackColor = Color.Red

BrowseOnly

Gets or sets the enable browse only state for Grid, can't able to edit and update.

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

CellModels

See CellModels in the GridModel class for information.

Declaration
public GridCellModelCollection CellModels { get; }
Property Value
Type
GridCellModelCollection
Examples

This example shows how to use CellModels property.

       
//Specify the cell model to be added in the grid model with cell type name.
this.gridControl1.CellModels.Add("SampleCellType", new GridHeaderCellModel(this.gridControl1.Model));
// Set the added cell type to the cell.
this.gridControl1.ColStyles[1].CellType = "SampleCellType";
' Specify the cell model to be added in the grid model with cell type name.
Me.gridControl1.CellModels.Add("SampleCellType", new GridHeaderCellModel(this.gridControl1.Model))
' Set the added cell type to the cell.
Me.gridControl1.ColStyles[1].CellType = "SampleCellType"

ClickedOnDisabledCellBehavior

Gets or sets Excel-like current cell behavior. When the user clicks on a cell out of a selected range for which .Enabled has been set to false.

Declaration
public GridClickedOnDisabledCellBehavior ClickedOnDisabledCellBehavior { get; set; }
Property Value
Type
GridClickedOnDisabledCellBehavior

ColCount

See ColCount in the GridModel class for information.

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

ColHiddenEntries

Gets or sets a collection of GridColHidden objects. This collection is a wrapper collection for values in the HideCols object. It provides support for modifying values through a CollectionEditor and code serialization at design-time.

Declaration
public GridColHiddenCollection ColHiddenEntries { get; set; }
Property Value
Type
GridColHiddenCollection

ColorStyles

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

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

Cols

See Cols in the GridModel class for information.

Declaration
public GridModelRowColOperations Cols { get; }
Property Value
Type
GridModelRowColOperations

ColStyles

See ColStyles in the GridModel class for information.

Declaration
public GridModelColStylesIndexer ColStyles { get; set; }
Property Value
Type
GridModelColStylesIndexer
Examples

This example shows how to use ColStyles property.

       
// Setting whole column's styles.
this.gridControl1.ColStyles[1].BackColor = Color.Red;
this.gridControl1.ColStyles[1].Font.Facename = "Segoe UI";
this.gridControl1.ColStyles[1].Font.Bold = true;
' Setting whole column's styles.
Me.gridControl1.ColStyles[1].BackColor = Color.Red
Me.gridControl1.ColStyles[1].Font.Facename = "Segoe UI"
Me.gridControl1.ColStyles[1].Font.Bold = true

ColWidthEntries

Gets or sets a collection of GridColWidth objects. This collection is a wrapper collection for values in the ColWidths object. It provides support for modifying values through a CollectionEditor and code serialization at design-time.

Declaration
public GridColWidthCollection ColWidthEntries { get; set; }
Property Value
Type
GridColWidthCollection

ColWidths

See ColWidths in the GridModel class for information.

Declaration
public GridModelRowColSizeIndexer ColWidths { get; set; }
Property Value
Type
GridModelRowColSizeIndexer

CommandStack

See CommandStack in the GridModel class for information.

Declaration
public GridModelCommandManager CommandStack { get; }
Property Value
Type
GridModelCommandManager
Examples

This example shows how to use CommandStack property.

       
// Undo the actions in the grid.
this.gridControl1.CommandStack.Undo();
//Redo the actions in the grid.
this.gridControl1.CommandStack.Redo();
// Getting the current command mode of the grid.
GridCommandMode commandMode = this.gridControl1.CommandStack.Mode;
' Undo the actions in the grid.
Me.gridControl1.CommandStack.Undo()
' Redo the actions in the grid.
Me.gridControl1.CommandStack.Redo()
' Getting the current command mode of the grid.
Dim commandMode As GridCommandMode = Me.gridControl1.CommandStack.Mode

ControllerOptions

See ControllerOptionsChanged in the GridModel class for information.

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

This example shows how to use ControllerOptions property.

       
// Resizing and selecting functionality of row and column will be enabled for grid. Other functionalities like Clicking, OleDropTarget ..etc will not be worked.
this.gridControl1.ControllerOptions = GridControllerOptions.ResizeCells | GridControllerOptions.SelectCells;
' Resizing and selecting functionality of row and column will be enabled for grid. Other functionalities like Clicking, OleDropTarget ..etc will not be worked.
Me.gridControl1.ControllerOptions = (GridControllerOptions.ResizeCells Or GridControllerOptions.SelectCells)

CoveredRanges

See CoveredRanges in the GridModel class for information.

Declaration
public GridModelCoveredRanges CoveredRanges { get; }
Property Value
Type
GridModelCoveredRanges
Examples

This example shows how to use CoveredRanges property.

       
// Defining the covered range.
GridRangeInfo coveredRange = GridRangeInfo.Cells(1, 2, 5, 5);
// Adding the range to be covered.
this.gridControl1.CoveredRanges.Add(coveredRange);
' Defining the covered range.
Dim coveredRange As GridRangeInfo = GridRangeInfo.Cells(1, 2, 5, 5)
' Adding the range to be covered.
Me.gridControl1.CoveredRanges.Add(coveredRange)

CurrentCellInfo

See CurrentCellInfo in the GridModel class for information.

Declaration
public GridCurrentCellInfo CurrentCellInfo { get; set; }
Property Value
Type
GridCurrentCellInfo

CurrentCellRenderer

See CurrentCellRenderer in the GridModel class for information.

Declaration
public GridCellRendererBase CurrentCellRenderer { get; }
Property Value
Type
GridCellRendererBase

CutPaste

See CutPaste in the GridModel class for information.

Declaration
public GridModelCutPaste CutPaste { get; }
Property Value
Type
GridModelCutPaste

Data

See Data in the GridModel class for information.

Declaration
public GridData Data { get; set; }
Property Value
Type
GridData

DataExchange

See DataExchange in the GridModel class for information.

Declaration
public GridModelStyleDataExchange DataExchange { get; }
Property Value
Type
GridModelStyleDataExchange

DataObjectConsumerOptions

See DataObjectConsumerOptions in the GridModel class for information.

Declaration
public GridDataObjectConsumerOptions DataObjectConsumerOptions { get; set; }
Property Value
Type
GridDataObjectConsumerOptions

DefaultGridBorderStyle

See DefaultGridBorderStyle in the GridModel class for information.

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

DiscardReadOnly

See DiscardReadOnly in the GridModel class for information.

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

DisplayHorizontalLines

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

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

DisplayVerticalLines

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

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

DragSelectedCellsMouseButtonsMask

See SelectCellsMouseButtonsMask in the GridModel class for information.

Declaration
public MouseButtons DragSelectedCellsMouseButtonsMask { get; set; }
Property Value
Type
System.Windows.Forms.MouseButtons
Examples

This example shows how to use DragSelectedCellsMouseButtonsMask property.

       
// Setting the mouse button mask to drag either using Left or Right mouse button.
this.gridControl1.DragSelectedCellsMouseButtonsMask = System.Windows.Forms.MouseButtons.Left | System.Windows.Forms.MouseButtons.Right; 
' Setting the mouse button mask to drag either using Left or Right mouse button.
Me.gridControl1.DragSelectedCellsMouseButtonsMask = (System.Windows.Forms.MouseButtons.Left Or System.Windows.Forms.MouseButtons.Right)

DrawOrder

See DrawOrder in the GridModel class for information.

Declaration
public GridDrawOrder DrawOrder { get; set; }
Property Value
Type
GridDrawOrder

EnableTouchMode

Gets or sets the touch mode.

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

EnterKeyBehavior

See EnterKeyBehavior in the GridModel class for information.

Declaration
public GridDirectionType EnterKeyBehavior { get; set; }
Property Value
Type
GridDirectionType
Examples

This example shows how to use EnterKeyBehavior property.

       
// Moves the current cell to the bottom when pressing Enter key.
this.gridControl1.EnterKeyBehavior = GridDirectionType.Bottom;
' Moves the current cell to the bottom when pressing Enter key.
Me.gridControl1.EnterKeyBehavior = GridDirectionType.Bottom

ExcelLikeCurrentCell

See ExcelLikeCurrentCell in the GridModel class for information.

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

ExcelLikeSelectionFrame

See ExcelLikeSelectionFrame in the GridModel class for information.

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

FileName

See FileName in the GridModel class for information.

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

FloatCellsMode

See FloatCellsMode in the GridModel class for information.

Declaration
public GridFloatCellsMode FloatCellsMode { get; set; }
Property Value
Type
GridFloatCellsMode

FloatingCells

See FloatingCells in the GridModel class for information.

Declaration
public GridModelFloatingCells FloatingCells { get; }
Property Value
Type
GridModelFloatingCells

Font

Specifies the font used to display text in the grid.

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

GridCells

Gets or sets a collection of GridCellInfo objects. This collection is a wrapper collection for cells in the GridData object. It provides support for code serialization at design-time.

Declaration
public GridCellInfoCollection GridCells { get; set; }
Property Value
Type
GridCellInfoCollection

GridLineColor

Gets or sets the color of grid lines.

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

GridVisualStyles

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

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

GridVisualStylesDrawing

Gets or sets the VisualStylesDrawing object

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

HasCurrentCellInfo

See HasCurrentCellInfo in the GridModel class for information.

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

HasData

See HasData in the GridModel class for information.

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

HideCols

See HideCols in the GridModel class for information.

Declaration
public GridModelHideRowColsIndexer HideCols { get; set; }
Property Value
Type
GridModelHideRowColsIndexer
Examples

This example shows how to use HideCols property.

       
// Hiding the first column.
this.gridControl1.HideCols[1] = true;
// Removing the second column from hidden.
this.gridControl1.HideCols[4] = false;
' Hiding the first column.
Me.gridControl1.HideCols[1] = true
' Removing the second column from hidden.
Me.gridControl1.HideCols[4] = false

HideRows

See HideRows in the GridModel class for information.

Declaration
public GridModelHideRowColsIndexer HideRows { get; set; }
Property Value
Type
GridModelHideRowColsIndexer
Examples

This example shows how to use HideRows property.

       
// Hiding the first row.
this.gridControl1.HideRows[1] = true;
// Removing the first row from hidden.
this.gridControl1.HideRows [3] = false;
' Hiding the first row.
Me.gridControl1.HideRows[1] = true
' Removing the first row from hidden.
Me.gridControl1.HideRows [3] = false

HighlightFrozenLine

See HighlightFrozenLine in the GridModel class for information.

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

HorizontalScrollTips

See HorizontalScrollTips in the GridModel class for information.

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

HorizontalThumbTrack

See HorizontalThumbTrack in the GridModel class for information.

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

IgnoreReadOnly

See IgnoreReadOnly in the GridModel class for information.

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

Initializing

See Initializing in the GridModel class for information.

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

IsExcelFilterWired

Indicates the grid is wired with excel style filter. This is specifically used to apply the filter in excel sheet while exporting.

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

IsUntitled

See IsUntitled in the GridModel class for information.

Declaration
public bool IsUntitled { get; }
Property Value
Type
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
GridStyleInfo

ListBoxSelectionMode

Gets or sets the method in which items are selected in the GridControl when it is being used in list box mode .

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

This example shows how to use ListBoxSelectionMode property.

       
// Setting grid's selection mode as MultiExtended
this.gridControl1.ListBoxSelectionMode = SelectionMode.MultiExtended;
' Setting grid control selection mode as MultiExtended
Me.gridControl1.ListBoxSelectionMode = SelectionMode.MultiExtended

MinResizeColSize

See MinResizeColSize in the GridModel class for information.

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

MinResizeRowSize

See MinResizeRowSize in the GridModel class for information.

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

Modified

See Modified in the GridModel class for information.

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

NumberedColHeaders

See NumberedColHeaders in the GridModel class for information.

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

NumberedRowHeaders

See NumberedRowHeaders in the GridModel class for information.

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

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
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
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
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
System.Boolean

Properties

See Properties in the GridModel class for information.

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

Provider

Assigns the new UIAProvider for Accessibility.

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

RangeStyles

Gets or sets a collection of GridRangeStyle objects. This collection is a wrapper collection for cells in the GridData object. It provides support for modifying cells through a CollectionEditor and code serialization at design-time.

Declaration
public GridRangeStyleCollection RangeStyles { get; set; }
Property Value
Type
GridRangeStyleCollection

ReadOnly

See ReadOnly in the GridModel class for information.

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

RefreshCurrentCellBehavior

See ShowCurrentCellBorderBehavior in the GridModel class for information.

Declaration
public GridRefreshCurrentCellBehavior RefreshCurrentCellBehavior { get; set; }
Property Value
Type
GridRefreshCurrentCellBehavior

ResizeColsBehavior

See ResizeColsBehavior in the GridModel class for information.

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

ResizeRowsBehavior

See ResizeRowsBehavior in the GridModel class for information.

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

RowCount

See RowCount in the GridModel class for information.

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

RowHeightEntries

Gets or sets a collection of GridRowHeight objects. This collection is a wrapper collection for values in the RowHeights object. It provides support for modifying values through a CollectionEditor and code serialization at design-time.

Declaration
public GridRowHeightCollection RowHeightEntries { get; set; }
Property Value
Type
GridRowHeightCollection

RowHeights

See RowHeights in the GridModel class for information.

Declaration
public GridModelRowColSizeIndexer RowHeights { get; set; }
Property Value
Type
GridModelRowColSizeIndexer

RowHiddenEntries

Gets or sets a collection of GridRowHidden objects. This collection is a wrapper collection for values in the HideRows object. It provides support for modifying values through a CollectionEditor and code serialization at design-time.

Declaration
public GridRowHiddenCollection RowHiddenEntries { get; set; }
Property Value
Type
GridRowHiddenCollection

Rows

See Rows in the GridModel class for information.

Declaration
public GridModelRowColOperations Rows { get; }
Property Value
Type
GridModelRowColOperations

RowStyles

See RowStyles and see RowStylesin the GridModel class for information.

Declaration
public GridModelRowStylesIndexer RowStyles { get; }
Property Value
Type
GridModelRowStylesIndexer
Examples

This example shows how to use RowStyles property.

       
// Setting styles for the whole row with the specific row index.
this.gridControl1.RowStyles[1].BackColor = Color.Red;
this.gridControl1.RowStyles[1].Font.Facename = "Segoe UI";
this.gridControl1.RowStyles[1].Font.Bold = true;
' Setting styles for the whole row with the specific row index.
Me.gridControl1.RowStyles(1).BackColor = Color.Red
Me.gridControl1.RowStyles(1).Font.Facename = "Segoe UI"
Me.gridControl1.RowStyles(1).Font.Bold = true

ScrollFrozen

See ScrollFrozen in the GridModel class for information.

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

SelectCellsMouseButtonsMask

See SelectCellsMouseButtonsMask in the GridModel class for information.

Declaration
public MouseButtons SelectCellsMouseButtonsMask { get; set; }
Property Value
Type
System.Windows.Forms.MouseButtons

SerializeCellsBehavior

Gets or sets how to serialize grid data at design-time. You can choose to serialize cell contents as code into the Forms InitializeComponent method or you can choose to serialize cell contents into a ResX file. Default is GridSerializeCellsBehavior.SerializeIntoCode.

Declaration
public GridSerializeCellsBehavior SerializeCellsBehavior { get; set; }
Property Value
Type
GridSerializeCellsBehavior
Remarks

If you have a larger number of cells then you should switch to Resx serialization. For smaller number of cells SerializeIntoCode is easier to maintain since you can change cell contents directly within the Forms code.

ShouldSynchronizeCurrentCell

See ShouldSynchronizeCurrentCell in the GridModel class for information.

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

ShowColumnHeaders

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

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

ShowCurrentCellBorderBehavior

See ShowCurrentCellBorderBehavior in the GridModel class for information.

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

This example shows how to use ShowCurrentCellBorderBehavior property.

       
//Current cell border will always visible
this.gridControl1.ShowCurrentCellBorderBehavior = GridShowCurrentCellBorder.AlwaysVisible;
'Current cell border will always visible
Me.gridControl1.ShowCurrentCellBorderBehavior = GridShowCurrentCellBorder.AlwaysVisible

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
System.Boolean

Site

Gets or sets the site of the control.

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

SmoothControlResize

See SmoothControlResize in the GridModel class for information.

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

TableStyle

See TableStyle in the GridModel class for information.

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

This example shows how to use TableStyle/// This example shows how to use CoveredRanges property. property.

       
this.gridControl1.TableStyle.TextColor = Color.Red;
this.gridControl1.TableStyle.Font.Facename = "Segoe UI";
this.gridControl1.TableStyle.Font.Size = 15;
Me.gridControl1.TableStyle.TextColor = Color.Red
Me.gridControl1.TableStyle.Font.Facename = "Segoe UI"
Me.gridControl1.TableStyle.Font.Size = 15

TextDataExchange

See TextDataExchange in the GridModel class for information.

Declaration
public GridModelTextDataExchange TextDataExchange { get; }
Property Value
Type
GridModelTextDataExchange

TransparentBackground

See TransparentBackground in the GridModel class for information.

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

UpdateOptions

See UpdateOptions in the GridModel class for information.

Declaration
public override BeginUpdateOptions UpdateOptions { get; }
Property Value
Type
BeginUpdateOptions
Overrides

UserData

See UserData in the GridModel class for information.

Declaration
public IDictionary UserData { get; }
Property Value
Type
System.Collections.IDictionary

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
System.Boolean

VerticalScrollTips

See VerticalScrollTips in the GridModel class for information.

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

VerticalThumbTrack

See VerticalThumbTrack in the GridModel class for information.

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

Methods

add_BanneredRangesChanged(GridBanneredRangesChangedEventHandler)

Declaration
public void add_BanneredRangesChanged(GridBanneredRangesChangedEventHandler value)
Parameters
Type Name Description
GridBanneredRangesChangedEventHandler value

add_BanneredRangesChanging(GridBanneredRangesChangingEventHandler)

Declaration
public void add_BanneredRangesChanging(GridBanneredRangesChangingEventHandler value)
Parameters
Type Name Description
GridBanneredRangesChangingEventHandler value

add_CellsChanged(GridCellsChangedEventHandler)

Declaration
public void add_CellsChanged(GridCellsChangedEventHandler value)
Parameters
Type Name Description
GridCellsChangedEventHandler value

add_CellsChanging(GridCellsChangingEventHandler)

Declaration
public void add_CellsChanging(GridCellsChangingEventHandler value)
Parameters
Type Name Description
GridCellsChangingEventHandler value

add_ClearingCells(GridClearingCellsEventHandler)

Declaration
public void add_ClearingCells(GridClearingCellsEventHandler value)
Parameters
Type Name Description
GridClearingCellsEventHandler value

add_ClipboardCanCopy(GridCutPasteEventHandler)

Declaration
public void add_ClipboardCanCopy(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

add_ClipboardCanCut(GridCutPasteEventHandler)

Declaration
public void add_ClipboardCanCut(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

add_ClipboardCanPaste(GridCutPasteEventHandler)

Declaration
public void add_ClipboardCanPaste(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

add_ClipboardCopy(GridCutPasteEventHandler)

Declaration
public void add_ClipboardCopy(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

add_ClipboardCopyToBuffer(ClipboardCopyToBufferEventHandler)

Declaration
public void add_ClipboardCopyToBuffer(ClipboardCopyToBufferEventHandler value)
Parameters
Type Name Description
ClipboardCopyToBufferEventHandler value

add_ClipboardCut(GridCutPasteEventHandler)

Declaration
public void add_ClipboardCut(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

add_ClipboardPaste(GridCutPasteEventHandler)

Declaration
public void add_ClipboardPaste(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

add_ColsHidden(GridRowColHiddenEventHandler)

Declaration
public void add_ColsHidden(GridRowColHiddenEventHandler value)
Parameters
Type Name Description
GridRowColHiddenEventHandler value

add_ColsHiding(GridRowColHidingEventHandler)

Declaration
public void add_ColsHiding(GridRowColHidingEventHandler value)
Parameters
Type Name Description
GridRowColHidingEventHandler value

add_ColsInserted(GridRangeInsertedEventHandler)

Declaration
public void add_ColsInserted(GridRangeInsertedEventHandler value)
Parameters
Type Name Description
GridRangeInsertedEventHandler value

add_ColsInserting(GridRangeInsertingEventHandler)

Declaration
public void add_ColsInserting(GridRangeInsertingEventHandler value)
Parameters
Type Name Description
GridRangeInsertingEventHandler value

add_ColsMoved(GridRangeMovedEventHandler)

Declaration
public void add_ColsMoved(GridRangeMovedEventHandler value)
Parameters
Type Name Description
GridRangeMovedEventHandler value

add_ColsMoving(GridRangeMovingEventHandler)

Declaration
public void add_ColsMoving(GridRangeMovingEventHandler value)
Parameters
Type Name Description
GridRangeMovingEventHandler value

add_ColsRemoved(GridRangeRemovedEventHandler)

Declaration
public void add_ColsRemoved(GridRangeRemovedEventHandler value)
Parameters
Type Name Description
GridRangeRemovedEventHandler value

add_ColsRemoving(GridRangeRemovingEventHandler)

Declaration
public void add_ColsRemoving(GridRangeRemovingEventHandler value)
Parameters
Type Name Description
GridRangeRemovingEventHandler value

add_ColWidthsChanged(GridRowColSizeChangedEventHandler)

Declaration
public void add_ColWidthsChanged(GridRowColSizeChangedEventHandler value)
Parameters
Type Name Description
GridRowColSizeChangedEventHandler value

add_ColWidthsChanging(GridRowColSizeChangingEventHandler)

Declaration
public void add_ColWidthsChanging(GridRowColSizeChangingEventHandler value)
Parameters
Type Name Description
GridRowColSizeChangingEventHandler value

add_CoveredRangesChanged(GridCoveredRangesChangedEventHandler)

Declaration
public void add_CoveredRangesChanged(GridCoveredRangesChangedEventHandler value)
Parameters
Type Name Description
GridCoveredRangesChangedEventHandler value

add_CoveredRangesChanging(GridCoveredRangesChangingEventHandler)

Declaration
public void add_CoveredRangesChanging(GridCoveredRangesChangingEventHandler value)
Parameters
Type Name Description
GridCoveredRangesChangingEventHandler value

add_DefaultColWidthChanged(GridDefaultSizeChangedEventHandler)

Declaration
public void add_DefaultColWidthChanged(GridDefaultSizeChangedEventHandler value)
Parameters
Type Name Description
GridDefaultSizeChangedEventHandler value

add_DefaultColWidthChanging(GridDefaultSizeChangingEventHandler)

Declaration
public void add_DefaultColWidthChanging(GridDefaultSizeChangingEventHandler value)
Parameters
Type Name Description
GridDefaultSizeChangingEventHandler value

add_DefaultRowHeightChanged(GridDefaultSizeChangedEventHandler)

Declaration
public void add_DefaultRowHeightChanged(GridDefaultSizeChangedEventHandler value)
Parameters
Type Name Description
GridDefaultSizeChangedEventHandler value

add_DefaultRowHeightChanging(GridDefaultSizeChangingEventHandler)

Declaration
public void add_DefaultRowHeightChanging(GridDefaultSizeChangingEventHandler value)
Parameters
Type Name Description
GridDefaultSizeChangingEventHandler value

add_EndUpdateRequest(GridEndUpdateRequestEventHandler)

Declaration
public void add_EndUpdateRequest(GridEndUpdateRequestEventHandler value)
Parameters
Type Name Description
GridEndUpdateRequestEventHandler value

add_FilterBarChoices(GridFilterBarChoicesEventHandler)

Declaration
public void add_FilterBarChoices(GridFilterBarChoicesEventHandler value)
Parameters
Type Name Description
GridFilterBarChoicesEventHandler value

add_FilterBarSelectionChanged(FilterBarSelectionChangedEventHandler)

Declaration
public void add_FilterBarSelectionChanged(FilterBarSelectionChangedEventHandler value)
Parameters
Type Name Description
FilterBarSelectionChangedEventHandler value

add_FilterBarSelectionChanging(FilterBarSelectionChangingEventHandler)

Declaration
public void add_FilterBarSelectionChanging(FilterBarSelectionChangingEventHandler value)
Parameters
Type Name Description
FilterBarSelectionChangingEventHandler value

add_FloatingCellsChanged(GridFloatingCellsChangedEventHandler)

Declaration
public void add_FloatingCellsChanged(GridFloatingCellsChangedEventHandler value)
Parameters
Type Name Description
GridFloatingCellsChangedEventHandler value

add_FrozenColCountChanged(GridCountChangedEventHandler)

Declaration
public void add_FrozenColCountChanged(GridCountChangedEventHandler value)
Parameters
Type Name Description
GridCountChangedEventHandler value

add_FrozenColCountChanging(GridCountChangingEventHandler)

Declaration
public void add_FrozenColCountChanging(GridCountChangingEventHandler value)
Parameters
Type Name Description
GridCountChangingEventHandler value

add_FrozenRowCountChanged(GridCountChangedEventHandler)

Declaration
public void add_FrozenRowCountChanged(GridCountChangedEventHandler value)
Parameters
Type Name Description
GridCountChangedEventHandler value

add_FrozenRowCountChanging(GridCountChangingEventHandler)

Declaration
public void add_FrozenRowCountChanging(GridCountChangingEventHandler value)
Parameters
Type Name Description
GridCountChangingEventHandler value

add_HeaderColCountChanged(GridCountChangedEventHandler)

Declaration
public void add_HeaderColCountChanged(GridCountChangedEventHandler value)
Parameters
Type Name Description
GridCountChangedEventHandler value

add_HeaderColCountChanging(GridCountChangingEventHandler)

Declaration
public void add_HeaderColCountChanging(GridCountChangingEventHandler value)
Parameters
Type Name Description
GridCountChangingEventHandler value

add_HeaderRowCountChanged(GridCountChangedEventHandler)

Declaration
public void add_HeaderRowCountChanged(GridCountChangedEventHandler value)
Parameters
Type Name Description
GridCountChangedEventHandler value

add_HeaderRowCountChanging(GridCountChangingEventHandler)

Declaration
public void add_HeaderRowCountChanging(GridCountChangingEventHandler value)
Parameters
Type Name Description
GridCountChangingEventHandler value

add_MergeCellsChanged(GridMergeCellsChangedEventHandler)

Declaration
public void add_MergeCellsChanged(GridMergeCellsChangedEventHandler value)
Parameters
Type Name Description
GridMergeCellsChangedEventHandler value

add_OperationFeedback(OperationFeedbackEventHandler)

Declaration
public void add_OperationFeedback(OperationFeedbackEventHandler value)
Parameters
Type Name Description
OperationFeedbackEventHandler value

add_ParseCommonFormats(GridCellTextEventHandler)

Declaration
public void add_ParseCommonFormats(GridCellTextEventHandler value)
Parameters
Type Name Description
GridCellTextEventHandler value

add_PasteCellText(GridPasteCellTextEventHandler)

Declaration
public void add_PasteCellText(GridPasteCellTextEventHandler value)
Parameters
Type Name Description
GridPasteCellTextEventHandler value

add_PrepareChangeSelection(GridPrepareChangeSelectionEventHandler)

Declaration
public void add_PrepareChangeSelection(GridPrepareChangeSelectionEventHandler value)
Parameters
Type Name Description
GridPrepareChangeSelectionEventHandler value

add_PrepareGraphics(GraphicsEventHandler)

Declaration
public void add_PrepareGraphics(GraphicsEventHandler value)
Parameters
Type Name Description
GraphicsEventHandler value

add_QueryBanneredRange(GridQueryBanneredRangeEventHandler)

Declaration
public void add_QueryBanneredRange(GridQueryBanneredRangeEventHandler value)
Parameters
Type Name Description
GridQueryBanneredRangeEventHandler value

add_QueryCanMergeCells(GridQueryCanMergeCellsEventHandler)

Declaration
public void add_QueryCanMergeCells(GridQueryCanMergeCellsEventHandler value)
Parameters
Type Name Description
GridQueryCanMergeCellsEventHandler value

add_QueryCellFormattedText(GridCellTextEventHandler)

Declaration
public void add_QueryCellFormattedText(GridCellTextEventHandler value)
Parameters
Type Name Description
GridCellTextEventHandler value

add_QueryCellInfo(GridQueryCellInfoEventHandler)

Declaration
public void add_QueryCellInfo(GridQueryCellInfoEventHandler value)
Parameters
Type Name Description
GridQueryCellInfoEventHandler value

add_QueryCellModel(GridQueryCellModelEventHandler)

Declaration
public void add_QueryCellModel(GridQueryCellModelEventHandler value)
Parameters
Type Name Description
GridQueryCellModelEventHandler value

add_QueryCellText(GridCellTextEventHandler)

Declaration
public void add_QueryCellText(GridCellTextEventHandler value)
Parameters
Type Name Description
GridCellTextEventHandler value

add_QueryColCount(GridRowColCountEventHandler)

Declaration
public void add_QueryColCount(GridRowColCountEventHandler value)
Parameters
Type Name Description
GridRowColCountEventHandler value

add_QueryColWidth(GridRowColSizeEventHandler)

Declaration
public void add_QueryColWidth(GridRowColSizeEventHandler value)
Parameters
Type Name Description
GridRowColSizeEventHandler value

add_QueryCoveredRange(GridQueryCoveredRangeEventHandler)

Declaration
public void add_QueryCoveredRange(GridQueryCoveredRangeEventHandler value)
Parameters
Type Name Description
GridQueryCoveredRangeEventHandler value

add_QueryOleDataSourceData(GridQueryOleDataSourceDataEventHandler)

Declaration
public void add_QueryOleDataSourceData(GridQueryOleDataSourceDataEventHandler value)
Parameters
Type Name Description
GridQueryOleDataSourceDataEventHandler value

add_QueryRowCount(GridRowColCountEventHandler)

Declaration
public void add_QueryRowCount(GridRowColCountEventHandler value)
Parameters
Type Name Description
GridRowColCountEventHandler value

add_QueryRowHeight(GridRowColSizeEventHandler)

Declaration
public void add_QueryRowHeight(GridRowColSizeEventHandler value)
Parameters
Type Name Description
GridRowColSizeEventHandler value

add_RowHeightsChanged(GridRowColSizeChangedEventHandler)

Declaration
public void add_RowHeightsChanged(GridRowColSizeChangedEventHandler value)
Parameters
Type Name Description
GridRowColSizeChangedEventHandler value

add_RowHeightsChanging(GridRowColSizeChangingEventHandler)

Declaration
public void add_RowHeightsChanging(GridRowColSizeChangingEventHandler value)
Parameters
Type Name Description
GridRowColSizeChangingEventHandler value

add_RowsHidden(GridRowColHiddenEventHandler)

Declaration
public void add_RowsHidden(GridRowColHiddenEventHandler value)
Parameters
Type Name Description
GridRowColHiddenEventHandler value

add_RowsHiding(GridRowColHidingEventHandler)

Declaration
public void add_RowsHiding(GridRowColHidingEventHandler value)
Parameters
Type Name Description
GridRowColHidingEventHandler value

add_RowsInserted(GridRangeInsertedEventHandler)

Declaration
public void add_RowsInserted(GridRangeInsertedEventHandler value)
Parameters
Type Name Description
GridRangeInsertedEventHandler value

add_RowsInserting(GridRangeInsertingEventHandler)

Declaration
public void add_RowsInserting(GridRangeInsertingEventHandler value)
Parameters
Type Name Description
GridRangeInsertingEventHandler value

add_RowsMoved(GridRangeMovedEventHandler)

Declaration
public void add_RowsMoved(GridRangeMovedEventHandler value)
Parameters
Type Name Description
GridRangeMovedEventHandler value

add_RowsMoving(GridRangeMovingEventHandler)

Declaration
public void add_RowsMoving(GridRangeMovingEventHandler value)
Parameters
Type Name Description
GridRangeMovingEventHandler value

add_RowsRemoved(GridRangeRemovedEventHandler)

Declaration
public void add_RowsRemoved(GridRangeRemovedEventHandler value)
Parameters
Type Name Description
GridRangeRemovedEventHandler value

add_RowsRemoving(GridRangeRemovingEventHandler)

Declaration
public void add_RowsRemoving(GridRangeRemovingEventHandler value)
Parameters
Type Name Description
GridRangeRemovingEventHandler value

add_SaveCellFormattedText(GridCellTextEventHandler)

Declaration
public void add_SaveCellFormattedText(GridCellTextEventHandler value)
Parameters
Type Name Description
GridCellTextEventHandler value

add_SaveCellInfo(GridSaveCellInfoEventHandler)

Declaration
public void add_SaveCellInfo(GridSaveCellInfoEventHandler value)
Parameters
Type Name Description
GridSaveCellInfoEventHandler value

add_SaveCellText(GridCellTextEventHandler)

Declaration
public void add_SaveCellText(GridCellTextEventHandler value)
Parameters
Type Name Description
GridCellTextEventHandler value

add_SaveColCount(GridRowColCountEventHandler)

Declaration
public void add_SaveColCount(GridRowColCountEventHandler value)
Parameters
Type Name Description
GridRowColCountEventHandler value

add_SaveColWidth(GridRowColSizeEventHandler)

Declaration
public void add_SaveColWidth(GridRowColSizeEventHandler value)
Parameters
Type Name Description
GridRowColSizeEventHandler value

add_SaveRowCount(GridRowColCountEventHandler)

Declaration
public void add_SaveRowCount(GridRowColCountEventHandler value)
Parameters
Type Name Description
GridRowColCountEventHandler value

add_SaveRowHeight(GridRowColSizeEventHandler)

Declaration
public void add_SaveRowHeight(GridRowColSizeEventHandler value)
Parameters
Type Name Description
GridRowColSizeEventHandler value

add_SelectionChanged(GridSelectionChangedEventHandler)

Declaration
public void add_SelectionChanged(GridSelectionChangedEventHandler value)
Parameters
Type Name Description
GridSelectionChangedEventHandler value

add_SelectionChanging(GridSelectionChangingEventHandler)

Declaration
public void add_SelectionChanging(GridSelectionChangingEventHandler value)
Parameters
Type Name Description
GridSelectionChangingEventHandler value

AddBorders(Size, GridStyleInfo)

Adds border margins to given cell client area size. The borders are determined from a specified style with cell content information.

Declaration
public Size AddBorders(Size size, GridStyleInfo style)
Parameters
Type Name Description
System.Drawing.Size size

The System.Drawing.Size with the cell size.
GridStyleInfo style

The GridStyleInfo object that holds cell information.
Returns
Type Description
System.Drawing.Size

The System.Drawing.Size with the cell size including its borders.

ApplyScaleToControl(Single)

applies the scaling

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

Represents the floating point number

Attach(GridModel)

Attaches a model for the grid control.

Declaration
public void Attach(GridModel model)
Parameters
Type Name Description
GridModel model

The grid model to be attached.
Remarks

The GridModel can be attached and replaced with another object at run-time. The GridControl class will remove any dependencies on the old model and set up a relationship with the new model.

When you replace the model, the grid control will completely refresh and draw the new cell data.

BeginInit()

See BeginInit() in the GridModel class for information.

Declaration
public void BeginInit()

BeginUpdate(BeginUpdateOptions, String)

Suspends the painting of associated grid controls until the EndUpdate method is called and records a command description why painting is suspended.

Declaration
public void BeginUpdate(BeginUpdateOptions options, string commandDesc)
Parameters
Type Name Description
BeginUpdateOptions options

Specifies the painting support during the BeginUpdate, EndUpdate batch.
System.String commandDesc

A description of the command.

BeginUpdateModel(BeginUpdateOptions, Boolean)

See BeginUpdate() in the GridModel class for information.

Declaration
public override void BeginUpdateModel(BeginUpdateOptions options, bool fromModel)
Parameters
Type Name Description
BeginUpdateOptions options
System.Boolean fromModel
Overrides

CalculatePreferredCellSize(Graphics, Int32, Int32, GridQueryBounds)

See CalculatePreferredCellSize(Graphics, Int32, Int32, GridStyleInfo, GridQueryBounds) in the GridModel class for information.

Declaration
public Size CalculatePreferredCellSize(Graphics g, int rowIndex, int colIndex, GridQueryBounds queryBounds)
Parameters
Type Name Description
System.Drawing.Graphics g
System.Int32 rowIndex
System.Int32 colIndex
GridQueryBounds queryBounds
Returns
Type
System.Drawing.Size

CalculatePreferredCellSize(Graphics, Int32, Int32, GridStyleInfo, GridQueryBounds)

See CalculatePreferredCellSize(Graphics, Int32, Int32, GridStyleInfo, GridQueryBounds) in the GridModel class for information.

Declaration
public Size CalculatePreferredCellSize(Graphics g, int rowIndex, int colIndex, GridStyleInfo style, GridQueryBounds queryBounds)
Parameters
Type Name Description
System.Drawing.Graphics g
System.Int32 rowIndex
System.Int32 colIndex
GridStyleInfo style
GridQueryBounds queryBounds
Returns
Type
System.Drawing.Size

CanClearSelection()

Checks if a range of cells is selected or if the grid has a current cell which contents can be cleared.

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

True if clearing cells with Clear(Boolean) is possible; False otherwise.
Remarks

Use this to enable a "Clear" menu item or gray it out.

ChangeCells(GridRangeInfo, GridStyleInfo)

See ChangeCells(GridRangeInfo, GridStyleInfo[], StyleModifyType) in the GridModel class for information.

Declaration
public bool ChangeCells(GridRangeInfo range, GridStyleInfo cellInfo)
Parameters
Type Name Description
GridRangeInfo range
GridStyleInfo cellInfo
Returns
Type
System.Boolean
Examples

This example shows how to change the cell values with the specified style and range.

       
// Defining the new cell styles.
GridStyleInfo newStyle = new GridStyleInfo();
newStyle.CellType = GridCellTypeName.ComboBox;
// Setting the styles of range of cells to new style.
this.gridControl1.ChangeCells(GridRangeInfo.Rows(1, 2), newStyle);
' Defining the new cell styles.
Dim newStyle As GridStyleInfo = New GridStyleInfo
newStyle.CellType = GridCellTypeName.ComboBox
// Setting the styles of range of cells to new style.
Me.gridControl1.ChangeCells(GridRangeInfo.Rows(1, 2), newStyle)

ChangeCells(GridRangeInfo, GridStyleInfo, StyleModifyType)

See ChangeCells(GridRangeInfo, GridStyleInfo[], StyleModifyType) in the GridModel class for information.

Declaration
public bool ChangeCells(GridRangeInfo range, GridStyleInfo cellInfo, StyleModifyType modifyType)
Parameters
Type Name Description
GridRangeInfo range
GridStyleInfo cellInfo
StyleModifyType modifyType
Returns
Type
System.Boolean
Examples

This example shows how to change the cell values with the specified style and range.

       
// Defining the new cell styles.
GridStyleInfo newStyle = new GridStyleInfo();
newStyle.CellType = GridCellTypeName.ComboBox;
// Setting the styles of range of cells to new style.
this.gridControl1.ChangeCells(GridRangeInfo.Rows(1, 2), newStyle, Syncfusion.Styles.StyleModifyType.Changes);
Dim newStyle As GridStyleInfo = New GridStyleInfo
newStyle.CellType = GridCellTypeName.ComboBox
' Setting the styles of range of cells to new style.
Me.gridControl1.ChangeCells(GridRangeInfo.Rows(1, 2), newStyle, Syncfusion.Styles.StyleModifyType.Changes)

ChangeCells(GridRangeInfo, GridStyleInfo[])

See ChangeCells(GridRangeInfo, GridStyleInfo[], StyleModifyType) in the GridModel class for information.

Declaration
public bool ChangeCells(GridRangeInfo range, GridStyleInfo[] cellsInfo)
Parameters
Type Name Description
GridRangeInfo range
GridStyleInfo[] cellsInfo
Returns
Type
System.Boolean
Examples

This example shows how to change the cell values with the specified range and array of specific style values.

       
// Defining the new cell styles.
GridStyleInfo newStyle = new GridStyleInfo();
newStyle.CellType = GridCellTypeName.ComboBox;
// Setting the styles of range of cells to new style.
this.gridControl1.ChangeCells(GridRangeInfo.Rows(1, 2), newStyle, Syncfusion.Styles.StyleModifyType.Changes);
' Defining the new cell styles.
Dim newStyle As GridStyleInfo = New GridStyleInfo
newStyle.CellType = GridCellTypeName.ComboBox
' Setting the styles of range of cells to new style.
Me.gridControl1.ChangeCells(GridRangeInfo.Rows(1, 2), newStyle, Syncfusion.Styles.StyleModifyType.Changes)

ChangeCells(GridRangeInfo, GridStyleInfo[], StyleModifyType)

See ChangeCells(GridRangeInfo, GridStyleInfo[], StyleModifyType) in the GridModel class for information.

Declaration
public bool ChangeCells(GridRangeInfo range, GridStyleInfo[] cellsInfo, StyleModifyType modifyType)
Parameters
Type Name Description
GridRangeInfo range
GridStyleInfo[] cellsInfo
StyleModifyType modifyType
Returns
Type
System.Boolean
Examples

This example shows how to use CoveredRanges property.

       
GridStyleInfo style1 = new GridStyleInfo();
style1.TextColor = Color.Blue;
GridStyleInfo style2 = new GridStyleInfo();
style2.BackColor = Color.Red;
GridStyleInfo[] styles = new GridStyleInfo[] { style1, style2 };
GridRangeInfo range = GridRangeInfo.Rows(1,2);       
this.gridControl1.ChangeCells(range, styles, Syncfusion.Styles.StyleModifyType.Remove);
Dim style1 As GridStyleInfo = New GridStyleInfo
style1.TextColor = Color.Blue
Dim style2 As GridStyleInfo = New GridStyleInfo
style2.BackColor = Color.Red
Dim styles() As GridStyleInfo = New GridStyleInfo() {style1, style2}
Dim range As GridRangeInfo = GridRangeInfo.Rows(1, 2)
Me.gridControl1.ChangeCells(range, styles, Syncfusion.Styles.StyleModifyType.Remove)

ChangeCells(GridRangeInfo, String)

See ChangeCells(GridRangeInfo, GridStyleInfo[], StyleModifyType) in the GridModel class for information.

Declaration
public bool ChangeCells(GridRangeInfo range, string textValue)
Parameters
Type Name Description
GridRangeInfo range
System.String textValue
Returns
Type
System.Boolean
Examples

This example shows how to change the cell values with the specified text and range.

       
// The target range to set the text.
GridRangeInfo range = GridRangeInfo.Cols(1, 2);

//Setting the "SampleData" text to target range.
this.gridControl1.ChangeCells(range, "SampleData");
' The target range to set the text.
Dim range As GridRangeInfo = GridRangeInfo.Cols(1, 2)

'Setting the "SampleData" text to target range.
Me.gridControl1.ChangeCells(range, "SampleData")

ChangeSelectionState(Int32, Int32, GridRangeInfo[])

Records current selection state - current cell and selected ranges. Will be used for restoring selections when performing undo / redo,

Declaration
public void ChangeSelectionState(int currentRow, int currentCol, GridRangeInfo[] ranges)
Parameters
Type Name Description
System.Int32 currentRow

The row index of current cell.
System.Int32 currentCol

The column index of current cell.
GridRangeInfo[] ranges

The current list of selected ranges.

Clear(Boolean)

See Clear(Boolean) in the GridModel class for information.

Declaration
public bool Clear(bool styleOrValue)
Parameters
Type Name Description
System.Boolean styleOrValue
Returns
Type
System.Boolean

ClearCells(GridRangeInfo, Boolean)

See ClearCells(GridRangeInfo, Boolean) in the GridModel class for information.

Declaration
public bool ClearCells(GridRangeInfo range, bool bStyleOrValue)
Parameters
Type Name Description
GridRangeInfo range
System.Boolean bStyleOrValue
Returns
Type
System.Boolean

ClearCells(GridRangeInfoList, Boolean)

See ClearCells(GridRangeInfo, Boolean) in the GridModel class for information.

Declaration
public bool ClearCells(GridRangeInfoList selList, bool styleOrValue)
Parameters
Type Name Description
GridRangeInfoList selList
System.Boolean styleOrValue
Returns
Type
System.Boolean

ConfirmChanges()

See ConfirmChanges() in the GridModel class for information.

Declaration
public void ConfirmChanges()

ConfirmPendingChanges()

Confirms any pending changes, raises the ConfirmingPendingChanges event, and calls the current cells ConfirmChanges() method.

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

True if this action is successfully completed; False otherwise.

Detach()

Detaches a model from the grid control.

Declaration
public GridModel Detach()
Returns
Type Description
GridModel

The grid model.
Remarks

The GridModel can be attached and replaced with another object at run-time. The GridControl class will remove any dependencies on the old model and set up a relationship with the new model.

When you replace the model, the grid control will completely refresh and draw the new cell data.

DoPrepareGraphics(Graphics)

Raise a PrepareGraphics event.

Declaration
public void DoPrepareGraphics(Graphics g)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object.

EndEdit()

See EndEdit() in the GridModel class for information.

Declaration
public void EndEdit()

EndInit()

See EndInit() in the GridModel class for information.

Declaration
public void EndInit()

EndUpdateModel(Boolean, Boolean)

See EndUpdate() in the GridModel class for information.

Declaration
public override void EndUpdateModel(bool update, bool fromModel)
Parameters
Type Name Description
System.Boolean update

Specifies whether current pending paint operations should be discarded.
System.Boolean fromModel

Specified if this EndUpdate call was triggered by a call to the EndUpdate() of the GridModel
Overrides

GetCells(GridRangeInfo)

See GetCells(GridRangeInfo) in the GridModel class for information.

Declaration
public GridStyleInfoStoreTable GetCells(GridRangeInfo range)
Parameters
Type Name Description
GridRangeInfo range

A GridRangeInfo that specifies the range of cells.
Returns
Type Description
GridStyleInfoStoreTable

A GridStyleInfoStoreTable object that holds contents for all the cells.

GetCellsInfo(GridRangeInfo)

See GetCellsInfo(GridRangeInfo) in the GridModel class for information.

Declaration
public GridStyleInfo[] GetCellsInfo(GridRangeInfo range)
Parameters
Type Name Description
GridRangeInfo range
Returns
Type
GridStyleInfo[]

GetCellsInfo(GridRangeInfo, OperationFeedback)

See GetCellsInfo(GridRangeInfo) in the GridModel class for information.

Declaration
public GridStyleInfo[] GetCellsInfo(GridRangeInfo range, OperationFeedback op)
Parameters
Type Name Description
GridRangeInfo range
OperationFeedback op
Returns
Type
GridStyleInfo[]

GetCombinedStyle(GridRangeInfo)

See GetCombinedStyle(GridRangeInfo) in the GridModel class for information.

Declaration
public GridStyleInfo GetCombinedStyle(GridRangeInfo range)
Parameters
Type Name Description
GridRangeInfo range
Returns
Type
GridStyleInfo

GetCombinedStyle(GridRangeInfoList)

See GetCombinedStyle(GridRangeInfo) in the GridModel class for information.

Declaration
public GridStyleInfo GetCombinedStyle(GridRangeInfoList ranges)
Parameters
Type Name Description
GridRangeInfoList ranges
Returns
Type
GridStyleInfo

GetSpannedRangeInfo(Int32, Int32, out GridRangeInfo)

See GetSpannedRangeInfo(Int32, Int32, out GridRangeInfo) in the GridModel class for information.

Declaration
public virtual bool GetSpannedRangeInfo(int rowIndex, int colIndex, out GridRangeInfo range)
Parameters
Type Name Description
System.Int32 rowIndex
System.Int32 colIndex
GridRangeInfo range
Returns
Type
System.Boolean

InitializeFromXml(Stream)

Recreates the GridControl with properties and data that was saved in xml format.

Declaration
public void InitializeFromXml(Stream s)
Parameters
Type Name Description
System.IO.Stream s

InitializeFromXml(Stream, Boolean)

Recreates the GridControl with properties and data that was saved in xml format.

Declaration
public void InitializeFromXml(Stream s, bool resolveBackgroundImages)
Parameters
Type Name Description
System.IO.Stream s
System.Boolean resolveBackgroundImages

InitializeFromXml(String)

Recreates the GridControl with properties and data that was saved in xml format.

Declaration
public void InitializeFromXml(string fileName)
Parameters
Type Name Description
System.String fileName

InitializeFromXml(String, Boolean)

Recreates the GridControl with properties and data that was saved in xml format.

Declaration
public void InitializeFromXml(string fileName, bool resolveBackgroundImages)
Parameters
Type Name Description
System.String fileName
System.Boolean resolveBackgroundImages

OnBanneredRangesChanged(GridBanneredRangesChangedEventArgs)

Raises the BanneredRangesChanged event.

Declaration
protected virtual void OnBanneredRangesChanged(GridBanneredRangesChangedEventArgs e)
Parameters
Type Name Description
GridBanneredRangesChangedEventArgs e

A GridBanneredRangesChangedEventArgs that contains the event data.

OnBanneredRangesChanging(GridBanneredRangesChangingEventArgs)

Raises the BanneredRangesChanging event.

Declaration
protected virtual void OnBanneredRangesChanging(GridBanneredRangesChangingEventArgs e)
Parameters
Type Name Description
GridBanneredRangesChangingEventArgs e

A GridBanneredRangesChangingEventArgs that contains the event data.

OnBaseStylesMapChanged(EventArgs)

Raises the BaseStylesMapChanged event.

Declaration
protected virtual void OnBaseStylesMapChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnBeginUpdateRequest(EventArgs)

Raises the BeginUpdateRequest event.

Declaration
protected virtual void OnBeginUpdateRequest(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnCellModelsChanged(CollectionChangeEventArgs)

Raises the CellModelsChanged event.

Declaration
protected virtual void OnCellModelsChanged(CollectionChangeEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CollectionChangeEventArgs e

A System.ComponentModel.CollectionChangeEventArgs that contains the event data.

OnCellsChanged(GridCellsChangedEventArgs)

Raises the CellsChanged event.

Declaration
protected virtual void OnCellsChanged(GridCellsChangedEventArgs e)
Parameters
Type Name Description
GridCellsChangedEventArgs e

A GridCellsChangedEventArgs that contains the event data.

OnCellsChanging(GridCellsChangingEventArgs)

Raises the CellsChanging event.

Declaration
protected virtual void OnCellsChanging(GridCellsChangingEventArgs e)
Parameters
Type Name Description
GridCellsChangingEventArgs e

A GridCellsChangingEventArgs that contains the event data.

OnColsHidden(GridRowColHiddenEventArgs)

Raises the ColsHidden event.

Declaration
protected virtual void OnColsHidden(GridRowColHiddenEventArgs e)
Parameters
Type Name Description
GridRowColHiddenEventArgs e

A GridRowColHiddenEventArgs that contains the event data.

OnColsHiding(GridRowColHidingEventArgs)

Raises the ColsHiding event.

Declaration
protected virtual void OnColsHiding(GridRowColHidingEventArgs e)
Parameters
Type Name Description
GridRowColHidingEventArgs e

A GridRowColHidingEventArgs that contains the event data.

OnColsInserted(GridRangeInsertedEventArgs)

Raises the ColsInserted event.

Declaration
protected virtual void OnColsInserted(GridRangeInsertedEventArgs e)
Parameters
Type Name Description
GridRangeInsertedEventArgs e

A GridRangeInsertedEventArgs that contains the event data.

OnColsInserting(GridRangeInsertingEventArgs)

Raises the ColsInserting event.

Declaration
protected virtual void OnColsInserting(GridRangeInsertingEventArgs e)
Parameters
Type Name Description
GridRangeInsertingEventArgs e

A GridRangeInsertingEventArgs that contains the event data.

OnColsMoved(GridRangeMovedEventArgs)

Raises the ColsMoved event.

Declaration
protected virtual void OnColsMoved(GridRangeMovedEventArgs e)
Parameters
Type Name Description
GridRangeMovedEventArgs e

A GridRangeMovedEventArgs that contains the event data.

OnColsMoving(GridRangeMovingEventArgs)

Raises the ColsMoving event.

Declaration
protected virtual void OnColsMoving(GridRangeMovingEventArgs e)
Parameters
Type Name Description
GridRangeMovingEventArgs e

A GridRangeMovingEventArgs that contains the event data.

OnColsRemoved(GridRangeRemovedEventArgs)

Raises the ColsRemoved event.

Declaration
protected virtual void OnColsRemoved(GridRangeRemovedEventArgs e)
Parameters
Type Name Description
GridRangeRemovedEventArgs e

A GridRangeRemovedEventArgs that contains the event data.

OnColsRemoving(GridRangeRemovingEventArgs)

Raises the ColsRemoving event.

Declaration
protected virtual void OnColsRemoving(GridRangeRemovingEventArgs e)
Parameters
Type Name Description
GridRangeRemovingEventArgs e

A GridRangeRemovingEventArgs that contains the event data.

OnColWidthsChanged(GridRowColSizeChangedEventArgs)

Raises the ColWidthsChanged event.

Declaration
protected virtual void OnColWidthsChanged(GridRowColSizeChangedEventArgs e)
Parameters
Type Name Description
GridRowColSizeChangedEventArgs e

A GridRowColSizeChangedEventArgs that contains the event data.

OnColWidthsChanging(GridRowColSizeChangingEventArgs)

Raises the ColWidthsChanging event.

Declaration
protected virtual void OnColWidthsChanging(GridRowColSizeChangingEventArgs e)
Parameters
Type Name Description
GridRowColSizeChangingEventArgs e

A GridRowColSizeChangingEventArgs that contains the event data.

OnConfirmingPendingChanges(CancelEventArgs)

Raises the ConfirmingPendingChanges event.

Declaration
protected virtual void OnConfirmingPendingChanges(CancelEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs e

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

OnControllerOptionsChanged(EventArgs)

Raises the ControllerOptionsChanged event.

Declaration
protected virtual void OnControllerOptionsChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnCoveredRangesChanged(GridCoveredRangesChangedEventArgs)

Raises the CoveredRangesChanged event.

Declaration
protected virtual void OnCoveredRangesChanged(GridCoveredRangesChangedEventArgs e)
Parameters
Type Name Description
GridCoveredRangesChangedEventArgs e

A GridCoveredRangesChangedEventArgs that contains the event data.

OnCoveredRangesChanging(GridCoveredRangesChangingEventArgs)

Raises the CoveredRangesChanging event.

Declaration
protected virtual void OnCoveredRangesChanging(GridCoveredRangesChangingEventArgs e)
Parameters
Type Name Description
GridCoveredRangesChangingEventArgs e

A GridCoveredRangesChangingEventArgs that contains the event data.

OnDataChanged(EventArgs)

Raises the DataChanged event.

Declaration
protected virtual void OnDataChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnDataObjectConsumerOptionsChanged(EventArgs)

Raises the DataObjectConsumerOptionsChanged event.

Declaration
protected virtual void OnDataObjectConsumerOptionsChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnDefaultColWidthChanged(GridDefaultSizeChangedEventArgs)

Raises the DefaultColWidthChanged event.

Declaration
protected virtual void OnDefaultColWidthChanged(GridDefaultSizeChangedEventArgs e)
Parameters
Type Name Description
GridDefaultSizeChangedEventArgs e

A GridDefaultSizeChangedEventArgs that contains the event data.

OnDefaultColWidthChanging(GridDefaultSizeChangingEventArgs)

Raises the DefaultColWidthChanging event.

Declaration
protected virtual void OnDefaultColWidthChanging(GridDefaultSizeChangingEventArgs e)
Parameters
Type Name Description
GridDefaultSizeChangingEventArgs e

A GridDefaultSizeChangingEventArgs that contains the event data.

OnDefaultRowHeightChanged(GridDefaultSizeChangedEventArgs)

Raises the DefaultRowHeightChanged event.

Declaration
protected virtual void OnDefaultRowHeightChanged(GridDefaultSizeChangedEventArgs e)
Parameters
Type Name Description
GridDefaultSizeChangedEventArgs e

A GridDefaultSizeChangedEventArgs that contains the event data.

OnDefaultRowHeightChanging(GridDefaultSizeChangingEventArgs)

Raises the DefaultRowHeightChanging event.

Declaration
protected virtual void OnDefaultRowHeightChanging(GridDefaultSizeChangingEventArgs e)
Parameters
Type Name Description
GridDefaultSizeChangingEventArgs e

A GridDefaultSizeChangingEventArgs that contains the event data.

OnEndUpdateRequest(GridEndUpdateRequestEventArgs)

Raises the EndUpdateRequest event.

Declaration
protected virtual void OnEndUpdateRequest(GridEndUpdateRequestEventArgs e)
Parameters
Type Name Description
GridEndUpdateRequestEventArgs e

A GridEndUpdateRequestEventArgs that contains the event data.

OnFileNameChanged(EventArgs)

Raises the FileNameChanged event.

Declaration
protected virtual void OnFileNameChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnFilterBarChoices(GridFilterBarChoicesEventArgs)

Raises the OnFilterBarChoices(GridFilterBarChoicesEventArgs) event.

Declaration
public virtual void OnFilterBarChoices(GridFilterBarChoicesEventArgs e)
Parameters
Type Name Description
GridFilterBarChoicesEventArgs e

Event data.

OnFilterBarSelectionChanging(FilterBarSelectionChangingEventArgs)

Raises the OnFilterBarSelectionChanging(FilterBarSelectionChangingEventArgs) event.

Declaration
public virtual void OnFilterBarSelectionChanging(FilterBarSelectionChangingEventArgs e)
Parameters
Type Name Description
FilterBarSelectionChangingEventArgs e

Event data.

OnFilterBarSelectionItemChanged(FilterBarSelectionChangedEventArgs)

Raises the OnFilterBarSelectionItemChanged(FilterBarSelectionChangedEventArgs) event.

Declaration
public virtual void OnFilterBarSelectionItemChanged(FilterBarSelectionChangedEventArgs e)
Parameters
Type Name Description
FilterBarSelectionChangedEventArgs e

Event data.

OnFloatingCellsChanged(GridFloatingCellsChangedEventArgs)

Raises the FloatingCellsChanged event.

Declaration
protected virtual void OnFloatingCellsChanged(GridFloatingCellsChangedEventArgs e)
Parameters
Type Name Description
GridFloatingCellsChangedEventArgs e

A GridFloatingCellsChangedEventArgs that contains the event data.

OnFontChanged(EventArgs)

Used to change the default behaviour of the FontChanged event

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

provides the value to use for events

OnFrozenColCountChanged(GridCountChangedEventArgs)

Raises the FrozenColCountChanged event.

Declaration
protected virtual void OnFrozenColCountChanged(GridCountChangedEventArgs e)
Parameters
Type Name Description
GridCountChangedEventArgs e

A GridCountChangedEventArgs that contains the event data.

OnFrozenColCountChanging(GridCountChangingEventArgs)

Raises the FrozenColCountChanging event.

Declaration
protected virtual void OnFrozenColCountChanging(GridCountChangingEventArgs e)
Parameters
Type Name Description
GridCountChangingEventArgs e

A GridCountChangingEventArgs that contains the event data.

OnFrozenRowCountChanged(GridCountChangedEventArgs)

Raises the FrozenRowCountChanged event.

Declaration
protected virtual void OnFrozenRowCountChanged(GridCountChangedEventArgs e)
Parameters
Type Name Description
GridCountChangedEventArgs e

A GridCountChangedEventArgs that contains the event data.

OnFrozenRowCountChanging(GridCountChangingEventArgs)

Raises the FrozenRowCountChanging event.

Declaration
protected virtual void OnFrozenRowCountChanging(GridCountChangingEventArgs e)
Parameters
Type Name Description
GridCountChangingEventArgs e

A GridCountChangingEventArgs that contains the event data.

OnGiveFeedback(GiveFeedbackEventArgs)

Declaration
protected override void OnGiveFeedback(GiveFeedbackEventArgs gfbevent)
Parameters
Type Name Description
System.Windows.Forms.GiveFeedbackEventArgs gfbevent

OnHeaderColCountChanged(GridCountChangedEventArgs)

Raises the HeaderColCountChanged event.

Declaration
protected virtual void OnHeaderColCountChanged(GridCountChangedEventArgs e)
Parameters
Type Name Description
GridCountChangedEventArgs e

A GridCountChangedEventArgs that contains the event data.

OnHeaderColCountChanging(GridCountChangingEventArgs)

Raises the HeaderColCountChanging event.

Declaration
protected virtual void OnHeaderColCountChanging(GridCountChangingEventArgs e)
Parameters
Type Name Description
GridCountChangingEventArgs e

A GridCountChangingEventArgs that contains the event data.

OnHeaderRowCountChanged(GridCountChangedEventArgs)

Raises the HeaderRowCountChanged event.

Declaration
protected virtual void OnHeaderRowCountChanged(GridCountChangedEventArgs e)
Parameters
Type Name Description
GridCountChangedEventArgs e

A GridCountChangedEventArgs that contains the event data.

OnHeaderRowCountChanging(GridCountChangingEventArgs)

Raises the HeaderRowCountChanging event.

Declaration
protected virtual void OnHeaderRowCountChanging(GridCountChangingEventArgs e)
Parameters
Type Name Description
GridCountChangingEventArgs e

A GridCountChangingEventArgs that contains the event data.

OnLocationChanged(EventArgs)

Raises the event the location for the control is changed

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

event arguments
Overrides

OnMergeCellsChanged(GridMergeCellsChangedEventArgs)

Raises the MergeCellsChanged event.

Declaration
protected virtual void OnMergeCellsChanged(GridMergeCellsChangedEventArgs e)
Parameters
Type Name Description
GridMergeCellsChangedEventArgs e

A GridMergeCellsChangedEventArgs that contains the event data.

OnModifiedChanged(EventArgs)

Raises the ModifiedChanged event.

Declaration
protected virtual void OnModifiedChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnOperationFeedback(OperationFeedbackEventArgs)

Raises the OperationFeedback event.

Declaration
protected virtual void OnOperationFeedback(OperationFeedbackEventArgs e)
Parameters
Type Name Description
OperationFeedbackEventArgs e

A OperationFeedbackEventArgs that contains the event data.

OnPasteCellText(GridPasteCellTextEventArgs)

Raises the PasteCellText event.

Declaration
protected virtual void OnPasteCellText(GridPasteCellTextEventArgs e)
Parameters
Type Name Description
GridPasteCellTextEventArgs e

A GridSaveCellInfoEventArgs that contains the event data.

OnPrepareChangeSelection(GridPrepareChangeSelectionEventArgs)

Raises the PrepareChangeSelection event.

Declaration
protected virtual void OnPrepareChangeSelection(GridPrepareChangeSelectionEventArgs e)
Parameters
Type Name Description
GridPrepareChangeSelectionEventArgs e

A GridPrepareChangeSelectionEventArgs that contains the event data.

OnPrepareClearSelection(EventArgs)

Raises the PrepareClearSelection event.

Declaration
protected virtual void OnPrepareClearSelection(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnPrepareGraphics(GraphicsEventArgs)

Raises the PrepareGraphics event.

Declaration
protected virtual void OnPrepareGraphics(GraphicsEventArgs e)
Parameters
Type Name Description
GraphicsEventArgs e

A GraphicsEventArgs that contains the event data.

OnQueryBanneredRange(GridQueryBanneredRangeEventArgs)

Raises the QueryBanneredRange event.

Declaration
protected virtual void OnQueryBanneredRange(GridQueryBanneredRangeEventArgs e)
Parameters
Type Name Description
GridQueryBanneredRangeEventArgs e

A GridQueryBanneredRangeEventArgs that contains the event data.

OnQueryCanMergeCells(GridQueryCanMergeCellsEventArgs)

Raises the QueryCanMergeCells event.

Declaration
protected virtual void OnQueryCanMergeCells(GridQueryCanMergeCellsEventArgs e)
Parameters
Type Name Description
GridQueryCanMergeCellsEventArgs e

A GridQueryCanMergeCellsEventArgs that contains the event data.

OnQueryCellInfo(GridQueryCellInfoEventArgs)

Raises the QueryCellInfo event.

Declaration
protected virtual void OnQueryCellInfo(GridQueryCellInfoEventArgs e)
Parameters
Type Name Description
GridQueryCellInfoEventArgs e

A GridQueryCellInfoEventArgs that contains the event data.

OnQueryCellModel(GridQueryCellModelEventArgs)

Raises the QueryCellModel event.

Declaration
protected virtual void OnQueryCellModel(GridQueryCellModelEventArgs e)
Parameters
Type Name Description
GridQueryCellModelEventArgs e

A GridQueryCellModelEventArgs that contains the event data.

OnQueryColCount(GridRowColCountEventArgs)

Raises the QueryColCount event.

Declaration
protected virtual void OnQueryColCount(GridRowColCountEventArgs e)
Parameters
Type Name Description
GridRowColCountEventArgs e

A GridRowColCountEventArgs that contains the event data.

OnQueryColWidth(GridRowColSizeEventArgs)

Raises the QueryColWidth event.

Declaration
protected virtual void OnQueryColWidth(GridRowColSizeEventArgs e)
Parameters
Type Name Description
GridRowColSizeEventArgs e

A GridRowColSizeEventArgs that contains the event data.

OnQueryCoveredRange(GridQueryCoveredRangeEventArgs)

Raises the QueryCoveredRange event.

Declaration
protected virtual void OnQueryCoveredRange(GridQueryCoveredRangeEventArgs e)
Parameters
Type Name Description
GridQueryCoveredRangeEventArgs e

A GridQueryCoveredRangeEventArgs that contains the event data.

OnQueryHideCol(GridRowColHideEventArgs)

Raises the Syncfusion.Windows.Forms.Grid.GridControl.QueryHideCol event.

Declaration
protected virtual void OnQueryHideCol(GridRowColHideEventArgs e)
Parameters
Type Name Description
GridRowColHideEventArgs e

A GridRowColHideEventArgs that contains the event data.

OnQueryHideRow(GridRowColHideEventArgs)

Raises the Syncfusion.Windows.Forms.Grid.GridControl.QueryHideRow event.

Declaration
protected virtual void OnQueryHideRow(GridRowColHideEventArgs e)
Parameters
Type Name Description
GridRowColHideEventArgs e

A GridRowColHideEventArgs that contains the event data.

OnQueryRowCount(GridRowColCountEventArgs)

Raises the QueryRowCount event.

Declaration
protected virtual void OnQueryRowCount(GridRowColCountEventArgs e)
Parameters
Type Name Description
GridRowColCountEventArgs e

A GridRowColCountEventArgs that contains the event data.

OnQueryRowHeight(GridRowColSizeEventArgs)

Raises the QueryRowHeight event.

Declaration
protected virtual void OnQueryRowHeight(GridRowColSizeEventArgs e)
Parameters
Type Name Description
GridRowColSizeEventArgs e

A GridRowColSizeEventArgs that contains the event data.

OnReadOnlyChanged(EventArgs)

Raises the ReadOnlyChanged event.

Declaration
protected virtual void OnReadOnlyChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnRefreshRequest(EventArgs)

Raises the RefreshRequest event.

Declaration
protected virtual void OnRefreshRequest(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

A System.EventArgs that contains the event data.

OnRowHeightsChanged(GridRowColSizeChangedEventArgs)

Raises the RowHeightsChanged event.

Declaration
protected virtual void OnRowHeightsChanged(GridRowColSizeChangedEventArgs e)
Parameters
Type Name Description
GridRowColSizeChangedEventArgs e

A GridRowColSizeChangedEventArgs that contains the event data.

OnRowHeightsChanging(GridRowColSizeChangingEventArgs)

Raises the RowHeightsChanging event.

Declaration
protected virtual void OnRowHeightsChanging(GridRowColSizeChangingEventArgs e)
Parameters
Type Name Description
GridRowColSizeChangingEventArgs e

A GridRowColSizeChangingEventArgs that contains the event data.

OnRowsHidden(GridRowColHiddenEventArgs)

Raises the RowsHidden event.

Declaration
protected virtual void OnRowsHidden(GridRowColHiddenEventArgs e)
Parameters
Type Name Description
GridRowColHiddenEventArgs e

A GridRowColHiddenEventArgs that contains the event data.

OnRowsHiding(GridRowColHidingEventArgs)

Raises the RowsHiding event.

Declaration
protected virtual void OnRowsHiding(GridRowColHidingEventArgs e)
Parameters
Type Name Description
GridRowColHidingEventArgs e

A GridRowColHidingEventArgs that contains the event data.

OnRowsInserted(GridRangeInsertedEventArgs)

Raises the RowsInserted event.

Declaration
protected virtual void OnRowsInserted(GridRangeInsertedEventArgs e)
Parameters
Type Name Description
GridRangeInsertedEventArgs e

A GridRangeInsertedEventArgs that contains the event data.

OnRowsInserting(GridRangeInsertingEventArgs)

Raises the RowsInserting event.

Declaration
protected virtual void OnRowsInserting(GridRangeInsertingEventArgs e)
Parameters
Type Name Description
GridRangeInsertingEventArgs e

A GridRangeInsertingEventArgs that contains the event data.

OnRowsMoved(GridRangeMovedEventArgs)

Raises the RowsMoved event.

Declaration
protected virtual void OnRowsMoved(GridRangeMovedEventArgs e)
Parameters
Type Name Description
GridRangeMovedEventArgs e

A GridRangeMovedEventArgs that contains the event data.

OnRowsMoving(GridRangeMovingEventArgs)

Raises the RowsMoving event.

Declaration
protected virtual void OnRowsMoving(GridRangeMovingEventArgs e)
Parameters
Type Name Description
GridRangeMovingEventArgs e

A GridRangeMovingEventArgs that contains the event data.

OnRowsRemoved(GridRangeRemovedEventArgs)

Raises the RowsRemoved event.

Declaration
protected virtual void OnRowsRemoved(GridRangeRemovedEventArgs e)
Parameters
Type Name Description
GridRangeRemovedEventArgs e

A GridRangeRemovedEventArgs that contains the event data.

OnRowsRemoving(GridRangeRemovingEventArgs)

Raises the RowsRemoving event.

Declaration
protected virtual void OnRowsRemoving(GridRangeRemovingEventArgs e)
Parameters
Type Name Description
GridRangeRemovingEventArgs e

A GridRangeRemovingEventArgs that contains the event data.

OnSaveCellInfo(GridSaveCellInfoEventArgs)

Raises the SaveCellInfo event.

Declaration
protected virtual void OnSaveCellInfo(GridSaveCellInfoEventArgs e)
Parameters
Type Name Description
GridSaveCellInfoEventArgs e

A GridSaveCellInfoEventArgs that contains the event data.

OnSaveColCount(GridRowColCountEventArgs)

Raises the SaveColCount event.

Declaration
protected virtual void OnSaveColCount(GridRowColCountEventArgs e)
Parameters
Type Name Description
GridRowColCountEventArgs e

A GridRowColCountEventArgs that contains the event data.

OnSaveColWidth(GridRowColSizeEventArgs)

Raises the SaveColWidth event.

Declaration
protected virtual void OnSaveColWidth(GridRowColSizeEventArgs e)
Parameters
Type Name Description
GridRowColSizeEventArgs e

A GridRowColSizeEventArgs that contains the event data.

OnSaveHideCol(GridRowColHideEventArgs)

Raises the Syncfusion.Windows.Forms.Grid.GridControl.SaveHideCol event.

Declaration
protected virtual void OnSaveHideCol(GridRowColHideEventArgs e)
Parameters
Type Name Description
GridRowColHideEventArgs e

A GridRowColHideEventArgs that contains the event data.

OnSaveHideRow(GridRowColHideEventArgs)

Raises the Syncfusion.Windows.Forms.Grid.GridControl.SaveHideRow event.

Declaration
protected virtual void OnSaveHideRow(GridRowColHideEventArgs e)
Parameters
Type Name Description
GridRowColHideEventArgs e

A GridRowColHideEventArgs that contains the event data.

OnSaveRowCount(GridRowColCountEventArgs)

Raises the SaveRowCount event.

Declaration
protected virtual void OnSaveRowCount(GridRowColCountEventArgs e)
Parameters
Type Name Description
GridRowColCountEventArgs e

A GridRowColCountEventArgs that contains the event data.

OnSaveRowHeight(GridRowColSizeEventArgs)

Raises the SaveRowHeight event.

Declaration
protected virtual void OnSaveRowHeight(GridRowColSizeEventArgs e)
Parameters
Type Name Description
GridRowColSizeEventArgs e

A GridRowColSizeEventArgs that contains the event data.

OnSelectionChanged(GridSelectionChangedEventArgs)

Raises the SelectionChanged event.

Declaration
protected virtual void OnSelectionChanged(GridSelectionChangedEventArgs e)
Parameters
Type Name Description
GridSelectionChangedEventArgs e

A GridSelectionChangedEventArgs that contains the event data.

OnSelectionChanging(GridSelectionChangingEventArgs)

Raises the SelectionChanging event.

Declaration
protected virtual void OnSelectionChanging(GridSelectionChangingEventArgs e)
Parameters
Type Name Description
GridSelectionChangingEventArgs e

A GridSelectionChangingEventArgs that contains the event data.

OnSizeChanged(EventArgs)

Used to change the default behaviour of the SizeChanged event

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

provides the value to use for events
Overrides

OnTouchPan(Point, Boolean)

Handles the Resize,Selection,Dragging or the panning operations based on the touch controller.

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

Current touch position
System.Boolean isSwipeScroll

used to decide the swipe scrolling operation occurs. When isSwipeScroll is true then cancel the panning operations while touch over the header cell.
Returns
Type Description
System.Boolean

Retruns false if do the resize, dragging and selection process. Otherwise return true
Overrides

OnTouchPanBegin(Point)

Used to decide to do the selection or dragging or resizing operations based on touchController.

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

touch position when panning operation start
Returns
Type Description
System.Boolean

return false when do other operations like selection, dragging and resizing
Overrides

OnTouchPanEnd(Point)

Call the mouse up method when resize or dragging or selection process done otherwise call the base method

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

touch control end point
Returns
Type Description
System.Boolean

Return false when resizing or selection or dragging process done
Overrides

PopulateHeaders(GridRangeInfo, Object)

See PopulateHeaders(GridRangeInfo, Object) in the GridModel class for information.

Declaration
public void PopulateHeaders(GridRangeInfo range, object dataSource)
Parameters
Type Name Description
GridRangeInfo range
System.Object dataSource
Examples

This example shows how to populate the header values with the specified range and datasource. PopulateHeaders(GridRangeInfo, Object) method.

       
// Populating DataSource
DataTable dataTable = new DataTable("Sample");
dataTable.Columns.Add("Column 1");
dataTable.Columns.Add("Column 2");
dataTable.Columns.Add("Column 3");
dataTable.Columns.Add("Column 4");
dataTable.Rows.Add("Row1", "Row2", "Row3", "Row4");

//Populating the headers
this.gridControl1.PopulateHeaders(GridRangeInfo.Cells(0, 1, 0, 4), dataTable);
' Populating DataSource
Dim dataTable As DataTable = New DataTable("Sample")
dataTable.Columns.Add("Column 1")
dataTable.Columns.Add("Column 2")
dataTable.Columns.Add("Column 3")
dataTable.Columns.Add("Column 4")
dataTable.Rows.Add("Row1", "Row2", "Row3", "Row4")

' Populating the headers
Me.gridControl1.PopulateHeaders(GridRangeInfo.Cells(0, 1, 0, 4), dataTable)

PopulateValues(GridRangeInfo, Object)

See PopulateValues(GridRangeInfo, Object) in the GridModel class for information.

Declaration
public void PopulateValues(GridRangeInfo range, object dataSource)
Parameters
Type Name Description
GridRangeInfo range
System.Object dataSource
Examples

This example shows how to populate the values to the grid with the specified range and datasource.

       
// Populating DataSource
DataTable dataTable = new DataTable("Sample");
dataTable.Columns.Add("Column 1");
dataTable.Columns.Add("Column 2");
dataTable.Columns.Add("Column 3");
dataTable.Columns.Add("Column 4");
dataTable.Rows.Add("Row1", "Row2", "Row3", "Row4");

Populating the values to grid.
this.gridControl1.PopulateValues(GridRangeInfo.Cells(1, 1, dataTable.Rows.Count, dataTable.Columns.Count), dataTable);
' Populating DataSource
Dim dataTable As DataTable = New DataTable("Sample")
dataTable.Columns.Add("Column 1")
dataTable.Columns.Add("Column 2")
dataTable.Columns.Add("Column 3")
dataTable.Columns.Add("Column 4")
dataTable.Rows.Add("Row1", "Row2", "Row3", "Row4")

'Populating the values to grid.
this.gridControl1.PopulateValues(GridRangeInfo.Cells(1, 1, dataTable.Rows.Count, dataTable.Columns.Count), dataTable)

QueryMaximumRowCol(Int32, Int32)

See RaiseQueryMaximumRowCol(Int32, Int32) in the GridModel class for information.

Declaration
public void QueryMaximumRowCol(int nLastRow, int nLastCol)
Parameters
Type Name Description
System.Int32 nLastRow
System.Int32 nLastCol

Refresh(Boolean)

See Refresh() in the GridModel class for information.

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

remove_BanneredRangesChanged(GridBanneredRangesChangedEventHandler)

Declaration
public void remove_BanneredRangesChanged(GridBanneredRangesChangedEventHandler value)
Parameters
Type Name Description
GridBanneredRangesChangedEventHandler value

remove_BanneredRangesChanging(GridBanneredRangesChangingEventHandler)

Declaration
public void remove_BanneredRangesChanging(GridBanneredRangesChangingEventHandler value)
Parameters
Type Name Description
GridBanneredRangesChangingEventHandler value

remove_CellsChanged(GridCellsChangedEventHandler)

Declaration
public void remove_CellsChanged(GridCellsChangedEventHandler value)
Parameters
Type Name Description
GridCellsChangedEventHandler value

remove_CellsChanging(GridCellsChangingEventHandler)

Declaration
public void remove_CellsChanging(GridCellsChangingEventHandler value)
Parameters
Type Name Description
GridCellsChangingEventHandler value

remove_ClearingCells(GridClearingCellsEventHandler)

Declaration
public void remove_ClearingCells(GridClearingCellsEventHandler value)
Parameters
Type Name Description
GridClearingCellsEventHandler value

remove_ClipboardCanCopy(GridCutPasteEventHandler)

Declaration
public void remove_ClipboardCanCopy(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

remove_ClipboardCanCut(GridCutPasteEventHandler)

Declaration
public void remove_ClipboardCanCut(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

remove_ClipboardCanPaste(GridCutPasteEventHandler)

Declaration
public void remove_ClipboardCanPaste(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

remove_ClipboardCopy(GridCutPasteEventHandler)

Declaration
public void remove_ClipboardCopy(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

remove_ClipboardCopyToBuffer(ClipboardCopyToBufferEventHandler)

Declaration
public void remove_ClipboardCopyToBuffer(ClipboardCopyToBufferEventHandler value)
Parameters
Type Name Description
ClipboardCopyToBufferEventHandler value

remove_ClipboardCut(GridCutPasteEventHandler)

Declaration
public void remove_ClipboardCut(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

remove_ClipboardPaste(GridCutPasteEventHandler)

Declaration
public void remove_ClipboardPaste(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler value

remove_ColsHidden(GridRowColHiddenEventHandler)

Declaration
public void remove_ColsHidden(GridRowColHiddenEventHandler value)
Parameters
Type Name Description
GridRowColHiddenEventHandler value

remove_ColsHiding(GridRowColHidingEventHandler)

Declaration
public void remove_ColsHiding(GridRowColHidingEventHandler value)
Parameters
Type Name Description
GridRowColHidingEventHandler value

remove_ColsInserted(GridRangeInsertedEventHandler)

Declaration
public void remove_ColsInserted(GridRangeInsertedEventHandler value)
Parameters
Type Name Description
GridRangeInsertedEventHandler value

remove_ColsInserting(GridRangeInsertingEventHandler)

Declaration
public void remove_ColsInserting(GridRangeInsertingEventHandler value)
Parameters
Type Name Description
GridRangeInsertingEventHandler value

remove_ColsMoved(GridRangeMovedEventHandler)

Declaration
public void remove_ColsMoved(GridRangeMovedEventHandler value)
Parameters
Type Name Description
GridRangeMovedEventHandler value

remove_ColsMoving(GridRangeMovingEventHandler)

Declaration
public void remove_ColsMoving(GridRangeMovingEventHandler value)
Parameters
Type Name Description
GridRangeMovingEventHandler value

remove_ColsRemoved(GridRangeRemovedEventHandler)

Declaration
public void remove_ColsRemoved(GridRangeRemovedEventHandler value)
Parameters
Type Name Description
GridRangeRemovedEventHandler value

remove_ColsRemoving(GridRangeRemovingEventHandler)

Declaration
public void remove_ColsRemoving(GridRangeRemovingEventHandler value)
Parameters
Type Name Description
GridRangeRemovingEventHandler value

remove_ColWidthsChanged(GridRowColSizeChangedEventHandler)

Declaration
public void remove_ColWidthsChanged(GridRowColSizeChangedEventHandler value)
Parameters
Type Name Description
GridRowColSizeChangedEventHandler value

remove_ColWidthsChanging(GridRowColSizeChangingEventHandler)

Declaration
public void remove_ColWidthsChanging(GridRowColSizeChangingEventHandler value)
Parameters
Type Name Description
GridRowColSizeChangingEventHandler value

remove_CoveredRangesChanged(GridCoveredRangesChangedEventHandler)

Declaration
public void remove_CoveredRangesChanged(GridCoveredRangesChangedEventHandler value)
Parameters
Type Name Description
GridCoveredRangesChangedEventHandler value

remove_CoveredRangesChanging(GridCoveredRangesChangingEventHandler)

Declaration
public void remove_CoveredRangesChanging(GridCoveredRangesChangingEventHandler value)
Parameters
Type Name Description
GridCoveredRangesChangingEventHandler value

remove_DefaultColWidthChanged(GridDefaultSizeChangedEventHandler)

Declaration
public void remove_DefaultColWidthChanged(GridDefaultSizeChangedEventHandler value)
Parameters
Type Name Description
GridDefaultSizeChangedEventHandler value

remove_DefaultColWidthChanging(GridDefaultSizeChangingEventHandler)

Declaration
public void remove_DefaultColWidthChanging(GridDefaultSizeChangingEventHandler value)
Parameters
Type Name Description
GridDefaultSizeChangingEventHandler value

remove_DefaultRowHeightChanged(GridDefaultSizeChangedEventHandler)

Declaration
public void remove_DefaultRowHeightChanged(GridDefaultSizeChangedEventHandler value)
Parameters
Type Name Description
GridDefaultSizeChangedEventHandler value

remove_DefaultRowHeightChanging(GridDefaultSizeChangingEventHandler)

Declaration
public void remove_DefaultRowHeightChanging(GridDefaultSizeChangingEventHandler value)
Parameters
Type Name Description
GridDefaultSizeChangingEventHandler value

remove_EndUpdateRequest(GridEndUpdateRequestEventHandler)

Declaration
public void remove_EndUpdateRequest(GridEndUpdateRequestEventHandler value)
Parameters
Type Name Description
GridEndUpdateRequestEventHandler value

remove_FilterBarChoices(GridFilterBarChoicesEventHandler)

Declaration
public void remove_FilterBarChoices(GridFilterBarChoicesEventHandler value)
Parameters
Type Name Description
GridFilterBarChoicesEventHandler value

remove_FilterBarSelectionChanged(FilterBarSelectionChangedEventHandler)

Declaration
public void remove_FilterBarSelectionChanged(FilterBarSelectionChangedEventHandler value)
Parameters
Type Name Description
FilterBarSelectionChangedEventHandler value

remove_FilterBarSelectionChanging(FilterBarSelectionChangingEventHandler)

Declaration
public void remove_FilterBarSelectionChanging(FilterBarSelectionChangingEventHandler value)
Parameters
Type Name Description
FilterBarSelectionChangingEventHandler value

remove_FloatingCellsChanged(GridFloatingCellsChangedEventHandler)

Declaration
public void remove_FloatingCellsChanged(GridFloatingCellsChangedEventHandler value)
Parameters
Type Name Description
GridFloatingCellsChangedEventHandler value

remove_FrozenColCountChanged(GridCountChangedEventHandler)

Declaration
public void remove_FrozenColCountChanged(GridCountChangedEventHandler value)
Parameters
Type Name Description
GridCountChangedEventHandler value

remove_FrozenColCountChanging(GridCountChangingEventHandler)

Declaration
public void remove_FrozenColCountChanging(GridCountChangingEventHandler value)
Parameters
Type Name Description
GridCountChangingEventHandler value

remove_FrozenRowCountChanged(GridCountChangedEventHandler)

Declaration
public void remove_FrozenRowCountChanged(GridCountChangedEventHandler value)
Parameters
Type Name Description
GridCountChangedEventHandler value

remove_FrozenRowCountChanging(GridCountChangingEventHandler)

Declaration
public void remove_FrozenRowCountChanging(GridCountChangingEventHandler value)
Parameters
Type Name Description
GridCountChangingEventHandler value

remove_HeaderColCountChanged(GridCountChangedEventHandler)

Declaration
public void remove_HeaderColCountChanged(GridCountChangedEventHandler value)
Parameters
Type Name Description
GridCountChangedEventHandler value

remove_HeaderColCountChanging(GridCountChangingEventHandler)

Declaration
public void remove_HeaderColCountChanging(GridCountChangingEventHandler value)
Parameters
Type Name Description
GridCountChangingEventHandler value

remove_HeaderRowCountChanged(GridCountChangedEventHandler)

Declaration
public void remove_HeaderRowCountChanged(GridCountChangedEventHandler value)
Parameters
Type Name Description
GridCountChangedEventHandler value

remove_HeaderRowCountChanging(GridCountChangingEventHandler)

Declaration
public void remove_HeaderRowCountChanging(GridCountChangingEventHandler value)
Parameters
Type Name Description
GridCountChangingEventHandler value

remove_MergeCellsChanged(GridMergeCellsChangedEventHandler)

Declaration
public void remove_MergeCellsChanged(GridMergeCellsChangedEventHandler value)
Parameters
Type Name Description
GridMergeCellsChangedEventHandler value

remove_OperationFeedback(OperationFeedbackEventHandler)

Declaration
public void remove_OperationFeedback(OperationFeedbackEventHandler value)
Parameters
Type Name Description
OperationFeedbackEventHandler value

remove_ParseCommonFormats(GridCellTextEventHandler)

Declaration
public void remove_ParseCommonFormats(GridCellTextEventHandler value)
Parameters
Type Name Description
GridCellTextEventHandler value

remove_PasteCellText(GridPasteCellTextEventHandler)

Declaration
public void remove_PasteCellText(GridPasteCellTextEventHandler value)
Parameters
Type Name Description
GridPasteCellTextEventHandler value

remove_PrepareChangeSelection(GridPrepareChangeSelectionEventHandler)

Declaration
public void remove_PrepareChangeSelection(GridPrepareChangeSelectionEventHandler value)
Parameters
Type Name Description
GridPrepareChangeSelectionEventHandler value

remove_PrepareGraphics(GraphicsEventHandler)

Declaration
public void remove_PrepareGraphics(GraphicsEventHandler value)
Parameters
Type Name Description
GraphicsEventHandler value

remove_QueryBanneredRange(GridQueryBanneredRangeEventHandler)

Declaration
public void remove_QueryBanneredRange(GridQueryBanneredRangeEventHandler value)
Parameters
Type Name Description
GridQueryBanneredRangeEventHandler value

remove_QueryCanMergeCells(GridQueryCanMergeCellsEventHandler)

Declaration
public void remove_QueryCanMergeCells(GridQueryCanMergeCellsEventHandler value)
Parameters
Type Name Description
GridQueryCanMergeCellsEventHandler value

remove_QueryCellFormattedText(GridCellTextEventHandler)

Declaration
public void remove_QueryCellFormattedText(GridCellTextEventHandler value)
Parameters
Type Name Description
GridCellTextEventHandler value

remove_QueryCellInfo(GridQueryCellInfoEventHandler)

Declaration
public void remove_QueryCellInfo(GridQueryCellInfoEventHandler value)
Parameters
Type Name Description
GridQueryCellInfoEventHandler value

remove_QueryCellModel(GridQueryCellModelEventHandler)

Declaration
public void remove_QueryCellModel(GridQueryCellModelEventHandler value)
Parameters
Type Name Description
GridQueryCellModelEventHandler value

remove_QueryCellText(GridCellTextEventHandler)

Declaration
public void remove_QueryCellText(GridCellTextEventHandler value)
Parameters
Type Name Description
GridCellTextEventHandler value

remove_QueryColCount(GridRowColCountEventHandler)

Declaration
public void remove_QueryColCount(GridRowColCountEventHandler value)
Parameters
Type Name Description
GridRowColCountEventHandler value

remove_QueryColWidth(GridRowColSizeEventHandler)

Declaration
public void remove_QueryColWidth(GridRowColSizeEventHandler value)
Parameters
Type Name Description
GridRowColSizeEventHandler value

remove_QueryCoveredRange(GridQueryCoveredRangeEventHandler)

Declaration
public void remove_QueryCoveredRange(GridQueryCoveredRangeEventHandler value)
Parameters
Type Name Description
GridQueryCoveredRangeEventHandler value

remove_QueryOleDataSourceData(GridQueryOleDataSourceDataEventHandler)

Declaration
public void remove_QueryOleDataSourceData(GridQueryOleDataSourceDataEventHandler value)
Parameters
Type Name Description
GridQueryOleDataSourceDataEventHandler value

remove_QueryRowCount(GridRowColCountEventHandler)

Declaration
public void remove_QueryRowCount(GridRowColCountEventHandler value)
Parameters
Type Name Description
GridRowColCountEventHandler value

remove_QueryRowHeight(GridRowColSizeEventHandler)

Declaration
public void remove_QueryRowHeight(GridRowColSizeEventHandler value)
Parameters
Type Name Description
GridRowColSizeEventHandler value

remove_RowHeightsChanged(GridRowColSizeChangedEventHandler)

Declaration
public void remove_RowHeightsChanged(GridRowColSizeChangedEventHandler value)
Parameters
Type Name Description
GridRowColSizeChangedEventHandler value

remove_RowHeightsChanging(GridRowColSizeChangingEventHandler)

Declaration
public void remove_RowHeightsChanging(GridRowColSizeChangingEventHandler value)
Parameters
Type Name Description
GridRowColSizeChangingEventHandler value

remove_RowsHidden(GridRowColHiddenEventHandler)

Declaration
public void remove_RowsHidden(GridRowColHiddenEventHandler value)
Parameters
Type Name Description
GridRowColHiddenEventHandler value

remove_RowsHiding(GridRowColHidingEventHandler)

Declaration
public void remove_RowsHiding(GridRowColHidingEventHandler value)
Parameters
Type Name Description
GridRowColHidingEventHandler value

remove_RowsInserted(GridRangeInsertedEventHandler)

Declaration
public void remove_RowsInserted(GridRangeInsertedEventHandler value)
Parameters
Type Name Description
GridRangeInsertedEventHandler value

remove_RowsInserting(GridRangeInsertingEventHandler)

Declaration
public void remove_RowsInserting(GridRangeInsertingEventHandler value)
Parameters
Type Name Description
GridRangeInsertingEventHandler value

remove_RowsMoved(GridRangeMovedEventHandler)

Declaration
public void remove_RowsMoved(GridRangeMovedEventHandler value)
Parameters
Type Name Description
GridRangeMovedEventHandler value

remove_RowsMoving(GridRangeMovingEventHandler)

Declaration
public void remove_RowsMoving(GridRangeMovingEventHandler value)
Parameters
Type Name Description
GridRangeMovingEventHandler value

remove_RowsRemoved(GridRangeRemovedEventHandler)

Declaration
public void remove_RowsRemoved(GridRangeRemovedEventHandler value)
Parameters
Type Name Description
GridRangeRemovedEventHandler value

remove_RowsRemoving(GridRangeRemovingEventHandler)

Declaration
public void remove_RowsRemoving(GridRangeRemovingEventHandler value)
Parameters
Type Name Description
GridRangeRemovingEventHandler value

remove_SaveCellFormattedText(GridCellTextEventHandler)

Declaration
public void remove_SaveCellFormattedText(GridCellTextEventHandler value)
Parameters
Type Name Description
GridCellTextEventHandler value

remove_SaveCellInfo(GridSaveCellInfoEventHandler)

Declaration
public void remove_SaveCellInfo(GridSaveCellInfoEventHandler value)
Parameters
Type Name Description
GridSaveCellInfoEventHandler value

remove_SaveCellText(GridCellTextEventHandler)

Declaration
public void remove_SaveCellText(GridCellTextEventHandler value)
Parameters
Type Name Description
GridCellTextEventHandler value

remove_SaveColCount(GridRowColCountEventHandler)

Declaration
public void remove_SaveColCount(GridRowColCountEventHandler value)
Parameters
Type Name Description
GridRowColCountEventHandler value

remove_SaveColWidth(GridRowColSizeEventHandler)

Declaration
public void remove_SaveColWidth(GridRowColSizeEventHandler value)
Parameters
Type Name Description
GridRowColSizeEventHandler value

remove_SaveRowCount(GridRowColCountEventHandler)

Declaration
public void remove_SaveRowCount(GridRowColCountEventHandler value)
Parameters
Type Name Description
GridRowColCountEventHandler value

remove_SaveRowHeight(GridRowColSizeEventHandler)

Declaration
public void remove_SaveRowHeight(GridRowColSizeEventHandler value)
Parameters
Type Name Description
GridRowColSizeEventHandler value

remove_SelectionChanged(GridSelectionChangedEventHandler)

Declaration
public void remove_SelectionChanged(GridSelectionChangedEventHandler value)
Parameters
Type Name Description
GridSelectionChangedEventHandler value

remove_SelectionChanging(GridSelectionChangingEventHandler)

Declaration
public void remove_SelectionChanging(GridSelectionChangingEventHandler value)
Parameters
Type Name Description
GridSelectionChangingEventHandler value

ResetAlphaBlendSelectionColor()

Resets the AlphaBlendSelectionColor property.

Declaration
public void ResetAlphaBlendSelectionColor()

ResetBanneredRanges()

Clears all bannered ranges.

Declaration
public void ResetBanneredRanges()

ResetBaseStylesMap()

Resets the BaseStylesMap property.

Declaration
public void ResetBaseStylesMap()

ResetColHiddenEntries()

Resets values in the HideCols collection.

Declaration
public void ResetColHiddenEntries()

ResetColWidthEntries()

Resets values in the ColWidths collection.

Declaration
public void ResetColWidthEntries()

ResetCoveredRanges()

Clears all CoveredRanges covered ranges.

Declaration
public void ResetCoveredRanges()

ResetCurrentCellInfo()

See ResetCurrentCellInfo() in the GridModel class for information.

Declaration
public void ResetCurrentCellInfo()

ResetGridCells()

Clears all cell formatting.

Declaration
public void ResetGridCells()

ResetRangeStyles()

Clears all cell formatting in the GridData object.

Declaration
public void ResetRangeStyles()

ResetRowHeightEntries()

Resets values in the RowHeights collection.

Declaration
public void ResetRowHeightEntries()

ResetRowHiddenEntries()

Resets values in the HideRows collection.

Declaration
public void ResetRowHiddenEntries()

ResetTableStyle()

Resets the TableStyle property.

Declaration
public void ResetTableStyle()

ResetVolatileData()

See ResetVolatileData() in the GridModel class for information.

Declaration
public void ResetVolatileData()

ResumeChangeEvents()

See ResumeChangeEvents() in the GridModel class for information.

Declaration
public void ResumeChangeEvents()

ResumeRecordUndo()

See ResumeRecordUndo() in the GridModel class for information.

Declaration
public void ResumeRecordUndo()

SaveXml()

Saves the current GridModel object to a file in xml format. The filename can be specified with FileName.

Declaration
public void SaveXml()

SaveXml(Stream)

Saves the current GridModel object to a stream in xml format.

Declaration
public void SaveXml(Stream s)
Parameters
Type Name Description
System.IO.Stream s

SaveXml(String)

Saves the current GridModel object in xml format to a file with the specified filename.

Declaration
public void SaveXml(string fileName)
Parameters
Type Name Description
System.String fileName

SetCellInfo(Int32, Int32, GridStyleInfo, StyleModifyType)

See SetCellInfo(Int32, Int32, GridStyleInfo, StyleModifyType) in the GridModel class for information.

Declaration
public bool SetCellInfo(int rowIndex, int colIndex, GridStyleInfo style, StyleModifyType modifyType)
Parameters
Type Name Description
System.Int32 rowIndex
System.Int32 colIndex
GridStyleInfo style
StyleModifyType modifyType
Returns
Type
System.Boolean

SetCellInfo(Int32, Int32, GridStyleInfo, StyleModifyType, Boolean, Boolean)

See SetCellInfo(Int32, Int32, GridStyleInfo, StyleModifyType) in the GridModel class for information.

Declaration
public bool SetCellInfo(int rowIndex, int colIndex, GridStyleInfo style, StyleModifyType modifyType, bool dontRaiseSaveCellInfoEvent, bool copyReferenceOnly)
Parameters
Type Name Description
System.Int32 rowIndex
System.Int32 colIndex
GridStyleInfo style
StyleModifyType modifyType
System.Boolean dontRaiseSaveCellInfoEvent
System.Boolean copyReferenceOnly
Returns
Type
System.Boolean

SetCells(GridRangeInfo, GridStyleInfoStoreTable)

See SetCells(GridRangeInfo, GridStyleInfoStoreTable) in the GridModel class for information.

Declaration
public void SetCells(GridRangeInfo range, GridStyleInfoStoreTable data)
Parameters
Type Name Description
GridRangeInfo range
GridStyleInfoStoreTable data

SetCells(GridRangeInfo, GridStyleInfoStoreTable, Boolean, Boolean)

See SetCells(GridRangeInfo, GridStyleInfoStoreTable) in the GridModel class for information.

Declaration
public void SetCells(GridRangeInfo range, GridStyleInfoStoreTable data, bool dontRaiseSaveCellInfoEvent, bool copyReferenceOnly)
Parameters
Type Name Description
GridRangeInfo range
GridStyleInfoStoreTable data
System.Boolean dontRaiseSaveCellInfoEvent
System.Boolean copyReferenceOnly

SetMetroStyle(GridMetroColors)

set the color for metro theme in Grid

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

GridMetroColors Collection of metro colors

SetMetroStyle(Object, Object, Object)

Sets the Custom metro colors to the Grid.

Declaration
public void SetMetroStyle(object metroColor, object metroHoverColor, object metroColorPressed)
Parameters
Type Name Description
System.Object metroColor

Custom Metro Color
System.Object metroHoverColor

Custom MouseHover Color
System.Object metroColorPressed

Custom PushButtonPress Color

SetOffice2016ThemeStyle(GridVisualStyles, GridOffice2016ThemeColors)

Sets the custom colors for the Office2016 themes.

Declaration
public void SetOffice2016ThemeStyle(GridVisualStyles visualSyle, GridOffice2016ThemeColors office2016Colors)
Parameters
Type Name Description
GridVisualStyles visualSyle

Office 2016 visual style which needs to be customized.
GridOffice2016ThemeColors office2016Colors

GridOffice2016ThemeColors Collection of office 2016 theme colors.

ShouldSerializeColHiddenEntries()

Determines if values in the HideCols collection were modified.

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

true if modified; false otherwise.

ShouldSerializeColWidthEntries()

Determines if values in the ColWidths collection were modified.

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

True if modified; False otherwise.

ShouldSerializeGridCells()

True if SerializeCellsBehavior is set to SerializeIntoCode, otherwise false.

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

returns True if SerializeCellsBehavior is set to SerializeIntoCode, otherwise false.

ShouldSerializeRangeStyles()

Determines if the range styles should be serialized.

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

True if they should be serialized; False otherwise.

ShouldSerializeRowHeightEntries()

Determines if values in the RowHeights collection were modified.

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

True if modified; False otherwise.

ShouldSerializeRowHiddenEntries()

Determines if values in the HideRows collection were modified.

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

True if modified; False otherwise.

StyleInfoBordersToMargins(GridStyleInfo)

See StyleInfoBordersToMargins(GridStyleInfo) in the GridModel class for information.

Declaration
public GridMargins StyleInfoBordersToMargins(GridStyleInfo style)
Parameters
Type Name Description
GridStyleInfo style
Returns
Type
GridMargins

SubtractBorders(Rectangle, GridStyleInfo)

See SubtractBorders(Rectangle, GridStyleInfo, Boolean) in the GridModel class for information.

Declaration
public Rectangle SubtractBorders(Rectangle cellBounds, GridStyleInfo style)
Parameters
Type Name Description
System.Drawing.Rectangle cellBounds
GridStyleInfo style
Returns
Type
System.Drawing.Rectangle

SubtractBorders(Rectangle, GridStyleInfo, Boolean)

See SubtractBorders(Rectangle, GridStyleInfo, Boolean) in the GridModel class for information.

Declaration
public Rectangle SubtractBorders(Rectangle cellBounds, GridStyleInfo style, bool isRightToLeft)
Parameters
Type Name Description
System.Drawing.Rectangle cellBounds
GridStyleInfo style
System.Boolean isRightToLeft
Returns
Type
System.Drawing.Rectangle

SuspendChangeEvents()

See SuspendChangeEvents() in the GridModel class for information.

Declaration
public void SuspendChangeEvents()

SuspendRecordUndo()

See SuspendRecordUndo() in the GridModel class for information.

Declaration
public void SuspendRecordUndo()

SynchronizeCurrentCell(Int32, Int32)

See SynchronizeCurrentCell(Int32, Int32) in the GridModel class for information.

Declaration
public void SynchronizeCurrentCell(int rowIndex, int colIndex)
Parameters
Type Name Description
System.Int32 rowIndex
System.Int32 colIndex

UnwireModel()

Declaration
protected override void UnwireModel()
Overrides

UpdateColWidth()

Recalculates the Column width of the Grid Control.

Declaration
public void UpdateColWidth()

WireModel()

Declaration
protected override void WireModel()
Overrides

WndProc(ref Message)

Used to modify the windows processing messages.

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

The System.Windows.Forms.Messagepassed form windows.
Overrides

Events

BanneredRangesChanged

See BanneredRangesChanged in the GridModel class for information.

Declaration
public event GridBanneredRangesChangedEventHandler BanneredRangesChanged
Event Type
Type
GridBanneredRangesChangedEventHandler

BanneredRangesChanging

See BanneredRangesChanging in the GridModel class for information.

Declaration
public event GridBanneredRangesChangingEventHandler BanneredRangesChanging
Event Type
Type
GridBanneredRangesChangingEventHandler

BaseStylesMapChanged

See BaseStylesMapChanged in the GridModel class for information.

Declaration
public event EventHandler BaseStylesMapChanged
Event Type
Type
System.EventHandler

BeginUpdateRequest

See BeginUpdateRequest in the GridModel class for information.

Declaration
public event EventHandler BeginUpdateRequest
Event Type
Type
System.EventHandler

CellModelsChanged

See CellModelsChanged in the GridModel class for information.

Declaration
public event CollectionChangeEventHandler CellModelsChanged
Event Type
Type
System.ComponentModel.CollectionChangeEventHandler

CellsChanged

See CellsChanged in the GridModel class for information.

Declaration
public event GridCellsChangedEventHandler CellsChanged
Event Type
Type
GridCellsChangedEventHandler

CellsChanging

See CellsChanging in the GridModel class for information.

Declaration
public event GridCellsChangingEventHandler CellsChanging
Event Type
Type
GridCellsChangingEventHandler

ClearingCells

Occurs when the grid's ClearCells method is called.

Declaration
public event GridClearingCellsEventHandler ClearingCells
Event Type
Type
GridClearingCellsEventHandler

ClipboardCanCopy

Occurs when the grid's CanCopy method is called.

Declaration
public event GridCutPasteEventHandler ClipboardCanCopy
Event Type
Type
GridCutPasteEventHandler

ClipboardCanCut

Occurs when the grid's CanCut method is called.

Declaration
public event GridCutPasteEventHandler ClipboardCanCut
Event Type
Type
GridCutPasteEventHandler

ClipboardCanPaste

Occurs when the grid's CanPaste method is called.

Declaration
public event GridCutPasteEventHandler ClipboardCanPaste
Event Type
Type
GridCutPasteEventHandler

ClipboardCopy

Occurs when the grid's Copy method is called.

Declaration
public event GridCutPasteEventHandler ClipboardCopy
Event Type
Type
GridCutPasteEventHandler

ClipboardCopyToBuffer

Occurs when the grid's CopyToBuffer method is called.

Declaration
public event ClipboardCopyToBufferEventHandler ClipboardCopyToBuffer
Event Type
Type
ClipboardCopyToBufferEventHandler

ClipboardCut

Occurs when the grid's Cut method is called.

Declaration
public event GridCutPasteEventHandler ClipboardCut
Event Type
Type
GridCutPasteEventHandler

ClipboardPaste

Occurs when the grid's Paste method is called.

Declaration
public event GridCutPasteEventHandler ClipboardPaste
Event Type
Type
GridCutPasteEventHandler

ColsHidden

See ColsHidden in the GridModel class for information.

Declaration
public event GridRowColHiddenEventHandler ColsHidden
Event Type
Type
GridRowColHiddenEventHandler

ColsHiding

See ColsHiding in the GridModel class for information.

Declaration
public event GridRowColHidingEventHandler ColsHiding
Event Type
Type
GridRowColHidingEventHandler

ColsInserted

See ColsInserted in the GridModel class for information.

Declaration
public event GridRangeInsertedEventHandler ColsInserted
Event Type
Type
GridRangeInsertedEventHandler

ColsInserting

See ColsInserting in the GridModel class for information.

Declaration
public event GridRangeInsertingEventHandler ColsInserting
Event Type
Type
GridRangeInsertingEventHandler

ColsMoved

See ColsMoved in the GridModel class for information.

Declaration
public event GridRangeMovedEventHandler ColsMoved
Event Type
Type
GridRangeMovedEventHandler

ColsMoving

See ColsMoving in the GridModel class for information.

Declaration
public event GridRangeMovingEventHandler ColsMoving
Event Type
Type
GridRangeMovingEventHandler

ColsRemoved

See ColsRemoved in the GridModel class for information.

Declaration
public event GridRangeRemovedEventHandler ColsRemoved
Event Type
Type
GridRangeRemovedEventHandler

ColsRemoving

See ColsRemoving in the GridModel class for information.

Declaration
public event GridRangeRemovingEventHandler ColsRemoving
Event Type
Type
GridRangeRemovingEventHandler

ColWidthsChanged

See ColWidthsChanged in the GridModel class for information.

Declaration
public event GridRowColSizeChangedEventHandler ColWidthsChanged
Event Type
Type
GridRowColSizeChangedEventHandler

ColWidthsChanging

See ColWidthsChanging in the GridModel class for information.

Declaration
public event GridRowColSizeChangingEventHandler ColWidthsChanging
Event Type
Type
GridRowColSizeChangingEventHandler

ConfirmingPendingChanges

See ConfirmingPendingChanges in the GridModel class for information.

Declaration
public event CancelEventHandler ConfirmingPendingChanges
Event Type
Type
System.ComponentModel.CancelEventHandler

ControllerOptionsChanged

See ControllerOptionsChanged in the GridModel class for information.

Declaration
public event EventHandler ControllerOptionsChanged
Event Type
Type
System.EventHandler

CoveredRangesChanged

See CoveredRangesChanged in the GridModel class for information.

Declaration
public event GridCoveredRangesChangedEventHandler CoveredRangesChanged
Event Type
Type
GridCoveredRangesChangedEventHandler

CoveredRangesChanging

See CoveredRangesChanging in the GridModel class for information.

Declaration
public event GridCoveredRangesChangingEventHandler CoveredRangesChanging
Event Type
Type
GridCoveredRangesChangingEventHandler

DataChanged

See DataChanged in the GridModel class for information.

Declaration
public event EventHandler DataChanged
Event Type
Type
System.EventHandler

DataObjectConsumerOptionsChanged

See DataObjectConsumerOptionsChanged in the GridModel class for information.

Declaration
public event EventHandler DataObjectConsumerOptionsChanged
Event Type
Type
System.EventHandler

DefaultColWidthChanged

See DefaultColWidthChanged in the GridModel class for information.

Declaration
public event GridDefaultSizeChangedEventHandler DefaultColWidthChanged
Event Type
Type
GridDefaultSizeChangedEventHandler

DefaultColWidthChanging

See DefaultColWidthChanging in the GridModel class for information.

Declaration
public event GridDefaultSizeChangingEventHandler DefaultColWidthChanging
Event Type
Type
GridDefaultSizeChangingEventHandler

DefaultRowHeightChanged

See DefaultRowHeightChanged in the GridModel class for information.

Declaration
public event GridDefaultSizeChangedEventHandler DefaultRowHeightChanged
Event Type
Type
GridDefaultSizeChangedEventHandler

DefaultRowHeightChanging

See DefaultRowHeightChanging in the GridModel class for information.

Declaration
public event GridDefaultSizeChangingEventHandler DefaultRowHeightChanging
Event Type
Type
GridDefaultSizeChangingEventHandler

EndUpdateRequest

See EndUpdateRequest in the GridModel class for information.

Declaration
public event GridEndUpdateRequestEventHandler EndUpdateRequest
Event Type
Type
GridEndUpdateRequestEventHandler

FileNameChanged

See FileNameChanged in the GridModel class for information.

Declaration
public event EventHandler FileNameChanged
Event Type
Type
System.EventHandler

FilterBarChoices

This event occurs when GridTableDescriptor is initializing columns with .AllowFilter set and gives you the option to handle filterBar choices through custom code. In such case the event is also raised when the user clicks on on dropdown button of a GridTableFilterBarCell.

Declaration
public event GridFilterBarChoicesEventHandler FilterBarChoices
Event Type
Type
GridFilterBarChoicesEventHandler

FilterBarSelectionChanged

This event occurs after an item selected through the filtered dropdown.

Declaration
public event FilterBarSelectionChangedEventHandler FilterBarSelectionChanged
Event Type
Type
FilterBarSelectionChangedEventHandler

FilterBarSelectionChanging

This event occurs when an item selected through the filtered dropdown.

Declaration
public event FilterBarSelectionChangingEventHandler FilterBarSelectionChanging
Event Type
Type
FilterBarSelectionChangingEventHandler

FloatingCellsChanged

See FloatingCellsChanged in the GridModel class for information.

Declaration
public event GridFloatingCellsChangedEventHandler FloatingCellsChanged
Event Type
Type
GridFloatingCellsChangedEventHandler

FrozenColCountChanged

See FrozenColCountChanged in the GridModel class for information.

Declaration
public event GridCountChangedEventHandler FrozenColCountChanged
Event Type
Type
GridCountChangedEventHandler

FrozenColCountChanging

See FrozenColCountChanging in the GridModel class for information.

Declaration
public event GridCountChangingEventHandler FrozenColCountChanging
Event Type
Type
GridCountChangingEventHandler

FrozenRowCountChanged

See FrozenRowCountChanged in the GridModel class for information.

Declaration
public event GridCountChangedEventHandler FrozenRowCountChanged
Event Type
Type
GridCountChangedEventHandler

FrozenRowCountChanging

See FrozenRowCountChanging in the GridModel class for information.

Declaration
public event GridCountChangingEventHandler FrozenRowCountChanging
Event Type
Type
GridCountChangingEventHandler

HeaderColCountChanged

See HeaderColCountChanged in the GridModel class for information.

Declaration
public event GridCountChangedEventHandler HeaderColCountChanged
Event Type
Type
GridCountChangedEventHandler

HeaderColCountChanging

See HeaderColCountChanging in the GridModel class for information.

Declaration
public event GridCountChangingEventHandler HeaderColCountChanging
Event Type
Type
GridCountChangingEventHandler

HeaderRowCountChanged

See HeaderRowCountChanged in the GridModel class for information.

Declaration
public event GridCountChangedEventHandler HeaderRowCountChanged
Event Type
Type
GridCountChangedEventHandler

HeaderRowCountChanging

See HeaderRowCountChanging in the GridModel class for information.

Declaration
public event GridCountChangingEventHandler HeaderRowCountChanging
Event Type
Type
GridCountChangingEventHandler

MergeCellsChanged

Occurs after floating state was changed for a range of cells.

Declaration
public event GridMergeCellsChangedEventHandler MergeCellsChanged
Event Type
Type
GridMergeCellsChangedEventHandler

ModifiedChanged

See ModifiedChanged in the GridModel class for information.

Declaration
public event EventHandler ModifiedChanged
Event Type
Type
System.EventHandler

OperationFeedback

See OperationFeedback in the GridModel class for information.

Declaration
public event OperationFeedbackEventHandler OperationFeedback
Event Type
Type
OperationFeedbackEventHandler

ParseCommonFormats

Handle this event to provide support for parsing the formatted string and convert it into the the underlying cell's value.

Declaration
public event GridCellTextEventHandler ParseCommonFormats
Event Type
Type
GridCellTextEventHandler

PasteCellText

See PasteCellText in the GridModel class for information.

Declaration
public event GridPasteCellTextEventHandler PasteCellText
Event Type
Type
GridPasteCellTextEventHandler

PrepareChangeSelection

See PrepareChangeSelection in the GridModel class for information.

Declaration
public event GridPrepareChangeSelectionEventHandler PrepareChangeSelection
Event Type
Type
GridPrepareChangeSelectionEventHandler

PrepareClearSelection

See PrepareClearSelection in the GridModel class for information.

Declaration
public event EventHandler PrepareClearSelection
Event Type
Type
System.EventHandler

PrepareGraphics

See PrepareGraphics in the GridModel class for information.

Declaration
public event GraphicsEventHandler PrepareGraphics
Event Type
Type
GraphicsEventHandler

QueryBanneredRange

See QueryBanneredRange in the GridModel class for information.

Declaration
public event GridQueryBanneredRangeEventHandler QueryBanneredRange
Event Type
Type
GridQueryBanneredRangeEventHandler

QueryCanMergeCells

Occurs when grid compares the contents of two cells to determine if they should be merged.

Declaration
public event GridQueryCanMergeCellsEventHandler QueryCanMergeCells
Event Type
Type
GridQueryCanMergeCellsEventHandler

QueryCellFormattedText

Occurs each time the GridStyleInfo.Text is called to get the string that represents the underlying cell's value.

Declaration
public event GridCellTextEventHandler QueryCellFormattedText
Event Type
Type
GridCellTextEventHandler

QueryCellInfo

See QueryCellInfo in the GridModel class for information.

Declaration
public event GridQueryCellInfoEventHandler QueryCellInfo
Event Type
Type
GridQueryCellInfoEventHandler

QueryCellModel

Occurs when the QueryCellModel is querying for the GridCellModelBase based on a string cellType.

Declaration
public event GridQueryCellModelEventHandler QueryCellModel
Event Type
Type
GridQueryCellModelEventHandler
Remarks

The GridModel has a table with all cell types used in the grid. Whenever the grid encounters a new cell type that it cannot find in the table, it will raise a QueryCellModel event. The CellType identifies the name of the cell type. The CellModel should receive the new instance of the associated cell object. This object will be stored in the table together with its name and reused among cells with the same CellType.

You should process this event if you want to add custom cell types and initialize these cell types on demand when associated cells are accessed the first time.

See Also

QueryCellText

Occurs each time the GridStyleInfo.Text is called to get the string that represents the underlying cell's value.

Declaration
public event GridCellTextEventHandler QueryCellText
Event Type
Type
GridCellTextEventHandler

QueryColCount

See QueryColCount in the GridModel class for information.

Declaration
public event GridRowColCountEventHandler QueryColCount
Event Type
Type
GridRowColCountEventHandler

QueryColWidth

See QueryColWidth in the GridModel class for information.

Declaration
public event GridRowColSizeEventHandler QueryColWidth
Event Type
Type
GridRowColSizeEventHandler

QueryCoveredRange

See QueryCoveredRange in the GridModel class for information.

Declaration
public event GridQueryCoveredRangeEventHandler QueryCoveredRange
Event Type
Type
GridQueryCoveredRangeEventHandler

QueryOleDataSourceData

Occurs when a user starts dragging a range of selected cells using OLE drag-and-drop.

Declaration
public event GridQueryOleDataSourceDataEventHandler QueryOleDataSourceData
Event Type
Type
GridQueryOleDataSourceDataEventHandler

QueryRowCount

See QueryRowCount in the GridModel class for information.

Declaration
public event GridRowColCountEventHandler QueryRowCount
Event Type
Type
GridRowColCountEventHandler

QueryRowHeight

See QueryRowHeight in the GridModel class for information.

Declaration
public event GridRowColSizeEventHandler QueryRowHeight
Event Type
Type
GridRowColSizeEventHandler

ReadOnlyChanged

See ReadOnlyChanged in the GridModel class for information.

Declaration
public event EventHandler ReadOnlyChanged
Event Type
Type
System.EventHandler

RefreshRequest

See RefreshRequest in the GridModel class for information.

Declaration
public event EventHandler RefreshRequest
Event Type
Type
System.EventHandler

RowHeightsChanged

See RowHeightsChanged in the GridModel class for information.

Declaration
public event GridRowColSizeChangedEventHandler RowHeightsChanged
Event Type
Type
GridRowColSizeChangedEventHandler

RowHeightsChanging

See RowHeightsChanging in the GridModel class for information.

Declaration
public event GridRowColSizeChangingEventHandler RowHeightsChanging
Event Type
Type
GridRowColSizeChangingEventHandler

RowsHidden

See RowsHidden in the GridModel class for information.

Declaration
public event GridRowColHiddenEventHandler RowsHidden
Event Type
Type
GridRowColHiddenEventHandler

RowsHiding

See RowsHiding in the GridModel class for information.

Declaration
public event GridRowColHidingEventHandler RowsHiding
Event Type
Type
GridRowColHidingEventHandler

RowsInserted

See RowsInserted in the GridModel class for information.

Declaration
public event GridRangeInsertedEventHandler RowsInserted
Event Type
Type
GridRangeInsertedEventHandler

RowsInserting

See RowsInserting in the GridModel class for information.

Declaration
public event GridRangeInsertingEventHandler RowsInserting
Event Type
Type
GridRangeInsertingEventHandler

RowsMoved

See RowsMoved in the GridModel class for information.

Declaration
public event GridRangeMovedEventHandler RowsMoved
Event Type
Type
GridRangeMovedEventHandler

RowsMoving

See RowsMoving in the GridModel class for information.

Declaration
public event GridRangeMovingEventHandler RowsMoving
Event Type
Type
GridRangeMovingEventHandler

RowsRemoved

See RowsRemoved in the GridModel class for information.

Declaration
public event GridRangeRemovedEventHandler RowsRemoved
Event Type
Type
GridRangeRemovedEventHandler

RowsRemoving

See RowsRemoving in the GridModel class for information.

Declaration
public event GridRangeRemovingEventHandler RowsRemoving
Event Type
Type
GridRangeRemovingEventHandler

SaveCellFormattedText

Occurs each time the GridStyleInfo.FormattedText is called to set the raw string that represents the underlying cell's value.

Declaration
public event GridCellTextEventHandler SaveCellFormattedText
Event Type
Type
GridCellTextEventHandler

SaveCellInfo

See SaveCellInfo in the GridModel class for information.

Declaration
public event GridSaveCellInfoEventHandler SaveCellInfo
Event Type
Type
GridSaveCellInfoEventHandler

SaveCellText

Occurs each time the GridStyleInfo.Text is called to set the raw string that represents the underlying cell's value.

Declaration
public event GridCellTextEventHandler SaveCellText
Event Type
Type
GridCellTextEventHandler

SaveColCount

See SaveColCount in the GridModel class for information.

Declaration
public event GridRowColCountEventHandler SaveColCount
Event Type
Type
GridRowColCountEventHandler

SaveColWidth

See SaveColWidth in the GridModel class for information.

Declaration
public event GridRowColSizeEventHandler SaveColWidth
Event Type
Type
GridRowColSizeEventHandler

SaveRowCount

See SaveRowCount in the GridModel class for information.

Declaration
public event GridRowColCountEventHandler SaveRowCount
Event Type
Type
GridRowColCountEventHandler

SaveRowHeight

See SaveRowHeight in the GridModel class for information.

Declaration
public event GridRowColSizeEventHandler SaveRowHeight
Event Type
Type
GridRowColSizeEventHandler

SelectionChanged

See SelectionChanged in the GridModel class for information.

Declaration
public event GridSelectionChangedEventHandler SelectionChanged
Event Type
Type
GridSelectionChangedEventHandler

SelectionChanging

See SelectionChanging in the GridModel class for information.

Declaration
public event GridSelectionChangingEventHandler SelectionChanging
Event Type
Type
GridSelectionChangingEventHandler

Explicit Interface Implementations

IVisualStyle.VisualTheme

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

Implements

System.IDisposable
System.ComponentModel.ISupportInitialize