Class SfCellGrid

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

Inheritance
System.Object
SfCellGrid
SpreadsheetGrid
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable
Namespace: Syncfusion.UI.Xaml.CellGrid
Assembly: Syncfusion.SfCellGrid.WPF.dll
Syntax
public class SfCellGrid : Control, INotifyPropertyChanged, IDisposable, ICalcData
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

HeaderCellBorderBrushProperty

The Dependency property for HeaderCellBorderBrush

Declaration
public static readonly DependencyProperty HeaderCellBorderBrushProperty
Field Value
Type
System.Windows.DependencyProperty

SelectionBorderBrushProperty

The Dependency property for SelectionBorderBrush

Declaration
public static readonly DependencyProperty SelectionBorderBrushProperty
Field Value
Type
System.Windows.DependencyProperty

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.

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 ContextMenu CellContextMenu { get; set; }
Property Value
Type Description
System.Windows.Controls.ContextMenu

ContextMenu item of Grid.

CellRenderers

Manages the collection of GridCellRendererBase objects for the current grid view method.

Declaration
public GridCellRendererCollection CellRenderers { get; }
Property Value
Type Description
GridCellRendererCollection

Collection of GridCellRendererBase.

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<, > 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.Windows.Media.Brush

Color for the Gridline.

HeaderCellBorderBrush

Gets or sets the border brush for header cell

Declaration
public Brush HeaderCellBorderBrush { get; set; }
Property Value
Type
System.Windows.Media.Brush

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.

IsDisposed

Gets or sets a value indicating whether this instance SfCellGrid is disposed or not.

Declaration
protected bool IsDisposed { get; set; }
Property Value
Type Description
System.Boolean

true if this instance can be disposed; otherwise, false.

Model

Gets the value indicating the instance of GridModel which holds all the data related operations in grid.

Declaration
public GridModel Model { get; }
Property Value
Type Description
GridModel

An instance of GridModel.

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.Windows.Media.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.Windows.Media.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

add_CellClick(GridCellClickEventHandler)

Declaration
public void add_CellClick(GridCellClickEventHandler value)
Parameters
Type Name Description
GridCellClickEventHandler value

add_CellCommentOpening(CellCommentOpeningEventHandler)

Declaration
public void add_CellCommentOpening(CellCommentOpeningEventHandler value)
Parameters
Type Name Description
CellCommentOpeningEventHandler value

add_CellContextMenuOpening(CellContextMenuOpeningEventHandler)

Declaration
public void add_CellContextMenuOpening(CellContextMenuOpeningEventHandler value)
Parameters
Type Name Description
CellContextMenuOpeningEventHandler value

add_CellRequestNavigate(CellRequestNavigateEventHandler)

Declaration
public void add_CellRequestNavigate(CellRequestNavigateEventHandler value)
Parameters
Type Name Description
CellRequestNavigateEventHandler value

add_CellTooltipOpening(CellTooltipOpeningEventHandler)

Declaration
public void add_CellTooltipOpening(CellTooltipOpeningEventHandler value)
Parameters
Type Name Description
CellTooltipOpeningEventHandler value

add_CurrentCellActivated(CurrentCellActivatedEventHandler)

Declaration
public void add_CurrentCellActivated(CurrentCellActivatedEventHandler value)
Parameters
Type Name Description
CurrentCellActivatedEventHandler value

add_CurrentCellActivating(CurrentCellActivatingEventHandler)

Declaration
public void add_CurrentCellActivating(CurrentCellActivatingEventHandler value)
Parameters
Type Name Description
CurrentCellActivatingEventHandler value

add_CurrentCellBeginEdit(CurrentCellBeginEditEventHandler)

Declaration
public void add_CurrentCellBeginEdit(CurrentCellBeginEditEventHandler value)
Parameters
Type Name Description
CurrentCellBeginEditEventHandler value

add_CurrentCellEndEdit(CurrentCellEndEditEventHandler)

Declaration
public void add_CurrentCellEndEdit(CurrentCellEndEditEventHandler value)
Parameters
Type Name Description
CurrentCellEndEditEventHandler value

add_CurrentCellValidated(CurrentCellValidatedEventHandler)

Declaration
public void add_CurrentCellValidated(CurrentCellValidatedEventHandler value)
Parameters
Type Name Description
CurrentCellValidatedEventHandler value

add_CurrentCellValidating(CurrentCellValidatingEventHandler)

Declaration
public void add_CurrentCellValidating(CurrentCellValidatingEventHandler value)
Parameters
Type Name Description
CurrentCellValidatingEventHandler value

add_CurrentCellValueChanged(CurrentCellValueChangedEventhandler)

Declaration
public void add_CurrentCellValueChanged(CurrentCellValueChangedEventhandler value)
Parameters
Type Name Description
CurrentCellValueChangedEventhandler value

add_ResizingColumns(ResizingColumnsEventHandler)

Declaration
public void add_ResizingColumns(ResizingColumnsEventHandler value)
Parameters
Type Name Description
ResizingColumnsEventHandler value

add_ResizingRows(ResizingRowsEventHandler)

Declaration
public void add_ResizingRows(ResizingRowsEventHandler value)
Parameters
Type Name Description
ResizingRowsEventHandler value

add_SelectionChanged(SelectionChangedEventHandler)

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

add_SelectionChanging(SelectionChangingEventHandler)

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

add_ValueChanged(ValueChangedEventHandler)

Declaration
public void add_ValueChanged(ValueChangedEventHandler value)
Parameters
Type Name Description
ValueChangedEventHandler value

ArrangeOverride(Size)

Called to arrange and size the content of a System.Windows.Controls.Control object.

Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
Type Name Description
System.Windows.Size finalSize

The computed size that is used to arrange the content.
Returns
Type Description
System.Windows.Size

The size of the control.

Dispose()

Call the Dispose and SuppressFinalize method for dispose the instance used in the SfCellGrid class.

Declaration
public void Dispose()

Dispose(Boolean)

Dispose the live resources used by the SfCellGrid class.

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

Dispose the instance, if it is True

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()

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.

MeasureOverride(Size)

Called to remeasure a control.

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
Type Name Description
System.Windows.Size availableSize

The maximum size that the method can return.
Returns
Type Description
System.Windows.Size

The size of the control, up to the maximum specified by availableSize.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration
public override void OnApplyTemplate()
Remarks

Builds the visual tree for the SfCellGi when a new template is applied.

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.UI.Xaml.CellGrid.SfCellGrid.VisualContainer.

Declaration
protected virtual bool OnContainerKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Input.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.

OnCreateModel()

Creates a new instance for GridModel.

Declaration
protected virtual GridModel OnCreateModel()
Returns
Type Description
GridModel

An instance of GridModel.

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.

OnManipulationBoundaryFeedback(ManipulationBoundaryFeedbackEventArgs)

Used to avoid the slightly moving of entire window when touch inertia encountered its edge.

Declaration
protected override void OnManipulationBoundaryFeedback(ManipulationBoundaryFeedbackEventArgs e)
Parameters
Type Name Description
System.Windows.Input.ManipulationBoundaryFeedbackEventArgs e

Event args

OnPreviewKeyDown(KeyEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.PreviewKeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnPreviewKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Input.KeyEventArgs e

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

OnTextInput(TextCompositionEventArgs)

Invoked when an unhandled System.Windows.Input.TextCompositionManager.TextInput attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnTextInput(TextCompositionEventArgs e)
Parameters
Type Name Description
System.Windows.Input.TextCompositionEventArgs e

The System.Windows.Input.TextCompositionEventArgs that contains the event data.

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.

OnVisualContainerPointerExited(Object, MouseEventArgs)

Occurs when pointer leaves from Syncfusion.UI.Xaml.CellGrid.SfCellGrid.VisualContainer.

Declaration
protected virtual void OnVisualContainerPointerExited(object sender, MouseEventArgs args)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Windows.Input.MouseEventArgs args

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

OnVisualContainerPointerMoved(Object, MouseEventArgs)

Occurs when pointer moved hover Syncfusion.UI.Xaml.CellGrid.SfCellGrid.VisualContainer.

Declaration
protected virtual void OnVisualContainerPointerMoved(object sender, MouseEventArgs args)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Windows.Input.MouseEventArgs args

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

OnVisualContainerPointerPressed(Object, MouseButtonEventArgs)

Occurs when pointer pressed on Syncfusion.UI.Xaml.CellGrid.SfCellGrid.VisualContainer.

Declaration
protected virtual void OnVisualContainerPointerPressed(object sender, MouseButtonEventArgs args)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Windows.Input.MouseButtonEventArgs args

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

OnVisualContainerPointerReleased(Object, MouseButtonEventArgs)

Occurs when pointer released on Syncfusion.UI.Xaml.CellGrid.SfCellGrid.VisualContainer.

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

The source of the event.
System.Windows.Input.MouseButtonEventArgs e

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

PointToCellRowColumnIndex(Point)

Gets the RowColumnIndex of the cell under the mentioned location

Declaration
public RowColumnIndex PointToCellRowColumnIndex(Point p)
Parameters
Type Name Description
System.Windows.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.Windows.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.

remove_CellClick(GridCellClickEventHandler)

Declaration
public void remove_CellClick(GridCellClickEventHandler value)
Parameters
Type Name Description
GridCellClickEventHandler value

remove_CellCommentOpening(CellCommentOpeningEventHandler)

Declaration
public void remove_CellCommentOpening(CellCommentOpeningEventHandler value)
Parameters
Type Name Description
CellCommentOpeningEventHandler value

remove_CellContextMenuOpening(CellContextMenuOpeningEventHandler)

Declaration
public void remove_CellContextMenuOpening(CellContextMenuOpeningEventHandler value)
Parameters
Type Name Description
CellContextMenuOpeningEventHandler value

remove_CellRequestNavigate(CellRequestNavigateEventHandler)

Declaration
public void remove_CellRequestNavigate(CellRequestNavigateEventHandler value)
Parameters
Type Name Description
CellRequestNavigateEventHandler value

remove_CellTooltipOpening(CellTooltipOpeningEventHandler)

Declaration
public void remove_CellTooltipOpening(CellTooltipOpeningEventHandler value)
Parameters
Type Name Description
CellTooltipOpeningEventHandler value

remove_CurrentCellActivated(CurrentCellActivatedEventHandler)

Declaration
public void remove_CurrentCellActivated(CurrentCellActivatedEventHandler value)
Parameters
Type Name Description
CurrentCellActivatedEventHandler value

remove_CurrentCellActivating(CurrentCellActivatingEventHandler)

Declaration
public void remove_CurrentCellActivating(CurrentCellActivatingEventHandler value)
Parameters
Type Name Description
CurrentCellActivatingEventHandler value

remove_CurrentCellBeginEdit(CurrentCellBeginEditEventHandler)

Declaration
public void remove_CurrentCellBeginEdit(CurrentCellBeginEditEventHandler value)
Parameters
Type Name Description
CurrentCellBeginEditEventHandler value

remove_CurrentCellEndEdit(CurrentCellEndEditEventHandler)

Declaration
public void remove_CurrentCellEndEdit(CurrentCellEndEditEventHandler value)
Parameters
Type Name Description
CurrentCellEndEditEventHandler value

remove_CurrentCellValidated(CurrentCellValidatedEventHandler)

Declaration
public void remove_CurrentCellValidated(CurrentCellValidatedEventHandler value)
Parameters
Type Name Description
CurrentCellValidatedEventHandler value

remove_CurrentCellValidating(CurrentCellValidatingEventHandler)

Declaration
public void remove_CurrentCellValidating(CurrentCellValidatingEventHandler value)
Parameters
Type Name Description
CurrentCellValidatingEventHandler value

remove_CurrentCellValueChanged(CurrentCellValueChangedEventhandler)

Declaration
public void remove_CurrentCellValueChanged(CurrentCellValueChangedEventhandler value)
Parameters
Type Name Description
CurrentCellValueChangedEventhandler value

remove_ResizingColumns(ResizingColumnsEventHandler)

Declaration
public void remove_ResizingColumns(ResizingColumnsEventHandler value)
Parameters
Type Name Description
ResizingColumnsEventHandler value

remove_ResizingRows(ResizingRowsEventHandler)

Declaration
public void remove_ResizingRows(ResizingRowsEventHandler value)
Parameters
Type Name Description
ResizingRowsEventHandler value

remove_SelectionChanged(SelectionChangedEventHandler)

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

remove_SelectionChanging(SelectionChangingEventHandler)

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

remove_ValueChanged(ValueChangedEventHandler)

Declaration
public void remove_ValueChanged(ValueChangedEventHandler value)
Parameters
Type Name Description
ValueChangedEventHandler value

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()

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

Implements

System.ComponentModel.INotifyPropertyChanged
System.IDisposable

Extension Methods