Class GridCellTemplateRenderer

Represents a class that maintains the Rendering of GridTemplateColumn.

Inheritance
System.Object
GridCellRendererBase
GridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>
GridVirtualizingCellRenderer<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>
GridCellTemplateRenderer
GridCellDataTemplateRenderer
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.UI.Xaml.Grid.Cells
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class GridCellTemplateRenderer : GridVirtualizingCellRenderer<ContentControl, ContentControl>, IGridCellRenderer, IDisposable
Examples
this.sfDataGrid.CellRenderers.Remove("Template");
this.sfDataGrid.CellRenderers.Add("Template", new GridCellTemplateRendererExt());
public class GridCellTemplateRendererExt : GridCellTemplateRenderer
{
public override void OnInitializeEditElement(DataColumnBase dataColumn, ContentControl uiElement, object dataContext)
   {
       uiElement.SelectionShape = SelectionShape.Circle;
       uiElement.SelectionHighlightMode = SelectionHighlightMode.Filled;
       base.OnInitializeEditElement(dataColumn, uiElement, dataContext);
   }
}

Constructors

GridCellTemplateRenderer()

Declaration
public GridCellTemplateRenderer()

Methods

CanValidate()

Determines whether the cell validation is allowed.

Declaration
public override bool CanValidate()
Returns
Type Description
System.Boolean

true if the cell validation is allowed; otherwise false.
Overrides

InitializeCellStyle(DataColumnBase, Object)

Initializes the cell style.

Declaration
protected override void InitializeCellStyle(DataColumnBase dataColumn, object record)
Parameters
Type Name Description
DataColumnBase dataColumn

DataColumn which holds GridColumn, RowColumnIndex and GridCell
System.Object record

The record.
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.InitializeCellStyle(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Object)

OnArrange(RowColumnIndex, FrameworkElement, Rect)

Set focus to UIElement loaded in DataTemplate of GridCell on loading. since OnEditElementloaded will not fire for GridCell again when start editing.

Declaration
protected override void OnArrange(RowColumnIndex cellRowColumnIndex, FrameworkElement uiElement, Rect cellRect)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex
System.Windows.FrameworkElement uiElement
System.Windows.Rect cellRect
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.OnArrange(Syncfusion.UI.Xaml.ScrollAxis.RowColumnIndex, System.Windows.FrameworkElement, System.Windows.Rect)

OnEditingComplete(DataColumnBase, FrameworkElement)

Invoked when the editing is completed on the cell.

Declaration
protected override void OnEditingComplete(DataColumnBase dataColumn, FrameworkElement currentRendererElement)
Parameters
Type Name Description
DataColumnBase dataColumn

The corresponding column.
System.Windows.FrameworkElement currentRendererElement

The corresponding renderer element.
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.OnEditingComplete(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Windows.FrameworkElement)

OnEnteredEditMode(DataColumnBase, FrameworkElement)

Called when [entered edit mode].

Declaration
protected override void OnEnteredEditMode(DataColumnBase dataColumn, FrameworkElement currentRendererElement)
Parameters
Type Name Description
DataColumnBase dataColumn
System.Windows.FrameworkElement currentRendererElement

The current renderer element.
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.OnEnteredEditMode(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Windows.FrameworkElement)

OnInitializeDisplayElement(DataColumnBase, ContentControl, Object)

Method overridden to avoid binding for a content cntrol when cell template is not defined.

Declaration
public override void OnInitializeDisplayElement(DataColumnBase dataColumn, ContentControl uiElement, object dataContext)
Parameters
Type Name Description
DataColumnBase dataColumn
System.Windows.Controls.ContentControl uiElement
System.Object dataContext
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRenderer<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.OnInitializeDisplayElement(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Windows.Controls.ContentControl, System.Object)

OnInitializeEditElement(DataColumnBase, ContentControl, Object)

Called when [initialize edit element].

Declaration
public override void OnInitializeEditElement(DataColumnBase dataColumn, ContentControl uiElement, object dataContext)
Parameters
Type Name Description
DataColumnBase dataColumn

DataColumn which holds GridColumn, RowColumnIndex and GridCell
System.Windows.Controls.ContentControl uiElement

Corresponding Renderer Element
System.Object dataContext

The data context.
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRenderer<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.OnInitializeEditElement(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Windows.Controls.ContentControl, System.Object)

OnInitializeTemplateElement(DataColumnBase, ContentControl, Object)

Called when [initialize display element].

Declaration
public override void OnInitializeTemplateElement(DataColumnBase dataColumn, ContentControl uiElement, object dataContext)
Parameters
Type Name Description
DataColumnBase dataColumn

DataColumn which holds GridColumn, RowColumnIndex and GridCell
System.Windows.Controls.ContentControl uiElement

Corresponding Renderer Element
System.Object dataContext

The data context.
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRenderer<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.OnInitializeTemplateElement(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Windows.Controls.ContentControl, System.Object)

OnRenderContent(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, Object)

Declaration
protected override void OnRenderContent(DrawingContext dc, Rect cellRect, Geometry clipGeometry, DataColumnBase dataColumnBase, GridCell gridCell, object dataContext)
Parameters
Type Name Description
System.Windows.Media.DrawingContext dc
System.Windows.Rect cellRect
System.Windows.Media.Geometry clipGeometry
DataColumnBase dataColumnBase
GridCell gridCell
System.Object dataContext
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.OnRenderContent(System.Windows.Media.DrawingContext, System.Windows.Rect, System.Windows.Media.Geometry, Syncfusion.UI.Xaml.Grid.DataColumnBase, Syncfusion.UI.Xaml.Grid.GridCell, System.Object)

OnUnwireDisplayUIElement(ContentControl)

Called when [unwire display unique identifier element].

Declaration
protected override void OnUnwireDisplayUIElement(ContentControl uiElement)
Parameters
Type Name Description
System.Windows.Controls.ContentControl uiElement

The unique identifier element.
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.OnUnwireDisplayUIElement(System.Windows.Controls.ContentControl)

OnUnwireEditUIElement(ContentControl)

Called when [unwire edit unique identifier element].

Declaration
protected override void OnUnwireEditUIElement(ContentControl uiElement)
Parameters
Type Name Description
System.Windows.Controls.ContentControl uiElement

The unique identifier element.
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.OnUnwireEditUIElement(System.Windows.Controls.ContentControl)

OnUpdateEditBinding(DataColumnBase, ContentControl, Object)

Updates the binding for editor control for the specified column.

Declaration
public override void OnUpdateEditBinding(DataColumnBase dataColumn, ContentControl uiElement, object dataContext)
Parameters
Type Name Description
DataColumnBase dataColumn

The corresponding Data column.
System.Windows.Controls.ContentControl uiElement

The corresponding UIElement.
System.Object dataContext

The DataContext.
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRenderer<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.OnUpdateEditBinding(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Windows.Controls.ContentControl, System.Object)

ShouldGridTryToHandleKeyDown(KeyEventArgs)

Let Renderer decide whether the parent grid should be allowed to handle keys and prevent the key event from being handled by the visual UIElement for this renderer. If this method returns true the parent grid will handle arrow keys and set the Handled flag in the event data. Keys that the grid does not handle will be ignored and be routed to the UIElement for this renderer.

Declaration
protected override bool ShouldGridTryToHandleKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Input.KeyEventArgs e

A System.Windows.Input.KeyEventArgs object.
Returns
Type Description
System.Boolean

True if the parent grid should be allowed to handle keys; false otherwise.
Overrides
Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRenderer<System.Windows.Controls.ContentControl, System.Windows.Controls.ContentControl>.ShouldGridTryToHandleKeyDown(System.Windows.Input.KeyEventArgs)

Implements

System.IDisposable