How to Create Custom Text Image Column in .NET MAUI DataGrid?

In this article, we will show you how to create a custom text image column in .NET MAUI DataGrid.

Xaml

<ContentPage.BindingContext>
    <local:EmployeeViewModel x:Name="viewModel" />
</ContentPage.BindingContext>

<syncfusion:SfDataGrid x:Name="sfGrid" 
                        GridLinesVisibility="Both"
                        HeaderGridLinesVisibility="Both"
                        ColumnWidthMode="Auto"
                        AutoGenerateColumnsMode="None"
                        ItemsSource="{Binding Employees}">

    <syncfusion:SfDataGrid.Columns>
        <syncfusion:DataGridTextColumn MappingName="Name"
                                        HeaderText="Employee Name" />
        <syncfusion:DataGridTextColumn MappingName="Title"
                                        HeaderText="Designation" />
        <syncfusion:DataGridTextColumn MappingName="LoginID"
                                        HeaderText="Login ID" />
        <syncfusion:DataGridTextColumn MappingName="Gender"
                                        HeaderText="Gender" />

    </syncfusion:SfDataGrid.Columns>

</syncfusion:SfDataGrid>

Xaml.cs

public partial class MainPage : ContentPage
{
    public MainPage()
    {
        InitializeComponent();
        sfGrid.CellRenderers.Add("TextImage", new TextImageColumnRenderer());
    }
}

TextImageColumn.cs

The code below demonstrates how to create a custom text image column in SfDataGrid.

public class TextImageColumn : DataGridColumn
{
    public TextImageColumn()
    {
        var cellType = typeof(DataGridColumn).GetRuntimeProperties().FirstOrDefault(property => property.Name == "CellType");
        cellType?.SetValue(this, "TextImage");
    }

    protected override void SetConverterForDisplayBinding()
    {
        base.SetConverterForDisplayBinding();

        if (DisplayBinding is Binding binding)
        {
            binding.Converter = new CustomTextConverter();
        }
    }

    public class CustomTextConverter : IValueConverter
    {
        public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
        {
            if (value == null || string.IsNullOrEmpty(value.ToString()))
                return null;

            return $"{value}"; // Modify text as needed
        }

        public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
        {
            return value?.ToString().Replace(" ", ""); // Reverse conversion
        }
    }
}

public class TextImageColumnRenderer : DataGridCellRenderer<Grid, Grid>
{
    protected override Grid OnCreateDisplayUIView()
    {
        var grid = new Grid
        {
            ColumnDefinitions =
        {
            new ColumnDefinition { Width = new GridLength(1, GridUnitType.Star) },
            new ColumnDefinition { Width = new GridLength(30) }
        }
        };

        var textLabel = new Label
        {
            VerticalOptions = LayoutOptions.Center,
            HorizontalOptions = LayoutOptions.Start
        };
        Grid.SetColumn(textLabel, 0);

        var iconLabel = new Label
        {
            VerticalOptions = LayoutOptions.Center,
            HorizontalOptions = LayoutOptions.End,
            FontSize = 20,
            FontFamily = "Segoe UI Emoji"
        };
        Grid.SetColumn(iconLabel, 1);

        grid.Children.Add(textLabel);
        grid.Children.Add(iconLabel);

        return grid;
    }

    protected override void OnInitializeDisplayView(DataColumnBase dataColumn, Grid view)
    {
        base.OnInitializeDisplayView(dataColumn, view);


        if (view.Children[0] is Label textLabel)
        {
            var binding = new Binding
            {
                Path = dataColumn.DataGridColumn.MappingName,
                Mode = BindingMode.TwoWay,
                Converter = new CustomTextConverter()
            };

            textLabel.SetBinding(Label.TextProperty, binding);
        }

        if (view.Children[1] is Label iconLabel )
        {
            if (dataColumn.DataGridColumn.MappingName == "Title")
            {
                iconLabel.Text = "📄";
            }
            else if (dataColumn.DataGridColumn.MappingName == "BirthDate")
            {
                iconLabel.Text = "\u23F1";
            }
        }
    }
}

Output

Download the complete sample from GitHub.

Conclusion

I hope you enjoyed learning how to create custom text image columns in .NET MAUI DataGrid.
You can refer to our .NET MAUI DataGrid feature tour page to know 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!