DataStoreDataExtensions.ExportXml(this IDataStoreBase dataStore, bool changedOnly, MappingMethod mappingMethod) Method

.NET Standard 2.x

Exports all rows or only the changed rows from DataStore to a DataWindow XML string.

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

  public static string ExportXml(this IDataStoreBase dataStore, bool changeOnly, MappingMethod mappingMethod);

Parameters

changeOnly System.Boolean

A boolean specifying the changing flag.

True: to export the changed rows only (and all rows in the delete buffer).

False (default): to export all rows.

mappingMethod SnapObjects.Data.MappingMethod

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

Returns

System.String

Returns the XML string.

Examples

The following code example demonstrates how to export the department records to XML strings using different changeOnly arguments. When changeOnly is true, exports the modified data from primary/filter/delete buffers to an XML string; when changeOnly is false, exports all data from primary/filter/delete buffers to an XML string.

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

namespace Appeon.ApiDoc.DataStoreDataExtensionsExamples
{
    public class ExportXmlExample
    {
        private readonly SchoolContext _context;

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

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

            // When changeOnly is true, exports the modified data from 
            // primary/filter/delete buffers
            string xml1 = datastore.ExportXml(true, MappingMethod.Index);

            Console.WriteLine("datastore.ExportXml(true, " +
                              "MappingMethod.Index):");
            Console.WriteLine(xml1);

            /*The exported XML file is:

            ExportXml2_1.xml  
            */

            // When changeOnly is false, exports all data from 
            // primary/filter/delete buffers
            string xml2 = datastore.ExportXml(false, MappingMethod.Index);

            Console.WriteLine("datastore.ExportXml(false, " +
                              "MappingMethod.Index):");
            Console.WriteLine(xml2);

            /*The exported XML file is:

            ExportXml2_2.xml  
            */
        }
    }
}

Example Refer To

Model Class: D_Department
DataWindow File: d_department

Applies to

.NET Standard

2.x