TxtCsvHelper 1.2.8

TxtCsvHelper

TxtCsvHelper is a library to assist in parsing CSV, or any other form of delimited files. You can fill models, fill dynamics, or simply get a list of fields by line.

Installation

Use the package manager console to install TxtCsvHelper.

Install-Package TxtCsvHelper -Version 1.2.8

Usage

using TxtCsvHelper;

To return an IEnumerable<T>. Dynamic types must be IEnumerable<dynamic> Parser can take a Stream, StreamReader, ReadStream, FileStream, MemoryStream or a string followed by 3 optional parameters: the delimiter character (will default to a comma). A bool if there is a header line (will default to true). A bool if there are spaces between delimiters and fields (will default to false). Deserialize takes a type.

using(Parser pars = new Parser(streamvar, delimiter: ',', hasHeader: true, hasSpaces: false))
{
	var models = pars.Deserialize<Person>();
}

To return an IEnumerable<string> for each line, call using StreamReader. If fields may have a line break use ReadStream instead of StreamReader. ReadStream is called with the exact syntax as StreamReader. Parser in this case takes 3 optional parameters: the delimiter character (will default to a comma). A bool if there is a header line (will default to true). A bool if there are spaces between delimiters and fields (will default to false). SplitLine takes a Line of delimited fields. Followed by 2 optional parameters: the delimiter character (will default to a comma). A bool if there are spaces between delimiters and fields (will default to false)

using (StreamReader sr = new StreamReader(postedFile.OpenReadStream()))
using(Parser pars = new Parser())
{
	while(sr.Peek() >= 0)
		var substrings = pars.SplitLine(sr.ReadLine());
		//do something with the strings
}

To return an IEnumerable<string> for each line, call using StreamReader. If fields may have a line break use ReadStream instead of StreamReader. ReadStream is called with the exact syntax as StreamReader. Only use this if fields may or may not be quoted (and contain a delimiter), otherwise use .SplitLine(). Parser in this case takes 3 optional parameters: the delimiter character (will default to a comma). A bool if there is a header line (will default to true). A bool if there are spaces between delimiters and fields (will default to false). SplitLine takes a Line of delimited fields. Followed by 2 optional parameters: the delimiter character (will default to a comma). A bool if there are spaces between delimiters and fields (will default to false)

using (StreamReader sr = new StreamReader(postedFile.OpenReadStream()))
using(Parser pars = new Parser())
{
	while(sr.Peek() >= 0)
		var substrings = pars.SplitLine(sr.ReadLine());
		//do something with the strings
}

If no header exists, you may declare the index of the field in the model with [SetIndex()] simply put the index starting with 0 inside the parentheses If a header exists but the names do not match your model, you may declare the header name with [HeaderName()] simply put the column name in the parentheses

public class Person
{
	[SetIndex(1)]
	[HeaderName(Last)]
        public string LastName { get; set; }
        [SetIndex(0)]
        public string FirstName { get; set; }
        [SetIndex(2)]
        public string MiddleName { get; set; }
        [SetIndex(3)]
        public int Age { get; set; }
}