Class GridModel

A class that holds all the data related information of the Grid

Inheritance
System.Object
GridModel
Implements
System.IDisposable
Namespace: Syncfusion.UI.Xaml.CellGrid
Assembly: Syncfusion.SfCellGrid.WPF.dll
Syntax
public class GridModel : Object, IDisposable, IGridVolatileCellStylesHost

Constructors

GridModel(SfCellGrid)

Declaration
public GridModel(SfCellGrid grid)
Parameters
Type Name Description
SfCellGrid grid

Properties

BaseStylesMap

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

ColStyles

Declaration
public GridStyleInfoIndexer ColStyles { get; }
Property Value
Type
GridStyleInfoIndexer

CopyPasteOptions

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

FooterStyle

Declaration
public GridStyleInfo FooterStyle { get; }
Property Value
Type
GridStyleInfo

FormulaEngine

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

Grid

Declaration
public SfCellGrid Grid { get; }
Property Value
Type
SfCellGrid

HasBaseStylesMap

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

HeaderStyle

Declaration
public GridStyleInfo HeaderStyle { get; }
Property Value
Type
GridStyleInfo

Item[Int32, Int32]

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

RowColStylePrecedence

Declaration
public PrecedenceStyle RowColStylePrecedence { get; set; }
Property Value
Type
PrecedenceStyle

RowStyles

Declaration
public GridStyleInfoIndexer RowStyles { get; }
Property Value
Type
GridStyleInfoIndexer

TableStyle

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

Methods

add_ClipboardCopy(GridCutPasteEventHandler)

Declaration
public void add_ClipboardCopy(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler 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_ColumnsInserted(GridRangeInsertedEventHandler)

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

add_ColumnsRemoved(GridRangeRemovedEventHandler)

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

add_CommitCellInfo(GridCommitCellInfoEventHandler)

Declaration
public void add_CommitCellInfo(GridCommitCellInfoEventHandler value)
Parameters
Type Name Description
GridCommitCellInfoEventHandler value

add_QueryBaseStyles(GridQueryBaseStylesEventHandler)

Declaration
public void add_QueryBaseStyles(GridQueryBaseStylesEventHandler value)
Parameters
Type Name Description
GridQueryBaseStylesEventHandler value

add_QueryCellInfo(GridQueryCellInfoEventHandler)

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

add_QueryCoveredRange(GridQueryCoveredRangeEventHandler)

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

add_RowsInserted(GridRangeInsertedEventHandler)

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

add_RowsRemoved(GridRangeRemovedEventHandler)

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

ClearStyle(RowColumnIndex)

Declaration
public void ClearStyle(RowColumnIndex cell)
Parameters
Type Name Description
RowColumnIndex cell

ClearStyles()

Declaration
public void ClearStyles()

Dispose()

Call the Dispose and SuppressFinalize method for dipose the instance of GridModel class.

Declaration
public void Dispose()

Dispose(Boolean)

Dispose the live resources used by the GridModel class.

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

Dispose the instance, if it is True

InsertColumns(Int32, Int32)

Inserts the given number of columns at the specified column index.

Declaration
public virtual void InsertColumns(int insertAtColumnIndex, int count)
Parameters
Type Name Description
System.Int32 insertAtColumnIndex

The column index to insert.
System.Int32 count

Number of columns to be inserted.

InsertColumnsCore(Int32, Int32, GridMoveCellsState)

Declaration
protected virtual void InsertColumnsCore(int insertAtColumnIndex, int count, GridMoveCellsState moveCellsState)
Parameters
Type Name Description
System.Int32 insertAtColumnIndex
System.Int32 count
GridMoveCellsState moveCellsState

InsertRows(Int32, Int32)

Inserts specified number of rows at the given row index.

Declaration
public virtual void InsertRows(int insertAtRowIndex, int count)
Parameters
Type Name Description
System.Int32 insertAtRowIndex

The row index to insert.
System.Int32 count

Number of rows to be inserted

InsertRowsCore(Int32, Int32, GridMoveCellsState)

Declaration
protected virtual void InsertRowsCore(int insertAtRowIndex, int count, GridMoveCellsState moveCellsState)
Parameters
Type Name Description
System.Int32 insertAtRowIndex
System.Int32 count
GridMoveCellsState moveCellsState

LookupCellRenderer(String)

Declaration
public IGridCellRenderer LookupCellRenderer(string id)
Parameters
Type Name Description
System.String id
Returns
Type
IGridCellRenderer

OnClipboardCopy(GridCutPasteEventArgs)

Raises the ClipboardCopy event.

Declaration
protected virtual void OnClipboardCopy(GridCutPasteEventArgs e)
Parameters
Type Name Description
GridCutPasteEventArgs e

A GridCutPasteEventArgs that contains the event data.

OnClipboardCut(GridCutPasteEventArgs)

Raises the ClipboardCut event.

Declaration
protected virtual void OnClipboardCut(GridCutPasteEventArgs e)
Parameters
Type Name Description
GridCutPasteEventArgs e

A GridCutPasteEventArgs that contains the event data.

OnClipboardPaste(GridCutPasteEventArgs)

Raises the ClipboardPaste event.

Declaration
protected virtual void OnClipboardPaste(GridCutPasteEventArgs e)
Parameters
Type Name Description
GridCutPasteEventArgs e

A GridCutPasteEventArgs that contains the event data.

OnColumnsInserted(GridRangeInsertedEventArgs)

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

OnColumnsRemoved(GridRangeRemovedEventArgs)

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

OnCommitCellInfo(GridCommitCellInfoEventArgs)

Declaration
protected virtual void OnCommitCellInfo(GridCommitCellInfoEventArgs e)
Parameters
Type Name Description
GridCommitCellInfoEventArgs e

OnCreateBaseStylesMap()

Declaration
protected virtual GridBaseStylesMap OnCreateBaseStylesMap()
Returns
Type
GridBaseStylesMap

OnCreateVolatileCellStyles()

Declaration
protected virtual GridVolatileCellStyles OnCreateVolatileCellStyles()
Returns
Type
GridVolatileCellStyles

OnQueryCellInfo(GridQueryCellInfoEventArgs)

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

OnRowsInserted(GridRangeInsertedEventArgs)

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

OnRowsRemoved(GridRangeRemovedEventArgs)

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

remove_ClipboardCopy(GridCutPasteEventHandler)

Declaration
public void remove_ClipboardCopy(GridCutPasteEventHandler value)
Parameters
Type Name Description
GridCutPasteEventHandler 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_ColumnsInserted(GridRangeInsertedEventHandler)

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

remove_ColumnsRemoved(GridRangeRemovedEventHandler)

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

remove_CommitCellInfo(GridCommitCellInfoEventHandler)

Declaration
public void remove_CommitCellInfo(GridCommitCellInfoEventHandler value)
Parameters
Type Name Description
GridCommitCellInfoEventHandler value

remove_QueryBaseStyles(GridQueryBaseStylesEventHandler)

Declaration
public void remove_QueryBaseStyles(GridQueryBaseStylesEventHandler value)
Parameters
Type Name Description
GridQueryBaseStylesEventHandler value

remove_QueryCellInfo(GridQueryCellInfoEventHandler)

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

remove_QueryCoveredRange(GridQueryCoveredRangeEventHandler)

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

remove_RowsInserted(GridRangeInsertedEventHandler)

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

remove_RowsRemoved(GridRangeRemovedEventHandler)

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

RemoveColumns(Int32, Int32)

Removes given number of columns from the specified index.

Declaration
public virtual void RemoveColumns(int removeAtColumnIndex, int count)
Parameters
Type Name Description
System.Int32 removeAtColumnIndex

The column index.
System.Int32 count

Number of columns to be removed.

RemoveColumnsCore(Int32, Int32, GridMoveCellsState)

Declaration
protected virtual void RemoveColumnsCore(int removeAtColumnIndex, int count, GridMoveCellsState moveCellsState)
Parameters
Type Name Description
System.Int32 removeAtColumnIndex
System.Int32 count
GridMoveCellsState moveCellsState

RemoveRows(Int32, Int32)

Deletes given number of rows from the specified index.

Declaration
public virtual void RemoveRows(int removeAtRowIndex, int count)
Parameters
Type Name Description
System.Int32 removeAtRowIndex

The row index.
System.Int32 count

Number of rows to be removed.

RemoveRowsCore(Int32, Int32, GridMoveCellsState)

Declaration
protected virtual void RemoveRowsCore(int removeAtRowIndex, int count, GridMoveCellsState moveCellsState)
Parameters
Type Name Description
System.Int32 removeAtRowIndex
System.Int32 count
GridMoveCellsState moveCellsState

ResizeColumnsToFit(GridRangeInfo, GridResizeToFitOptions)

Set the columnwidth of given range based on the content width.

Declaration
public bool ResizeColumnsToFit(GridRangeInfo range, GridResizeToFitOptions options)
Parameters
Type Name Description
GridRangeInfo range

specify the range to apply for resizing
GridResizeToFitOptions options

specify the resizing options such as includeheaders,noshrinksize by default set as none
Returns
Type
System.Boolean

ResizeRowsToFit(GridRangeInfo, GridResizeToFitOptions)

Set the rowheight of given range based on the content height.

Declaration
public bool ResizeRowsToFit(GridRangeInfo range, GridResizeToFitOptions options)
Parameters
Type Name Description
GridRangeInfo range

resizing range
GridResizeToFitOptions options

specify th resizeoptions such as includeheaders,Noshrinksize by default set as None
Returns
Type
System.Boolean

Events

ClipboardCopy

Occurs when is called on the ClipboardCopy component of a GridModel.

Declaration
public event GridCutPasteEventHandler ClipboardCopy
Event Type
Type
GridCutPasteEventHandler

ClipboardCut

Occurs when is called on the ClipboardCut component of a GridModel.

Declaration
public event GridCutPasteEventHandler ClipboardCut
Event Type
Type
GridCutPasteEventHandler

ClipboardPaste

Occurs when is called on the ClipboardPaste component of a GridModel.

Declaration
public event GridCutPasteEventHandler ClipboardPaste
Event Type
Type
GridCutPasteEventHandler

ColumnsInserted

Occurs after a range of columns has been inserted. See GridRangeInsertedEventArgs for more details.

Declaration
public event GridRangeInsertedEventHandler ColumnsInserted
Event Type
Type
GridRangeInsertedEventHandler

ColumnsRemoved

Occurs after a range of columns has been removed. See GridRangeRemovedEventArgs for more details.

Declaration
public event GridRangeRemovedEventHandler ColumnsRemoved
Event Type
Type
GridRangeRemovedEventHandler

CommitCellInfo

Declaration
public event GridCommitCellInfoEventHandler CommitCellInfo
Event Type
Type
GridCommitCellInfoEventHandler

QueryBaseStyles

Declaration
public event GridQueryBaseStylesEventHandler QueryBaseStyles
Event Type
Type
GridQueryBaseStylesEventHandler

QueryCellInfo

Declaration
public event GridQueryCellInfoEventHandler QueryCellInfo
Event Type
Type
GridQueryCellInfoEventHandler

QueryCoveredRange

Declaration
public event GridQueryCoveredRangeEventHandler QueryCoveredRange
Event Type
Type
GridQueryCoveredRangeEventHandler

RowsInserted

Occurs after a range of rows has been inserted. See GridRangeInsertedEventArgs for more details.

Declaration
public event GridRangeInsertedEventHandler RowsInserted
Event Type
Type
GridRangeInsertedEventHandler

RowsRemoved

Occurs when a range of rows is removed. See GridRangeRemovedEventArgs for more details.

Declaration
public event GridRangeRemovedEventHandler RowsRemoved
Event Type
Type
GridRangeRemovedEventHandler

Explicit Interface Implementations

IGridVolatileCellStylesHost.BaseStylesMap

Declaration
GridBaseStylesMap IGridVolatileCellStylesHost.BaseStylesMap { get; }
Returns
Type
GridBaseStylesMap

IGridVolatileCellStylesHost.CommitCellInfo(RowColumnIndex, GridStyleInfo, StyleInfoProperty)

Declaration
void IGridVolatileCellStylesHost.CommitCellInfo(RowColumnIndex cell, GridStyleInfo style, StyleInfoProperty sip)
Parameters
Type Name Description
RowColumnIndex cell
GridStyleInfo style
StyleInfoProperty sip

IGridVolatileCellStylesHost.QueryBaseStyles(RowColumnIndex, GridStyleInfo)

Declaration
IStyleInfo[] IGridVolatileCellStylesHost.QueryBaseStyles(RowColumnIndex cell, GridStyleInfo style)
Parameters
Type Name Description
RowColumnIndex cell
GridStyleInfo style
Returns
Type
IStyleInfo[]

IGridVolatileCellStylesHost.QueryCellInfo(RowColumnIndex, GridStyleInfo)

Declaration
void IGridVolatileCellStylesHost.QueryCellInfo(RowColumnIndex cell, GridStyleInfo style)
Parameters
Type Name Description
RowColumnIndex cell
GridStyleInfo style

Implements

System.IDisposable