How to bind a property of the view model in .NET MAUI DataGrid?
The .NET MAUI DataGrid (SfDataGrid) allows you to load a HeaderTemplate for a DataGridColumn to load a customized view of choice. You can bind a property in the ViewModel to a view inside the HeaderTemplate and set its BindingContext to be the reference of the ViewModel to get it working.
C#
Define the HeaderText property in the ViewModel class.
public class ViewModel : INotifyPropertyChanged
{
private ObservableCollection<OrderInfo> orderInfo;
private ICommand buttonCommand;
public ObservableCollection<OrderInfo> OrderInfoCollection
{
get { return orderInfo; }
set { this.orderInfo = value; RaisePropertyChanged("OrderInfoCollection"); }
}
public string HeaderText { get; set; }
public ICommand ButtonCommand
{
get { return buttonCommand; }
set { buttonCommand = value; }
}
public ViewModel()
{
this.HeaderText = "OrderID";
this.OrderInfoCollection = new ObservableCollection<OrderInfo>();
this.GenerateOrders();
}
public void GenerateOrders()
{
this.OrderInfoCollection.Add(new OrderInfo(1001, "Ana Trujillo", "Mexico", "ANATR"));
this.OrderInfoCollection.Add(new OrderInfo(1002, "Ant Fuller", "Mexico", "ANTON"));
this.OrderInfoCollection.Add(new OrderInfo(1003, "Thomas Hardy", "UK", "AROUT"));
this.OrderInfoCollection.Add(new OrderInfo(1004, "Tim Adams", "Sweden", "BERGS"));
this.OrderInfoCollection.Add(new OrderInfo(1005, "Hanna Moos", "Germany", "BLAUS"));
this.OrderInfoCollection.Add(new OrderInfo(1006, "Andrew Fuller", "France", "BLONP"));
this.OrderInfoCollection.Add(new OrderInfo(1007, "Martin King", "Spain", "BOLID"));
this.OrderInfoCollection.Add(new OrderInfo(1008, "Lenny Lin", "France", "BONAP"));
this.OrderInfoCollection.Add(new OrderInfo(1009, "John Carter", "Canada", "BOTTM"));
this.OrderInfoCollection.Add(new OrderInfo(1010, "Laura King", "UK", "AROUT"));
}
#region INotifyPropertyChanged
public event PropertyChangedEventHandler PropertyChanged;
private void RaisePropertyChanged(string name)
{
if (PropertyChanged != null)
this.PropertyChanged(this, new PropertyChangedEventArgs(name));
}
#endregion
}
XAML
Bind the HeaderText property of the ViewModel to the Text property of a Label within the HeaderTemplate..
<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:local="clr-namespace:DataGridMAUI"
xmlns:syncfusion="clr-namespace:Syncfusion.Maui.DataGrid;assembly=Syncfusion.Maui.DataGrid"
x:Class="DataGridMAUI.MainPage">
<ContentPage.BindingContext>
<local:ViewModel x:Name="ViewModel"></local:ViewModel>
</ContentPage.BindingContext>
<syncfusion:SfDataGrid x:Name="dataGrid" AutoGenerateColumnsMode="None" GridLinesVisibility="Both" HeaderGridLinesVisibility="Both" VerticalOptions="FillAndExpand" ItemsSource="{Binding OrderInfoCollection}" >
<syncfusion:SfDataGrid.Columns>
<syncfusion:DataGridNumericColumn MappingName="OrderID" Format="D">
<syncfusion:DataGridNumericColumn.HeaderTemplate>
<DataTemplate>
<StackLayout>
<Label BindingContext="{x:Reference ViewModel}"
Text="{Binding HeaderText}" FontAttributes="Bold" VerticalOptions="Center" Padding="12" HorizontalOptions="End"
TextColor="Black"
/>
</StackLayout>
</DataTemplate>
</syncfusion:DataGridNumericColumn.HeaderTemplate>
</syncfusion:DataGridNumericColumn>
<syncfusion:DataGridTextColumn MappingName="Customer" HeaderText="Name"></syncfusion:DataGridTextColumn>
<syncfusion:DataGridTextColumn MappingName="Country"></syncfusion:DataGridTextColumn>
</syncfusion:SfDataGrid.Columns>
</syncfusion:SfDataGrid>
</ContentPage>
Output
Download the complete sample from GitHub.
Conclusion
I hope you enjoyed learning how to bind a property of the view model in the header template in MAUI DataGrid (SfDataGrid)
You can refer to our .NET MAUI DataGrid feature tour page to learn about its other groundbreaking feature representations and documentation, and how to quickly get started with configuration specifications. Explore our .NET MAUI DataGrid example to understand how to create and manipulate data.
For current customers, check out our components from the License and Downloads page. If you are new to Syncfusion®, try our 30-day free trial to check out our other controls.
Please let us know in the comments section if you have any queries or require clarification. You can also contact us through our support forums, Direct-Trac, or feedback portal. We are always happy to assist you!