WPF

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

    Show / Hide Table of Contents

    Class GridVirtualizingCellRenderer<D, E>

    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 parameter. 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 meaningful functionality to GridVirtualizingCellRendererBase we created this extra layer of inheritance to make it easy to share code for the GridVirtualizingCellRendererBase 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
    GridCellRendererBase
    GridVirtualizingCellRendererBase<D, E>
    GridVirtualizingCellRenderer<D, E>
    GridCaptionSummaryCellRenderer
    GridCellCheckBoxRenderer
    GridCellCheckBoxSelectorRenderer
    GridCellComboBoxRenderer
    GridCellCurrencyRenderer
    GridCellDateTimeRenderer
    GridCellHyperlinkRenderer
    GridCellImageRenderer
    GridCellMaskRenderer
    GridCellMultiColumnDropDownRenderer
    GridCellNumericRenderer
    GridCellPercentageRenderer
    GridCellTemplateRenderer
    GridCellTextBlockRenderer
    GridCellTextBoxRenderer
    GridCellTimeSpanRenderer
    GridDataHeaderCellRenderer
    GridDetailsViewExpanderCellRenderer
    GridStackedHeaderCellRenderer
    GridSummaryCellRenderer
    GridTableSummaryCellRenderer
    GridUnBoundCellTemplateRenderer
    GridUnBoundCellTextBoxRenderer
    GridUnBoundRowCellRenderer<D, E>
    GridRowHeaderCellRenderer
    GridFilterRowCellRenderer<D, E>
    Implements
    IGridCellRenderer
    System.IDisposable
    Inherited Members
    GridVirtualizingCellRendererBase<D, E>.OnPrepareUIElements(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<D, E>.BeginEdit(RowColumnIndex, FrameworkElement, GridColumn, Object)
    GridVirtualizingCellRendererBase<D, E>.OnEnteredEditMode(DataColumnBase, FrameworkElement)
    GridVirtualizingCellRendererBase<D, E>.EndEdit(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<D, E>.OnEditingComplete(DataColumnBase, FrameworkElement)
    GridVirtualizingCellRendererBase<D, E>.OnUnloadUIElements(DataColumnBase)
    GridVirtualizingCellRendererBase<D, E>.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    GridVirtualizingCellRendererBase<D, E>.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    GridVirtualizingCellRendererBase<D, E>.OnRenderCell(DrawingContext, Rect, DataColumnBase, Object)
    GridVirtualizingCellRendererBase<D, E>.OnRenderCellBorder(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridVirtualizingCellRendererBase<D, E>.OnRenderContent(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, Object)
    GridVirtualizingCellRendererBase<D, E>.DrawFormattedText(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, String)
    GridVirtualizingCellRendererBase<D, E>.DrawGlyphs(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, String)
    GridVirtualizingCellRendererBase<D, E>.OnRenderCurrentCell(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridVirtualizingCellRendererBase<D, E>.OnUpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<D, E>.OnUpdateStyleInfo(DataColumnBase, Object)
    GridVirtualizingCellRendererBase<D, E>.OnCreateEditUIElement()
    GridVirtualizingCellRendererBase<D, E>.OnCreateDisplayUIElement()
    GridVirtualizingCellRendererBase<D, E>.OnInitializeDisplayElement(DataColumnBase, D, Object)
    GridVirtualizingCellRendererBase<D, E>.OnUpdateDisplayBinding(DataColumnBase, D, Object)
    GridVirtualizingCellRendererBase<D, E>.OnInitializeTemplateElement(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRendererBase<D, E>.OnUpdateTemplateBinding(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRendererBase<D, E>.OnInitializeEditElement(DataColumnBase, E, Object)
    GridVirtualizingCellRendererBase<D, E>.OnUpdateEditBinding(DataColumnBase, E, Object)
    GridVirtualizingCellRendererBase<D, E>.InitializeEditElement(DataColumnBase, E, Object)
    GridVirtualizingCellRendererBase<D, E>.InitializeDisplayElement(DataColumnBase, D, Object)
    GridVirtualizingCellRendererBase<D, E>.InitializeTemplateElement(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRendererBase<D, E>.OnWireDisplayUIElement(D)
    GridVirtualizingCellRendererBase<D, E>.OnUnwireDisplayUIElement(D)
    GridVirtualizingCellRendererBase<D, E>.OnWireTemplateUIElement(ContentControl)
    GridVirtualizingCellRendererBase<D, E>.OnUnwireTemplateUIElement(ContentControl)
    GridVirtualizingCellRendererBase<D, E>.OnWireEditUIElement(E)
    GridVirtualizingCellRendererBase<D, E>.OnUnwireEditUIElement(E)
    GridVirtualizingCellRendererBase<D, E>.OnEditElementLoaded(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<D, E>.OnEditElementUnloaded(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<D, E>.OnEditElementLostFocus(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<D, E>.InitializeCellStyle(DataColumnBase, Object)
    GridVirtualizingCellRendererBase<D, E>.ClearRecycleBin()
    GridVirtualizingCellRendererBase<D, E>.Dispose(Boolean)
    GridVirtualizingCellRendererBase<D, E>.OnCreateTemplateUIElement()
    GridVirtualizingCellRendererBase<D, E>.DisplayRecycleBin
    GridVirtualizingCellRendererBase<D, E>.EditRecycleBin
    GridVirtualizingCellRendererBase<D, E>.TemplateRecycleBin
    GridVirtualizingCellRendererBase<D, E>.AllowRecycle
    GridCellRendererBase.OnPrepareUIElements(DataColumnBase, Object, Boolean)
    GridCellRendererBase.OnPrepareUIElements()
    GridCellRendererBase.OnPreviewTextInput(TextCompositionEventArgs)
    GridCellRendererBase.CanValidate()
    GridCellRendererBase.CanUpdateBinding(GridColumn)
    GridCellRendererBase.CommitUnBoundCellValue(Object, GridColumn, Object)
    GridCellRendererBase.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    GridCellRendererBase.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    GridCellRendererBase.OnRenderCell(DrawingContext, Rect, DataColumnBase, Object)
    GridCellRendererBase.OnRenderCellBorder(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridCellRendererBase.OnRenderContent(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, Object)
    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.GetControlValue()
    GridCellRendererBase.SetControlValue(Object)
    GridCellRendererBase.SetCurrentCellState(RowColumnIndex, FrameworkElement, Boolean, Boolean, GridColumn, DataColumnBase)
    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.EndEdit(DataColumnBase, Object, Boolean)
    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
    public abstract class GridVirtualizingCellRenderer<D, E> : GridVirtualizingCellRendererBase<D, E>, IGridCellRenderer, IDisposable where D : FrameworkElement, new()
        where E : FrameworkElement, new()
    Type Parameters
    Name Description
    D
    E

    Constructors

    GridVirtualizingCellRenderer()

    Declaration
    protected GridVirtualizingCellRenderer()

    Properties

    EditorType

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

    Methods

    CurrentRendererValueChanged()

    Declaration
    protected virtual void CurrentRendererValueChanged()

    OnInitializeDisplayElement(DataColumnBase, D, Object)

    Initialize the binding for display element of corresponding column.

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

    Specifies the dataColumn which contain GridColumn, 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.Grid.Cells.GridVirtualizingCellRendererBase<D, E>.OnInitializeDisplayElement(Syncfusion.UI.Xaml.Grid.DataColumnBase, D, System.Object)

    OnInitializeEditElement(DataColumnBase, E, Object)

    Initialize the binding for editor control of corresponding column.

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

    Specifies the dataColumn which contain GridColumn, 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.Grid.Cells.GridVirtualizingCellRendererBase<D, E>.OnInitializeEditElement(Syncfusion.UI.Xaml.Grid.DataColumnBase, E, System.Object)

    OnInitializeTemplateElement(DataColumnBase, ContentControl, Object)

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

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

    Specifies the dataColumn which contain GridColumn, 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.Grid.Cells.GridVirtualizingCellRendererBase<D, E>.OnInitializeTemplateElement(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Windows.Controls.ContentControl, System.Object)

    OnUpdateDisplayBinding(DataColumnBase, D, Object)

    Updates the binding for display element of corresponding column.

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

    Specifies the dataColumn which contain GridColumn, RowColumnIndex

    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.Grid.Cells.GridVirtualizingCellRendererBase<D, E>.OnUpdateDisplayBinding(Syncfusion.UI.Xaml.Grid.DataColumnBase, D, System.Object)

    OnUpdateEditBinding(DataColumnBase, E, Object)

    Updates the binding for editor control of corresponding column.

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

    Specifies the dataColumn which contain GridColumn, RowColumnIndex

    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.Grid.Cells.GridVirtualizingCellRendererBase<D, E>.OnUpdateEditBinding(Syncfusion.UI.Xaml.Grid.DataColumnBase, E, System.Object)

    OnUpdateTemplateBinding(DataColumnBase, ContentControl, Object)

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

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

    Specifies the dataColumn which contain GridColumn, 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.Grid.Cells.GridVirtualizingCellRendererBase<D, E>.OnUpdateTemplateBinding(Syncfusion.UI.Xaml.Grid.DataColumnBase, 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
    Returns
    Type Description
    System.Boolean

    Returns true handled by SfDataGrid. Returns false handled by editor of column.

    Overrides
    GridCellRendererBase.ShouldGridTryToHandleKeyDown(KeyEventArgs)

    TextAlignmentToHorizontalAlignment(TextAlignment)

    Texts the alignment to horizontal alignment.

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

    The text alignment.

    Returns
    Type Description
    System.Windows.HorizontalAlignment

    UpdateToolTip(DataColumnBase)

    Updates the tool tip for GridCell.

    Declaration
    public override void UpdateToolTip(DataColumnBase dataColumn)
    Parameters
    Type Name Description
    DataColumnBase dataColumn

    Which holds GridColumn, Row Column Index and GridCell

    Overrides
    GridCellRendererBase.UpdateToolTip(DataColumnBase)

    Implements

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