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

.NET Standard 2.x

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

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

  public static string ExportXml(this IDataStoreBase dataStore, DwBuffer dwbuffer, bool changedOnly, 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. For a list of valid values, see DWBuffer. If not specified, all of the DataWindow buffers will be exported, however, the data for DataWindowChild will not be exported (even if changedonly parameter is false).

changedOnly 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 if it succeeds.

Examples

The following code example demonstrates how to export the department records from the primary buffer to XML strings using different changedOnly arguments. When changedOnly is true, exports the modified data from the primary buffer to an XML string; when changedOnly is false, exports all data from the primary buffer 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 Example3()
        {
            // 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();

            // Exports the modified data from the primary buffer
            string xml1 =
                datastore.ExportXml(DwBuffer.Primary, true, MappingMethod.Index);


            Console.WriteLine("datastore.ExportXml(DwBuffer.Primary,true, 0):");
            Console.WriteLine(xml1);

            /*The exported XML file is:

            ExportXml3_1.xml  
            */

            // Exports all data from the primary buffer
            string xml2 =
                datastore.ExportXml(DwBuffer.Primary, false, MappingMethod.Index);

            Console.WriteLine("datastore.ExportXml(DwBuffer.Primary, false, 0):");
            Console.WriteLine(xml2);

            /*The exported XML file is:

            ExportXml3_2.xml
            */
        }
    }
}

Example Refer To

Model Class: D_Department
DataWindow File: d_department

Applies to

.NET Standard

2.x