DataStoreDataExtensions.ExportJson(this IDataStoreBase dataStore, DwBuffer dwbuffer, int startRow, int endRow, int startColumn, int endColumn, MappingMethod mappingMethod) Method

.NET Standard 2.x

Exports the rows (from the specified starting position to the ending position) and the columns (from the specified starting position to the ending position) from the specified buffer to a DataWindow JSON string.

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

  public static string ExportJson(this IDataStoreBase dataStore, DwBuffer dwbuffer, int startRow, int endRow, int startColumn, int endColumn, MappingMethod mappingMethod);

Parameters

dwbuffer DWNet.Data.DwBuffer

A value of the DwBuffer enumerated datatype identifying the DataWindow buffer from which you want to export the data.

startRow System.Int32

The zero-based index number of the first row in the buffer that you want to export.

endRow System.Int32

The zero-based index number of the last row in the buffer that you want to export.

If it is negative, it indicates the rest of rows.

startColumn System.Int32

The zero-based index number of the first column in the buffer that you want to export.

If it is negative, 0 is used.

endColumn System.Int32

The zero-based index number of the last column in the buffer that you want to export.

If it is negative, it indicates the rest of columns.

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.

Examples

The following code example demonstrates how to export the department records to a JSON string using startRow, endRow, startColumn and endColumn parameters.

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 Example9()
        {
            // Instantiates a DataStore object with datawindow: d_department.
            var datastore = new DataStore("d_department", _context);

            datastore.Retrieve();

            // Exports data from rows (from 1st to 11th) and columns (2nd and 3rd) of the 
            // primary buffer.
            string json = datastore.ExportJson(
                DwBuffer.Primary, 0, 10, 1, 2, MappingMethod.Index);

            Console.WriteLine(json);

            /*The exported JSON file is:

            ExportJson9.json  
            */
        }
    }
}

Example Refer To

Model Class: D_Department
JSON File: ExportJson9
DataWindow File: d_department

Applies to

.NET Standard

2.x