Class GridCellDateRenderer

Represents the class that loads the SfCalendarDatePicker as editor for GridDateColumn.

Inheritance
System.Object
GridCellRendererBase
GridVirtualizingCellRendererBase<Microsoft.UI.Xaml.Controls.TextBlock, SfCalendarDatePicker>
GridVirtualizingCellRenderer<Microsoft.UI.Xaml.Controls.TextBlock, SfCalendarDatePicker>
GridCellDateRenderer
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.DataGrid.Renderers
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class GridCellDateRenderer : GridVirtualizingCellRenderer<TextBlock, SfCalendarDatePicker>, IGridCellRenderer, IDisposable
Examples
this.sfDataGrid.CellRenderers.Remove("DateTimeOffset");
this.sfDataGrid.CellRenderers.Add("DateTimeOffset", new GridCellDateRendererExt());
public class GridCellDateRendererExt : GridCellDateRenderer
{
   public override void OnInitializeDisplayElement(DataColumnBase dataColumn, TextBlock uiElement, object dataContext)
   {
       base.OnInitializeDisplayElement(dataColumn, uiElement, dataContext);
       uiElement.Foreground = new SolidColorBrush(Colors.DarkOrange);
   }
}

Constructors

GridCellDateRenderer()

Initializes a new instance of the GridCellDateRenderer class.

Declaration
public GridCellDateRenderer()

Methods

EndEdit(DataColumnBase, Object, Boolean)

Ends the edit occuring on the cell.

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

Specifies the DataColumnBase.
System.Object record

Specifies the record.
System.Boolean canResetBinding

Indicates whether binding can be reset or not.
Returns
Type Description
System.Boolean

True if the edit ends on the cell; otherwise false.
Overrides
Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRendererBase<Microsoft.UI.Xaml.Controls.TextBlock, Syncfusion.UI.Xaml.Calendar.SfCalendarDatePicker>.EndEdit(Syncfusion.UI.Xaml.DataGrid.DataColumnBase, System.Object, System.Boolean)

GetControlValue()

Gets the control value of the cell.

Declaration
public override object GetControlValue()
Returns
Type Description
System.Object

The control value of the cell.
Overrides

OnEditElementLoaded(Object, RoutedEventArgs)

Invoked when the edit element(SfCalenderDatePicker) is loaded on the cell in column.

Declaration
protected override void OnEditElementLoaded(object sender, RoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The sender.
Microsoft.UI.Xaml.RoutedEventArgs e

The Microsoft.UI.Xaml.RoutedEventArgs instance containing the event data.
Overrides
Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRendererBase<Microsoft.UI.Xaml.Controls.TextBlock, Syncfusion.UI.Xaml.Calendar.SfCalendarDatePicker>.OnEditElementLoaded(System.Object, Microsoft.UI.Xaml.RoutedEventArgs)

OnEditElementUnloaded(Object, RoutedEventArgs)

Invoked when the edit element(SfCalenderDatePicker) is unloaded on the cell in column.

Declaration
protected override void OnEditElementUnloaded(object sender, RoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The sender.
Microsoft.UI.Xaml.RoutedEventArgs e

The Microsoft.UI.Xaml.RoutedEventArgs instance containing the event data.
Overrides
Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRendererBase<Microsoft.UI.Xaml.Controls.TextBlock, Syncfusion.UI.Xaml.Calendar.SfCalendarDatePicker>.OnEditElementUnloaded(System.Object, Microsoft.UI.Xaml.RoutedEventArgs)

OnInitializeDisplayElement(DataColumnBase, TextBlock, Object)

Method which initialize the display element of the column.

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

Specifies the corresponding DataColumnBase.
Microsoft.UI.Xaml.Controls.TextBlock uiElement

Specifies the corresponding renderer element.
System.Object dataContext

Specifies the data context of the cell.
Overrides
Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRenderer<Microsoft.UI.Xaml.Controls.TextBlock, Syncfusion.UI.Xaml.Calendar.SfCalendarDatePicker>.OnInitializeDisplayElement(Syncfusion.UI.Xaml.DataGrid.DataColumnBase, Microsoft.UI.Xaml.Controls.TextBlock, System.Object)

OnInitializeEditElement(DataColumnBase, SfCalendarDatePicker, Object)

Method which is used to initialize the renderer element bindings with corresponding column values.

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

Specifies the corresponding DataColumnBase.
SfCalendarDatePicker uiElement

Specifies the corresponding renderer element.
System.Object dataContext

Specifies the data context of the cell.
Overrides
Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRenderer<Microsoft.UI.Xaml.Controls.TextBlock, Syncfusion.UI.Xaml.Calendar.SfCalendarDatePicker>.OnInitializeEditElement(Syncfusion.UI.Xaml.DataGrid.DataColumnBase, Syncfusion.UI.Xaml.Calendar.SfCalendarDatePicker, System.Object)

OnUnloadUIElements(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
protected override void OnUnloadUIElements(DataColumnBase dataColumn)
Parameters
Type Name Description
DataColumnBase dataColumn

Specifies the column to unload the cell UIElement.
Overrides
Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRendererBase<Microsoft.UI.Xaml.Controls.TextBlock, Syncfusion.UI.Xaml.Calendar.SfCalendarDatePicker>.OnUnloadUIElements(Syncfusion.UI.Xaml.DataGrid.DataColumnBase)

ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs)

Handles the key interaction with editor of corresponding column.

Declaration
protected override bool ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs e)
Parameters
Type Name Description
Microsoft.UI.Xaml.Input.KeyRoutedEventArgs e

The Microsoft.UI.Xaml.Input.KeyRoutedEventArgs instance containing the event data.
Returns
Type Description
System.Boolean

Returns true if the parent grid should be allowed to handle keys; otherwise false.
Overrides
Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRenderer<Microsoft.UI.Xaml.Controls.TextBlock, Syncfusion.UI.Xaml.Calendar.SfCalendarDatePicker>.ShouldGridTryToHandleKeyDown(Microsoft.UI.Xaml.Input.KeyRoutedEventArgs)

Implements

System.IDisposable