menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridVirtualizingCellRenderer<T> - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridVirtualizingCellRenderer<T>

    GridVirtualizingCellRenderer 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 paramater. The class provides strong typed virtual methods for initializing content of the cell and arranging the cell visuals. See GridVirtualizingCellRendererBase<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 GridVirtualizingCellRendererBase. While this class does at the moment not add meaningfull functionality to GridVirtualizingCellRendererBase we created this extra layer of inheritance to make it easy to share code for the GridVirtualizingCellRendererBase base class between grid, tree and common assemblies and keep tree/grid control specific code out of the base class. It is currently not possible with C# to the base class as template type parameter. This is the reason for this copy/paste approach for the codebase for the base class of this class.

    Inheritance
    System.Object
    NonFinalizeDisposable
    Disposable
    CellRendererBase<GridRenderStyleInfo>
    GridCellRendererBase
    GridVirtualizingCellRendererBase<T>
    GridVirtualizingCellRenderer<T>
    GridCellButtonRenderer
    GridCellCheckboxRenderer
    GridCellCurrencyEditCellRenderer
    GridCellDataBoundTemplateRenderer
    GridCellDataTemplateRenderer
    GridCellDateTimeEditCellRenderer
    GridCellDoubleEditCellRenderer
    GridCellDropDownCellRenderer<T>
    GridCellHyperlinkCellRenderer
    GridCellImageContentRenderer
    GridCellIntegerEditCellRenderer
    GridCellMaskEditCellRenderer
    GridCellNestedGridRenderer
    GridCellNestedScrollGridRenderer
    GridCellPercentEditCellRenderer
    GridCellRichTextBoxCellRenderer
    GridCellTextBlockRenderer
    GridCellTextBoxRenderer
    GridCellTimeSpanEditCellRenderer
    GridCellUpDownCellRenderer
    GridDataAddNewRowContentCellRenderer
    GridDataCellNestedGridRenderer
    GridDataFilterBarCellRenderer
    GridDataHeaderCellRenderer
    GridTreeHeaderCellRenderer
    PivotGridExpandCellRenderer
    PivotGridHyperlinkCellRenderer
    PivotGridRowGroupBarRenderer
    PivotGridSortCellRenderer
    PivotGridTemplateCellRenderer
    OlapGridExpandHyperlinkCellRenderer
    OlapGridHyperlinkCellRenderer
    OlapGridKpiCellRenderer
    OlapGridTemplateCellRenderer
    Implements
    IGridCellRenderer
    ICellRenderer
    IHitTestSelectCells
    IStyleChanged
    System.IDisposable
    IAllowKeepAliveOnlyCurrentCell
    Inherited Members
    CellRendererBase<GridRenderStyleInfo>.AllowCancelMouseCapture
    CellRendererBase<GridRenderStyleInfo>.Hide(UIElement)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.Arrange(ArrangeCellArgs)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.CancelMouseCapture(UIElement)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.PrepareUIElements(ArrangeCellArgs, List<UIElement>, ScrollControlChildFrame)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.RecaptureMouse(UIElement)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.Render(DrawingContext, RenderCellArgs)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.UnloadUIElements(VirtualizingCellsControl, RowColumnIndex, CellUIElements)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.UnloadUIElementsWhenScrolledOutOfView
    CellRendererBase<GridRenderStyleInfo>.isInArrange
    CellRendererBase<GridRenderStyleInfo>.IsInArrange
    CellRendererBase<GridRenderStyleInfo>.OnRender(DrawingContext, RenderCellArgs, GridRenderStyleInfo)
    CellRendererBase<GridRenderStyleInfo>.RefreshCellUIElementsContent(VirtualizingCellsControl, CellUIElements, RowColumnIndex)
    CellRendererBase<GridRenderStyleInfo>.UnloadVisualsWhenScrolledOutOfView
    GridCellRendererBase.ActivateOptions
    GridCellRendererBase.AllowGridToFocus
    GridCellRendererBase.ApplyControlText(GridRenderStyleInfo, String)
    GridCellRendererBase.CellModel
    GridCellRendererBase.CellRowColumnIndex
    GridCellRendererBase.ColumnIndex
    GridCellRendererBase.ControlText
    GridCellRendererBase.ControlValue
    GridCellRendererBase.CurrentCell
    GridCellRendererBase.CurrentStyle
    GridCellRendererBase.CurrentStyleCopy
    GridCellRendererBase.EditorType
    GridCellRendererBase.GetControlText(GridRenderStyleInfo)
    GridCellRendererBase.GetControlTextCore(GridRenderStyleInfo, Object)
    GridCellRendererBase.GetControlValue(GridRenderStyleInfo)
    GridCellRendererBase.GridControl
    GridCellRendererBase.HasControlText
    GridCellRendererBase.HasControlValue
    GridCellRendererBase.HasCurrentCellState
    GridCellRendererBase.IGridCellRenderer.RaiseConfirmChangesFailed()
    GridCellRendererBase.IGridCellRenderer.RaiseGridPreviewTextInput(TextCompositionEventArgs)
    GridCellRendererBase.IGridCellRenderer.RenderForPrinting(DrawingContext, RenderCellArgs, GridRenderStyleInfo)
    GridCellRendererBase.IGridCellRenderer.ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs)
    GridCellRendererBase.InInitialize
    GridCellRendererBase.InSetControlText
    GridCellRendererBase.InSetControlValue
    GridCellRendererBase.IsControlTextShown
    GridCellRendererBase.IsCurrentCell(GridControlBase, RowColumnIndex)
    GridCellRendererBase.IsCurrentCell(GridRenderStyleInfo)
    GridCellRendererBase.IsCurrentCell(UIElement)
    GridCellRendererBase.IsDropDownable
    GridCellRendererBase.IsDroppedDown
    GridCellRendererBase.IsEditable
    GridCellRendererBase.IsFocusable
    GridCellRendererBase.IsFocused
    GridCellRendererBase.IsModifiable
    GridCellRendererBase.IsModified
    GridCellRendererBase.MouseDown(FrameworkElement, MouseControllerEventArgs)
    GridCellRendererBase.MoveCurrentHelper(FrameworkElement, MouseControllerEventArgs)
    GridCellRendererBase.NotifyCurrentCellChanged()
    GridCellRendererBase.NotifyCurrentCellChanging()
    GridCellRendererBase.OnActivated()
    GridCellRendererBase.OnActivateFailed()
    GridCellRendererBase.OnActivating()
    GridCellRendererBase.OnClipboardPaste(GridCutPasteEventArgs)
    GridCellRendererBase.OnClipboardPasted(GridCutPasteEventArgs)
    GridCellRendererBase.OnConfirmChangesFailed()
    GridCellRendererBase.OnCreateAutomationPeer()
    GridCellRendererBase.OnCreated()
    GridCellRendererBase.OnDeactivated()
    GridCellRendererBase.OnDeactivateFailed()
    GridCellRendererBase.OnDeactivating()
    GridCellRendererBase.OnEditingComplete()
    GridCellRendererBase.OnEnteredEditMode()
    GridCellRendererBase.OnGridPreviewTextInput(TextCompositionEventArgs)
    GridCellRendererBase.OnInitialize()
    GridCellRendererBase.OnRejectChanges()
    GridCellRendererBase.OnRenderForPrinting(DrawingContext, RenderCellArgs, GridRenderStyleInfo)
    GridCellRendererBase.OnResetFocus()
    GridCellRendererBase.OnSaveChanges()
    GridCellRendererBase.OnSetFocus()
    GridCellRendererBase.OnValidate()
    GridCellRendererBase.OnValidated()
    GridCellRendererBase.RaiseActivated()
    GridCellRendererBase.RaiseActivateFailed()
    GridCellRendererBase.RaiseActivating(GridControlBase, RowColumnIndex, GridActivateCurrentCellOptions)
    GridCellRendererBase.RaiseBeginEdit()
    GridCellRendererBase.RaiseClipboardPaste(GridCutPasteEventArgs)
    GridCellRendererBase.RaiseClipboardPasted(GridCutPasteEventArgs)
    GridCellRendererBase.RaiseCreated(GridCellModelBase)
    GridCellRendererBase.RaiseDeactivated()
    GridCellRendererBase.RaiseDeactivateFailed()
    GridCellRendererBase.RaiseDeactivating()
    GridCellRendererBase.RaiseEditingComplete()
    GridCellRendererBase.RaiseEndEdit()
    GridCellRendererBase.RaiseGridCellClick(Int32, Int32, MouseControllerEventArgs)
    GridCellRendererBase.RaiseInitialize(GridActivateCurrentCellOptions)
    GridCellRendererBase.RaiseRejectChanges()
    GridCellRendererBase.RaiseSaveChanges()
    GridCellRendererBase.RaiseStartEditing()
    GridCellRendererBase.RaiseValidate()
    GridCellRendererBase.RaiseValidated()
    GridCellRendererBase.ResetControlText()
    GridCellRendererBase.ResetControlValue()
    GridCellRendererBase.ResetCurrentCellState()
    GridCellRendererBase.RowIndex
    GridCellRendererBase.ScrollInView()
    GridCellRendererBase.SetControlText(String)
    GridCellRendererBase.SetControlText(String, Boolean)
    GridCellRendererBase.SetControlValue(Object)
    GridCellRendererBase.SetCurrentCellState(GridControlBase, RowColumnIndex, GridActivateCurrentCellOptions)
    GridCellRendererBase.ShouldCurrentCellShowCellText()
    GridCellRendererBase.ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs)
    GridCellRendererBase.StyleChanged(StyleChangedEventArgs)
    GridCellRendererBase.SupportsRenderOptimization
    GridCellRendererBase.UpdateCellRowColumnIndex(RowColumnIndex)
    GridCellRendererBase.UpdateCurrentStyle()
    GridCellRendererBase.ValidateControlText(String)
    GridCellRendererBase.ValidateControlValue(Object)
    GridVirtualizingCellRendererBase<T>.AllowRecycle
    GridVirtualizingCellRendererBase<T>.AllowRecycleIfIsKeyboardFocusWithin
    GridVirtualizingCellRendererBase<T>.AllowTransparentBackground
    GridVirtualizingCellRendererBase<T>.ArrangeUIElement(ArrangeCellArgs, T, GridRenderStyleInfo)
    GridVirtualizingCellRendererBase<T>.CreateUIElement(ArrangeCellArgs, GridRenderStyleInfo)
    GridVirtualizingCellRendererBase<T>.Dispose(Boolean)
    GridVirtualizingCellRendererBase<T>.GetBounds(UIElement)
    GridVirtualizingCellRendererBase<T>.GetUIElement(CellUIElements)
    GridVirtualizingCellRendererBase<T>.InInitializeContent
    GridVirtualizingCellRendererBase<T>.InitializeContent(T, GridRenderStyleInfo)
    GridVirtualizingCellRendererBase<T>.InitializeDefaultProperties(T)
    GridVirtualizingCellRendererBase<T>.InvalidateMeasureRecursive(UIElement)
    GridVirtualizingCellRendererBase<T>.OnArrange(ArrangeCellArgs, GridRenderStyleInfo)
    GridVirtualizingCellRendererBase<T>.OnElementArranged(UIElement, Rect)
    GridVirtualizingCellRendererBase<T>.OnElementMeasured(UIElement, Size)
    GridVirtualizingCellRendererBase<T>.OnPrepareUIElements(ArrangeCellArgs, List<UIElement>, ScrollControlChildFrame, GridRenderStyleInfo)
    GridVirtualizingCellRendererBase<T>.OnUnloadUIElements(VirtualizingCellsControl, RowColumnIndex, CellUIElements)
    GridVirtualizingCellRendererBase<T>.SetBounds(UIElement, Rect)
    GridVirtualizingCellRendererBase<T>.SetBounds(UIElement, Rect, Boolean, Boolean)
    NonFinalizeDisposable.Dispose()
    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()
    Namespace: Syncfusion.Windows.Controls.Grid
    Assembly: Syncfusion.Grid.Wpf.dll
    Syntax
    public abstract class GridVirtualizingCellRenderer<T> : GridVirtualizingCellRendererBase<T>, IGridCellRenderer, ICellRenderer, IHitTestSelectCells, IStyleChanged, IDisposable, IAllowKeepAliveOnlyCurrentCell where T : FrameworkElement, new()
    Type Parameters
    Name Description
    T

    The type of the UIElement that should be placed inside cells

    Constructors

    GridVirtualizingCellRenderer()

    Initializes a new .

    Declaration
    public GridVirtualizingCellRenderer()

    Properties

    AllowKeepAliveOnlyCurrentCell

    Gets or sets whether the renderer will create the UIElement only when BeginEdit is called for the current cell and the UIElement should be discarded once EndEdit or CancelEdit is called. Setting this option is only valid when SupportsRenderOptimization is enabled.

    Declaration
    public bool AllowKeepAliveOnlyCurrentCell { get; set; }
    Property Value
    Type
    System.Boolean

    CurrentCellUIElement

    Gets or sets the UI element for the current cell.

    Declaration
    public T CurrentCellUIElement { get; }
    Property Value
    Type
    T

    Methods

    CreateRendererElement(T, GridRenderStyleInfo)

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

    Declaration
    public override void CreateRendererElement(T uiElement, GridRenderStyleInfo style)
    Parameters
    Type Name Description
    T uiElement

    The current cell ui element.

    GridRenderStyleInfo style

    The cell style info.

    Overrides
    Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRendererBase<T>.CreateRendererElement(T, Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo)

    EmptyRecycleBin()

    Empties recyclebin.

    Declaration
    public override void EmptyRecycleBin()
    Overrides
    GridCellRendererBase.EmptyRecycleBin()

    EnsureCurrentCellUIElement()

    Returns true if current cell holds an UI element.

    Declaration
    public bool EnsureCurrentCellUIElement()
    Returns
    Type Description
    System.Boolean

    True if current cell has an UI element; false otherwise.

    GetControlTextFromEditor()

    Returns the ControlText from the current cell's editor control.

    Declaration
    public override sealed string GetControlTextFromEditor()
    Returns
    Type Description
    System.String

    ControlText of the current cell editor.

    Overrides
    GridCellRendererBase.GetControlTextFromEditor()

    GetControlTextFromEditorCore(T)

    Declaration
    protected virtual string GetControlTextFromEditorCore(T uiElement)
    Parameters
    Type Name Description
    T uiElement
    Returns
    Type
    System.String

    GetControlValueFromEditor()

    Declaration
    protected override object GetControlValueFromEditor()
    Returns
    Type
    System.Object
    Overrides
    GridCellRendererBase.GetControlValueFromEditor()

    GetControlValueFromEditorCore(T)

    Declaration
    protected virtual object GetControlValueFromEditorCore(T uiElement)
    Parameters
    Type Name Description
    T uiElement
    Returns
    Type
    System.Object

    OnCancelMouseCapture(UIElement)

    Declaration
    protected override void OnCancelMouseCapture(UIElement element)
    Parameters
    Type Name Description
    System.Windows.UIElement element
    Overrides
    Syncfusion.Windows.Controls.Cells.CellRendererBase<Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo>.OnCancelMouseCapture(System.Windows.UIElement)

    OnInitializeContent(T, GridRenderStyleInfo)

    Initializes the content of the cell when in edit mode using the information from the cell style (value, text, behavior etc.).

    Declaration
    public override void OnInitializeContent(T uiElement, GridRenderStyleInfo style)
    Parameters
    Type Name Description
    T uiElement

    The current cell ui element.

    GridRenderStyleInfo style

    The cell style info.

    Overrides
    Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRendererBase<T>.OnInitializeContent(T, Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo)

    OnRecaptureMouse(UIElement)

    Declaration
    protected override void OnRecaptureMouse(UIElement element)
    Parameters
    Type Name Description
    System.Windows.UIElement element
    Overrides
    Syncfusion.Windows.Controls.Cells.CellRendererBase<Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo>.OnRecaptureMouse(System.Windows.UIElement)

    OnUnwireUIElement(T)

    Declaration
    protected override void OnUnwireUIElement(T uiElement)
    Parameters
    Type Name Description
    T uiElement
    Overrides
    Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRendererBase<T>.OnUnwireUIElement(T)

    OnWireUIElement(T)

    Declaration
    protected override void OnWireUIElement(T uiElement)
    Parameters
    Type Name Description
    T uiElement
    Overrides
    Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRendererBase<T>.OnWireUIElement(T)

    RaiseGridPreviewMouseMove(RowColumnIndex, MouseEventArgs)

    Triggers GridPreviewMouseMove event.

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

    The cell row column index.

    System.Windows.Input.MouseEventArgs e

    A object.

    Overrides
    GridCellRendererBase.RaiseGridPreviewMouseMove(RowColumnIndex, MouseEventArgs)

    RefreshContent()

    Refreshes the content of current cell.

    Declaration
    public override void RefreshContent()
    Overrides
    GridCellRendererBase.RefreshContent()

    RollbackTextChange(TextBoxBase)

    Declaration
    protected void RollbackTextChange(TextBoxBase textBox)
    Parameters
    Type Name Description
    System.Windows.Controls.Primitives.TextBoxBase textBox

    Implements

    IGridCellRenderer
    ICellRenderer
    IHitTestSelectCells
    IStyleChanged
    System.IDisposable
    IAllowKeepAliveOnlyCurrentCell
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved