WPF

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

    Show / Hide Table of Contents

    Class TreeGridCellCheckBoxRenderer

    Inheritance
    System.Object
    TreeGridCellRendererBase
    TreeGridVirtualizingCellRendererBase<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>
    TreeGridVirtualizingCellRenderer<System.Windows.Controls.CheckBox, System.Windows.Controls.CheckBox>
    TreeGridCellCheckBoxRenderer
    Implements
    ITreeGridCellRenderer
    System.IDisposable
    Inherited Members
    TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>.TextAlignmentToHorizontalAlignment(TextAlignment)
    TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>.CurrentRendererValueChanged()
    TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>.ShouldGridTryToHandleKeyDown(KeyEventArgs)
    TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>.OnInitializeTemplateElement(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>.OnUpdateTemplateBinding(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>.OnInitializeDisplayElement(TreeDataColumnBase, CheckBox, Object)
    TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>.OnUpdateDisplayBinding(TreeDataColumnBase, CheckBox, Object)
    TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>.OnInitializeEditElement(TreeDataColumnBase, CheckBox, Object)
    TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>.OnUpdateEditBinding(TreeDataColumnBase, CheckBox, Object)
    TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>.EditorType
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnPrepareUIElements(TreeDataColumnBase, Object, Boolean)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.BeginEdit(RowColumnIndex, FrameworkElement, TreeGridColumn, Object)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnEnteredEditMode(TreeDataColumnBase, FrameworkElement)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.EndEdit(TreeDataColumnBase, Object, Boolean)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnEditingComplete(TreeDataColumnBase, FrameworkElement)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUnloadUIElements(TreeDataColumnBase)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.UpdateToolTip(TreeDataColumnBase)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnCreateEditUIElement()
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnCreateDisplayUIElement()
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.InitializeEditElement(TreeDataColumnBase, CheckBox, Object)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.InitializeDisplayElement(TreeDataColumnBase, CheckBox, Object)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.InitializeTemplateElement(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnWireDisplayUIElement(CheckBox)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUnwireDisplayUIElement(CheckBox)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnWireTemplateUIElement(ContentControl)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUnwireTemplateUIElement(ContentControl)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnWireEditUIElement(CheckBox)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUnwireEditUIElement(CheckBox)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnEditElementLoaded(Object, RoutedEventArgs)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnEditElementUnloaded(Object, RoutedEventArgs)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnEditElementLostFocus(Object, RoutedEventArgs)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.InitializeCellStyle(TreeDataColumnBase, Object)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.OnUpdateStyleInfo(TreeDataColumn)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.ClearRecycleBin()
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.Dispose(Boolean)
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.DisplayRecycleBin
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.EditRecycleBin
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.TemplateRecycleBin
    TreeGridVirtualizingCellRendererBase<CheckBox, CheckBox>.AllowRecycle
    TreeGridCellRendererBase.OnPrepareUIElements(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.OnPreviewTextInput(TextCompositionEventArgs)
    TreeGridCellRendererBase.CanValidate()
    TreeGridCellRendererBase.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    TreeGridCellRendererBase.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    TreeGridCellRendererBase.UpdateToolTip(TreeDataColumnBase)
    TreeGridCellRendererBase.OnUnloadUIElements(TreeDataColumnBase)
    TreeGridCellRendererBase.OnUpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.SetFocus(FrameworkElement, Boolean)
    TreeGridCellRendererBase.ITreeGridCellRenderer.ShouldGridTryToHandleKeyDown(KeyEventArgs)
    TreeGridCellRendererBase.Arrange(RowColumnIndex, FrameworkElement, Rect)
    TreeGridCellRendererBase.Measure(RowColumnIndex, FrameworkElement, Size)
    TreeGridCellRendererBase.PrepareUIElements(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.UnloadUIElements(TreeDataColumnBase)
    TreeGridCellRendererBase.ITreeGridCellRenderer.UpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.UpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.PreviewTextInput(TextCompositionEventArgs)
    TreeGridCellRendererBase.SetCurrentCellState(RowColumnIndex, FrameworkElement, Boolean, Boolean, TreeGridColumn, TreeDataColumnBase)
    TreeGridCellRendererBase.UpdateCurrentCellState(FrameworkElement, Boolean)
    TreeGridCellRendererBase.ResetCurrentCellState()
    TreeGridCellRendererBase.SetFocus(Boolean)
    TreeGridCellRendererBase.RaiseCurrentCellValidatingEvent(SfTreeGrid, TreeGridColumn, Object, Object, Object, Object, TreeNode)
    TreeGridCellRendererBase.RaiseCurrentCellValidatedEvent(SfTreeGrid, TreeGridColumn, Object, Object, Object, TreeNode)
    TreeGridCellRendererBase.RaiseCurrentCellValueChangedEvent(SfTreeGrid, TreeDataColumnBase)
    TreeGridCellRendererBase.BeginEdit(RowColumnIndex, FrameworkElement, TreeGridColumn, Object)
    TreeGridCellRendererBase.UpdateSource(FrameworkElement)
    TreeGridCellRendererBase.ClearRecycleBin()
    TreeGridCellRendererBase.Dispose()
    TreeGridCellRendererBase.Dispose(Boolean)
    TreeGridCellRendererBase.UpdateCellStyle(TreeDataColumn)
    TreeGridCellRendererBase.OnUpdateStyleInfo(TreeDataColumn)
    TreeGridCellRendererBase.PreviewInputText
    TreeGridCellRendererBase.TreeGrid
    TreeGridCellRendererBase.BindingExpression
    TreeGridCellRendererBase.SupportsRenderOptimization
    TreeGridCellRendererBase.UseOnlyRendererElement
    TreeGridCellRendererBase.HasCurrentCellState
    TreeGridCellRendererBase.CurrentCellIndex
    TreeGridCellRendererBase.CurrentCellElement
    TreeGridCellRendererBase.CurrentCellRendererElement
    TreeGridCellRendererBase.IsInEditing
    TreeGridCellRendererBase.IsFocused
    TreeGridCellRendererBase.IsEditable
    TreeGridCellRendererBase.IsFocusable
    TreeGridCellRendererBase.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.TreeGrid.Cells
    Assembly: Syncfusion.SfGrid.WPF.dll
    Syntax
    public class TreeGridCellCheckBoxRenderer : TreeGridVirtualizingCellRenderer<CheckBox, CheckBox>, ITreeGridCellRenderer, IDisposable

    Constructors

    TreeGridCellCheckBoxRenderer()

    Initializes a new instance of the class.

    Declaration
    public TreeGridCellCheckBoxRenderer()

    Fields

    IsCheckedProperty

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

    Methods

    CanUpdateBinding(TreeGridColumn)

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

    EndEdit(TreeDataColumnBase, Object, Boolean)

    Declaration
    public override bool EndEdit(TreeDataColumnBase dc, object record, bool canResetBinding = false)
    Parameters
    Type Name Description
    TreeDataColumnBase dc
    System.Object record
    System.Boolean canResetBinding
    Returns
    Type Description
    System.Boolean
    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
    TreeGridCellRendererBase.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.

    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)

    Declaration
    protected override void OnUnwireEditUIElement(CheckBox uiElement)
    Parameters
    Type Name Description
    System.Windows.Controls.CheckBox 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
    TreeGridCellRendererBase.SetControlValue(Object)

    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

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