menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Interface IDataGridCellRenderer - MAUI API Reference | Syncfusion

    Show / Hide Table of Contents

    Interface IDataGridCellRenderer

    Defines the interface for all cell renderer.

    Namespace: Syncfusion.Maui.DataGrid
    Assembly: Syncfusion.Maui.DataGrid.dll
    Syntax
    public interface IDataGridCellRenderer : IDisposable

    Properties

    CurrentCellIndex

    ToDo

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

    DataGrid

    Gets or sets the reference of the SfDataGrid control.

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

    HasCurrentCellState

    Gets a value indicating whether the cell state for the current cell has been set.

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

    True if the cell state for the current cell is set, otherwise false.

    IsEditable

    Gets or sets a value indicating whether the cell is editable or not.

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

    True if the current cell is editable, otherwise false.

    IsInEditing

    Gets or sets a value indicating whether the current cell is in editing.

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

    Methods

    BeginEdit(RowColumnIndex, DataGridCell, DataGridColumn, Object)

    This method fires when editing in the current cell begins.

    Declaration
    bool BeginEdit(RowColumnIndex rowColumnIndex, DataGridCell cellElement, DataGridColumn column, object rowData)
    Parameters
    Type Name Description
    RowColumnIndex rowColumnIndex

    The row column index of the cell which is in edit mode.

    DataGridCell cellElement

    The UIElement of the cell which is in edit mode.

    DataGridColumn column

    The corresponding grid column of the cell which is in edit mode.

    System.Object rowData

    The corresponding record of the row which is in edit mode.

    Returns
    Type Description
    System.Boolean

    Returns a value indicating whether the cell enters into the editing mode or not.

    CanUpdateBinding(DataColumnBase)

    to do

    Declaration
    bool CanUpdateBinding(DataColumnBase dataColumnBase)
    Parameters
    Type Name Description
    Syncfusion.Maui.DataGrid.DataColumnBase dataColumnBase
    Returns
    Type
    System.Boolean

    ClearRecycleBin()

    Clears the recycle bin. The cell element will be stored for recycling purpose, when the cell element is scrolled out of view. This method clears all the cell elements which are stored for recycling purpose.

    Declaration
    void ClearRecycleBin()

    CommitCellValue(Boolean)

    Commits the edited value to the underlying data.

    Declaration
    void CommitCellValue(bool isNewValue)
    Parameters
    Type Name Description
    System.Boolean isNewValue

    A value indicating whether the edited value is new value.

    EndEdit(DataColumnBase, Object, Boolean)

    This method fires when the editing in the current cell is ended.

    Declaration
    bool EndEdit(DataColumnBase dataColumn, object record, bool canResetBinding = false)
    Parameters
    Type Name Description
    Syncfusion.Maui.DataGrid.DataColumnBase dataColumn

    The corresponding data column of the cell, which leaves the edit mode.

    System.Object record

    The underlying data of the cell, which leaves the edit mode.

    System.Boolean canResetBinding

    The value indicating whether to reset the binding or not.

    Returns
    Type Description
    System.Boolean

    A boolean value indicating whether the current cell has focus.

    GetControlValue()

    Returns the current cell value, only if the renderer's HasCurrentCellState is true.

    Declaration
    object GetControlValue()
    Returns
    Type Description
    System.Object

    The current cell value.

    PrepareViews(DataColumnBase)

    Method which is used to create and initiate the view for cell.

    Declaration
    DataGridCell PrepareViews(DataColumnBase dataColumn)
    Parameters
    Type Name Description
    Syncfusion.Maui.DataGrid.DataColumnBase dataColumn
    Returns
    Type
    DataGridCell

    RefreshDisplayValue(DataColumnBase)

    Method which is used to refresh the display value of the cell.

    Declaration
    void RefreshDisplayValue(DataColumnBase dataColumn)
    Parameters
    Type Name Description
    Syncfusion.Maui.DataGrid.DataColumnBase dataColumn

    ResetCurrentCellState()

    Resets the current cell information in renderer, when the current cell is deactivated.

    Declaration
    void ResetCurrentCellState()

    SetCellStyle(DataColumnBase)

    Method is used to set the cell style

    Declaration
    void SetCellStyle(DataColumnBase dataColumn)
    Parameters
    Type Name Description
    Syncfusion.Maui.DataGrid.DataColumnBase dataColumn

    SetControlValue(Object)

    Set the current cell value, only if the renderer's is true.

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

    The value to be set to the current cell.

    SetCurrentCellState(RowColumnIndex, DataGridCell, Boolean)

    Update the current cell information in the renderer while current cell was activated.

    Declaration
    void SetCurrentCellState(RowColumnIndex currentCellIndex, DataGridCell currentCellElement, bool isInEdit)
    Parameters
    Type Name Description
    RowColumnIndex currentCellIndex

    The row column index of the current cell.

    DataGridCell currentCellElement

    The UIElement of the current cell.

    System.Boolean isInEdit

    The value indicating whether the view is in edit mode or not.

    SetFocus(Boolean)

    Sets the focus to the current cell renderer element.

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

    The value indicating whether the current cell renderer element is focusable or not.

    UnloadViews(DataColumnBase)

    Method which is used for Unloading the view of the cell.(For Recycling Purpose).

    Declaration
    void UnloadViews(DataColumnBase dataColumn)
    Parameters
    Type Name Description
    Syncfusion.Maui.DataGrid.DataColumnBase dataColumn

    UpdateCellValue(DataColumnBase)

    Method which is used to update the cell value.

    Declaration
    void UpdateCellValue(DataColumnBase dataColumn)
    Parameters
    Type Name Description
    Syncfusion.Maui.DataGrid.DataColumnBase dataColumn

    UpdateColumnInfo(DataColumnBase)

    Method which is used to update the binding information of the cell UIElement.

    Declaration
    void UpdateColumnInfo(DataColumnBase dataColumn)
    Parameters
    Type Name Description
    Syncfusion.Maui.DataGrid.DataColumnBase dataColumn
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved