Skip to main content

JsonDataSource.Schema Property

Gets or sets the JsonDataSource‘s data schema.

Namespace: DevExpress.DataAccess.Json

Assembly: DevExpress.DataAccess.v24.1.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap


public JsonSchemaNode Schema { get; set; }

Property Value

Type Description

The data source schema’s root node.


Use this property to specify the data source schema. When the schema is specified, you can bind controls to data source fields.

If the Schema property is set to null (Nothing in Visual Basic), the Fill method call provides both the schema and data. The schema is generated based on the provided data. The SchemaDiscoveryMaxItemCount property specifies how many records to analyze in order to build the schema.

Customize the Schema property to build a custom data source schema:

  1. Create a JsonSchemaNode class instance and set its properties.
  2. Use the JsonSchemaNode.Children property to specify the collection of child nodes.
  3. Assign the root node instance to the Schema property.


If you modify the schema after you called the Fill method, call this method again to apply changes to the data.

In the following code, the Customers node’s schema is defined and added to the data source’s root node.

root: {
    customers: [{
using DevExpress.DataAccess.Json;
using DevExpress.XtraReports.UI;
public static JsonDataSource CreateDataSourceFromWeb() {
    var jsonDataSource = new JsonDataSource();
    // Specify the endpoint.
    jsonDataSource.JsonSource = new UriJsonSource(
        new Uri(""));
var root = new JsonSchemaNode();
root.NodeType = JsonNodeType.Object;

var customers = new JsonSchemaNode() {NodeType=JsonNodeType.Array, Name="Customers", Selected=true };
customers.AddChildren(new[] {
    new JsonSchemaNode(new JsonNode("CustomerID", true,
    JsonNodeType.Property, typeof(string))) 
    DisplayName = "Customer ID" },
    new JsonSchemaNode() {
        Name =  "CompanyName",
        Selected = true,
        NodeType = JsonNodeType.Property,
        Type = typeof(string)
    new JsonSchemaNode(new JsonNode("ContactTitle", true, JsonNodeType.Property, typeof(string))),
    new JsonSchemaNode(new JsonNode("Address", false, JsonNodeType.Property, typeof(string)))

jsonDataSource.Schema = root;
            // The schema is built, you do not have to call the Fill method to populate the Field List.
            // The Designer calls the Fill method automatically when a document is generated for preview.
            return jsonDataSource;

View Example: How to Create a Report Bound to JsonDataSource

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


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.

See Also