Show / Hide Table of Contents

    IDwDataExporter.Export(DwBuffer dwbuffer, int startRow, MappingMethod importMapping) Method

    .NET Standard 2.x

    Exports data from the specified buffer of the DataStore in the specified DataFormat, and specifies the start position of the rows, and how to map columns.

    Namespace: DWNet.Data

    Assembly: DWNet.Data.dll

    Syntax

    string Export(DwBuffer dwbuffer, int startRow, 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.

    startRow System.Int32

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

    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 in rows 2 through the end in 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 Example9()
            {
                // Instantiates a DataStore object with datawindow: d_department.
                var datastore = new DataStore("d_department", _context);
    
                datastore.Retrieve();
    
                // Get DataStore exporter in JSON format.
                var exporter = datastore.GetDataExporter(DataFormat.Json);
    
                // Exports records starting from rows 2 through the end in the primary buffer.
                string json = exporter.Export(DwBuffer.Primary, 1, MappingMethod.Index);
    
                Console.WriteLine(json);
    
                /*The exported JSON file is:
    
                ExportJson6.json  
                */
            }
        }
    }
    

    Example Refer To

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

    Back to top Generated by Appeon