ObjectDataSource.RebuildResultSchema() Method

Builds the ObjectDataSource schema.

Namespace: DevExpress.DataAccess.ObjectBinding

Assembly: DevExpress.DataAccess.v24.2.dll

NuGet Package: DevExpress.DataAccess

Declaration

C#

public void RebuildResultSchema()

VB.NET

Public Sub RebuildResultSchema

Remarks

Call this method to build the data source schema. You can use the schema to bind controls to data source fields.

Use the RebuildResultSchema(IEnumerable<IParameter>) method instead to apply values from external parameters (for instance, report parameters) to the data source parameters before the schema is built.

Example

The code sample below configures an object data source and calls the RebuildResultSchema method to build the data source schema.

C#

using System.Collections.Generic;
using DevExpress.DataAccess;
using DevExpress.DataAccess.ObjectBinding;
// ...
public class Employee {
    public string Name { get; set; }
    public string Position { get; set; }
}
// The class that fetches data to the ObjectDataSource.
public static class EmployeeDataSource {
    public static IEnumerable<Employee> GetEmployeeList(bool fetchData) {
        if (!fetchData)
            return null;
        var employees = new List<Employee>() {
                new Employee() {
                    Name = "Andrew Fuller",
                    Position = "Vice President, Sales"
                },
                new Employee() {
                    Name = "Nancy Davolio",
                    Position = "Sales Representative"
                },
                new Employee() {
                    Name = "Maria Anders",
                    Position = "Sales Representative"
                },
                new Employee() {
                    Name = "Ana Trujillo",
                    Position = "Owner"
                },
                new Employee() {
                    Name = "Antonio Moreno",
                    Position = "Sales Representative"
                },
                new Employee() {
                    Name = "Thomas Hardy",
                    Position = "Sales Representative"
                },
                new Employee() {
                    Name = "Christina Berglund",
                    Position = "Order Administrator"
                },
                new Employee() {
                    Name = "Frederique Citeaux",
                    Position = "Marketing Manager"
                },
                new Employee() {
                    Name = "Hanna Moos",
                    Position = "Sales Representative"
                },
            };
        return employees;
    }
}
// ...
// Create an ObjectDataSource instance.
ObjectDataSource dataSource = new ObjectDataSource();
dataSource.Name = "objectDataSource1";
dataSource.DataSource = typeof(EmployeeDataSource);
// Specify the data member.
dataSource.DataMember = "GetEmployeeList";
// Specify the data source parameters.
dataSource.Parameters.Add(new Parameter("fetchData", typeof(bool), true));
// Build the data source schema.
dataSource.RebuildResultSchema();

VB.NET

Imports System.Collections.Generic
Imports DevExpress.DataAccess
Imports DevExpress.DataAccess.ObjectBinding
' ...
Public Class Employee
    Public Property Name() As String
    Public Property Position() As String
End Class
' The class that fetches data to the ObjectDataSource.
Public NotInheritable Class EmployeeDataSource

    Private Sub New()
    End Sub

    Public Shared Function GetEmployeeList(ByVal fetchData As Boolean) As IEnumerable(Of Employee)
        If Not fetchData Then
            Return Nothing
        End If
        Dim employees = New List(Of Employee)() From {
            New Employee() With {.Name = "Andrew Fuller", .Position = "Vice President, Sales"},
            New Employee() With {.Name = "Nancy Davolio", .Position = "Sales Representative"},
            New Employee() With {.Name = "Maria Anders", .Position = "Sales Representative"},
            New Employee() With {.Name = "Ana Trujillo", .Position = "Owner"},
            New Employee() With {.Name = "Antonio Moreno", .Position = "Sales Representative"},
            New Employee() With {.Name = "Thomas Hardy", .Position = "Sales Representative"},
            New Employee() With {.Name = "Christina Berglund", .Position = "Order Administrator"},
            New Employee() With {.Name = "Frederique Citeaux", .Position = "Marketing Manager"},
            New Employee() With {.Name = "Hanna Moos", .Position = "Sales Representative"}
        }
        Return employees
    End Function
End Class

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RebuildResultSchema() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

reporting-web-object-data-source/CS/Reporting-How-To-Use-Object-Data-Source/MVC/CS/Reporting_ObjectDS_Mvc/Controllers/HomeController.cs#L19

dataSource.DataMember = "Items";
dataSource.RebuildResultSchema();
model.DataSources = new Dictionary<string, object>();

VB.NET

reporting-web-object-data-source/CS/Reporting-How-To-Use-Object-Data-Source/MVC/VB/Reporting_ObjectDS_Mvc/Controllers/HomeController.vb#L20

dataSource.DataMember = "Items"
dataSource.RebuildResultSchema()
model.DataSources = New Dictionary(Of String, Object)()