menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfCellGrid - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfCellGrid

    Represents the SfCellGrid control in which data will be displayed in the form of rows and columns.

    Inheritance
    System.Object
    BaseControl
    ScrollControl
    SfCellGrid
    SpreadsheetGrid
    Implements
    IThemeProvider
    IVisualStyle
    ICancelModeProvider
    ISplitterPaneSupport
    IScrollBarWrapperContainer
    ISupportUpdating
    ISupportIntelliMouse
    IQueryFocusInside
    INonClientPaintingSupport
    ICalcData
    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable
    Inherited Members
    BaseControl.CanApplyTheme
    BaseControl.CanOverrideStyle
    BaseControl.ControlName
    BaseControl.GetActiveThemeName()
    BaseControl.GetControlName(String)
    BaseControl.IsVisualStyleEnabled
    BaseControl.IThemeProvider.BaseThemeName
    BaseControl.OnCanApplyThemeChanged(Boolean)
    BaseControl.OnCanOverrideStyleChanged(Boolean)
    BaseControl.RaiseThemeChanged(Object, ThemeChangedEventArgs)
    BaseControl.ThemeName
    BaseControl.ThemeNameChanged
    ScrollControl.AccelerateScrolling
    ScrollControl.AccelerateScrollingChanged
    ScrollControl.ActiveController
    ScrollControl.AllowIncreaseSmallChange
    ScrollControl.AllowRaiseMouseMoveInOnDragOver
    ScrollControl.AllowSizeGrip
    ScrollControl.AutoScrollBounds
    ScrollControl.AutoScrolling
    ScrollControl.AutoScrollingChanged
    ScrollControl.AutoScrollTimerEnable
    ScrollControl.BeginUpdate()
    ScrollControl.BeginUpdate(BeginUpdateOptions)
    ScrollControl.BorderStyle
    ScrollControl.Bounds
    ScrollControl.CancelMode
    ScrollControl.CancelUpdate()
    ScrollControl.ClientRectangle
    ScrollControl.ClientSize
    ScrollControl.CreateParams
    ScrollControl.Cursor
    ScrollControl.Deactivated
    ScrollControl.DisableScrollWindow
    ScrollControl.DiscardPaintMessagesAfterBeginUpdate
    ScrollControl.Dispose()
    ScrollControl.DoubleBufferSurface
    ScrollControl.DpiAware
    ScrollControl.EnableDoubleBufferSurface()
    ScrollControl.EnableIntelliMouse
    ScrollControl.EnableTouchMode
    ScrollControl.EndUpdate()
    ScrollControl.EndUpdate(Boolean)
    ScrollControl.EnsurePaintCodeJitted(Boolean)
    ScrollControl.FillSplitterPane
    ScrollControl.FillSplitterPaneChanged
    ScrollControl.FixRenderOrigin(Graphics)
    ScrollControl.ForceSizeBox
    ScrollControl.GetDynamicSplitterFrameOfComponent(Object)
    ScrollControl.GetScrollBarFrameOfComponent(Object)
    ScrollControl.GridOfficeScrollBars
    ScrollControl.HasControlFocus
    ScrollControl.HasDoubleBufferSurface
    ScrollControl.HitTest(Point)
    ScrollControl.HitTest(Point, MouseButtons)
    ScrollControl.HitTest(Point, MouseButtons, IMouseController)
    ScrollControl.HitTest(Point, MouseButtons, Int32, IMouseController)
    ScrollControl.HorizontalScroll
    ScrollControl.HorizontalScrollTips
    ScrollControl.HorizontalThumbTrack
    ScrollControl.HScroll
    ScrollControl.HScrollBar
    ScrollControl.HScrollIncrement
    ScrollControl.IgnoreSizeGripStyleHideShow
    ScrollControl.IgnoreUICues
    ScrollControl.INonClientPaintingSupport.NonClientPaint(PaintEventArgs, Rectangle, Rectangle)
    ScrollControl.InsideScrollBounds
    ScrollControl.InsideScrollMargins
    ScrollControl.IntelliMouseDragScrolling
    ScrollControl.InvalidateNc()
    ScrollControl.InvalidateNc(Rectangle)
    ScrollControl.IsActiveControl
    ScrollControl.IsDeactivated
    ScrollControl.IsDisposing
    ScrollControl.IsMousePressed
    ScrollControl.ISplitterPaneSupport.FillSplitterPane
    ScrollControl.ISplitterPaneSupport.PaneClosed()
    ScrollControl.ISplitterPaneSupport.PaneClosing()
    ScrollControl.IsSplitterPaneClosed
    ScrollControl.IsSplitterPaneClosing
    ScrollControl.ISupportUpdating.Updating
    ScrollControl.IsValidated
    ScrollControl.IsValidating
    ScrollControl.IVisualStyle.VisualTheme
    ScrollControl.LastMousePosition
    ScrollControl.LastMousePositionToClient()
    ScrollControl.MetroColorTable
    ScrollControl.MetroScrollBars
    ScrollControl.MouseControllerDispatcher
    ScrollControl.MouseWheelScrollLines
    ScrollControl.MouseWheelZoom
    ScrollControl.NotifyCancelMode()
    ScrollControl.Office2007ScrollBars
    ScrollControl.Office2007ScrollBarsChanged
    ScrollControl.Office2007ScrollBarsColorScheme
    ScrollControl.Office2007ScrollBarsColorSchemeChanged
    ScrollControl.Office2010ScrollBarsColorScheme
    ScrollControl.Office2010ScrollBarsColorSchemeChanged
    ScrollControl.Office2016BlackColorTable
    ScrollControl.Office2016ColorfulColorTable
    ScrollControl.Office2016DarkGrayColorTable
    ScrollControl.Office2016ScrollBars
    ScrollControl.Office2016ScrollBarsColorScheme
    ScrollControl.Office2016ScrollBarsColorSchemeChanged
    ScrollControl.Office2016WhiteColorTable
    ScrollControl.OfficeScrollBarsChanged
    ScrollControl.OnAccelerateScrollingChanged(EventArgs)
    ScrollControl.OnAutoScrollingChanged(EventArgs)
    ScrollControl.OnBeginUpdateScrollBars()
    ScrollControl.OnCancelMode(EventArgs)
    ScrollControl.OnControlAdded(ControlEventArgs)
    ScrollControl.OnControlGotFocus()
    ScrollControl.OnControlLostFocus()
    ScrollControl.OnControlRemoved(ControlEventArgs)
    ScrollControl.OnCreateScrollTipWindow()
    ScrollControl.OnDeactivated(EventArgs)
    ScrollControl.OnDragOver(DragEventArgs)
    ScrollControl.OnEndUpdateScrollBars()
    ScrollControl.OnEnsurePaintCodeJitted()
    ScrollControl.OnEnter(EventArgs)
    ScrollControl.OnFillSplitterPaneChanged(EventArgs)
    ScrollControl.OnGotFocus(EventArgs)
    ScrollControl.OnHandleCreated(EventArgs)
    ScrollControl.OnHorizontalScroll(ScrollEventArgs)
    ScrollControl.OnHScrollBarValueChanged(Object, EventArgs)
    ScrollControl.OnIntelliMouseDragScrolling(IntelliMouseDragScrollEventArgs)
    ScrollControl.OnInvalidated(InvalidateEventArgs)
    ScrollControl.OnLeave(EventArgs)
    ScrollControl.OnLocationChanged(EventArgs)
    ScrollControl.OnLostFocus(EventArgs)
    ScrollControl.OnMouseDown(MouseEventArgs)
    ScrollControl.OnMouseHover(EventArgs)
    ScrollControl.OnMouseLeave(EventArgs)
    ScrollControl.OnMouseMove(MouseEventArgs)
    ScrollControl.OnMouseWheel(MouseEventArgs)
    ScrollControl.OnMouseWheelZoom(MouseWheelZoomEventArgs)
    ScrollControl.OnNcCalcSize(Rectangle)
    ScrollControl.OnNCPaint(NCPaintEventArgs)
    ScrollControl.OnOffice2007ScrollBarsChanged(EventArgs)
    ScrollControl.OnOffice2007ScrollBarsColorSchemeChanged(EventArgs)
    ScrollControl.OnOffice2010ScrollBarsColorSchemeChanged(EventArgs)
    ScrollControl.OnOffice2016ScrollBarsColorSchemeChanged(EventArgs)
    ScrollControl.OnOfficeScrollBarsChanged(ScrollControl.OfficeScrollBarsEventArgs)
    ScrollControl.OnPaint(PaintEventArgs)
    ScrollControl.OnParentChanged(EventArgs)
    ScrollControl.OnRightToLeftChanged(EventArgs)
    ScrollControl.OnScrollbarsVisibleChanged(EventArgs)
    ScrollControl.OnScrollControlHandledMouseDown(MouseEventArgs)
    ScrollControl.OnScrollControlHandledMouseMove(MouseEventArgs)
    ScrollControl.OnScrollControlHandledMouseUp(MouseEventArgs)
    ScrollControl.OnScrollControlMouseDown(CancelMouseEventArgs)
    ScrollControl.OnScrollControlMouseMove(CancelMouseEventArgs)
    ScrollControl.OnScrollControlMouseUp(CancelMouseEventArgs)
    ScrollControl.OnScrollTipFeedback(ScrollTipFeedbackEventArgs)
    ScrollControl.OnSetCursor(Message)
    ScrollControl.OnShowContextMenu(ShowContextMenuEventArgs)
    ScrollControl.OnSplitterPaneClosed(EventArgs)
    ScrollControl.OnSplitterPaneClosing(EventArgs)
    ScrollControl.OnStartAutoScrolling(StartAutoScrollingEventArgs)
    ScrollControl.OnThemeNameChanged(String)
    ScrollControl.OnTouchPan(Point, Boolean)
    ScrollControl.OnTouchPanBegin(Point)
    ScrollControl.OnTouchPanEnd(Point)
    ScrollControl.OnUpdatingChanged(EventArgs)
    ScrollControl.OnValidated(EventArgs)
    ScrollControl.OnValidating(CancelEventArgs)
    ScrollControl.OnValidatingLostFocus()
    ScrollControl.OnVerticalScroll(ScrollEventArgs)
    ScrollControl.OnVisibleChanged(EventArgs)
    ScrollControl.OnVScrollBarValueChanged(Object, EventArgs)
    ScrollControl.OnWindowScrolled(ScrollWindowEventArgs)
    ScrollControl.OnWindowScrolling(ScrollWindowEventArgs)
    ScrollControl.PaintPending
    ScrollControl.PaneDesc
    ScrollControl.PreJitPaint
    ScrollControl.ProcessMouseWheel(MouseEventArgs)
    ScrollControl.QueryFocusInside()
    ScrollControl.ResetInsideScrollMargins()
    ScrollControl.ResetMouseController()
    ScrollControl.ResetMouseWheelScrollLines()
    ScrollControl.ScrollbarsVisibleChanged
    ScrollControl.ScrollControlHandledMouseDown
    ScrollControl.ScrollControlHandledMouseMove
    ScrollControl.ScrollControlHandledMouseUp
    ScrollControl.ScrollControlMouseDown
    ScrollControl.ScrollControlMouseMove
    ScrollControl.ScrollControlMouseUp
    ScrollControl.ScrollTip
    ScrollControl.ScrollTipFeedback
    ScrollControl.ScrollTipFormat
    ScrollControl.ScrollWindow(Int32, Int32, Rectangle, Rectangle, Boolean)
    ScrollControl.ShouldPrepareUpdate()
    ScrollControl.ShouldPrepareUpdate(Boolean)
    ScrollControl.ShouldSerializeMouseWheelScrollLines()
    ScrollControl.ShowContextMenu
    ScrollControl.Size
    ScrollControl.SizeGripStyle
    ScrollControl.SmartSizeBox
    ScrollControl.SmoothMouseWheelScrolling
    ScrollControl.SplitterPaneClosed
    ScrollControl.SplitterPaneClosing
    ScrollControl.StartAutoScrolling
    ScrollControl.StartAutoScrollTimer(Message)
    ScrollControl.StartAutoScrollTimer(Message, Int32)
    ScrollControl.StartAutoScrollTimer(ScrollBarWrapper, ScrollEventType)
    ScrollControl.SupportsThumbTrack
    ScrollControl.TabIndex
    ScrollControl.ThemeStyle
    ScrollControl.UpdateNc()
    ScrollControl.UpdateOptions
    ScrollControl.UpdateScrollTips(ScrollEventArgs)
    ScrollControl.UpdateStyles()
    ScrollControl.Updating
    ScrollControl.UpdatingChanged
    ScrollControl.UpdatingStyles
    ScrollControl.UseSharedScrollBars
    ScrollControl.VerticalScroll
    ScrollControl.VerticalScrollTips
    ScrollControl.VerticalThumbTrack
    ScrollControl.VScroll
    ScrollControl.VScrollBar
    ScrollControl.VScrollIncrement
    ScrollControl.WindowScrolled
    ScrollControl.WindowScrolling
    ScrollControl.WndProc(Message)
    Namespace: Syncfusion.Windows.Forms.CellGrid
    Assembly: Syncfusion.Spreadsheet.Windows.dll
    Syntax
    public class SfCellGrid : ScrollControl, IThemeProvider, IVisualStyle, ICancelModeProvider, ISplitterPaneSupport, IScrollBarWrapperContainer, ISupportUpdating, ISupportIntelliMouse, IQueryFocusInside, INonClientPaintingSupport, ICalcData, INotifyPropertyChanged, IDisposable
    Remarks

    This class offers events associated with selection, editing and resizing operations in grid.

    Constructors

    SfCellGrid()

    Initializes a new instance of the SfCellGrid class.

    Declaration
    public SfCellGrid()

    Fields

    currentCell

    Declaration
    protected GridCurrentCell currentCell
    Field Value
    Type
    GridCurrentCell

    Properties

    AllowColumnResize

    Gets or sets the value indicating whether to allow column resizing or not.

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

    True or False.

    AllowEditing

    Gets or sets the value indicating whether to allow the editing operation or not.

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

    True or False.

    AllowEditorsContextMenu

    Gets or sets the value whether the Editors Context menu is to be Enabled or not.

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

    True or False.

    AllowExcelLikeKeyNavigation

    Get or sets the value which indicates whether to allow editing like Excel. Which means, move the SelectionStart where pressed mouse pointer, move it to end when press Down Arrow key and move it where last placed when press Up Arrow key.

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

    True or False.

    AllowFloatingCell

    Gets or sets the value which indicates whether to float the cells or not while displaying the data.

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

    True or False.

    AllowFloatingCellInEdit

    /// Gets or sets the value which indicates whether to allow the flood the cells in Edit mode or not.

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

    True or False.

    AllowGesture

    Gets or sets whether the gesture is enabled or not.

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

    Default value is true. If it is false, then it will disable the touch selection, panning, etc.

    AllowHiddenColumnResize

    Gets or sets the value indicating whetherto allow hidden column resizing or not.

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

    True or False.

    AllowHiddenRowResize

    Gets or sets the value indicating whether to allow hidden row resizing or not.

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

    True or False.

    AllowRowResize

    Gets or sets the value indicating whether to allow row resizing or not.

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

    True or False.

    AllowSelection

    Gets or sets the value indicating whether to allow the selection or not.

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

    True or False.

    AutoScroller

    Gets the auto scroller which provides automatic scrolling of content when the user drags the pressed mouse to an edge of the control.

    Declaration
    public GridAutoScroller AutoScroller { get; }
    Property Value
    Type Description
    GridAutoScroller

    An instance of GridAutoScroller.

    CellContextMenu

    Gets or sets the ContextMenu Items for Grid.

    Declaration
    public ContextMenuStrip CellContextMenu { get; }
    Property Value
    Type Description
    System.Windows.Forms.ContextMenuStrip

    ContextMenu item of Grid.

    ColumnCount

    Gets or sets the number of columncount in grid.

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

    Number of columns.

    ColumnResizingController

    Gets or sets the value for resizing column controller.

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

    An instance of ColumnResizingController.

    ColumnWidths

    Gets the collection of columnwidths for grid.

    Declaration
    public LineSizeCollection ColumnWidths { get; }
    Property Value
    Type Description
    LineSizeCollection

    Collection of columnwidths.

    CopyPaste

    Gets the instance of GridCopyPaste class which used to perform clipboard operations(Cut, Copy, Paste).

    Declaration
    public GridCopyPaste CopyPaste { get; }
    Property Value
    Type Description
    GridCopyPaste

    An instance of GridCopyPaste.

    CoveredCells

    Gets the coveredcells in the grid.

    Declaration
    public CoveredCellInfoCollection CoveredCells { get; }
    Property Value
    Type Description
    CoveredCellInfoCollection

    Collection of CoveredCells.

    CreateGridColumn

    Gets or sets System.Func<T, TResult> to create instance of GridColumn.

    Declaration
    public Func<SfCellGrid, GridColumn> CreateGridColumn { get; set; }
    Property Value
    Type
    System.Func<SfCellGrid, GridColumn>

    CurrentCell

    Gets the current cell of the Grid.

    Declaration
    public GridCurrentCell CurrentCell { get; }
    Property Value
    Type Description
    GridCurrentCell

    An instance of GridCurrentCell.

    DefaultColumnWidth

    Gets or sets the default columnwidth for grid.

    Declaration
    public double DefaultColumnWidth { get; set; }
    Property Value
    Type Description
    System.Double

    Width of the column.

    DefaultRowHeight

    Gets or sets the default rowheight for grid.

    Declaration
    public double DefaultRowHeight { get; set; }
    Property Value
    Type Description
    System.Double

    Height of the row.

    EditorSelectionBehavior

    Gets or sets a value indicating whether editor select all the value or move last position.

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

    One of the enum options of EditBehavior.

    EditTrigger

    Gets or Sets a value indicating any of the trigger options will cause cells to enter Edit Mode.

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

    One of the enum options of EditTrigger.

    FooterColumns

    Gets or sets the number of footer columns in grid.

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

    Number of footercolumns.

    FooterRows

    Gets or sets the number of footer rows in grid.

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

    Number of footerrows.

    FormulaEngine

    Gets the value indicating the instance of FormulaEngine which is used to perform calculations in grid.

    Declaration
    public FormulaEngine FormulaEngine { get; }
    Property Value
    Type Description
    FormulaEngine

    An instance of FormulaEngine.

    FrozenColumns

    Gets or sets the number of frozencolumns in grid.

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

    Number of frozencolumns.

    FrozenRows

    Gets or sets the number of frozenrows in grid.

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

    Number of frozenrows.

    GridLineColor

    Gets or sets the gridline color.

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

    Color for the Gridline.

    HeaderColumns

    Gets or sets the number of header columns in grid.

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

    Number of header columns.

    HeaderRows

    Gets or sets the number of header rows in grid.

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

    Number of header rows.

    RowCount

    Gets or sets the number of rowcounts in grid.

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

    Number of rows.

    RowHeights

    Gets the collection of rowheights for grid.

    Declaration
    public LineSizeCollection RowHeights { get; }
    Property Value
    Type Description
    LineSizeCollection

    Collection of rowheights.

    RowResizingController

    Gets or sets the value for resizing row controller.

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

    An instance of RowResizingController.

    ScrollColumns

    Gets the ScrollAxisBase for columns.

    Declaration
    public ScrollAxisBase ScrollColumns { get; }
    Property Value
    Type Description
    ScrollAxisBase

    An instance of ScrollAxisBase.

    ScrollRows

    Gets the ScrollAxisBase for rows.

    Declaration
    public ScrollAxisBase ScrollRows { get; }
    Property Value
    Type Description
    ScrollAxisBase

    An instance of ScrollAxisBase.

    SelectedRanges

    Gets or sets the collection of selected ranges from grid.

    Declaration
    public GridRangeInfoList SelectedRanges { get; set; }
    Property Value
    Type Description
    GridRangeInfoList

    A collection of selected ranges.

    SelectionBorderBrush

    Gets or sets the selection border brush.

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

    Brush for border.

    SelectionBorderThickness

    Gets or sets the thickness of selection border.

    Declaration
    public double SelectionBorderThickness { get; set; }
    Property Value
    Type Description
    System.Double

    Thickness of the border.

    SelectionBrush

    Gets or sets the selected area brush.

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

    Brush for selection.

    SelectionController

    Gets or sets the Selection Controller which provides the selection of content when the user drags the pressed mouse to an edge of the control.

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

    An instance of SelectionController.

    ShowComment

    Gets or Sets the value which indicates whether to show the cell comment or not.

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

    True or False.

    ShowGridLines

    Gets or sets value indicating whether gridlines shown or not.

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

    True or False.

    ShowTooltip

    Gets or sets the value which indicates whether to show the cell tooltip or not.

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

    True or False.

    Methods

    Dispose(Boolean)

    Dispose the live resources used by the SfCellGrid class.

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

    Dispose the instance, if it is True

    Overrides
    ScrollControl.Dispose(Boolean)

    GetCellValue(Int32, Int32)

    Used to get the value of the cell.

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

    RowIndex of the cell

    System.Int32 colIndex

    ColumnIndex of the cell

    Returns
    Type Description
    System.Object

    Returns the cell value

    GetDependentCellValue(Int32, Int32)

    Gets the dependent cell value of the specified cell.

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

    Row index of the cell

    System.Int32 colIndex

    Column index of the cell

    Returns
    Type Description
    System.String

    retuns the value of the specified cell

    GetDisplayText(Int32, Int32)

    Used to get the display text of the cell.

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

    RowIndex of the cell

    System.Int32 colIndex

    ColumnIndex of the cell

    Returns
    Type Description
    System.String

    Returns the display text

    GetValueRowCol(Int32, Int32)

    Returns the formula string if the cell contains a formula, or the value if the cell cantains anything other than a formula.

    Declaration
    public object GetValueRowCol(int row, int col)
    Parameters
    Type Name Description
    System.Int32 row

    The row of the cell.

    System.Int32 col

    The column of the cell.

    Returns
    Type Description
    System.Object

    The formula string or value.

    InitializeCellRendererCollection()

    Initializes the GridCellRendererCollection.

    Declaration
    protected virtual void InitializeCellRendererCollection()

    InvalidateCell(GridRangeInfo, Boolean)

    Invalidates the mentioned range in the grid.

    Declaration
    public void InvalidateCell(GridRangeInfo range, bool clearStyles = true)
    Parameters
    Type Name Description
    GridRangeInfo range

    Specified range.

    System.Boolean clearStyles

    Set this false to avoid resetting the GridStyleInfo of cells in mentioned range

    InvalidateCell(Int32, Int32)

    Invaildates the mentioned cell in the gird.

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

    Index of the row.

    System.Int32 colIndex

    Index of the column

    InvalidateCellBorders(GridRangeInfo)

    Invalidates the cell borders in the mentioned range.

    Declaration
    public void InvalidateCellBorders(GridRangeInfo range)
    Parameters
    Type Name Description
    GridRangeInfo range

    An instance ofGridRangeInfo.

    InvalidateCells(Boolean)

    Invalidate all Cells in a grid.

    Declaration
    public void InvalidateCells(bool clearStyles = true)
    Parameters
    Type Name Description
    System.Boolean clearStyles

    Set this false to avoid resetting the GridStyleInfo

    InvalidateSelection()

    Invalidates the selection layout alone.

    Declaration
    public void InvalidateSelection()

    InvalidateSelection(GridRangeInfo)

    Invalidates the specified range of selection layout.

    Declaration
    public void InvalidateSelection(GridRangeInfo range)
    Parameters
    Type Name Description
    GridRangeInfo range

    GridRangeInfo

    InvalidateVisual()

    Invalidates measurement state(layout) of grid

    Declaration
    public void InvalidateVisual()

    InvalidateVisual(Boolean)

    Invalidates measurement state(layout) of grid

    Declaration
    public void InvalidateVisual(bool setLayoutDirty)
    Parameters
    Type Name Description
    System.Boolean setLayoutDirty

    If true, invalidates layout of each row

    InvalidateVisual(Boolean, GridRangeInfo)

    Invalidates measurement state(layout) of grid.

    Declaration
    public void InvalidateVisual(bool setLayoutDirty, GridRangeInfo range)
    Parameters
    Type Name Description
    System.Boolean setLayoutDirty

    If true, invalidates layout of rows in a mentioned range

    GridRangeInfo range

    Specified range.

    OnCellRequestNavigateEvent(CellRequestNavigateEventArgs)

    Helper method to raise Hyperlink Requset Navigate event.

    Declaration
    protected virtual bool OnCellRequestNavigateEvent(CellRequestNavigateEventArgs e)
    Parameters
    Type Name Description
    CellRequestNavigateEventArgs e

    An CellRequestNavigateEventArgs that contains the event data.

    Returns
    Type Description
    System.Boolean

    True or False.

    OnContainerKeyDown(KeyEventArgs)

    Occurs when key down on Syncfusion.Windows.Forms.CellGrid.SfCellGrid.VisualContainer.

    Declaration
    protected virtual bool OnContainerKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.KeyEventArgs e

    An System.Windows.Input.KeyEventArgs that contains the event data.

    Returns
    Type Description
    System.Boolean

    True or False.

    OnCreateCopyPaste()

    Creates a new instance of GridCopyPaste.

    Declaration
    protected virtual GridCopyPaste OnCreateCopyPaste()
    Returns
    Type Description
    GridCopyPaste

    An instance of GridCopyPaste.

    OnCreateCurrentCell()

    Creates a new instance of GridCurrentCell.

    Declaration
    protected virtual GridCurrentCell OnCreateCurrentCell()
    Returns
    Type Description
    GridCurrentCell

    An instance of GridCurrentCell.

    OnCreateGridColumn(SfCellGrid)

    Creates new instance for GridColumn.

    Declaration
    protected virtual GridColumn OnCreateGridColumn(SfCellGrid grid)
    Parameters
    Type Name Description
    SfCellGrid grid
    Returns
    Type Description
    GridColumn

    An instance of GridColumn.

    OnCreateVisualContainer()

    Initialize new instance for Visual Container

    Declaration
    protected virtual VisualContainer OnCreateVisualContainer()
    Returns
    Type
    VisualContainer

    OnCurrentCellEndEdit(CurrentCellEndEditEventArgs)

    Helper method to raise Current Cell Begin Edit Event.

    Declaration
    protected virtual void OnCurrentCellEndEdit(CurrentCellEndEditEventArgs e)
    Parameters
    Type Name Description
    CurrentCellEndEditEventArgs e

    An System.Windows.Input.KeyEventArgs that contains the event data.

    OnHorizontalScroll(Object, ScrollEventArgs)

    Declaration
    protected virtual void OnHorizontalScroll(object sender, ScrollEventArgs se)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Forms.ScrollEventArgs se

    OnHScroll(Object, ScrollEventArgs)

    Declaration
    protected override void OnHScroll(object sender, ScrollEventArgs se)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Forms.ScrollEventArgs se
    Overrides
    ScrollControl.OnHScroll(Object, ScrollEventArgs)

    OnKeyDown(KeyEventArgs)

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

    OnLayout(LayoutEventArgs)

    Declaration
    protected override void OnLayout(LayoutEventArgs levent)
    Parameters
    Type Name Description
    System.Windows.Forms.LayoutEventArgs levent

    OnMouseUp(MouseEventArgs)

    Trigger the method when mouse up in visualcontainer.

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

    OnPreviewKeyDown(PreviewKeyDownEventArgs)

    Declaration
    protected override void OnPreviewKeyDown(PreviewKeyDownEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.PreviewKeyDownEventArgs e

    OnSizeChanged(EventArgs)

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

    OnValueChanged(Int32, Int32, String)

    Raises the ValueChanged event.

    Declaration
    public void OnValueChanged(int row, int col, string value)
    Parameters
    Type Name Description
    System.Int32 row

    The row of the change.

    System.Int32 col

    The column of the change.

    System.String value

    The changed value.

    OnVerticalScroll(Object, ScrollEventArgs)

    Declaration
    protected virtual void OnVerticalScroll(object sender, ScrollEventArgs se)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Forms.ScrollEventArgs se

    OnVScroll(Object, ScrollEventArgs)

    Declaration
    protected override void OnVScroll(object sender, ScrollEventArgs se)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Forms.ScrollEventArgs se
    Overrides
    ScrollControl.OnVScroll(Object, ScrollEventArgs)

    PointToCellRowColumnIndex(Point)

    Gets the RowColumnIndex of the cell under the mentioned location

    Declaration
    public RowColumnIndex PointToCellRowColumnIndex(Point p)
    Parameters
    Type Name Description
    System.Drawing.Point p

    X and Y-Coordinates.

    Returns
    Type Description
    RowColumnIndex

    An instance of RowColumnIndex.

    PointToCellRowColumnIndexOutsideCells(Point, Boolean)

    Gets the RowColumnIndex of the cell under the mentioned location.

    Declaration
    public RowColumnIndex PointToCellRowColumnIndexOutsideCells(Point p, bool allowOutsideLines)
    Parameters
    Type Name Description
    System.Drawing.Point p

    X and Y-Coordinates.

    System.Boolean allowOutsideLines

    Set this true if point can be below corner of last line.

    Returns
    Type Description
    RowColumnIndex

    An instance of RowColumnIndex.

    RecalculateCell(Int32, Int32, Boolean)

    Recalculating dependency cells of the precedent cell. When ever the precedent cell is changed, thats dependecncy should be updated. When setting tag as null, that will be recalculate when invalidate the cell.

    Declaration
    public void RecalculateCell(int row, int col, bool invaladateCell)
    Parameters
    Type Name Description
    System.Int32 row

    Current Cell's row index.

    System.Int32 col

    Current Cell's column index.

    System.Boolean invaladateCell

    True or False.

    ScrollInView(RowColumnIndex)

    Scrolls the mentioned cell into view.

    Declaration
    public void ScrollInView(RowColumnIndex rowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex rowColumnIndex

    Coordinates of a cell.

    SetColumnWidth(Int32, Int32, Double)

    Set the column width

    Declaration
    public virtual void SetColumnWidth(int startIndex, int endIndex, double width)
    Parameters
    Type Name Description
    System.Int32 startIndex

    Starting column index

    System.Int32 endIndex

    End column index

    System.Double width

    Width

    SetRowHeight(Int32, Int32, Double)

    Set the row height

    Declaration
    public virtual void SetRowHeight(int startIndex, int endIndex, double height)
    Parameters
    Type Name Description
    System.Int32 startIndex

    Starting row index

    System.Int32 endIndex

    End row index

    System.Double height

    Height

    SetValueRowCol(Object, Int32, Int32)

    Sets the value of a cell.

    Declaration
    public void SetValueRowCol(object value, int row, int col)
    Parameters
    Type Name Description
    System.Object value

    The value to be set.

    System.Int32 row

    The row of the cell.

    System.Int32 col

    The column of the cell.

    ShowHidePopup(Boolean)

    Used to show/hide the popups shown in the grid

    Declaration
    public virtual void ShowHidePopup(bool show)
    Parameters
    Type Name Description
    System.Boolean show

    UnWireEvents()

    Unwire the events

    Declaration
    protected virtual void UnWireEvents()

    UpdateScrollBars()

    Update the Scrollbar when perform row or column manipulation(Insert, delete, hide, adjust size, etc.).

    Declaration
    public override void UpdateScrollBars()
    Overrides
    ScrollControl.UpdateScrollBars()

    WireEvents()

    Wire the events

    Declaration
    protected virtual void WireEvents()

    WireParentObject()

    Not implemented.

    Declaration
    public void WireParentObject()

    Events

    CellClick

    Occurs when click on the cell.

    Declaration
    public event GridCellClickEventHandler CellClick
    Event Type
    Type
    GridCellClickEventHandler

    CellCommentOpening

    Occurs when perform cell comment opening.

    Declaration
    public event CellCommentOpeningEventHandler CellCommentOpening
    Event Type
    Type
    CellCommentOpeningEventHandler

    CellContextMenuOpening

    Occurs When Context Menu is to be displayed

    Declaration
    public event CellContextMenuOpeningEventHandler CellContextMenuOpening
    Event Type
    Type
    CellContextMenuOpeningEventHandler

    CellRequestNavigate

    Occurs when the current cell request to navigate the URI.

    Declaration
    public event CellRequestNavigateEventHandler CellRequestNavigate
    Event Type
    Type
    CellRequestNavigateEventHandler

    CellTooltipOpening

    Occurs when perform cell tooltip opening.

    Declaration
    public event CellTooltipOpeningEventHandler CellTooltipOpening
    Event Type
    Type
    CellTooltipOpeningEventHandler

    CurrentCellActivated

    Occurs after the current cell is activated

    Declaration
    public event CurrentCellActivatedEventHandler CurrentCellActivated
    Event Type
    Type
    CurrentCellActivatedEventHandler

    CurrentCellActivating

    Occurs when the current cell going to be activated

    Declaration
    public event CurrentCellActivatingEventHandler CurrentCellActivating
    Event Type
    Type
    CurrentCellActivatingEventHandler

    CurrentCellBeginEdit

    Occurs when the current cell enters into edit mode

    Declaration
    public event CurrentCellBeginEditEventHandler CurrentCellBeginEdit
    Event Type
    Type
    CurrentCellBeginEditEventHandler

    CurrentCellEndEdit

    Occurs when the current cell leaves from edit mode

    Declaration
    public event CurrentCellEndEditEventHandler CurrentCellEndEdit
    Event Type
    Type
    CurrentCellEndEditEventHandler

    CurrentCellValidated

    Occurs after the current cell is validated

    Declaration
    public event CurrentCellValidatedEventHandler CurrentCellValidated
    Event Type
    Type
    CurrentCellValidatedEventHandler

    CurrentCellValidating

    Occurs when current cell value going to be validated

    Declaration
    public event CurrentCellValidatingEventHandler CurrentCellValidating
    Event Type
    Type
    CurrentCellValidatingEventHandler

    CurrentCellValueChanged

    Occurs when the current cell value gets changed while cell is in edit mode

    Declaration
    public event CurrentCellValueChangedEventhandler CurrentCellValueChanged
    Event Type
    Type
    CurrentCellValueChangedEventhandler

    PropertyChanged

    Occurs when property changed

    Declaration
    public event PropertyChangedEventHandler PropertyChanged
    Event Type
    Type
    System.ComponentModel.PropertyChangedEventHandler

    ResizingColumns

    Occurs when perform resizing columns.

    Declaration
    public event ResizingColumnsEventHandler ResizingColumns
    Event Type
    Type
    ResizingColumnsEventHandler

    ResizingRows

    Occurs when perform resizing rows.

    Declaration
    public event ResizingRowsEventHandler ResizingRows
    Event Type
    Type
    ResizingRowsEventHandler

    SelectionChanged

    Occurs after the selection is changed

    Declaration
    public event SelectionChangedEventHandler SelectionChanged
    Event Type
    Type
    SelectionChangedEventHandler

    SelectionChanging

    Occurs when selection going to be changed

    Declaration
    public event SelectionChangingEventHandler SelectionChanging
    Event Type
    Type
    SelectionChangingEventHandler

    ValueChanged

    An event raised on the IWorksheet whenever a value changes.

    Declaration
    public event ValueChangedEventHandler ValueChanged
    Event Type
    Type
    ValueChangedEventHandler

    Explicit Interface Implementations

    IDisposable.Dispose()

    Declaration
    void IDisposable.Dispose()

    Implements

    IThemeProvider
    IVisualStyle
    ICancelModeProvider
    ISplitterPaneSupport
    IScrollBarWrapperContainer
    ISupportUpdating
    ISupportIntelliMouse
    IQueryFocusInside
    INonClientPaintingSupport
    ICalcData
    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable

    Extension Methods

    SelectionHelper.GetGridRow(SfCellGrid, Int32)
    SelectionHelper.GetVisibleRowColumnIndex(SfCellGrid, Int32, Int32)
    SelectionHelper.GetPreviousVisibleRowColumnIndex(SfCellGrid, Int32, Int32)
    SelectionHelper.GetPreviousVisibleRowIndex(SfCellGrid, Int32)
    SelectionHelper.GetPreviousVisibleColumnIndex(SfCellGrid, Int32)
    SelectionHelper.GetFirstVisibleRowIndex(SfCellGrid)
    SelectionHelper.GetFirstVisibleColumnIndex(SfCellGrid)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved