WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridCellCheckBoxRenderer - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridCellCheckBoxRenderer

    Inheritance
    System.Object
    GridCellRendererBase
    GridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>
    GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>
    GridCellCheckBoxRenderer
    Implements
    IGridCellRenderer
    System.IDisposable
    Inherited Members
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.TextAlignmentToHorizontalAlignment(TextAlignment)
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.CurrentRendererValueChanged()
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.ShouldGridTryToHandleKeyDown(KeyEventArgs)
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.OnInitializeTemplateElement(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.OnUpdateTemplateBinding(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.OnInitializeDisplayElement(DataColumnBase, CheckBox, Object)
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.OnUpdateDisplayBinding(DataColumnBase, CheckBox, Object)
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.OnInitializeEditElement(DataColumnBase, CheckBox, Object)
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.OnUpdateEditBinding(DataColumnBase, CheckBox, Object)
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.UpdateToolTip(DataColumnBase)
    GridVirtualizingCellRenderer<CheckBox, CheckBox>.EditorType
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnPrepareUIElements(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.BeginEdit(RowColumnIndex, FrameworkElement, GridColumn, Object)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnEnteredEditMode(DataColumnBase, FrameworkElement)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.EndEdit(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnEditingComplete(DataColumnBase, FrameworkElement)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUnloadUIElements(DataColumnBase)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnRenderCell(DrawingContext, Rect, DataColumnBase, Object)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnRenderCellBorder(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnRenderContent(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, Object)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.DrawFormattedText(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, String)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.DrawGlyphs(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, String)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnRenderCurrentCell(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUpdateStyleInfo(DataColumnBase, Object)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnCreateEditUIElement()
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnCreateDisplayUIElement()
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.InitializeEditElement(DataColumnBase, CheckBox, Object)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.InitializeDisplayElement(DataColumnBase, CheckBox, Object)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.InitializeTemplateElement(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnWireDisplayUIElement(CheckBox)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUnwireDisplayUIElement(CheckBox)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnWireTemplateUIElement(ContentControl)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUnwireTemplateUIElement(ContentControl)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnWireEditUIElement(CheckBox)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUnwireEditUIElement(CheckBox)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnEditElementLoaded(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnEditElementUnloaded(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnEditElementLostFocus(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.InitializeCellStyle(DataColumnBase, Object)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.ClearRecycleBin()
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.Dispose(Boolean)
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnCreateTemplateUIElement()
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.DisplayRecycleBin
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.EditRecycleBin
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.TemplateRecycleBin
    GridVirtualizingCellRendererBase<CheckBox, CheckBox>.AllowRecycle
    GridCellRendererBase.OnPrepareUIElements(DataColumnBase, Object, Boolean)
    GridCellRendererBase.OnPrepareUIElements()
    GridCellRendererBase.OnPreviewTextInput(TextCompositionEventArgs)
    GridCellRendererBase.CanValidate()
    GridCellRendererBase.CommitUnBoundCellValue(Object, GridColumn, Object)
    GridCellRendererBase.UpdateToolTip(DataColumnBase)
    GridCellRendererBase.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    GridCellRendererBase.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    GridCellRendererBase.OnRenderCell(DrawingContext, Rect, DataColumnBase, Object)
    GridCellRendererBase.OnRenderCellBorder(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridCellRendererBase.OnRenderCurrentCell(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridCellRendererBase.OnUnloadUIElements(DataColumnBase)
    GridCellRendererBase.OnUpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridCellRendererBase.OnUpdateStyleInfo(DataColumnBase, Object)
    GridCellRendererBase.SetFocus(FrameworkElement, Boolean)
    GridCellRendererBase.IGridCellRenderer.ShouldGridTryToHandleKeyDown(KeyEventArgs)
    GridCellRendererBase.Arrange(RowColumnIndex, FrameworkElement, Rect)
    GridCellRendererBase.RenderCell(DrawingContext, Rect, DataColumnBase, Object)
    GridCellRendererBase.Measure(RowColumnIndex, FrameworkElement, Size)
    GridCellRendererBase.PrepareUIElements(DataColumnBase, Object, Boolean)
    GridCellRendererBase.UnloadUIElements(DataColumnBase)
    GridCellRendererBase.IGridCellRenderer.UpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridCellRendererBase.UpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridCellRendererBase.UpdateCellStyle(DataColumnBase, Object)
    GridCellRendererBase.PreviewTextInput(TextCompositionEventArgs)
    GridCellRendererBase.UpdateCurrentCellState(FrameworkElement, Boolean)
    GridCellRendererBase.ResetCurrentCellState()
    GridCellRendererBase.SetFocus(Boolean)
    GridCellRendererBase.RaiseCurrentCellValidatingEvent(SfDataGrid, GridColumn, Object, Object, Object)
    GridCellRendererBase.RaiseCurrentCellValidatedEvent(SfDataGrid, GridColumn, Object, Object)
    GridCellRendererBase.RaiseCurrentCellValueChangedEvent(SfDataGrid, DataColumnBase)
    GridCellRendererBase.BeginEdit(RowColumnIndex, FrameworkElement, GridColumn, Object)
    GridCellRendererBase.UpdateSource(FrameworkElement)
    GridCellRendererBase.ClearRecycleBin()
    GridCellRendererBase.Dispose()
    GridCellRendererBase.Dispose(Boolean)
    GridCellRendererBase.PreviewInputText
    GridCellRendererBase.DataGrid
    GridCellRendererBase.BindingExpression
    GridCellRendererBase.SupportsRenderOptimization
    GridCellRendererBase.UseOnlyRendererElement
    GridCellRendererBase.HasCurrentCellState
    GridCellRendererBase.CurrentCellIndex
    GridCellRendererBase.CurrentCellElement
    GridCellRendererBase.CurrentCellRendererElement
    GridCellRendererBase.IsInEditing
    GridCellRendererBase.IsFocused
    GridCellRendererBase.IsEditable
    GridCellRendererBase.IsFocusible
    GridCellRendererBase.IsDropDownable
    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
    [ClassReference(IsReviewed = false)]
    public class GridCellCheckBoxRenderer : GridVirtualizingCellRenderer<CheckBox, CheckBox>, IGridCellRenderer, IDisposable

    Constructors

    GridCellCheckBoxRenderer()

    Initializes a new instance of the GridCellCheckBoxRenderer class.

    Declaration
    public GridCellCheckBoxRenderer()

    Fields

    IsCheckedProperty

    Declaration
    public static readonly DependencyProperty IsCheckedProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    Methods

    CanCheckAddNewRowAtFirstClick()

    Method that used to decide whether AddNewRow check box column can get check at first click or not.

    Declaration
    protected virtual bool CanCheckAddNewRowAtFirstClick()
    Returns
    Type Description
    System.Boolean

    CanUpdateBinding(GridColumn)

    Declaration
    public override bool CanUpdateBinding(GridColumn column)
    Parameters
    Type Name Description
    GridColumn column
    Returns
    Type Description
    System.Boolean
    Overrides
    GridCellRendererBase.CanUpdateBinding(GridColumn)

    EndEdit(DataColumnBase, Object, Boolean)

    Declaration
    public override bool EndEdit(DataColumnBase dc, object record, bool canResetBinding = false)
    Parameters
    Type Name Description
    DataColumnBase dc
    System.Object record
    System.Boolean canResetBinding
    Returns
    Type Description
    System.Boolean
    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.EndEdit(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Object, System.Boolean)

    GetControlValue()

    Gets the control value.

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

    GetIsChecked(DependencyObject)

    Gets the IsChecked attached property value of CheckBox which is bound with underlying data object.

    Declaration
    public static object GetIsChecked(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj
    Returns
    Type Description
    System.Object
    Remarks

    IsChecked attached property used only when GridCheckBoxColumn.IsThreeState is true.

    OnEditElementLoaded(Object, RoutedEventArgs)

    Invoked when the edit element(CheckBox) 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.

    System.Windows.RoutedEventArgs e

    The System.Windows.RoutedEventArgs instance containing the event data.

    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.OnEditElementLoaded(System.Object, System.Windows.RoutedEventArgs)

    OnEditElementUnloaded(Object, RoutedEventArgs)

    Invoked when the edit element(CheckBox) 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.

    System.Windows.RoutedEventArgs e

    The System.Windows.RoutedEventArgs instance containing the event data.

    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.OnEditElementUnloaded(System.Object, System.Windows.RoutedEventArgs)

    OnInitializeEditElement(DataColumnBase, CheckBox, Object)

    Method which is initialize the Renderer element Bindings with corresponding column values.

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

    DataColumn Which holds GridColumn, RowColumnIndex and GridCell

    System.Windows.Controls.CheckBox uiElement

    Corresponding Renderer Element

    System.Object dataContext
    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.OnInitializeEditElement(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Windows.Controls.CheckBox, 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.CheckBox, System.Windows.Controls.CheckBox>.OnRenderContent(System.Windows.Media.DrawingContext, System.Windows.Rect, System.Windows.Media.Geometry, Syncfusion.UI.Xaml.Grid.DataColumnBase, Syncfusion.UI.Xaml.Grid.GridCell, System.Object)

    OnUnwireEditUIElement(CheckBox)

    Declaration
    protected override void OnUnwireEditUIElement(CheckBox uiElement)
    Parameters
    Type Name Description
    System.Windows.Controls.CheckBox uiElement
    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.OnUnwireEditUIElement(System.Windows.Controls.CheckBox)

    OnUpdateEditBinding(DataColumnBase, CheckBox, Object)

    Method which is used to update the Renderer element Bindings with corresponding column values.

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

    DataColumn Which holds GridColumn, RowColumnIndex and GridCell

    System.Windows.Controls.CheckBox element

    Corresponding Renderer Element

    System.Object dataContext

    dataContext of the row

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

    SetControlValue(Object)

    Sets the control value.

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

    The value.

    Overrides
    GridCellRendererBase.SetControlValue(Object)

    SetCurrentCellState(RowColumnIndex, FrameworkElement, Boolean, Boolean, GridColumn, DataColumnBase)

    Sets the current cell state when the cell is activated.

    Declaration
    public override void SetCurrentCellState(RowColumnIndex currentCellIndex, FrameworkElement currentCellElement, bool isInEditing, bool isFocused, GridColumn column, DataColumnBase dc)
    Parameters
    Type Name Description
    RowColumnIndex currentCellIndex

    Specifies the index of cell.

    System.Windows.FrameworkElement currentCellElement

    The corresponding current cell uielement.

    System.Boolean isInEditing

    Specifies whether the current cell is editable or not.

    System.Boolean isFocused

    Specifies whether the current cell is focused or not.

    GridColumn column

    The corresponding column to set the current cell state.

    DataColumnBase dc

    The corresponding data column to set the current cell state.

    Overrides
    GridCellRendererBase.SetCurrentCellState(RowColumnIndex, FrameworkElement, Boolean, Boolean, GridColumn, DataColumnBase)

    SetIsChecked(DependencyObject, Object)

    Sets the IsChecked attached property value of CheckBoox which is bound with underlying data object.

    Declaration
    public static void SetIsChecked(DependencyObject obj, object value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj
    System.Object value
    Remarks

    IsChecked attached property used only when GridCheckBoxColumn.IsThreeState is true.

    ShouldGridTryToHandleKeyDown(KeyEventArgs)

    Shoulds the grid try automatic handle key down.

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

    The instance containing the event data.

    Returns
    Type Description
    System.Boolean
    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRenderer<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.ShouldGridTryToHandleKeyDown(System.Windows.Input.KeyEventArgs)

    Implements

    IGridCellRenderer
    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved