Create Dynamic OData Grids Using the Infragistics XamDataGrid



Learn how you can connect OData to Infragistics XamDataGrid to build dynamic grids.

Using Infragistics WPF UI controls, you can build contemporary applications reminiscent of Microsoft Office for both desktop and touch-based devices. When coupled with the CData ADO.NET Provider for OData, you gain the capability to construct interactive grids, charts, and various other visual elements while directly accessing real-time data from OData services. This article will guide you through the process of creating a dynamic grid within Visual Studio using the Infragistics XamDataGrid control.

About OData Data Integration

CData simplifies access and integration of live OData services data. Our customers leverage CData connectivity to:

  • Access OData versions 2.0, 3.0, and 4.0, working with legacy services and the latest features and capabilities.
  • Leverage advanced query options, including $filter, $select, and $expand, enhancing data retrieval from 3rd party tools.
  • Use Server-side execution of aggregation and grouping to minimize data transfer and boost performance.
  • Authenticate securely using a variety of schemes, including Azure AD, digest, negotiate, NTLM, OAuth, and more means secure authentication with every connection.
  • Use SQL stored procedures to manage OData service entities - listing, creating, and removing associations between entities.

Customers use CData's solutions to regularly integrate their OData services with preferred tools, such as Power BI, MicroStrategy, or Tableau, and to replicate data from OData services to their databases or data warehouses.


Getting Started


You will need to install the Infragistics WPF UI components to continue. Download a free trial here: https://www.infragistics.com/products/wpf.

Create a WPF Project

Open VisualStudio and create a new WPF project.

Add a TextBox for passing a SQL query to the CData ADO.NET Provider and a Button for executing the query.

The XAML at this stage is as follows:

< Window
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:CDataXamDataGridGroupingListApp"
        xmlns:igWPF="http://schemas.infragistics.com/xaml/wpf" x:Class="CDataXamDataGridGroupingListApp.MainWindow"
        mc:Ignorable="d"
        Title="MainWindow" Height="450" Width="800">
  < Grid>
    < TextBox x:Name="textBox" HorizontalAlignment="Left" Height="44" TextWrapping="Wrap" Text="TextBox" VerticalAlignment="Top" Width="682" Margin="10,10,0,0"/>
    < Button x:Name="button" Content="Execute" HorizontalAlignment="Left" Margin="697,10,0,0" VerticalAlignment="Top" Width="85" Height="44"/>
  < /Grid>
< /Window>

Add and Configure a XamDataGrid

After adding the initial controls, add a XamDataGrid to the App. The component will appear in the Visual Studio toolbox.

Arrange the component on the designer so that it is below the TextBox & Button and linked to the boundaries of the app.

Once the XamDataGrid is placed, edit the XAML to set the XamDataGrid DataSource attribute to "{Binding}" and set the FieldSettings AllowRecordFiltering and AllowSummaries attributes to "true." Next, add an empty method as the Click event handler for the Button component. The XAML at this stage is as follows:

< Window
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:CDataXamDataGridGroupingListApp"
        xmlns:igWPF="http://schemas.infragistics.com/xaml/wpf" x:Class="CDataXamDataGridGroupingListApp.MainWindow"
        mc:Ignorable="d"
        Title="MainWindow" Height="450" Width="800">
  < Grid>
    < TextBox x:Name="textBox" HorizontalAlignment="Left" Height="44" TextWrapping="Wrap" Text="TextBox" VerticalAlignment="Top" Width="682" Margin="10,10,0,0"/>
    < Button x:Name="button" Content="Execute" HorizontalAlignment="Left" Margin="697,10,0,0" VerticalAlignment="Top" Width="85" Click="Button_Click" Height="44"/>

    < igWPF:XamDataGrid Margin="10,59,10,10" DataSource="{Binding}">
      < igWPF:XamDataGrid.FieldSettings>
        < igWPF:FieldSettings AllowSummaries="True" AllowRecordFiltering="True"/>
      < /igWPF:XamDataGrid.FieldSettings>
    < /igWPF:XamDataGrid>

  < /Grid>
< /Window>

Connect to and Query OData

The last step in building our WPG App with a dynamic DataGrid is connecting to and querying live OData services. First add a reference to the CData ADO.NET Provider to the project (typically found in C:\Program Files\CData[product_name]\lib).

Next, add the Provider to the namespace, along with the standard Data library:

using System.Data.CData.OData;
using System.Data;

Finally, add the code to connect to OData and query using the text from the TextBox to the Click event handler.

The User and Password properties, under the Authentication section, must be set to valid OData user credentials. In addition, you will need to specify a URL to a valid OData server organization root or OData services file.

private void Button_Click(object sender, RoutedEventArgs e)
{
  //connecting to OData
  string connString = "URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;";
  using (var conn = new ODataConnection(connString))
  {
    //using the query from the TextBox
    var dataAdapter = new ODataDataAdapter(textBox.Text, conn);
    var table = new DataTable();
    dataAdapter.Fill(table);
    
    //passing the DataRowCollection to the DataContext
    //  for use in the XamDataGrid
    this.DataContext = table.Rows;
  }
}

Run the Application

With the app fully configured, we are ready to display OData services in our XamDataGrid. When you click "Execute," the app connects to OData and submits the SQL query through the CData ADO.NET Provider.

Live OData services is displayed in the grid.

Group the data by dragging and dropping a column name into the header.

As you add groupings and filters, the underlying SQL query is submitted directly to OData, making it possible to drill down into live OData services to find only the specific information you need.

Free Trial & More Information

At this point, you have created a dynamic WPF App with access to live OData services. For more information, visit the CData ADO.NET Provider page. Download a free, 30-day trial and start working live OData services in apps built using the Infragistics UI controls today.

Ready to get started?

Download a free trial of the OData Data Provider to get started:

 Download Now

Learn more:

OData  Icon OData ADO.NET Provider

Easy-to-use OData client (consumer) enables developers to build .NET applications that easily communicate with OData services.