Class TreeGridCellRenderer<T1, T2>

Defines the base class for the cell renderer of the SfTreeGrid control.

Inheritance

System.Object

TreeGridCellRenderer<T1, T2>

TreeGridCheckBoxCellRenderer

TreeGridDateCellRenderer

TreeGridHeaderCellRenderer

TreeGridNumericCellRenderer

TreeGridTemplateCellRenderer

TreeGridTextCellRenderer

Implements

ITreeGridCellRenderer

System.IDisposable

Namespace: Syncfusion.Maui.TreeGrid

Assembly: Syncfusion.Maui.TreeGrid.dll

Syntax

public abstract class TreeGridCellRenderer<T1, T2> : Object, ITreeGridCellRenderer, IDisposable where T1 : View where T2 : View

Type Parameters

Name
T1
T2

Constructors

TreeGridCellRenderer()

Declaration

protected TreeGridCellRenderer()

Properties

SupportsRenderOptimization

Gets or sets a value indicating whether the renderer supports rendering itself directly to the drawing context. When this is possible the UIElement will only be created when the user moves the mouse over the cell or if the UIElement is needed for other reasons, e.g. animate after change. The benefit of rendering directly to the DrawingContext instead of creating the UIElement is a much improved scrolling performance.

Declaration

public bool SupportsRenderOptimization { get; set; }

Property Value

Type	Description
System.Boolean	True if the renderer supports optimization, otherwise false. The default value is true.

TreeGrid

Gets the SfTreeGrid

Declaration

public SfTreeGrid TreeGrid { get; set; }

Property Value

Type
SfTreeGrid

Methods

CanUpdateBinding(TreeGridDataColumnBase)

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

public virtual bool CanUpdateBinding(TreeGridDataColumnBase dataColumnBase)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumnBase	The corresponding column for which the binding update should be determined.

Returns

Type	Description
System.Boolean	True if the binding is updated for the column, otherwise false.

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

public void ClearRecycleBin()

Dispose()

Disposes the cell renderer and its elements.

Declaration

public void Dispose()

Dispose(Boolean)

Releases the unmanaged resources used by the component and optionally releases the managed resources

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnCreateDisplayUIView()

Creates the view for the display UI.

Declaration

protected virtual T1 OnCreateDisplayUIView()

Returns

Type
T1

OnInitializeDisplayView(TreeGridDataColumnBase, T1)

Initializes settings of the display view.

Declaration

protected virtual void OnInitializeDisplayView(TreeGridDataColumnBase dataColumn, T1 view)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn
T1	view

OnPrepareViews(TreeGridDataColumnBase)

Prepares the view for the display for the reusing while virtualization.

Declaration

protected virtual TreeGridCell OnPrepareViews(TreeGridDataColumnBase dataColumn)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn

Returns

Type
TreeGridCell

OnSetCellStyle(TreeGridDataColumnBase)

Called when the cell style is set.

Declaration

protected virtual void OnSetCellStyle(TreeGridDataColumnBase dataColumn)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn

OnUnloadViews(TreeGridDataColumnBase)

Called from after a cell is scrolled out of view. VirtualizingCellRendererBase overrides this method and either removes the cell renderer visuals from the parent canvas or hide them and reuse it later in same canvas depending on whether GridVirtualizingCellRendererBase.AllowRecycle was set.

Declaration

protected virtual void OnUnloadViews(TreeGridDataColumnBase dataColumn)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn	The DataColumn containing the details of the column.

OnUpdateCellValue(TreeGridDataColumnBase)

Called when the cell value is updated.

Declaration

protected virtual void OnUpdateCellValue(TreeGridDataColumnBase dataColumn)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn

PrepareViews(TreeGridDataColumnBase)

ToDo

Declaration

public TreeGridCell PrepareViews(TreeGridDataColumnBase dataColumn)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn

Returns

Type
TreeGridCell

RefreshDisplayValue(TreeGridDataColumnBase)

ToDo

Declaration

public void RefreshDisplayValue(TreeGridDataColumnBase dataColumn)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn

ResumeBinding(TreeGridDataColumnBase, T1)

Resumes the binding value.

Declaration

protected virtual void ResumeBinding(TreeGridDataColumnBase dataColumn, T1 view)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn	DataColumnBase instance.
T1	view	current view.

SetCellStyle(TreeGridDataColumnBase)

Called when set the cell style

Declaration

public void SetCellStyle(TreeGridDataColumnBase dataColumn)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn

SuspendBinding(TreeGridDataColumnBase, T1)

Suspends the binding value.

Declaration

protected virtual void SuspendBinding(TreeGridDataColumnBase dataColumn, T1 view)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn	DataColumnBase instance.
T1	view	current view.

UnloadViews(TreeGridDataColumnBase)

ToDo

Declaration

public void UnloadViews(TreeGridDataColumnBase dataColumn)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn

UnwireEditUIElement(T2)

Unwire the edit element to the view.

Declaration

protected virtual void UnwireEditUIElement(T2 editElement)

Parameters

Type	Name	Description
T2	editElement	The edit element .

UpdateCellValue(TreeGridDataColumnBase)

ToDo

Declaration

public void UpdateCellValue(TreeGridDataColumnBase dataColumn)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn

UpdateColumnInfo(TreeGridDataColumnBase)

ToDo

Declaration

public void UpdateColumnInfo(TreeGridDataColumnBase dataColumn)

Parameters

Type	Name	Description
TreeGridDataColumnBase	dataColumn

Implements

ITreeGridCellRenderer

System.IDisposable