DataStoreDataExtensions.ExportJson(this IDataStoreBase dataStore, bool primaryData, bool filterData, bool deleteData, bool dwcdata, MappingMethod mappingMethod) Method

.NET Standard 2.x

Exports data from the specified buffer(s) and/or DataWindowChild to a DataWindow JSON string.

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

  public static string ExportJson(this IDataStoreBase dataStore, bool primaryData, bool filterData, bool deleteData, bool dwcdata, MappingMethod mappingMethod);

Parameters

primaryData System.Boolean

A boolean specifying whether to export the data from the primary buffer.

True: to export;

False: not to export.

filterData System.Boolean

A boolean specifying whether to export the data from the filter buffer.

True: to export;

False: not to export.

deleteData System.Boolean

A boolean specifying whether to export the data from the delete buffer.

True: to export;

False: not to export.

dwcdata System.Boolean

Aboolean specifying whether to export the DataWindowChild data.

True: to export. If it is to export the DataWindowChild data, data from all buffers will be exported to a plain-format JSON, regardless of the value of the other arguments.

False: not to export.

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.

Remarks

See JSON formats for details about the DataWindow JSON.

Examples

The following code example demonstrates how to export the course records (including DataWindowChild) to JSON strings. When primaryData is true, exports data from the primary buffer to the JSON string; When filterData is true, exports data from the filter buffer to the JSON string; When deleteData is true, exports data from the delete buffer to the JSON string; When dwcdata is true, exports data from the DataWindowChild to the JSON string. The "d_course" DataWindow object has a departmentid column which embeds a child DataWindow "dddw_deparment".

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 Example4()
        {
            // Instantiates the datastore with datawindow: d_course
            var datastore = new DataStore("d_course", _context);

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

            // Exports all buffers including data of child DataWindow
            string json1 = datastore.ExportJson(true, true, true, true, 0);

            Console.WriteLine("datastore.ExportJson(true, true, true, 0):");
            Console.WriteLine(json1);

            /*The exported JSON file is:

            ExportJson4_1.json  
            */

            // Exports all buffers excluding data of child DataWindow
            string json2 = datastore.ExportJson(true, true, true, false, 0);

            Console.WriteLine("datastore.ExportJson(true, true, true, 0):");
            Console.WriteLine(json2);

            /*The exported JSON file is:

            ExportJson4_2.json  
            */
        }
    }
}

Example Refer To

Model Classes: D_Course Dddw_Department
JSON Files: ExportJson4_1 ExportJson4_2
DataWindow File: d_course

Applies to

.NET Standard

2.x