JsonDataSource.JsonSource Property

Gets or sets an object that stores JSON data import settings.

Namespace: DevExpress.DataAccess.Json

Assembly: DevExpress.DataAccess.v20.1.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.WindowsDesktop.DataAccess

Declaration

C#

[DefaultValue(null)]
[LocalizableCategory(DataAccessStringId.PropertyGridDataCategoryName)]
public JsonSourceBase JsonSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
<LocalizableCategory(DataAccessStringId.PropertyGridDataCategoryName)>
Public Property JsonSource As JsonSourceBase

Property Value

Type	Default	Description
JsonSourceBase	*null*	A JsonSourceBase descendant that specifies the JSON data location.

Remarks

Use the JsonSource property to specify the JSON data location. Set the JsonSource property to a JsonSourceBase descendant.

JSON Data Location	JsonSource Property Value
Web-service endpoint	A UriJsonSource object
Text file	A UriJsonSource object
JSON string	A CustomJsonSource object

Examples

The code sample below illustrates how to retrieve JSON data from the Web.

C#

using DevExpress.DataAccess.Json;
// ...
public static JsonDataSource CreateDataSourceFromWeb() {
    var jsonDataSource = new JsonDataSource();
    // Specify the endpoint.
    jsonDataSource.JsonSource = new UriJsonSource(new Uri("http://northwind.servicestack.net/customers.json"));
    // Populate the data source with data.
    jsonDataSource.Fill();
    return jsonDataSource;
}

VB.NET

Imports DevExpress.DataAccess.Json
' ...
Public Shared Function CreateDataSourceFromWeb() As JsonDataSource
    Dim jsonDataSource = New JsonDataSource()
    ' Specify the endpoint.
    jsonDataSource.JsonSource = New UriJsonSource(New Uri("http://northwind.servicestack.net/customers.json"))
    ' Populate the data source with data.
    jsonDataSource.Fill()
    Return jsonDataSource
End Function

The code sample below illustrates how to use JSON data from a file.

C#

using DevExpress.DataAccess.Json;
// ...
public static JsonDataSource CreateDataSourceFromFile() {
    var jsonDataSource = new JsonDataSource();
    // Specify the JSON file name.
    Uri fileUri = new Uri("customers.json", UriKind.RelativeOrAbsolute);
    jsonDataSource.JsonSource = new UriJsonSource(fileUri);
    // Populate the data source with data.
    jsonDataSource.Fill();
    return jsonDataSource;
}

VB.NET

Imports DevExpress.DataAccess.Json
' ...
Public Shared Function CreateDataSourceFromFile() As JsonDataSource
    Dim jsonDataSource = New JsonDataSource()
    ' Specify the JSON file name.
    Dim fileUri As New Uri("customers.json", UriKind.RelativeOrAbsolute)
    jsonDataSource.JsonSource = New UriJsonSource(fileUri)
    ' Populate the data source with data.
    jsonDataSource.Fill()
    Return jsonDataSource
End Function

The code sample below illustrates how to use JSON data from a string variable.

C#

using DevExpress.DataAccess.Json;
// ...
public static JsonDataSource CreateDataSourceFromText() {
    var jsonDataSource = new JsonDataSource();

    // Specify a string with JSON data.
    string json = "{\"Customers\":[{\"Id\":\"ALFKI\",\"CompanyName\":\"Alfreds Futterkiste\",\"ContactName\":\"Maria Anders\",\"ContactTitle\":\"Sales Representative\",\"Address\":\"Obere Str. 57\",\"City\":\"Berlin\",\"PostalCode\":\"12209\",\"Country\":\"Germany\",\"Phone\":\"030-0074321\",\"Fax\":\"030-0076545\"}],\"ResponseStatus\":{}}";

    // Specify the object that retrieves JSON data.
    jsonDataSource.JsonSource = new CustomJsonSource(json);
    // Populate the data source with data.
    jsonDataSource.Fill();
    return jsonDataSource;
}

VB.NET

Imports DevExpress.DataAccess.Json
' ...
Public Shared Function CreateDataSourceFromText() As JsonDataSource
    Dim jsonDataSource = New JsonDataSource()

    ' Specify a string with JSON data.
    Dim json As String = "{""Customers"":[{""Id"":""ALFKI"",""CompanyName"":""Alfreds Futterkiste"",""ContactName"":""Maria Anders"",""ContactTitle"":""Sales Representative"",""Address"":""Obere Str. 57"",""City"":""Berlin"",""PostalCode"":""12209"",""Country"":""Germany"",""Phone"":""030-0074321"",""Fax"":""030-0076545""}],""ResponseStatus"":{}}"

    ' Specify the object that retrieves JSON data.
    jsonDataSource.JsonSource = New CustomJsonSource(json)
    ' Populate the data source with data.
    jsonDataSource.Fill()
    Return jsonDataSource
End Function

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the JsonSource property.

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#

Create-a-Report-Bound-To-JsonDataSource/CS/Create-a-Report-Bound-to-JsonDataSource/Form1.cs#L54

var jsonDataSource = new JsonDataSource();
jsonDataSource.JsonSource = new UriJsonSource(new Uri("https://raw.githubusercontent.com/DevExpress-Examples/DataSources/master/JSON/customers.json"));
var root = new JsonSchemaNode();

winforms-dashboard-json-data-source/CS/DashboardJsonExample/Form1.cs#L50

var jsonDataSource = new DashboardJsonDataSource();
jsonDataSource.JsonSource = new UriJsonSource(new Uri("https://raw.githubusercontent.com/DevExpress-Examples/DataSources/master/JSON/customers.json"));
jsonDataSource.RootElement = "Customers";

how-to-create-a-federated-data-source-at-runtime/CS/FederationDataSourceExample/FederationDataSourceHelper.cs#L207

var jsonDataSource = new JsonDataSource();
jsonDataSource.JsonSource = new UriJsonSource(new Uri(urlString));
jsonDataSource.Fill();

jsondatasource-with-wpf-controls/CS/How-to-use-JsonDataSource-with-WPF-controls/MainWindow.xaml.cs#L29

Uri fileUri = new Uri("json_data.json", UriKind.RelativeOrAbsolute);
jsonDataSource.JsonSource = new UriJsonSource(fileUri);
jsonDataSource.Fill();

how-to-create-data-access-library-data-sources-at-runtime-t424210/CS/JsonDataSourceSnippets/Code.cs#L15

Uri sourceUri = new Uri("https://raw.githubusercontent.com/DevExpress-Examples/DataSources/master/JSON/customers.json");
jsonDataSource.JsonSource = new DevExpress.DataAccess.Json.UriJsonSource(sourceUri);
jsonDataSource.Fill();

VB.NET

winforms-dashboard-json-data-source/VB/DashboardJsonExample/Form1.vb#L47

Dim jsonDataSource = New DashboardJsonDataSource()
jsonDataSource.JsonSource = New UriJsonSource(New Uri("https://raw.githubusercontent.com/DevExpress-Examples/DataSources/master/JSON/customers.json"))
jsonDataSource.RootElement = "Customers"

Create-a-Report-Bound-To-JsonDataSource/VB/Create-a-Report-Bound-to-JsonDataSource/Form1.vb#L82

Dim fileUri As New Uri("file:///../../../../customers.txt")
jsonDataSource.JsonSource = New UriJsonSource(fileUri)
Return jsonDataSource

how-to-create-a-federated-data-source-at-runtime/VB/FederationDataSourceExample/FederationDataSourceHelper.vb#L157

Dim jsonDataSource = New JsonDataSource()
jsonDataSource.JsonSource = New UriJsonSource(New Uri(urlString))
jsonDataSource.Fill()

jsondatasource-with-wpf-controls/VB/How-to-use-JsonDataSource-with-WPF-controls/MainWindow.xaml.vb#L18

Dim fileUri As Uri = New Uri("json_data.json", UriKind.RelativeOrAbsolute)
jsonDataSource.JsonSource = New UriJsonSource(fileUri)
jsonDataSource.Fill()

how-to-create-data-access-library-data-sources-at-runtime-t424210/VB/JsonDataSourceSnippets/Code.vb#L12

Dim sourceUri As New Uri("https://raw.githubusercontent.com/DevExpress-Examples/DataSources/master/JSON/customers.json")
jsonDataSource.JsonSource = New DevExpress.DataAccess.Json.UriJsonSource(sourceUri)
jsonDataSource.Fill()