Interface IGridCellRenderer

Provides the functionality for all cell renderers in the SfDataGrid.

Namespace: Syncfusion.UI.Xaml.Grid.Cells
Assembly: Syncfusion.SfGrid.UWP.dll
Syntax
public interface IGridCellRenderer : IDisposable

Properties

DataGrid

Gets or sets the reference to the SfDataGrid control.

Declaration
SfDataGrid DataGrid { get; set; }
Property Value
Type Description
SfDataGrid

The reference to the SfDataGrid control.

HasCurrentCellState

Gets a value that indicates whether the current cell state is maintained in SfDataGrid.

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

Returns true if the current cell state is maintained; otherwise , false.

IsDropDownable

Gets or sets a value that indicates whether the cell that contains the drop-down control.

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

true if the cell is dropdownable; otherwise, false.

IsEditable

Gets or sets a value that indicates whether the current cell is editable or not.

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

true the current cell is editable; otherwise ,false.

IsFocusible

Gets or sets a value that indicates whether the cell is focusible.

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

true the current cell is focusible; otherwise ,false.

Methods

Arrange(RowColumnIndex, FrameworkElement, Rect)

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

Declaration
void Arrange(RowColumnIndex cellRowColumnIndex, FrameworkElement uiElement, Rect cellRect)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex

The corresponding row and column index of the cell.
Windows.UI.Xaml.FrameworkElement uiElement

The corresponding UiElement that is to be arranged
Windows.Foundation.Rect cellRect

The corresponding size of cell element for arranging the UIElement

BeginEdit(RowColumnIndex, FrameworkElement, GridColumn, Object)

Starts an edit operation on a current cell.

Declaration
bool BeginEdit(RowColumnIndex cellRowColumnIndex, FrameworkElement cellElement, GridColumn column, object record)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex

Specifies the row and column index of the cell to start an edit operation.
Windows.UI.Xaml.FrameworkElement cellElement

Specifies the UIElement of the cell to start an edit operation.
GridColumn column

The corresponding column to edit the cell.
System.Object record

The corresponding record to edit the cell.
Returns
Type Description
System.Boolean

Returns true if the current cell starts an editing; otherwise, false.

CanUpdateBinding(GridColumn)

Determines whether the binding for the column can be updated. Implement this method to update binding on particular renderer when the data context is set.

Declaration
bool CanUpdateBinding(GridColumn column)
Parameters
Type Name Description
GridColumn column

Specifies the corresponding GridColumn.
Returns
Type Description
System.Boolean

Returns true if the binding is updated for the column.

CanValidate()

Determines whether the cell validation is allowed. Implement this method to allow cell validation in particular renderer.

Declaration
bool CanValidate()
Returns
Type Description
System.Boolean

Returns true if the cell validation is allowed.

ClearRecycleBin()

Clears the recycle bin.

Declaration
void ClearRecycleBin()

CommitUnBoundCellValue(Object, GridColumn, Object)

Commits the changes in the unbound cell where the renderer doesn't support value changed event.

Declaration
void CommitUnBoundCellValue(object record, GridColumn column, object value)
Parameters
Type Name Description
System.Object record

Specifies the corresponding record to commit the cell value.
GridColumn column

Specifies the corresponding column to commit the cell value.
System.Object value

Specifies the cell value to commit it.

EndEdit(DataColumnBase, Object, Boolean)

Ends the edit occurring on the cell.

Declaration
bool EndEdit(DataColumnBase dc, object record, bool canResetBinding = false)
Parameters
Type Name Description
DataColumnBase dc

The corresponding datacolumn to complete the edit operation.
System.Object record

The corresponding record to complete the edit operation.
System.Boolean canResetBinding

Specifies whether the binding is reset or not.
Returns
Type Description
System.Boolean

Returns true if the editing is completed ; otherwise, false.

GetControlValue()

Gets the control value of the cell.

Declaration
object GetControlValue()
Returns
Type Description
System.Object

Returns the control value as null by default.

Measure(RowColumnIndex, FrameworkElement, Size)

Invoked when the desired size for cell is measured.

Declaration
void Measure(RowColumnIndex cellRowColumnIndex, FrameworkElement uiElement, Size availableSize)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex

The corresponding row and column index of the cell
Windows.UI.Xaml.FrameworkElement uiElement

Specifies the corresponding UiElement to measure.
Windows.Foundation.Size availableSize

The available size that a parent element can allocate the cell.

PrepareUIElements(DataColumnBase, Object, Boolean)

Invoked when the UIElements are prepared for rendering in view . overrides this method and creates new UIElements and wires them with the parent cells control.

Declaration
FrameworkElement PrepareUIElements(DataColumnBase dataColumn, object record, bool isInEdit)
Parameters
Type Name Description
DataColumnBase dataColumn

The corresponding column of the element.
System.Object record

The corresponding Record for the element.
System.Boolean isInEdit

Specifies whether the element is editable or not.
Returns
Type Description
Windows.UI.Xaml.FrameworkElement

Returns the new cell UIElement.

PreviewTextInput(KeyRoutedEventArgs)

Invoked when an unhanded PreviewTextInput 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
void PreviewTextInput(KeyRoutedEventArgs args)
Parameters
Type Name Description
Windows.UI.Xaml.Input.KeyRoutedEventArgs args

The Windows.UI.Xaml.Input.KeyRoutedEventArgs that contains the event data.

ResetCurrentCellState()

Resets the state of current cell when the cell is deactivated.

Declaration
void ResetCurrentCellState()

SetControlValue(Object)

Sets the control value of the cell.

Declaration
void SetControlValue(object value)
Parameters
Type Name Description
System.Object value

Specifies the value to set the control value of the cell.

SetCurrentCellState(RowColumnIndex, FrameworkElement, Boolean, Boolean, GridColumn, DataColumnBase)

Sets the current cell state when the cell is activated.

Declaration
void SetCurrentCellState(RowColumnIndex currentCellIndex, FrameworkElement currentCellElement, bool isInEditing, bool isFocused, GridColumn column, DataColumnBase dc)
Parameters
Type Name Description
RowColumnIndex currentCellIndex

Specifies the index of cell.
Windows.UI.Xaml.FrameworkElement currentCellElement

The corresponding current cell uielement.
System.Boolean isInEditing

Specifies whether the current cell is editable or not.
System.Boolean isFocused

Specifies whether the current cell is focused or not.
GridColumn column

The corresponding column to set the current cell state.
DataColumnBase dc

The corresponding data column to set the current cell state.

SetFocus(Boolean)

Sets the focus to the current cell renderer element.

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

Specifies whether the current cell renderer element is focusible or not.

ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs)

Decides whether the parent grid should allowed to handle keys and prevent the key event from being handled by the visual UIElement for this renderer.

Declaration
bool ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs e)
Parameters
Type Name Description
Windows.UI.Xaml.Input.KeyRoutedEventArgs e

A Windows.UI.Xaml.Input.KeyRoutedEventArgs that contains event data.
Returns
Type Description
System.Boolean

Returns true if the parent grid should be allowed to handle keys; otherwise false.

UnloadUIElements(DataColumnBase)

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

Declaration
void UnloadUIElements(DataColumnBase dataColumn)
Parameters
Type Name Description
DataColumnBase dataColumn

Specifies the column to unload the cell UIElement.

UpdateBindingInfo(DataColumnBase, Object, Boolean)

Updates the binding of the Cell UIElement for the specified column. Implement this method to update binding when the cell UIElement is reused during horizontal scrolling.

Declaration
void UpdateBindingInfo(DataColumnBase dataColumn, object record, bool isInEdit)
Parameters
Type Name Description
DataColumnBase dataColumn

Specifies the corresponding column to update binding.
System.Object record

The corresponding record to update binding.
System.Boolean isInEdit

Indicates the whether the cell is editable or not.

UpdateCellStyle(DataColumnBase, Object)

Updates the cell style of the particular column. Implement this method to update style when the cell UIElement is reused during scrolling.

Declaration
void UpdateCellStyle(DataColumnBase dataColumn, object dataContext)
Parameters
Type Name Description
DataColumnBase dataColumn

Specifies the corresponding column to update style.
System.Object dataContext

Specifies the data context.

UpdateSource(FrameworkElement)

Updates the current binding target value to the binding source property in TwoWay or OneWayToSource bindings.

Declaration
void UpdateSource(FrameworkElement cellElement)
Parameters
Type Name Description
Windows.UI.Xaml.FrameworkElement cellElement

Specifies the corresponding cell element to update binding.

UpdateToolTip(DataColumnBase)

Updates the tool tip for the specified column.

Declaration
void UpdateToolTip(DataColumnBase dataColumn)
Parameters
Type Name Description
DataColumnBase dataColumn

Specifies the column to update tool tip.

Extension Methods