Class TreeGridCellCheckBoxRenderer

Represents the class that maintains the rendering of TreeGridCheckBoxColumn

Inheritance
System.Object
TreeGridCellRendererBase
TreeGridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>
TreeGridVirtualizingCellRenderer<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>
TreeGridCellCheckBoxRenderer
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.TreeGrid.Cells
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class TreeGridCellCheckBoxRenderer : TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>, ITreeGridCellRenderer, IDisposable
Examples
this.treeGrid.CellRenderers.Remove("CheckBox");
this.treeGrid.CellRenderers.Add("CheckBox", new TreeGridCellCheckBoxRendererExt());
public class TreeGridCellCheckBoxRendererExt : TreeGridCellCheckBoxRenderer
{
 public override void OnInitializeEditElement(DataColumnBase dataColumn, CheckBox uiElement, object dataContext)
   {
       uiElement.SelectionShape = SelectionShape.Circle;
       uiElement.SelectionHighlightMode = SelectionHighlightMode.Filled;
       base.OnInitializeEditElement(dataColumn, uiElement, dataContext);
   }
}

Constructors

TreeGridCellCheckBoxRenderer()

Initializes a new instance of the TreeGridCellCheckBoxRenderer class.

Declaration
public TreeGridCellCheckBoxRenderer()

Fields

IsCheckedProperty

Dependency registration for IsChecked.

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

Methods

CanUpdateBinding(TreeGridColumn)

Determines whether the binding for the column can be updated.Implement this method to update binding on particular renderer whether the data context is set.

Declaration
public override bool CanUpdateBinding(TreeGridColumn column)
Parameters
Type Name Description
TreeGridColumn column

The corresponding column.
Returns
Type Description
System.Boolean

true if the binding is updated for the column; otherwise false.
Overrides

EndEdit(TreeDataColumnBase, Object, Boolean)

Ends the edit occuring on the cell.

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

The data column.
System.Object record

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.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.EndEdit(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, System.Object, System.Boolean)

GetControlValue()

Gets the control value.

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

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.

InitializeCellStyle(TreeDataColumnBase, Object)

Initalize the Cell Style

Declaration
protected override void InitializeCellStyle(TreeDataColumnBase dataColumn, object record)
Parameters
Type Name Description
TreeDataColumnBase dataColumn
System.Object record
Overrides
Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.InitializeCellStyle(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, System.Object)

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.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<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.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.OnEditElementUnloaded(System.Object, System.Windows.RoutedEventArgs)

OnInitializeEditElement(TreeDataColumnBase, CheckBox, Object)

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

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

DataColumn Which holds GridColumn, RowColumnIndex and GridCell
System.Windows.Controls.CheckBox uiElement

Corresponding Renderer Element
System.Object dataContext
Overrides
Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRenderer<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.OnInitializeEditElement(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, System.Windows.Controls.CheckBox, System.Object)

OnUnwireEditUIElement(CheckBox)

Unwires the events associated with edit UIElement

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

The Corresponding UIElement.
Overrides
Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.OnUnwireEditUIElement(System.Windows.Controls.CheckBox)

OnUpdateEditBinding(TreeDataColumnBase, CheckBox, Object)

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

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

TreeDataColumn Which holds TreeGridColumn, RowColumnIndex and GridCell
System.Windows.Controls.CheckBox element

Corresponding Renderer Element
System.Object dataContext

dataContext of the row
Overrides
Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRenderer<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.OnUpdateEditBinding(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, 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

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.TreeGrid.Cells.TreeGridVirtualizingCellRenderer<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>.ShouldGridTryToHandleKeyDown(System.Windows.Input.KeyEventArgs)

Implements

System.IDisposable