Interface ISpreadsheetCellRenderer

Provides the functionality for all cell renderers in the SfSpreadsheet.

Namespace: Syncfusion.UI.Xaml.Spreadsheet.CellRenderer

Assembly: Syncfusion.SfSpreadsheet.WPF.dll

Syntax

public interface ISpreadsheetCellRenderer : IDisposable

Properties

AllowEditInFormulaBar

Gets or sets the value indicating whether the user is allowed to edit the cell using formula bar or not.

Declaration

bool AllowEditInFormulaBar { get; set; }

Property Value

Type	Description
System.Boolean	True if the cell can be edited using formula bar; otherwise false.

CurrentCellElement

Gets a value indicating the current cell(GridCell) UIElement in SfSpreadsheet.

Declaration

UIElement CurrentCellElement { get; }

Property Value

Type	Description
System.Windows.UIElement	An instance of System.Windows.UIElement

CurrentCellRendererElement

Gets a value indicating edit UIElement of current cell. It should be null when current cell is not in editing.

Declaration

UIElement CurrentCellRendererElement { get; }

Property Value

Type	Description
System.Windows.UIElement	An instance of System.Windows.UIElement

DisplayElementOptimization

Gets or sets a value indicating whether to load the UIElement to display its content or not.

Declaration

bool DisplayElementOptimization { get; set; }

Property Value

Type	Description
System.Boolean	true it will loads the display element for the cell only when it have content which should not empty; otherwise, false.

Grid

Gets or sets the value indicating the instance of SfCellGrid.

Declaration

SpreadsheetGrid Grid { get; set; }

Property Value

Type	Description
SpreadsheetGrid	An instance of SfCellGrid

HasCurrentCellState

Gets a value indicating whether the current cell renderer is set or not.

Declaration

bool HasCurrentCellState { get; }

Property Value

Type	Description
System.Boolean	Returns true if the current cell state is maintained; otherwise , false.

SupportDrawingOptimization

Gets or sets a value whether the cell content should be drawn or not. If true, draw its content else loads display element to display its content.

Declaration

bool SupportDrawingOptimization { get; set; }

Property Value

Type	Description
System.Boolean	true if the user wants to draw the content instead of loading the display uiElement; otherwise, false.

SupportRenderOptimization

Gets or sets a value indicates whether the edit element directly loads to display the content even the cell is not in edit mode.

Declaration

bool SupportRenderOptimization { get; set; }

Property Value

Type	Description
System.Boolean	true if the renderer supports directly to the drawing context ; otherwise, false.

UseOnlyRendererElement

Gets or sets a value indicates whether to use the cell element (GridCell) to display its content.

Declaration

bool UseOnlyRendererElement { get; set; }

Property Value

Type	Description
System.Boolean	true if the grid cell is placed inside the renderer element; otherwise, false.

Methods

Arrange(RowColumnIndex, UIElement, Rect)

Invoked when the visual children of cell is arranged in view.

Declaration

void Arrange(RowColumnIndex cellRowColumnIndex, UIElement uiElement, Rect cellRect)

Parameters

Type	Name	Description
RowColumnIndex	cellRowColumnIndex	The Coordinates of the cell.
System.Windows.UIElement	uiElement	The corresponding UIElement that is to be arranged.
System.Windows.Rect	cellRect	The corresponding size of cell element for arranging the UIElement.

BeginEdit(RowColumnIndex, GridCell, SpreadsheetColumn)

Invoked when the current cell in the view starts the editing process.

Declaration

bool BeginEdit(RowColumnIndex CellRowColumnIndex, GridCell EditElement, SpreadsheetColumn column)

Parameters

Type	Name	Description
RowColumnIndex	CellRowColumnIndex	Coordinates of a cell.
GridCell	EditElement	An instance of GridCell.
SpreadsheetColumn	column	An instance of SpreadsheetColumn.

Returns

Type	Description
System.Boolean	Returns true if the current cell starts an editing; otherwise, false.

ClearRecycleBin()

Clears all the items from RecycleBin.

Declaration

void ClearRecycleBin()

EndEdit(RowColumnIndex, GridCell, SpreadsheetColumn)

Ends the editing operation occuring in the cell.

Declaration

bool EndEdit(RowColumnIndex cellRowColumnIndex, GridCell cellElement, SpreadsheetColumn column)

Parameters

Type	Name	Description
RowColumnIndex	cellRowColumnIndex	Cooridantes of a cell.
GridCell	cellElement	An instance of GridCell.
SpreadsheetColumn	column	An instance of SpreadsheetColumn.

Returns

Type	Description
System.Boolean	Returns true if the edit ends on the cell ; otherwise, false.

GetControlValue()

Used to get the control value for the current cell.

Declaration

object GetControlValue()

Returns

Type	Description
System.Object	null.

GetFormattedText(IStyle)

Used to get the formatted text for the particular cell

Declaration

string GetFormattedText(IStyle style)

Parameters

Type	Name	Description
IStyle	style	An instance of IStyle.

Returns

Type	Description
System.String	An empty string

Measure(RowColumnIndex, UIElement, Size)

Determines the size of the current cell in SfSpreadsheet.

Declaration

void Measure(RowColumnIndex cellRowColumnIndex, UIElement uiElement, Size availableSize)

Parameters

Type	Name	Description
RowColumnIndex	cellRowColumnIndex	Coordinates of a cell.
System.Windows.UIElement	uiElement	Corresponing UI element to measure .
System.Windows.Size	availableSize	The size of element.

OnTextInput(TextCompositionEventArgs)

Invoked when the element gets input text.

Declaration

void OnTextInput(TextCompositionEventArgs args)

Parameters

Type	Name	Description
System.Windows.Input.TextCompositionEventArgs	args	An System.Windows.Input.TextCompositionEventArgs that contains the event data.

PrepareUIElements(RowColumnIndex, GridCell, SpreadsheetColumn, Boolean)

Invoked when the UIElement for cell is prepared to render it in view . overrides this method and creates new UIElements and wires them with the parent cells control.

Declaration

GridCell PrepareUIElements(RowColumnIndex cellRowColumnIndex, GridCell cellContainer, SpreadsheetColumn column, bool isInEdit)

Parameters

Type	Name	Description
RowColumnIndex	cellRowColumnIndex	Coordinates of a cell.
GridCell	cellContainer	An instance of GridCell.
SpreadsheetColumn	column	An instance of SpreadsheetColumn.
System.Boolean	isInEdit	True or False.

Returns

Type	Description
GridCell	An instance of GridCell.

RaiseSaveChanges()

Invoked to save the current cell changes in SfSpreadsheet

Declaration

void RaiseSaveChanges()

Render(RowColumnIndex, DrawingContext, Rect, SpreadsheetColumn, Object)

Draws or renders the content of the given text element in the SpreadsheetColumn.

Declaration

void Render(RowColumnIndex CellRowColumnIndex, DrawingContext dc, Rect cellRect, SpreadsheetColumn column, object textElement)

Parameters

Type	Name	Description
RowColumnIndex	CellRowColumnIndex	Coordinates of a cell.
System.Windows.Media.DrawingContext	dc	An instance of System.Windows.Media.DrawingContext.
System.Windows.Rect	cellRect	An instance System.Windows.Rect of cell.
SpreadsheetColumn	column	An instance of SpreadsheetColumn.
System.Object	textElement	User defined text element.

ResetCurrentCellState()

Resets or updates the current cell state and style.

Declaration

void ResetCurrentCellState()

SetControlValue(Object)

Used to set the value for the current cell.

Declaration

bool SetControlValue(object value)

Parameters

Type	Name	Description
System.Object	value	Current cell value.

Returns

Type
System.Boolean

SetCurrentCellState(RowColumnIndex, UIElement, Boolean, Boolean)

Set the current cell state when the current cell is active.

Declaration

void SetCurrentCellState(RowColumnIndex currentCellIndex, UIElement currentCellElement, bool isInEditing, bool isFocused)

Parameters

Type	Name	Description
RowColumnIndex	currentCellIndex	Coordinates of a current cell
System.Windows.UIElement	currentCellElement	An instance of System.Windows.UIElement.
System.Boolean	isInEditing	True or False .
System.Boolean	isFocused	True or False .

SetFocus(Boolean)

Used to invoke the Focus method to set the focus on the given UIElement.

Declaration

void SetFocus(bool needToFocus)

Parameters

Type	Name	Description
System.Boolean	needToFocus	True or False .

ShouldGridTryToHandleKeyDown(KeyEventArgs)

Handles all the key down operations for the current cell in SfSpreadsheet

Declaration

bool ShouldGridTryToHandleKeyDown(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.

UnloadUIElements(GridCell)

Invoked when the cell is scrolled out of view or unloaded from the view. SpreadsheetVirtualizingCellRendererBase<D, E> overrides this method and either removes the cell renderer visuals from the parent or hide them and reuse it later in same element depending on whether AllowRecycle was set.

Declaration

void UnloadUIElements(GridCell uiElement)

Parameters

Type	Name	Description
GridCell	uiElement	An instance of GridCell.

UpdateCellStyle(RowColumnIndex, GridCell, SpreadsheetColumn, Boolean)

Updates the style for the current cell in SfSpreadsheet.

Declaration

void UpdateCellStyle(RowColumnIndex cellRowColumnIndex, GridCell uiElement, SpreadsheetColumn column, bool isInEdit)

Parameters

Type	Name	Description
RowColumnIndex	cellRowColumnIndex	Coordinates of cell.
GridCell	uiElement	An instance of GridCell.
SpreadsheetColumn	column	An instance of SpreadsheetColumn.
System.Boolean	isInEdit	True or False.