IDwDataExporter.Export(bool changedOnly, MappingMethod importMapping) Method

.NET Standard 2.x

Exports data from the DataStore primary buffer 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(bool changedOnly, MappingMethod importMapping);

Parameters

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 to JSON strings using different changeOnly arguments. 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 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 Example5()
        {
            // 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);

            // When changeOnly is true, exports the modified data from 
            // primary/filter/delete buffers
            string json1 = exporter.Export(true, MappingMethod.Index);

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

            /*The exported JSON file is:

            ExportJson2_1.json  
            */

            // When changeOnly is false, exports all data from 
            // primary/filter/delete buffers
            string json2 = exporter.Export(false, MappingMethod.Index);

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

            /*The exported JSON file is:

            ExportJson2_2.json  
            */
        }
    }
}

Example Refer To

Model Class: D_Department
JSON Files: ExportJson2_1 ExportJson2_2
DataWindow File: d_department