Class VirtualizingCellsControl
Inheritance
Implements
Namespace: Syncfusion.UI.Xaml.Grid
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class VirtualizingCellsControl : GridElement, IDisposable
Constructors
VirtualizingCellsControl()
Initialize a new instance of the DataGridRowControl class.
Declaration
public VirtualizingCellsControl()
Fields
CurrentFocusBorderMarginProperty
Declaration
public static readonly DependencyProperty CurrentFocusBorderMarginProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
CurrentFocusRowVisibilityProperty
Declaration
public static readonly DependencyProperty CurrentFocusRowVisibilityProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
GroupRowSelectionBrushProperty
Declaration
public static readonly DependencyProperty GroupRowSelectionBrushProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
HighlightBorderClipRectProperty
Declaration
public static readonly DependencyProperty HighlightBorderClipRectProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
HighlightSelectionBorderVisiblityProperty
Dependency registration for HighlightSelectionBorderVisiblity
Declaration
public static readonly DependencyProperty HighlightSelectionBorderVisiblityProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RowBackgroundClipProperty
Declaration
public static readonly DependencyProperty RowBackgroundClipProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RowHighlightBorderThicknessProperty
Dependeny registration for SelectionBackground.
Declaration
public static readonly DependencyProperty RowHighlightBorderThicknessProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RowHoverBackgroundBrushProperty
Dependeny registration for SelectionBackground.
Declaration
public static readonly DependencyProperty RowHoverBackgroundBrushProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RowHoverForegroundProperty
Identifies the RowHoverForeground dependency property.
Declaration
public static readonly DependencyProperty RowHoverForegroundProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RowSelectionBrushProperty
Dependeny registration for SelectionBackground.
Declaration
public static readonly DependencyProperty RowSelectionBrushProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ScrollAnimation
The property that used to stores the
Declaration
protected Storyboard ScrollAnimation
Field Value
| Type |
|---|
| System.Windows.Media.Animation.Storyboard |
SelectionBorderClipRectProperty
Declaration
public static readonly DependencyProperty SelectionBorderClipRectProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SelectionBorderVisiblityProperty
Dependency registration for SelectionborderVisiblity
Declaration
public static readonly DependencyProperty SelectionBorderVisiblityProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SelectionForegroundBrushProperty
Dependency Registration for SelectionForegroundBrush
Declaration
public static readonly DependencyProperty SelectionForegroundBrushProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Properties
CurrentFocusBorderMargin
Preperty which holds the margin value to avoid the overlapping in Indent Cell.
Declaration
public Thickness CurrentFocusBorderMargin { get; set; }
Property Value
| Type |
|---|
| System.Windows.Thickness |
CurrentFocusRowVisibility
Property which decides whethe Focus border is visible or not.
Declaration
public Visibility CurrentFocusRowVisibility { get; set; }
Property Value
| Type |
|---|
| System.Windows.Visibility |
GroupRowSelectionBrush
Gets or sets the GroupCaptionRowSelectionBrush
Declaration
public Brush GroupRowSelectionBrush { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
HighlightBorderClipRect
Declaration
public RectangleGeometry HighlightBorderClipRect { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.RectangleGeometry |
HighlightSelectionBorderVisiblity
Gets or Sets HighlightSelectionBorder visibility. Which is bind to the selection border visibility property
Declaration
public Visibility HighlightSelectionBorderVisiblity { get; set; }
Property Value
| Type |
|---|
| System.Windows.Visibility |
RowBackgroundClip
Declaration
public RectangleGeometry RowBackgroundClip { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.RectangleGeometry |
RowBorderState
This property is used for Frozen and Footer rows to highlight the freezed rows.
Declaration
public string RowBorderState { get; set; }
Property Value
| Type |
|---|
| System.String |
RowHighlightBorderThickness
Gets or sets value for Highlight Border Thickness.
Declaration
public Thickness RowHighlightBorderThickness { get; set; }
Property Value
| Type |
|---|
| System.Windows.Thickness |
RowHoverBackgroundBrush
Gets or sets value for Selection Background. Which is bind to the Selection Border Background property.
Declaration
public Brush RowHoverBackgroundBrush { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
RowHoverForeground
Gets or sets the value for foreground when hovering the row.
Declaration
public Brush RowHoverForeground { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
RowSelectionBrush
Gets or sets value for Selection Background. Which is bind to the Selection Border Background property.
Declaration
public Brush RowSelectionBrush { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
SelectionBorderClipRect
Declaration
public RectangleGeometry SelectionBorderClipRect { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.RectangleGeometry |
SelectionBorderVisiblity
Gets or sets SelectionBorder visibility. Which is bind to the Selection Border visibility property
Declaration
public Visibility SelectionBorderVisiblity { get; set; }
Property Value
| Type |
|---|
| System.Windows.Visibility |
SelectionForegroundBrush
Gets or sets the value for SelectionForegroundBrush
Declaration
public Brush SelectionForegroundBrush { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
Methods
ApplyFixedRowVisualState(Boolean)
Invoked to apply visual state for the fixed rows.
Declaration
protected virtual void ApplyFixedRowVisualState(bool canApplyDefaultState = true)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | canApplyDefaultState |
Dispose()
Disposes all the resources used by the
Declaration
public void Dispose()
Dispose(Boolean)
Disposes all the resources used by the VirtualizingCellsControl class.
Declaration
protected virtual void Dispose(bool isDisposing)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | isDisposing | Indicates whether the call is from Dispose method or from a finalizer. |
OnApplyTemplate()
Invoked to apply template for datagrid rows.
Declaration
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Returns a class-specific AutomationPeer Implementations for the Microsoft UI Automation infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
| Type | Description |
|---|---|
| System.Windows.Automation.Peers.AutomationPeer | The class-specific AutomationPeer subclass. |
OnCreateScrollAnimation()
Creates animation for
Declaration
protected virtual void OnCreateScrollAnimation()
OnLoaded(Object, RoutedEventArgs)
Invoked when data grid rows are loaded.
Declaration
protected virtual void OnLoaded(object sender, RoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | |
| System.Windows.RoutedEventArgs | e |
OnMouseEnter(MouseEventArgs)
Called before the PointerEntered event occurs.
Declaration
protected override void OnMouseEnter(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseEventArgs | e |
OnMouseLeave(MouseEventArgs)
Called before the PointerExited event occurs.
Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseEventArgs | e |
OnMouseLeftButtonDown(MouseButtonEventArgs)
Handles mouse left button down for row resizing — delegates to GridRowResizingController when AllowResizingRows is enabled and the pointer is hovering on a resize boundary.
Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseButtonEventArgs | e | The System.Windows.Input.MouseButtonEventArgs that contains the event data. |
OnMouseLeftButtonUp(MouseButtonEventArgs)
Handles mouse left button up for row resizing — commits the final row height
via GridRowResizingController when row resizing is enabled.
Always delegates (even if dragLine became null mid-drag due to a
cancelled RowResizing event) so the controller can release mouse capture
and reset state — preventing a leaked capture.
Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseButtonEventArgs | e | The System.Windows.Input.MouseButtonEventArgs that contains the event data. |
OnMouseMove(MouseEventArgs)
Handles mouse move for row resizing — delegates to GridRowResizingController when AllowResizingRows is enabled.
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseEventArgs | e | The System.Windows.Input.MouseEventArgs that contains the event data. |
Remarks
When AllowResizingRows is false the row may still carry a
previously-set System.Windows.Input.Cursors.SizeNS cursor (the column controller can leave that
residue while recycling cells). We always delegate the move so the controller can revert the
cursor to Arrow when AllowResizingRows flips off.
OnSizeChanged(Object, SizeChangedEventArgs)
Invoked when the size changed.
Declaration
protected virtual void OnSizeChanged(object sender, SizeChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | |
| System.Windows.SizeChangedEventArgs | e |
SetContent()
Sets the content of a content control.
Declaration
protected virtual void SetContent()
UnwireEvents()
Unwires the events.
Declaration
protected virtual void UnwireEvents()
WireEvents()
Wires the events.
Declaration
protected virtual void WireEvents()