DataGrid: expose row index (#15909)

* feat: expose index. * feat: make Index a direct property. obsolete get method. Update sample.
AvaloniaUI · Jun 6, 2024 · 7413434 · 7413434
1 parent e7819cc
commit 7413434
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 9 deletions.
diff --git a/samples/ControlCatalog/Pages/DataGridPage.xaml b/samples/ControlCatalog/Pages/DataGridPage.xaml
@@ -45,6 +45,11 @@
  </StackPanel>
  <DataGrid Name="dataGrid1" Margin="12" CanUserResizeColumns="True" CanUserReorderColumns="True" CanUserSortColumns="True" HeadersVisibility="All"
  RowBackground="#1000">
+ <DataGrid.Styles>
+ <Style Selector="DataGridRow">
+ <Setter Property="Header" Value="{Binding $self.Index}"/>
+ </Style>
+ </DataGrid.Styles>
  <DataGrid.Columns>
  <!-- Using HeaderTemplate -->
  <DataGridTextColumn Header="Country or Region" HeaderTemplate="{StaticResource Demo.DataTemplates.CountryHeader}" Binding="{Binding Name}" Width="6*" x:DataType="local:Country" />

diff --git a/samples/ControlCatalog/Pages/DataGridPage.xaml.cs b/samples/ControlCatalog/Pages/DataGridPage.xaml.cs
@@ -24,7 +24,6 @@ public DataGridPage()
  collectionView1.SortDescriptions.Add(dataGridSortDescription);
  var dg1 = this.Get<DataGrid>("dataGrid1");
  dg1.IsReadOnly = true;
- dg1.LoadingRow += Dg1_LoadingRow;
  dg1.Sorting += (s, a) =>
  {
  var binding = (a.Column as DataGridBoundColumn)?.Binding as Binding;
@@ -64,11 +63,6 @@ public DataGridPage()
  }
 
  public IEnumerable<Person> DataGrid3Source { get; }
-
- private void Dg1_LoadingRow(object? sender, DataGridRowEventArgs e)
- {
- e.Row.Header = e.Row.GetIndex() + 1;
- }
 
  private void InitializeComponent()
  {

diff --git a/src/Avalonia.Controls.DataGrid/DataGridRow.cs b/src/Avalonia.Controls.DataGrid/DataGridRow.cs
@@ -220,13 +220,18 @@ internal DataGrid OwningGrid
  set;
  }
 
+ private int _index;
+
+ public static readonly DirectProperty<DataGridRow, int> IndexProperty = AvaloniaProperty.RegisterDirect<DataGridRow, int>(
+ nameof(Index), o => o.Index, (o, v) => o.Index = v);
+
  /// <summary>
  /// Index of the row
  /// </summary>
- internal int Index
+ public int Index
  {
- get;
- set;
+ get => _index;
+ internal set => SetAndRaise(IndexProperty, ref _index, value);
  }
 
  internal double ActualBottomGridLineHeight
@@ -435,6 +440,7 @@ internal double TargetHeight
  /// <returns>
  /// The index of the current row.
  /// </returns>
+ [Obsolete("This API is going to be removed in a future version. Use the Index property instead.")]
  public int GetIndex()
  {
  return Index;