DataStoreDataExtensions.ExportPlainXml(this IDataStoreBase dataStore, bool changedOnly) Method

.NET Standard 2.x

Exports all rows or only the changed rows from the DataStore to a plain-format XML string.

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

  public static string ExportPlainXml(this IDataStoreBase dataStore, bool changedOnly);

Parameters

changedOnly System.Boolean

A boolean specifying the changing flag.

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

False (default): to export all rows.

Returns

System.String

Returns the XML string.

Examples

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

using DWNet.Data;
using System;

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

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

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

            // Exports the modified data from primary/filter/delete buffers.
            string xml1 = datastore.ExportPlainXml(true);

            Console.WriteLine("ExportPlainXml(true)");
            Console.WriteLine(xml1);

            /*The exported XML file is:

            ExportPlainXml2_1.xml  
            */

            // Exports all data from primary/filter/delete buffers
            string xml2 = datastore.ExportPlainXml(false);

            Console.WriteLine("ExportPlainXml(false)");
            Console.WriteLine(xml2);

            /*The exported XML file is:

            ExportPlainXml2_2.xml
            */
        }
    }
}

Example Refer To

Model Class: D_Department
DataWindow File: d_department

Applies to

.NET Standard

2.x