Class GridVirtualizingCellRendererBase<D, E>

Inheritance
System.Object
GridCellRendererBase
GridVirtualizingCellRendererBase<D, E>
GridVirtualizingCellRenderer<D, E>
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.CellGrid.GridCellRenderer
Assembly: Syncfusion.SfCellGrid.WPF.dll
Syntax
public abstract class GridVirtualizingCellRendererBase<D, E> : GridCellRendererBase, IGridCellRenderer, IDisposable where D : FrameworkElement, new()
    where E : FrameworkElement, new()
Type Parameters
Name
D
E

Constructors

GridVirtualizingCellRendererBase()

Declaration
public GridVirtualizingCellRendererBase()

Fields

DisplayRecycleBin

Creates a new instance of class.

Declaration
protected VirtualizingCellUIElementBin<D> DisplayRecycleBin
Field Value
Type
VirtualizingCellUIElementBin<D>

EditRecycleBin

Creates a new instance of class.

Declaration
protected VirtualizingCellUIElementBin<E> EditRecycleBin
Field Value
Type
VirtualizingCellUIElementBin<E>

TemplateRecycleBin

Creates a new instance of class.

Declaration
protected VirtualizingCellUIElementBin<ContentControl> TemplateRecycleBin
Field Value
Type
VirtualizingCellUIElementBin<System.Windows.Controls.ContentControl>

Properties

AllowRecycle

Gets or sets a value indicating whether elements can be recycled when scrolled out of view. In this case when a cell is scrolled out of view it is moved into a recycle bin and the next time a new element is scrolled into view the element is recovered from the recycle bin and reinitialized with the new content of the cell. The default value is false.

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

true if elements can be recycled when scrolled out of view; otherwise, false.

Methods

BeginEdit(RowColumnIndex, GridCell, GridStyleInfo, String)

Declaration
public override sealed bool BeginEdit(RowColumnIndex cellRowColumnIndex, GridCell cellContainer, GridStyleInfo style, string text)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex
GridCell cellContainer
GridStyleInfo style
System.String text
Returns
Type
System.Boolean
Overrides

ClearRecycleBin()

Clears all the items from RecycleBin.

Declaration
public override void ClearRecycleBin()
Overrides

Dispose(Boolean)

Releases all resources used by the Syncfusion.UI.Xaml.Spreadsheet.CellRenderer.SpreadsheetVirtualizingCellRendererBase.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Dispose the instance, if it is True
Overrides
Remarks

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

EndEdit(RowColumnIndex, GridCell, GridStyleInfo)

Declaration
public override sealed bool EndEdit(RowColumnIndex cellRowColumnIndex, GridCell cellContainer, GridStyleInfo style)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex
GridCell cellContainer
GridStyleInfo style
Returns
Type
System.Boolean
Overrides

GetFormattedText(GridStyleInfo)

Declaration
public override string GetFormattedText(GridStyleInfo style)
Parameters
Type Name Description
GridStyleInfo style
Returns
Type
System.String
Overrides

InitializeDisplayElement(RowColumnIndex, D, GridStyleInfo, String)

Declaration
public void InitializeDisplayElement(RowColumnIndex rowColumnIndex, D uiElement, GridStyleInfo style, string text)
Parameters
Type Name Description
RowColumnIndex rowColumnIndex
D uiElement
GridStyleInfo style
System.String text

InitializeEditElement(RowColumnIndex, E, GridStyleInfo, String)

Declaration
public void InitializeEditElement(RowColumnIndex rowColumnIndex, E uiElement, GridStyleInfo style, string text)
Parameters
Type Name Description
RowColumnIndex rowColumnIndex
E uiElement
GridStyleInfo style
System.String text

InitializeTemplateElement(RowColumnIndex, ContentControl, GridStyleInfo)

Declaration
public void InitializeTemplateElement(RowColumnIndex rowColumnIndex, ContentControl uiElement, GridStyleInfo style)
Parameters
Type Name Description
RowColumnIndex rowColumnIndex
System.Windows.Controls.ContentControl uiElement
GridStyleInfo style

OnArrange(RowColumnIndex, UIElement, Rect)

Invoked when the visual children of cell is arranged in view.

Declaration
protected override void OnArrange(RowColumnIndex cellRowColumnIndex, UIElement uiElement, Rect cellRect)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex

The Coordinates of the cell.
System.Windows.UIElement uiElement

The corresponding UIElement that is to be arranged.
System.Windows.Rect cellRect

The corresponding size of cell element for arranging the UIElement.
Overrides

OnCreateDisplayUIElement()

Creates a new UIElement for the display mode of cell.

Declaration
protected virtual D OnCreateDisplayUIElement()
Returns
Type Description
D

A UIElement for the display mode.

OnCreateEditUIElement()

Creates a new UIElement for the edit mode of cell.

Declaration
protected virtual E OnCreateEditUIElement()
Returns
Type Description
E

A UIElement for the edit mode.

OnCreateTemplateUIElement()

Creates a new template UIElement for the cell.

Declaration
protected virtual ContentControl OnCreateTemplateUIElement()
Returns
Type Description
System.Windows.Controls.ContentControl

An instance of System.Windows.Controls.

OnEditElementLoaded(Object, RoutedEventArgs)

Occurs when the Edit UIElement loaded in .

Declaration
protected virtual void OnEditElementLoaded(object sender, RoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Windows.RoutedEventArgs e

An System.Windows.RoutedEventArgs that contains the event data.

OnEditElementLostFocus(Object, RoutedEventArgs)

Occurs when the Edit UIElement loses its logical focus.

Declaration
protected virtual void OnEditElementLostFocus(object sender, RoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Windows.RoutedEventArgs e

An System.Windows.RoutedEventArgs that contains the event data.

OnEditingComplete(UIElement)

Invoked when the editing operation is completed on the cell.

Declaration
protected virtual void OnEditingComplete(UIElement currentRendererElement)
Parameters
Type Name Description
System.Windows.UIElement currentRendererElement

An instance of System.Windows.UIElement.

OnEnteredEditMode(UIElement)

Invoked when the cell is being entered into the edit mode.

Declaration
protected virtual void OnEnteredEditMode(UIElement currentRendererElement)
Parameters
Type Name Description
System.Windows.UIElement currentRendererElement

An instance of System.Windows.UIElement.

OnInitializeDisplayElement(RowColumnIndex, D, GridStyleInfo, String)

Declaration
protected abstract void OnInitializeDisplayElement(RowColumnIndex rowColumnIndex, D uiElement, GridStyleInfo style, string text)
Parameters
Type Name Description
RowColumnIndex rowColumnIndex
D uiElement
GridStyleInfo style
System.String text

OnInitializeEditElement(RowColumnIndex, E, GridStyleInfo, String)

Declaration
protected abstract void OnInitializeEditElement(RowColumnIndex rowColumnIndex, E uiElement, GridStyleInfo style, string text)
Parameters
Type Name Description
RowColumnIndex rowColumnIndex
E uiElement
GridStyleInfo style
System.String text

OnInitializeTemplateElement(RowColumnIndex, ContentControl, GridStyleInfo)

Declaration
protected abstract void OnInitializeTemplateElement(RowColumnIndex rowColumnIndex, ContentControl uiElement, GridStyleInfo style)
Parameters
Type Name Description
RowColumnIndex rowColumnIndex
System.Windows.Controls.ContentControl uiElement
GridStyleInfo style

OnMeasure(RowColumnIndex, UIElement, Size)

Invoked to determine the size of the current cell.

Declaration
protected override void OnMeasure(RowColumnIndex cellRowColumnIndex, UIElement uiElement, Size availableSize)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex

Coordinates of a cell.
System.Windows.UIElement uiElement

The corresponding UIElement to measure.
System.Windows.Size availableSize

The size of element.
Overrides

OnPrepareUIElements(RowColumnIndex, GridCell, GridStyleInfo, String, Boolean)

Declaration
protected override sealed GridCell OnPrepareUIElements(RowColumnIndex cellRowColumnIndex, GridCell cellContainer, GridStyleInfo style, string text, bool isInEdit)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex
GridCell cellContainer
GridStyleInfo style
System.String text
System.Boolean isInEdit
Returns
Type
GridCell
Overrides

OnUnloadUIElements(GridCell)

Invoked when the cell is scrolled out of view or unloaded from the view. overrides this method and either removes the cell renderer visuals from the parent or hide them and reuse it later in same element depending on whether was set.

Declaration
protected override void OnUnloadUIElements(GridCell uiElement)
Parameters
Type Name Description
GridCell uiElement

An instance of GridCell.
Overrides

OnUnwireDisplayUIElement(D)

Unwires the events associated with display UIElement.

Declaration
protected virtual void OnUnwireDisplayUIElement(D uiElement)
Parameters
Type Name Description
D uiElement

The corresponding display UIElement to unwire its events.

OnUnwireEditUIElement(E)

Unwires the events associated with edit UIElement.

Declaration
protected virtual void OnUnwireEditUIElement(E uiElement)
Parameters
Type Name Description
E uiElement

The corresponding edit UIElement to unwire its events.

OnUnWireTemplateUIElement(ContentControl)

Unwires the events associated with template UIElement.

Declaration
protected virtual void OnUnWireTemplateUIElement(ContentControl uiElement)
Parameters
Type Name Description
System.Windows.Controls.ContentControl uiElement

The corresponding template UIElement to unwire its events.

OnUpdateCellStyle(RowColumnIndex, D, GridStyleInfo, String)

Declaration
protected virtual void OnUpdateCellStyle(RowColumnIndex cellRowColumnIndex, D uiElement, GridStyleInfo style, string text)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex
D uiElement
GridStyleInfo style
System.String text

OnUpdateEditCellStyle(RowColumnIndex, E, GridStyleInfo, String)

Declaration
protected virtual void OnUpdateEditCellStyle(RowColumnIndex cellRowColumnIndex, E uiElement, GridStyleInfo style, string text)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex
E uiElement
GridStyleInfo style
System.String text

OnUpdateTemplateElement(ContentControl, GridStyleInfo)

Updates the Template UIElement with particular style info.

Declaration
protected virtual void OnUpdateTemplateElement(ContentControl uiElement, GridStyleInfo style)
Parameters
Type Name Description
System.Windows.Controls.ContentControl uiElement

Corresponding UIElement to update the template element.
GridStyleInfo style

An instance of IStyle.

OnWireDisplayUIElement(D)

Wires the events associated with display UIElement.

Declaration
protected virtual void OnWireDisplayUIElement(D uiElement)
Parameters
Type Name Description
D uiElement

The corresponding display UIElement to wire its events.

OnWireEditUIElement(E)

Wires the events associated with edit UIElement.

Declaration
protected virtual void OnWireEditUIElement(E uiElement)
Parameters
Type Name Description
E uiElement

The corresponding edit UIElement to wire its events.

OnWireTemplateUIElement(ContentControl)

Wires the events associated with template UIElement.

Declaration
protected virtual void OnWireTemplateUIElement(ContentControl uiElement)
Parameters
Type Name Description
System.Windows.Controls.ContentControl uiElement

The corresponding template UIElement to wire its events.

UpdateCellStyle(RowColumnIndex, GridCell, GridStyleInfo, String, Boolean)

Declaration
public override sealed void UpdateCellStyle(RowColumnIndex cellRowColumnIndex, GridCell uiElement, GridStyleInfo style, string text, bool isInEdit)
Parameters
Type Name Description
RowColumnIndex cellRowColumnIndex
GridCell uiElement
GridStyleInfo style
System.String text
System.Boolean isInEdit
Overrides

Implements

System.IDisposable