SpreadsheetCellRendererBase Class

Inheritance
System.Object
SpreadsheetCellRendererBase
SpreadsheetVirtualizingCellRendererBase<E>
Implements
System.IDisposable
Namespace: Syncfusion.Windows.Forms.Spreadsheet.CellRenderer
Assembly: Syncfusion.Spreadsheet.Windows.dll
Syntax
public class SpreadsheetCellRendererBase : Object, ISpreadsheetCellRenderer, IDisposable

Constructors

SpreadsheetCellRendererBase()

Declaration
public SpreadsheetCellRendererBase()

Properties

AllowEditInFormulaBar

Determines whether we can edit the cell using formula bar or not

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

CurrentCellIndex

Returns the cell's row column index.

Declaration
public RowColumnIndex CurrentCellIndex { get; }
Property Value
Type
RowColumnIndex

CurrentCellRendererElement

Returns the content of the current cell element.

Declaration
public Control CurrentCellRendererElement { get; }
Property Value
Type
System.Windows.Forms.Control

CurrentStyle

Declaration
public IStyle CurrentStyle { get; }
Property Value
Type
IStyle

Grid

Declaration
public SpreadsheetGrid Grid { get; set; }
Property Value
Type
SpreadsheetGrid

HasCurrentCellState

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

IsEditable

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

IsFocused

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

IsFocusible

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

IsInEditing

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

MoveCurrentCell

Set as true, when current cell is first time edit the text or directly edit the text if that cell is not in edit mode whether cell is empty or not empty. And also if true, then only move the current cell when up or down key is pressed otherwise not move. Otherwise set as false.

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

PreviewInputText

Declaration
protected dynamic PreviewInputText { get; set; }
Property Value
Type
System.Object

Methods

BeginEdit(RowColumnIndex, SpreadsheetColumn)

Declaration
public virtual bool BeginEdit(RowColumnIndex cellRowColumnIndex, SpreadsheetColumn column)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex
SpreadsheetColumn column
Returns
Type
System.Boolean

ClearRecycleBin()

Declaration
public virtual void ClearRecycleBin()

CurrentCellValueChanged(String)

Declaration
protected virtual void CurrentCellValueChanged(string ChangedText)
Parameters
Type Name Description
System.String ChangedText

Dispose()

Declaration
public void Dispose()

Dispose(Boolean)

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

EndEdit(RowColumnIndex, SpreadsheetColumn)

Declaration
public virtual bool EndEdit(RowColumnIndex cellRowColumnIndex, SpreadsheetColumn column)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex
SpreadsheetColumn column
Returns
Type
System.Boolean

GetControlValue()

Declaration
public virtual object GetControlValue()
Returns
Type
System.Object

GetFormattedText(IStyle)

Declaration
public virtual string GetFormattedText(IStyle style)
Parameters
Type Name Description
IStyle style
Returns
Type
System.String

HandlePointerOperations(SpreadsheetColumn, GridPointerEventArgs)

Declaration
public virtual bool HandlePointerOperations(SpreadsheetColumn column, GridPointerEventArgs e)
Parameters
Type Name Description
SpreadsheetColumn column
GridPointerEventArgs e
Returns
Type
System.Boolean

OnRender(SpreadsheetPaint, Rectangle, Rectangle, SpreadsheetColumn)

Declaration
protected virtual void OnRender(SpreadsheetPaint paint, Rectangle cellRect, Rectangle clipRect, SpreadsheetColumn column)
Parameters
Type Name Description
SpreadsheetPaint paint
System.Drawing.Rectangle cellRect
System.Drawing.Rectangle clipRect
SpreadsheetColumn column

OnSaveChanges()

Declaration
protected virtual void OnSaveChanges()

OnUpdateEditElement(Control, Rectangle, SpreadsheetColumn)

Declaration
protected virtual void OnUpdateEditElement(Control element, Rectangle rect, SpreadsheetColumn column)
Parameters
Type Name Description
System.Windows.Forms.Control element
System.Drawing.Rectangle rect
SpreadsheetColumn column

ProcessKeyEventArgs(KeyPressEventArgs)

Declaration
public void ProcessKeyEventArgs(KeyPressEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyPressEventArgs e

RaiseSaveChanges()

Declaration
public void RaiseSaveChanges()

RefreshContent()

Declaration
public virtual void RefreshContent()

Render(SpreadsheetPaint, Rectangle, Rectangle, SpreadsheetColumn)

Declaration
public void Render(SpreadsheetPaint paint, Rectangle cellRect, Rectangle clipRect, SpreadsheetColumn column)
Parameters
Type Name Description
SpreadsheetPaint paint
System.Drawing.Rectangle cellRect
System.Drawing.Rectangle clipRect
SpreadsheetColumn column

ResetCurrentCellState()

Declaration
public void ResetCurrentCellState()

SetControlValue(Object)

Declaration
public virtual bool SetControlValue(object value)
Parameters
Type Name Description
System.Object value
Returns
Type
System.Boolean

SetCurrentCellState(RowColumnIndex, Control, Boolean, Boolean)

Declaration
public void SetCurrentCellState(RowColumnIndex currentCellIndex, Control currentCellElement, bool isInEditing, bool isFocused)
Parameters
Type Name Description
RowColumnIndex currentCellIndex
System.Windows.Forms.Control currentCellElement
System.Boolean isInEditing
System.Boolean isFocused

SetFocus(Boolean)

Declaration
public void SetFocus(bool needToFocus)
Parameters
Type Name Description
System.Boolean needToFocus

SetFocus(Control, Boolean)

Declaration
protected virtual void SetFocus(Control uiElement, bool needToFocus)
Parameters
Type Name Description
System.Windows.Forms.Control uiElement
System.Boolean needToFocus

ShouldGridTryToHandleKeyDown(KeyEventArgs)

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

UnloadUIElements()

Declaration
public void UnloadUIElements()

UpdateCurrentCellState(Control, Boolean)

Declaration
protected void UpdateCurrentCellState(Control currentRendererElement, bool isInEdit)
Parameters
Type Name Description
System.Windows.Forms.Control currentRendererElement
System.Boolean isInEdit

UpdateEditElement(Control, Rectangle, SpreadsheetColumn)

Declaration
public void UpdateEditElement(Control element, Rectangle rect, SpreadsheetColumn column)
Parameters
Type Name Description
System.Windows.Forms.Control element
System.Drawing.Rectangle rect
SpreadsheetColumn column

Explicit Interface Implementations

ISpreadsheetCellRenderer.ShouldGridTryToHandleKeyDown(KeyEventArgs)

Declaration
bool ISpreadsheetCellRenderer.ShouldGridTryToHandleKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyEventArgs e
Returns
Type
System.Boolean

Implements

System.IDisposable