menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridVirtualizingCellRenderer<D, E> - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TreeGridVirtualizingCellRenderer<D, E>

    TreeGridVirtualizingCellRenderer is an abstract base class for cell renderers that need live UIElement visuals displayed in a cell. You can derive from this class and provide the type of the UIElement you want to show inside cells as type parameter. The class provides strong typed virtual methods for initializing content of the cell and arranging the cell visuals. See TreeGridVirtualizingCellRendererBase{T} for more details.

    The idea behind this class is to provide a place where we can add general code that should be shared for all cell renderers in the tree derived from TreeGridVirtualizingCellRendererBase. While this class does at the moment not add meaningful functionality to TreeGridVirtualizingCellRendererBase we created this extra layer of inheritance to make it easy to share code for the TreeGridVirtualizingCellRendererBase base class between grid and common assemblies and keep grid control specific code out of the base class. It is currently not possible with C# to the base class as template type parameter.

    Inheritance
    System.Object
    TreeGridCellRendererBase
    TreeGridVirtualizingCellRendererBase<D, E>
    TreeGridVirtualizingCellRenderer<D, E>
    TreeGridCellCheckBoxRenderer
    TreeGridCellComboBoxRenderer
    TreeGridCellCurrencyRenderer
    TreeGridCellDateTimeRenderer
    TreeGridCellHyperlinkRenderer
    TreeGridCellMaskRenderer
    TreeGridCellNumericRenderer
    TreeGridCellPercentageRenderer
    TreeGridCellTemplateRenderer
    TreeGridCellTextBlockRenderer
    TreeGridCellTextBoxRenderer
    TreeGridHeaderCellRenderer
    TreeGridRowHeaderCellRenderer
    TreeGridStackedHeaderCellRenderer
    Implements
    ITreeGridCellRenderer
    System.IDisposable
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    TreeGridCellRendererBase.Arrange(RowColumnIndex, FrameworkElement, Rect)
    TreeGridCellRendererBase.BeginEdit(RowColumnIndex, FrameworkElement, TreeGridColumn, Object)
    TreeGridCellRendererBase.BindingExpression
    TreeGridCellRendererBase.CanUpdateBinding(TreeGridColumn)
    TreeGridCellRendererBase.CanValidate()
    TreeGridCellRendererBase.ClearRecycleBin()
    TreeGridCellRendererBase.CurrentCellElement
    TreeGridCellRendererBase.CurrentCellIndex
    TreeGridCellRendererBase.CurrentCellRendererElement
    TreeGridCellRendererBase.Dispose()
    TreeGridCellRendererBase.Dispose(Boolean)
    TreeGridCellRendererBase.EndEdit(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.GetControlValue()
    TreeGridCellRendererBase.HasCurrentCellState
    TreeGridCellRendererBase.IsDropDownable
    TreeGridCellRendererBase.IsEditable
    TreeGridCellRendererBase.IsFocusable
    TreeGridCellRendererBase.IsFocused
    TreeGridCellRendererBase.IsInEditing
    TreeGridCellRendererBase.ITreeGridCellRenderer.ShouldGridTryToHandleKeyDown(KeyEventArgs)
    TreeGridCellRendererBase.ITreeGridCellRenderer.UpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.Measure(RowColumnIndex, FrameworkElement, Size)
    TreeGridCellRendererBase.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    TreeGridCellRendererBase.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    TreeGridCellRendererBase.OnPrepareUIElements(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.OnPreviewTextInput(TextCompositionEventArgs)
    TreeGridCellRendererBase.OnUnloadUIElements(TreeDataColumnBase)
    TreeGridCellRendererBase.OnUpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.OnUpdateStyleInfo(TreeDataColumn)
    TreeGridCellRendererBase.PrepareUIElements(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.PreviewInputText
    TreeGridCellRendererBase.PreviewTextInput(TextCompositionEventArgs)
    TreeGridCellRendererBase.RaiseCurrentCellValidatedEvent(SfTreeGrid, TreeGridColumn, Object, Object, Object, TreeNode)
    TreeGridCellRendererBase.RaiseCurrentCellValidatingEvent(SfTreeGrid, TreeGridColumn, Object, Object, Object, Object, TreeNode)
    TreeGridCellRendererBase.RaiseCurrentCellValueChangedEvent(SfTreeGrid, TreeDataColumnBase)
    TreeGridCellRendererBase.ResetCurrentCellState()
    TreeGridCellRendererBase.SetControlValue(Object)
    TreeGridCellRendererBase.SetCurrentCellState(RowColumnIndex, FrameworkElement, Boolean, Boolean, TreeGridColumn, TreeDataColumnBase)
    TreeGridCellRendererBase.SetFocus(Boolean)
    TreeGridCellRendererBase.SetFocus(FrameworkElement, Boolean)
    TreeGridCellRendererBase.SupportsRenderOptimization
    TreeGridCellRendererBase.TreeGrid
    TreeGridCellRendererBase.UnloadUIElements(TreeDataColumnBase)
    TreeGridCellRendererBase.UpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.UpdateCellStyle(TreeDataColumn)
    TreeGridCellRendererBase.UpdateCurrentCellState(FrameworkElement, Boolean)
    TreeGridCellRendererBase.UpdateSource(FrameworkElement)
    TreeGridCellRendererBase.UpdateToolTip(TreeDataColumnBase)
    TreeGridCellRendererBase.UseOnlyRendererElement
    TreeGridVirtualizingCellRendererBase<D, E>.AllowRecycle
    TreeGridVirtualizingCellRendererBase<D, E>.BeginEdit(RowColumnIndex, FrameworkElement, TreeGridColumn, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.ClearRecycleBin()
    TreeGridVirtualizingCellRendererBase<D, E>.DisplayRecycleBin
    TreeGridVirtualizingCellRendererBase<D, E>.Dispose(Boolean)
    TreeGridVirtualizingCellRendererBase<D, E>.EditRecycleBin
    TreeGridVirtualizingCellRendererBase<D, E>.EndEdit(TreeDataColumnBase, Object, Boolean)
    TreeGridVirtualizingCellRendererBase<D, E>.InitializeCellStyle(TreeDataColumnBase, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.InitializeDisplayElement(TreeDataColumnBase, D, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.InitializeEditElement(TreeDataColumnBase, E, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.InitializeTemplateElement(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    TreeGridVirtualizingCellRendererBase<D, E>.OnCreateDisplayUIElement()
    TreeGridVirtualizingCellRendererBase<D, E>.OnCreateEditUIElement()
    TreeGridVirtualizingCellRendererBase<D, E>.OnEditElementLoaded(Object, RoutedEventArgs)
    TreeGridVirtualizingCellRendererBase<D, E>.OnEditElementLostFocus(Object, RoutedEventArgs)
    TreeGridVirtualizingCellRendererBase<D, E>.OnEditElementUnloaded(Object, RoutedEventArgs)
    TreeGridVirtualizingCellRendererBase<D, E>.OnEditingComplete(TreeDataColumnBase, FrameworkElement)
    TreeGridVirtualizingCellRendererBase<D, E>.OnEnteredEditMode(TreeDataColumnBase, FrameworkElement)
    TreeGridVirtualizingCellRendererBase<D, E>.OnInitializeDisplayElement(TreeDataColumnBase, D, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.OnInitializeEditElement(TreeDataColumnBase, E, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.OnInitializeTemplateElement(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    TreeGridVirtualizingCellRendererBase<D, E>.OnPrepareUIElements(TreeDataColumnBase, Object, Boolean)
    TreeGridVirtualizingCellRendererBase<D, E>.OnUnloadUIElements(TreeDataColumnBase)
    TreeGridVirtualizingCellRendererBase<D, E>.OnUnwireDisplayUIElement(D)
    TreeGridVirtualizingCellRendererBase<D, E>.OnUnwireEditUIElement(E)
    TreeGridVirtualizingCellRendererBase<D, E>.OnUnwireTemplateUIElement(ContentControl)
    TreeGridVirtualizingCellRendererBase<D, E>.OnUpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridVirtualizingCellRendererBase<D, E>.OnUpdateDisplayBinding(TreeDataColumnBase, D, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.OnUpdateEditBinding(TreeDataColumnBase, E, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.OnUpdateStyleInfo(TreeDataColumn)
    TreeGridVirtualizingCellRendererBase<D, E>.OnUpdateTemplateBinding(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRendererBase<D, E>.OnWireDisplayUIElement(D)
    TreeGridVirtualizingCellRendererBase<D, E>.OnWireEditUIElement(E)
    TreeGridVirtualizingCellRendererBase<D, E>.OnWireTemplateUIElement(ContentControl)
    TreeGridVirtualizingCellRendererBase<D, E>.TemplateRecycleBin
    TreeGridVirtualizingCellRendererBase<D, E>.UpdateToolTip(TreeDataColumnBase)
    Namespace: Syncfusion.UI.Xaml.TreeGrid.Cells
    Assembly: Syncfusion.SfGrid.WPF.dll
    Syntax
    public abstract class TreeGridVirtualizingCellRenderer<D, E> : TreeGridVirtualizingCellRendererBase<D, E>, ITreeGridCellRenderer, IDisposable where D : FrameworkElement, new()
        where E : FrameworkElement, new()
    Type Parameters
    Name Description
    D

    D is a DisplayElement which is used to display the value on initilal loading of treegrid

    E

    E is a EditElement which is used to show the displayed data in the edit mode

    Constructors

    TreeGridVirtualizingCellRenderer()

    Initializes a new instance of TreeGridVirtualizingCellRenderer<D, E> class.

    Declaration
    protected TreeGridVirtualizingCellRenderer()

    Properties

    EditorType

    Gets or sets the Editor type.

    Declaration
    public Type EditorType { get; set; }
    Property Value
    Type Description
    System.Type

    Return the editor type.

    Methods

    CurrentRendererValueChanged()

    Invoked when the current renderer changed.

    Declaration
    protected virtual void CurrentRendererValueChanged()

    OnInitializeDisplayElement(TreeDataColumnBase, D, Object)

    Initialize the binding for display element of corresponding column.

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

    Specifies the dataColumn which contain TreeGridColumn, RowColumnIndex

    D uiElement

    Specifies the display control to initialize binding

    System.Object dataContext

    Specifies the data context of the particular row

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<D, E>.OnInitializeDisplayElement(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, D, System.Object)

    OnInitializeEditElement(TreeDataColumnBase, E, Object)

    Initialize the binding for editor control of corresponding column.

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

    Specifies the dataColumn which contain TreeGridColumn, RowColumnIndex

    E uiElement

    Specifies the data context of the particular row

    System.Object dataContext

    Specifies the data context of the particular row

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<D, E>.OnInitializeEditElement(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, E, System.Object)

    OnInitializeTemplateElement(TreeDataColumnBase, ContentControl, Object)

    Initialize the binding for TreeGridCell by Columns's CellTemplate and CellTemplateSelector.

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

    Specifies the dataColumn which contain TreeGridColumn, RowColumnIndex

    System.Windows.Controls.ContentControl uiElement

    Specifies the display control to initialize binding

    System.Object dataContext

    Specifies the data context of the particular row

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<D, E>.OnInitializeTemplateElement(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, System.Windows.Controls.ContentControl, System.Object)

    OnUpdateDisplayBinding(TreeDataColumnBase, D, Object)

    Updates the binding for display element of corresponding column.

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

    Specifies the TreeDataColumnBase.

    D uiElement

    Specifies the data context of the particular row.

    System.Object dataContext

    Specifies the data context of the particular row.

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<D, E>.OnUpdateDisplayBinding(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, D, System.Object)

    OnUpdateEditBinding(TreeDataColumnBase, E, Object)

    Updates the binding for editor control of corresponding column.

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

    Specifies the TreeDataColumnBase.

    E element

    Specifies the data context of the particular row.

    System.Object dataContext

    Specifies the data context of the particular row.

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<D, E>.OnUpdateEditBinding(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, E, System.Object)

    OnUpdateTemplateBinding(TreeDataColumnBase, ContentControl, Object)

    Updates the binding for the TreeGridCell by Column's CellTemplate and CellTemplateSelector.

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

    Specifies the dataColumn which contain TreeGridColumn, RowColumnIndex

    System.Windows.Controls.ContentControl uiElement

    Specifies the display control to initialize binding

    System.Object dataContext

    Specifies the data context of the particular row

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<D, E>.OnUpdateTemplateBinding(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, System.Windows.Controls.ContentControl, System.Object)

    ShouldGridTryToHandleKeyDown(KeyEventArgs)

    Handles the key interaction with editor of corresponding column.

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

    A System.Windows.Input.KeyEventArgs that contains event data.

    Returns
    Type Description
    System.Boolean

    Returns True if the parent grid should be allowed to handle keys; otherwise False.

    Overrides
    TreeGridCellRendererBase.ShouldGridTryToHandleKeyDown(KeyEventArgs)

    TextAlignmentToHorizontalAlignment(TextAlignment)

    Method to return the horizontal alignment for the text.

    Declaration
    protected HorizontalAlignment TextAlignmentToHorizontalAlignment(TextAlignment textAlignment)
    Parameters
    Type Name Description
    System.Windows.TextAlignment textAlignment

    The text alignment.

    Returns
    Type Description
    System.Windows.HorizontalAlignment

    HorizontalAlignment of text

    Implements

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