Class GridRowHeaderCell

Represents a class that provides common functionalities of RowHeaderCells in SfDataGrid.

Inheritance
System.Object
GridElement
GridCell
GridRowHeaderCell
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.Grid
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class GridRowHeaderCell : GridCell, IDisposable
Remarks

The GridRowHeaderCell is the row header cell template part used by the GridRowHeaderCellRenderer to display row indicators in SfDataGrid. It extends GridCell and provides the row index for numbering rows (similar to Excel), supports displaying row validation error messages as a tool tip, and exposes attached properties used by the WPF platform to render the row selection highlight and selection border.

Constructors

GridRowHeaderCell()

Initializes a new instance of the GridRowHeaderCell class.

Declaration
public GridRowHeaderCell()
Remarks

Sets the System.Windows.FrameworkElement.DefaultStyleKey to the type of the GridRowHeaderCell so that the default style from Generic.xaml is applied, and marks the cell as not focusable by setting System.Windows.Controls.Control.IsTabStop to false.

Fields

EnableHeaderHighlightProperty

Dependency registration for EnableHeaderHighlight property.

Declaration
public static readonly DependencyProperty EnableHeaderHighlightProperty
Field Value
Type
System.Windows.DependencyProperty

RowErrorMessageProperty

Identifies the RowErrorMessage dependency property.

Declaration
public static readonly DependencyProperty RowErrorMessageProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the RowErrorMessage dependency property.

RowIndexProperty

Identifies the RowIndex dependency property.

Declaration
public static readonly DependencyProperty RowIndexProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the RowIndex dependency property.

SelectionBackgroundProperty

Dependency registration for SelectionBackground property.

Declaration
public static readonly DependencyProperty SelectionBackgroundProperty
Field Value
Type
System.Windows.DependencyProperty

SelectionBorderBrushProperty

Dependency registration for SelectionBorderBrush property.

Declaration
public static readonly DependencyProperty SelectionBorderBrushProperty
Field Value
Type
System.Windows.DependencyProperty

SelectionBorderThicknessProperty

Dependency registration for SelectionBorderThickness Property.

Declaration
public static readonly DependencyProperty SelectionBorderThicknessProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

RowErrorMessage

Gets or sets the row validation error message that is displayed as a tool tip when the user hovers over the GridRowHeaderCell.

Declaration
public string RowErrorMessage { get; set; }
Property Value
Type Description
System.String

A System.String that contains the row validation error message. The default value is System.String.Empty.

RowIndex

Gets or sets the row index of the GridRowHeaderCell.

Declaration
public int RowIndex { get; set; }
Property Value
Type Description
System.Int32

An System.Int32 that represents the zero-based index of the row in the view. The default value is 0.
Remarks

The row index is used by the SfDataGrid to number the row similar to the row headers shown in Microsoft Excel. The value is automatically updated when the row is scrolled, sorted, filtered or grouped.

Methods

ApplyVisualState()

Applies the visual state for the GridRowHeaderCell.

Declaration
public void ApplyVisualState()
Remarks

Inspects the internal Syncfusion.UI.Xaml.Grid.GridRowHeaderCell.State property and uses System.Windows.VisualStateManager to transition the row header to the corresponding visual state. The supported states are Normal, CurrentRow, EditingRow, Error, Error_CurrentRow, AddNewRow, and FilterRow.

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()
Overrides

OnCreateAutomationPeer()

Returns a class-specific AutomationPeer Implementations for the Microsoft UI Automation infrastrucutre.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type Description
System.Windows.Automation.Peers.AutomationPeer

The class-specific AutomationPeer subclass.
Overrides

OnMouseDoubleClick(MouseButtonEventArgs)

Declaration
protected override void OnMouseDoubleClick(MouseButtonEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseButtonEventArgs e
Overrides

OnMouseUp(MouseButtonEventArgs)

Declaration
protected override void OnMouseUp(MouseButtonEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseButtonEventArgs e
Overrides

Implements

System.IDisposable

See Also