DataStoreDataExtensions.ExportJson(this IDataStoreBase dataStore, DwBuffer dwbuffer, MappingMethod mappingMethod) Method

.NET Standard 2.x

Exports data from the specified buffer to a DataWindow JSON string.

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

  public static string ExportJson(this IDataStoreBase dataStore, DwBuffer dwbuffer, MappingMethod mappingMethod);

Parameters

dwbuffer DWNet.Data.DwBuffer

A value of the DwBuffer enumerated datatype identifying the DataWindow buffer from which you want to export the data.

mappingMethod SnapObjects.Data.MappingMethod

A value of the MappingMethod enumerated datatype specifying the method for mapping columns.

Returns

System.String

Returns the JSON string if it succeeds.

Examples

The following code example demonstrates how to export the department records from the primary buffer to a JSON string.

using SnapObjects.Data;
using DWNet.Data;
using System;

namespace Appeon.ApiDoc.DataStoreDataExtensionsExamples
{
    public class ExportJsonExample
    {
        private readonly SchoolContext _context;

        public ExportJsonExample(SchoolContext dataContext)
        {
            // Sets the data context
            _context = dataContext;
        }

        public void Example5()
        {
            // Instantiates a DataStore object with datawindow: d_department.
            var datastore = new DataStore("d_department", _context);

            // Generates data in the primary/delete/filter buffers for this example.
            datastore.Retrieve();
            datastore.DeleteRow(0);
            datastore.SetFilter("departmentid < 5");
            datastore.Filter();

            // Exports data from the primary buffer
            string json = datastore.ExportJson(DwBuffer.Primary, MappingMethod.Index);

            Console.WriteLine(json);

            /*The exported JSON file is:

            ExportJson5.json  
            */
        }
    }
}

Example Refer To

Model Class: D_Department
JSON File: ExportJson5
DataWindow File: d_department

Applies to

.NET Standard

2.x