DataStoreDataExtensions.ImportString(this IDataStoreBase dataStore, string text, int startRow, int endRow, int startColumn, int endColumn, int dwStartColumn) Method

.NET Standard 2.x

Inserts the tab-separated data from a string into the DataStore. You can specify the starting and ending rows and columns in the string to import. You can also specify which column in the DataStore is the first column to receive data.

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

  public static int ImportString(this IDataStoreBase dataStore, string text, int startRow, int endRow, int startColumn, int endColumn, int dwStartColumn);

Parameters

text System.String

A string from which you want to copy the data. The string should contain tab-separated columns.

startrow System.Int32

The zero-based number of the first row in the string that you want to import. If it is negative, 0 is used.

endRow System.Int32

The zero-based number of the last row in the string that you want to import. If it is negative, the rest of the rows will be imported.

startColumn System.Int32

The zero-based number of the first column in the string that you want to import. If it is negative, 0 is used.

endColumn System.Int32

The zero-based number of the last column in the string that you want to copy. If it is negative, the rest of the columns will be imported.

dwStartColumn System.Int32

The zero-based number of the first column in the DataStore that should receive data. The default is 0.

Returns

System.Int32

Returns the number of rows that were imported if it succeeds.

Remarks

The string must be formatted in tab-separated. Each line must end with a carriage return and a newline character (~r~n). If the string has four tab-separated columns, one line might look like for a tab-separated string:

col1_data\t col2_data\t col3_data\t col4_data\r\n

The string should consist of rows of data. If the data includes column headings or row labels, set the startRow and startColumn arguments to skip them. The datatype and order of the DataStore columns must match with the columns of data in the string.

Examples

The following code example demonstrates how to import the department records from a string to a DataStore using the dwStartColumn parameter.

using DWNet.Data;
using System;

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

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

        public void Example6()
        {
            // Instantiates the datastore with datawindow: d_department
            var datastore = new DataStore("d_department", _context);
			
			// Gets the string to be imported.
            string importString = GetImportString();

            // Imports data in the first and second rows of the string to the datastore
            // Imports data in columns (2nd through 6th) of the string to the datastore
            // DataStore d_department receives data beginning in the second column.
            // The first column (departmentid) in DataStore has no data imported.
            datastore.ImportString(importString, 0, 1, 1, 5, 1);

            Console.WriteLine("Rowcount: {0}", datastore.RowCount);

            for (int row = 0, rowcount = datastore.RowCount; row < rowcount; row++)
            {
                Console.WriteLine("DepartmentID: {0}; Name: {1}; Budget: {2}",
                                  datastore.GetItem<int>(row, "departmentid"),
                                  datastore.GetItem<string>(row, "name"),
                                  datastore.GetItem<decimal>(row, "budget"));
            }
            /*This code produces the following output:

            Rowcount: 2
            DepartmentID: 0; Name: Engineering; Budget: 350000.0000
            DepartmentID: 0; Name: English; Budget: 120000.0000
           */
        }
    }
}

Example Refer To

Model Class: D_Department
DataWindow File: d_department

Applies to

.NET Standard

2.x