DataStoreDataExtensions.ExportPlainJson(this IDataStoreBase dataStore, bool changedOnly) Method

.NET Standard 2.x

Exports all rows or only the changed rows from the DataStore to a plain-format JSON string.

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

  public static string ExportPlainJson(this IDataStoreBase dataStore, bool changedOnly);

Parameters

changedOnly System.Boolean

A boolean specifying the changing flag.

True: to export the changed rows only (and all rows of the delete buffer).

False (default): to export all rows.

Returns

System.String

Returns the JSON string.

Examples

The following code example demonstrates how to export the changed department records to JSON strings by using the changeOnly argument. When changeOnly is true, exports the modified data from primary/filter/delete buffers to a JSON string; when changeOnly is false, exports all data from primary/filter/delete buffers to a JSON string.

using DWNet.Data;
using System;

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

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

        public void Example2()
        {
            // 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.SetItem(0, 1, "department name");
            datastore.SetFilter("departmentid < 5");
            datastore.Filter();

            // Exports the modified data from primary/filter/delete buffers.
            string json1 = datastore.ExportPlainJson(true);

            Console.WriteLine("ExportPlainJson(true)");
            Console.WriteLine(json1);

            /*The exported JSON file is:

            ExportPlainJson2_1.json  
            */

            // Exports all data from primary/filter/delete buffers
            string json2 = datastore.ExportPlainJson(false);

            Console.WriteLine("ExportPlainJson(false)");
            Console.WriteLine(json2);

            /*The exported JSON file is:

            ExportPlainJson2_2.json
            */
        }
    }
}

Example Refer To

Model Class: D_Department
JSON Files: ExportPlainJson2_1 ExportPlainJson2_2
DataWindow File: d_department

Applies to

.NET Standard

2.x