IDwDataExporter.ExportPlain(DwBuffer dwbuffer, bool changedOnly) Method

.NET Standard 2.x

Exports entity class data from the specified buffer of the DataStore in the specified DataFormat, and specifies whether to export only the changed rows.

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

string ExportPlain(DwBuffer dwbuffer, bool changedOnly);

Parameters

dwbuffer DWNet.Data.DdwBuffer

A value of the DwBuffer enumerated datatype identifying the DataWindow buffer from which you want to export the data. For a list of valid values, see DWBuffer.

changedOnly System.Boolean

A boolean specifying the changing flag.

Returns

System.String

Data string in the specified format.

Reference Plain JSON

Examples

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

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

namespace Appeon.ApiDoc.IDwDataExporterExamples
{
    public class ExportPlainExample
    {
        private readonly SchoolContext _context;

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

        public void Example3()
        {
            // 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();

            // Get DataStore exporter in JSON format.
            var exporter = datastore.GetDataExporter(DataFormat.Json);

            // Exports the modified data from the primary buffer
            string json1 = exporter.ExportPlain(DwBuffer.Primary, true);

            Console.WriteLine("exporter.ExportPlain(DwBuffer.Primary, true):");
            Console.WriteLine(json1);

            /*The exported JSON file is:

            ExportPlainJson3_1.json  
            */

            // Exports all data from the primary buffer
            string json2 = exporter.ExportPlain(DwBuffer.Primary, false);

            Console.WriteLine("exporter.ExportPlain(DwBuffer.Primary, true):");
            Console.WriteLine(json2);

            /*The exported JSON file is:

            ExportPlainJson3_2.json  
            */
        }
    }
}

Example Refer To

Model Class: D_Department
JSON Files: ExportPlainJson3_1 ExportPlainJson3_2
DataWindow File: d_department