Class GridCellCheckboxRenderer

Implements the renderer part of a checkbox cell.

Inheritance
System.Object
NonFinalizeDisposable
Disposable
CellRendererBase<GridRenderStyleInfo>
GridCellRendererBase
GridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox>
GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox>
GridCellCheckboxRenderer
Inherited Members
Namespace: Syncfusion.Windows.Controls.Grid
Assembly: Syncfusion.Grid.Wpf.dll
Syntax
public class GridCellCheckboxRenderer : GridVirtualizingCellRenderer<CheckBox>, IGridCellRenderer, ICellRenderer, IHitTestSelectCells, IStyleChanged, IDisposable, IAllowKeepAliveOnlyCurrentCell

Constructors

GridCellCheckboxRenderer()

Initializes a new GridCellCheckboxRenderer object for the given cell.

Declaration
public GridCellCheckboxRenderer()

Properties

PreventAnimationQueueCount

Gets or sets a value that indicates the number of elements in the prevent animation queue.

Declaration
public int PreventAnimationQueueCount { get; set; }
Property Value
Type
System.Int32
Remarks

Checkbox does not offer any way to turn off the animation. We have to workaround this, otherwise animation occurs while scrolling through grid.

Methods

ArrangeUIElement(ArrangeCellArgs, CheckBox, GridRenderStyleInfo)

Declaration
protected override void ArrangeUIElement(ArrangeCellArgs aca, CheckBox checkBox, GridRenderStyleInfo style)
Parameters
Type Name Description
ArrangeCellArgs aca
System.Windows.Controls.CheckBox checkBox
GridRenderStyleInfo style
Overrides
Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox>.ArrangeUIElement(Syncfusion.Windows.Controls.Cells.ArrangeCellArgs, System.Windows.Controls.CheckBox, Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo)

CreateRendererElement(CheckBox, GridRenderStyleInfo)

Declaration
public override void CreateRendererElement(CheckBox checkBox, GridRenderStyleInfo style)
Parameters
Type Name Description
System.Windows.Controls.CheckBox checkBox
GridRenderStyleInfo style
Overrides
Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox>.CreateRendererElement(System.Windows.Controls.CheckBox, Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo)

CreateUIElement(ArrangeCellArgs, GridRenderStyleInfo)

Declaration
protected override CheckBox CreateUIElement(ArrangeCellArgs aca, GridRenderStyleInfo style)
Parameters
Type Name Description
ArrangeCellArgs aca
GridRenderStyleInfo style
Returns
Type
System.Windows.Controls.CheckBox
Overrides
Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox>.CreateUIElement(Syncfusion.Windows.Controls.Cells.ArrangeCellArgs, Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo)

GetControlTextFromEditorCore(CheckBox)

Declaration
protected override string GetControlTextFromEditorCore(CheckBox uiElement)
Parameters
Type Name Description
System.Windows.Controls.CheckBox uiElement
Returns
Type
System.String
Overrides
Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox>.GetControlTextFromEditorCore(System.Windows.Controls.CheckBox)

GetControlValueFromEditor()

Declaration
protected override object GetControlValueFromEditor()
Returns
Type
System.Object
Overrides
Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox>.GetControlValueFromEditor()

GetControlValueFromEditorCore(CheckBox)

Declaration
protected override object GetControlValueFromEditorCore(CheckBox uiElement)
Parameters
Type Name Description
System.Windows.Controls.CheckBox uiElement
Returns
Type
System.Object
Overrides
Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox>.GetControlValueFromEditorCore(System.Windows.Controls.CheckBox)

OnActivated()

Declaration
protected override void OnActivated()
Overrides

OnClickedCheckBox(CheckBox)

Declaration
protected virtual void OnClickedCheckBox(CheckBox checkBox)
Parameters
Type Name Description
System.Windows.Controls.CheckBox checkBox

OnDeactivated()

Declaration
protected override void OnDeactivated()
Overrides

OnInitialize()

Declaration
protected override void OnInitialize()
Overrides

OnInitializeContent(CheckBox, GridRenderStyleInfo)

Initializes the content of the checkbox cell using the information from the cell style (value, text, behavior etc.).

Declaration
public override void OnInitializeContent(CheckBox checkBox, GridRenderStyleInfo style)
Parameters
Type Name Description
System.Windows.Controls.CheckBox checkBox

The check box.
GridRenderStyleInfo style

The cell style info.
Overrides
Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox>.OnInitializeContent(System.Windows.Controls.CheckBox, Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo)

OnRender(DrawingContext, RenderCellArgs, GridRenderStyleInfo)

Declaration
protected override void OnRender(DrawingContext dc, RenderCellArgs rca, GridRenderStyleInfo style)
Parameters
Type Name Description
System.Windows.Media.DrawingContext dc
RenderCellArgs rca
GridRenderStyleInfo style
Overrides
Syncfusion.Windows.Controls.Cells.CellRendererBase<Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo>.OnRender(System.Windows.Media.DrawingContext, Syncfusion.Windows.Controls.Cells.RenderCellArgs, Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo)

OnRenderForPrinting(DrawingContext, RenderCellArgs, GridRenderStyleInfo)

Declaration
protected override void OnRenderForPrinting(DrawingContext dc, RenderCellArgs rca, GridRenderStyleInfo cellInfo)
Parameters
Type Name Description
System.Windows.Media.DrawingContext dc
RenderCellArgs rca
GridRenderStyleInfo cellInfo
Overrides

OnUnwireUIElement(CheckBox)

Unwire previously wired events from checkBox.

Declaration
protected override void OnUnwireUIElement(CheckBox checkBox)
Parameters
Type Name Description
System.Windows.Controls.CheckBox checkBox
Overrides
Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox>.OnUnwireUIElement(System.Windows.Controls.CheckBox)

OnWireUIElement(CheckBox)

Wire events from checkBox

Declaration
protected override void OnWireUIElement(CheckBox checkBox)
Parameters
Type Name Description
System.Windows.Controls.CheckBox checkBox
Overrides
Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox>.OnWireUIElement(System.Windows.Controls.CheckBox)

RaiseGridCellClick(Int32, Int32, MouseControllerEventArgs)

Declaration
public override void RaiseGridCellClick(int rowIndex, int colIndex, MouseControllerEventArgs e)
Parameters
Type Name Description
System.Int32 rowIndex
System.Int32 colIndex
MouseControllerEventArgs e
Overrides

RaiseGridPreviewMouseMove(RowColumnIndex, MouseEventArgs)

Raises the grid preview mouse move.

Declaration
public override void RaiseGridPreviewMouseMove(RowColumnIndex rci, MouseEventArgs e)
Parameters
Type Name Description
RowColumnIndex rci

The rci.
System.Windows.Input.MouseEventArgs e

The System.Windows.Input.MouseEventArgs instance containing the event data.
Overrides
Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox>.RaiseGridPreviewMouseMove(Syncfusion.Windows.Controls.Cells.RowColumnIndex, System.Windows.Input.MouseEventArgs)

ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs)

Declaration
protected override bool ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Input.KeyEventArgs e
Returns
Type
System.Boolean
Overrides

Implements

System.IDisposable