IDwDataExporter.Export(DwBuffer dwbuffer, bool changedOnly, MappingMethod importMapping) Method

.NET Standard 2.x

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

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

string Export(DwBuffer dwbuffer, bool changedOnly, MappingMethod importMapping);

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.

importMapping SnapObjects.Data.MappingMethod

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

Returns

System.String

Data string in the specified format.

Reference DataWindow JSON Plain JSON

Examples

The following code example demonstrates how to export the department records from the primary buffer to JSON strings using different changeOnly arguments. 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 SnapObjects.Data;
using DWNet.Data;
using System;

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

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

        public void Example6()
        {
            // Instantiates the datastore 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.Export(DwBuffer.Primary, true, MappingMethod.Index);

            Console.WriteLine("exporter.Export(DwBuffer.Primary, true, MappingMethod.Index):");
            Console.WriteLine(json1);

            /*The exported JSON file is:

            ExportJson3_1.json  
            */

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

            Console.WriteLine("exporter.Export(DwBuffer.Primary, false, MappingMethod.Index):");
            Console.WriteLine(json2);

            /*The exported JSON file is:

            ExportJson3_2.json
            */
        }
    }
}

Example Refer To

Model Class: D_Department
JSON Files: ExportJson3_1 ExportJson3_2
DataWindow File: d_department