FileHelpers

Interface used to provide In record notification of read operations.


            private class SampleType: INotifyRead, INotifyWrite
            { ....
            
            	public void AfterRead(EngineBase engine, string line)
            	{
            		// Your Code Here
            	}
            	public void BeforeWrite(EngineBase engine)
            	{
            		// Your Code Here
            	}
            
            }

Method called by the engines after read a record from the source data.

The engine that makes the call. The source line.

Interface used to provide In record notification of write operations.


            private class SampleType: INotifyRead, INotifyWrite
            { ....
            
            	public void AfterRead(EngineBase engine, string line)
            	{
            		// Your Code Here
            	}
            	public void BeforeWrite(EngineBase engine)
            	{
            		// Your Code Here
            	}
            
            }

Method called by the engines before write a record to the destination stream.

The engine that makes the call.

Contains error information of the class.

The line number of the error

The string of the record of the error.

The exception that indicates the error.

Base class to provide bidirectional Field - String convertion.

Convert a string in the file to a field value.

The string to convert. The field value.

Convert a field value to an string to write this to the file.

The basic implementation performs a: from.ToString(); The field values to convert. The string representing the field value.

Thorws a ConvertException with the passed values

The source string. The custom error msg.

Allow you to set the default Date Format used for the converter. With the same format that the .NET framework. By default: "ddMMyyyy"

If the class retures false the engines don´t pass null values to the converter. If true the engines pass all the values to the converter.

Indicates the convertion used in the .

Null Converter.

Convert from/to Date values. Params: arg1 is the string with the date format.

Convert from/to Boolean values.

Convert from/to Byte values. Params: arg1 is the decimal separator, by default '.'

Convert from/to Int16 or short values. Params: arg1 is the decimal separator, by default '.'

Convert from/to Int32 or int values. Params: arg1 is the decimal separator, by default '.'

Convert from/to Int64 or long values. Params: arg1 is the decimal separator, by default '.'

Convert from/to Decimal values. Params: arg1 is the decimal separator, by default '.'

Convert from/to Double values. Params: arg1 is the decimal separator, by default '.'

Convert from/to Single values. Params: arg1 is the decimal separator, by default '.'

Convert from/to Byte values. Params: arg1 is the decimal separator, by default '.'

Convert from/to UInt16 or unsigned short values. Params: arg1 is the decimal separator, by default '.'

Convert from/to UInt32 or unsigned int values. Params: arg1 is the decimal separator, by default '.'

Convert from/to UInt64 or unsigned long values. Params: arg1 is the decimal separator, by default '.'

Base class for the two engines of the library: and

Set the handler to the engine used to notify progress into the operations.

The

Set the handler to the engine used to notify progress into the operations.

Your method. The to use.

The current line number.

The total numbers of records in the last read/written file (only works with whole read/write).

Returns the type of records handled by this engine.

The read header in the last read operation. If any.

The read footer in the last read operation. If any.

The encoding to Read and Write the streams.

Default is the system's current ANSI code page. Default is the system's current ANSI code page.

This is a common class that manage the errors of the library.

You can, for example, get the errors, their number, Save them to a file, etc.

Base class for all the Storage classes of the library or the custom Storage classes.

For internal Use.

Indicates the way to notify the progress.

You method handler used to notify progress.

Set the handler to the engine used to notify progress into the operations.

The

Set the handler to the engine used to notify progress into the operations.

Your method. The to use.

Must Return the records from the DataSource (DB, Excel, etc)

The extracted records.

Must Return the records from the DataSource (DB, Excel, etc)

The extracted records.

Must Insert the records in a DataSource (DB, Excel, etc)

The records to insert.

The Object responsable for manage the errors.

Add an error to the ErrorCollection.

The line when the error occurs. The exception throwed, can be null. The record values

Creates an instance of this class.

Returns a record created from an Array of values

The values used to created the record. The just created record.

Returns an array of value based on a record.

The source record. An array with the values of each field

Returns the class that represent the records in the file.

The Object responsable for manage the errors.

The number of fields in the record class.

This class has the responsability to enable the two directional transformation. DataStorage <-> DataStorage

Uses two to accomplish this task. Quick Start Guide Class Diagram Examples of Use Example of the DataLink Attributes List

Create a new instance of the class.

The First used to insert/extract records . The Second used to insert/extract records .

Extract the records from DataStorage1 and Insert them to the DataStorage2.

The Copied records.

Extract the records from DataStorage2 and Insert them to the DataStorage1.

The Copied records.

The fisrt of the .

The second of the .

Indicates a diferent delimiter for this field.

See the Complete Attributes List for more clear info and examples of each one. Attributes List Quick Start Guide Examples of Use

Base class of and

See the Complete Attributes List for more clear info and examples of each one. Attributes List Quick Start Guide Examples of Use

Abstract class, see the inheritors.

Indicates a diferent delimiter for this field.

The separator string used to split the fields of the record.

Used with the Delegate to determines the action used by the

Ignore the current record.

Use the current record as Master.

Use the current record as Detail.

Indicates the visibility of a member.

Public visivility.

Internal visivility. (Friend in VB.NET)

Protected visivility.

Private visivility.

Indicates that this class represents a delimited record.

See the Complete Attributes List for more clear info and examples of each one. Attributes List Quick Start Guide Examples of Use

Base class for the record types..

See the Complete Attributes List for more clear info and examples of each one. Attributes List Quick Start Guide Examples of Use

Abstract class, see inheritors.

Indicates that this class represents a delimited record.

The separator string used to split the fields of the record.

One of the main classes of the library. This engine is responsable to Read/Write Master-Details records from/to files or streams.

You can set the of this class when found an error, and can retrive them with the property. See in the Class Diagram and in the Quick Start Guide for more Info. Or you can browse the Examples Seccion for more code. Quick Start GuideClass DiagramExamples of UseAttributes List

Initializes a new instance of the MasterDetailEngine class with the specified type of records.

The master record class.The detail record class.The to get the .

Initializes a new instance of the MasterDetailEngine class with the specified type of records.

The master record class.The detail record class.The used by the engine.The string passed to the selector.

Read a file and return an array of the contained records.

This method open, read and close the file (don't open or close the file before or after to call this method) You need to define a Selector Method too:


RecordAction ExampleSelector(string record)
{
   if (Char.IsLetter(record[0]))
      return RecordAction.Master;
    else
      return RecordAction.Detail;
}

Finally you must to instanciate a MasterDetailEngine and Read/Write files:


MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));

// to Read use:
MasterDetail[] res = engine.ReadFile("TestIn.txt");

// to Write use:
engine.WriteFile("TestOut.txt", res);

The file path to be read.An array of the records in the file

Read a Stream and return an array of the contained records.

This method only uses the stream and dont close them after use it, you must do it. You need to define a Selector Method too:


RecordAction ExampleSelector(string record)
{
   if (Char.IsLetter(record[0]))
      return RecordAction.Master;
    else
      return RecordAction.Detail;
}

Finally you must to instanciate a MasterDetailEngine and Read/Write files:


MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));

// to Read use:
MasterDetail[] res = engine.ReadFile("TestIn.txt");

// to Write use:
engine.WriteFile("TestOut.txt", res);

The reader of the source stream.An array of the records in the Stream

Read a String and return an array of the contained records.

The string that contains the records.An array of the records in the String.

Write an array of records to the specified file.

This method open, write and close the file (don't open or close the file before or after to call this method) This method overrides existing files. You need to define a Selector Method too:


RecordAction ExampleSelector(string record)
{
   if (Char.IsLetter(record[0]))
      return RecordAction.Master;
    else
      return RecordAction.Detail;
}

Finally you must to instanciate a MasterDetailEngine and Read/Write files:


MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));

// to Read use:
MasterDetail[] res = engine.ReadFile("TestIn.txt");

// to Write use:
engine.WriteFile("TestOut.txt", res);

The file path to be write.The array of records to write.True if the operation is successful. False otherwise.

Write the specified number of records from the array to a file.

This method open, write and close the file (don't open or close the file before or after to call this method) This method overrides existing files. You need to define a Selector Method too:


RecordAction ExampleSelector(string record)
{
   if (Char.IsLetter(record[0]))
      return RecordAction.Master;
    else
      return RecordAction.Detail;
}

Finally you must to instanciate a MasterDetailEngine and Read/Write files:


MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));

// to Read use:
MasterDetail[] res = engine.ReadFile("TestIn.txt");

// to Write use:
engine.WriteFile("TestOut.txt", res);

The file path to be write.The array of records to write.The max number of array elements to write.True if the operation is successful. False otherwise.

Write an array of records to the specified Stream.

This method only uses the stream and don't close them after use it, you must do it. You need to define a Selector Method too:


RecordAction ExampleSelector(string record)
{
   if (Char.IsLetter(record[0]))
      return RecordAction.Master;
    else
      return RecordAction.Detail;
}

Finally you must to instanciate a MasterDetailEngine and Read/Write files:


MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));

// to Read use:
MasterDetail[] res = engine.ReadFile("TestIn.txt");

// to Write use:
engine.WriteFile("TestOut.txt", res);

The writer of the source stream.The array of records to write.True if the operation is successful. False otherwise.

Write the specified number of records in the array to the Stream.

This method only uses the stream and don't close them after use it, you must do it. You need to define a Selector Method too:


RecordAction ExampleSelector(string record)
{
   if (Char.IsLetter(record[0]))
      return RecordAction.Master;
    else
      return RecordAction.Detail;
}

Finally you must to instanciate a MasterDetailEngine and Read/Write files:


MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));

// to Read use:
MasterDetail[] res = engine.ReadFile("TestIn.txt");

// to Write use:
engine.WriteFile("TestOut.txt", res);

The writer of the source stream.The array of records to write.The max number of array elements to write.True if the operation is successful. False otherwise.

Write an array of records to an String and return it.

The array of records to write.The resulting string after write the records.

Write an array of records to an String and return it.

The array of records to write.The resulting string after write the records.The max number of array elements to write.True if the operation is successful. False otherwise.

Append a record to the specified file.

This method open, seek ends, write and close the file (don't open or close the file before or after to call this method) You need to define a Selector Method too:


RecordAction ExampleSelector(string record)
{
   if (Char.IsLetter(record[0]))
      return RecordAction.Master;
    else
      return RecordAction.Detail;
}

Finally you must to instanciate a MasterDetailEngine and Read/Write files:


MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));

// to Read use:
MasterDetail[] res = engine.ReadFile("TestIn.txt");

// to Write use:
engine.WriteFile("TestOut.txt", res);

The file path to be written at end.The record to write.True if the operation is successful. False otherwise.

Append an array of records to the specified file.

This method open, seek ends, write and close the file (don't open or close the file before or after to call this method) You need to define a Selector Method too:


RecordAction ExampleSelector(string record)
{
   if (Char.IsLetter(record[0]))
      return RecordAction.Master;
    else
      return RecordAction.Detail;
}

Finally you must to instanciate a MasterDetailEngine and Read/Write files:


MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));

// to Read use:
MasterDetail[] res = engine.ReadFile("TestIn.txt");

// to Write use:
engine.WriteFile("TestOut.txt", res);

The file path to be written at end.The array of records to write.True if the operation is successful. False otherwise.

Returns the type of the master records handled by this engine.

Base class for all Field Types. Implements all the basic functionality of a field in a typed file.

Engine used to create diff files based on the interface.

Creates a new

The record type class that implements the interface.

Returns the records in newFile that not are in the sourceFile

The file with the old records. The file with the new records. The records in newFile that not are in the sourceFile

Returns the records in newFile that not are in the sourceFile

The file with the old records. The file with the new records. The records in newFile that not are in the sourceFile

Returns the duplicated records in both files.

A file with record. A file with record. The records that appear in both files.

Returns the NON duplicated records in both files.

A file with record. A file with record. The records that NOT appear in both files.

Read the source file, the new file, get the new records and write them to a destination file.

The file with the source records. The file with the new records. The destination file. The new records on the new file.

This class has the responsability to enable the two directional transformation. File <-> DataStorage

Uses an to accomplish this task. See in the Class Diagram and in the DataLink Sample for more Info. Quick Start Guide Class Diagram Examples of Use Example of the DataLink Attributes List

Create a new instance of the class.

The used to performs the transformation.

Extract records from the data source and insert them to the specified file using the DataLinkProvider method.

The files where the records be written. True if the operation is successful. False otherwise.

Extract records from the data source and insert them to the specified stream using the DataLinkProvider method.

The stream where the records be written. The extracted records

Extract records from a file and insert them to the data source using the DataLinkProvider method.

The file with the source records. True if the operation is successful. False otherwise.

Extract records from a stream and insert them to the data source using the DataLinkProvider method.

The stream with the source records. True if the operation is successful. False otherwise.

The short way to Extract the records from a DataStorage to a file

The DataStorage from where get the records The file where to write the records to. The Extracted records.

The short way to Insert Records from a file to a DataStorage

The DataStorage where store the records. The file with the SourceRecords The Inserted records

The internal used to the file or stream ops.

The internal used to the link ops.

An array of the last records extracted from the data source to a file.

An array of the last records inserted in the data source that comes from a file.

This class contains information of a Master record an their Details records. This class is used for the Read and Write operations of the .

Create an empty instance.

Create a new instance with the specified values.

The master record. The details record.

Returns a canonical empty MasterDetail object.

The Master record.

An Array with the Detail records.

Delegate thats determines the Type of the current record (Master, Detail, Skip)

The string of the current record. the action used for the current record (Master, Detail, Skip)

The Action taken when the selector string is found.

Parse the current record as Master if the selector string is found.

Parse the current record as Master if the record starts with some string.

Parse the current record as Master if the record ends with some string.

Parse the current record as Master if the record begins and ends with some string.

Parse the current record as Detail if the selector string is found.

Parse the current record as Detail if the record starts with some string.

Parse the current record as Detail if the record ends with some string.

Parse the current record as Detail if the record begins and ends with some string.

Base class for all the library Exceptions.

Basic constructor of the exception.

Message of the exception.

Basic constructor of the exception.

Message of the exception. The inner Exception.

Indicates the wrong usage of the library.

Creates an instance of an BadUsageException.

The exception Message

This class allow you to convert the records of a file to a different record format.

Quick Start Guide Class Diagram Examples of Use Example of the DataLink Attributes List

Create a new instance of the class.

The source record Type. The destination record Type.

Transform the contents of the sourceFile and write them to the destFile.(use only if you need the array of the transformed records, TransformFileAsync is faster)

The source file. The destination file. The transformed records.

Transform the contents of the sourceFile and write them to the destFile. (faster and use less memory, best choice for big files)

The source file. The destination file. The number of transformed records.

Transform an array of records from the source type to the destination type

An array of the source records. The transformed records.

Transform a file that contains source records to an array of the destination type

A file containing the source records. The transformed records.

The source record Type.

The destination record Type.

The Encoding of the Source File.

The Encoding of the Destination File.

Is a version of the exclusive for delimited records that allow you to change the delimiter an other options at runtime

Useful when you need to export or import the same info with 2 or more different delimiters or little different options.

One of the main classes of the library. This engine is responsable to Read/Write the records at once from/to files or streams. You can use the or the if you need to change some options at runtime

Quick Start GuideClass DiagramExamples of UseAttributes List This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void ReadExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

		SampleType[] records;	
		
		records = (SampleType[]) engine.ReadFile("source.txt");
		
		// Now "records" array contains all the records in the
		// sourcefile and can be acceded like this:
		
		int sum = records[0].Field2 + records[1].Field2;
	}

	
	public void WriteExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.WriteFile("destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

Initializes a new instance of the FileHelperEngine class with the specified type of records.

The record mapping class.

Initializes a new instance of the FileHelperEngine class with the specified type of records.

The record mapping class. The Encoding used by the engine.

Read a file and return an array of the contained records.

This method open, read and close the file (don't open or close the file before or after to call this method) This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void ReadExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

		SampleType[] records;	
		
		records = (SampleType[]) engine.ReadFile("source.txt");
		
		// Now "records" array contains all the records in the
		// sourcefile and can be acceded like this:
		
		int sum = records[0].Field2 + records[1].Field2;
	}

The file path to be read.An array of the records in the file

Read a file and return an array of the contained records.

This method open, read and close the file (don't open or close the file before or after to call this method) This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void ReadExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

		SampleType[] records;	
		
		records = (SampleType[]) engine.ReadFile("source.txt");
		
		// Now "records" array contains all the records in the
		// sourcefile and can be acceded like this:
		
		int sum = records[0].Field2 + records[1].Field2;
	}

The file path to be read.An array of the records in the file The max number of records to read. Int32.MaxValue or -1 to read all records.

Read a Stream and return an array of the contained records.

This method only uses the stream and dont close them after use it, you must do it. This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void ReadExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

		SampleType[] records;	
		
		records = (SampleType[]) engine.ReadFile("source.txt");
		
		// Now "records" array contains all the records in the
		// sourcefile and can be acceded like this:
		
		int sum = records[0].Field2 + records[1].Field2;
	}

The reader of the source stream.An array of the records in the Stream

Read a Stream and return an array of the contained records.

This method only uses the stream and dont close them after use it, you must do it. This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void ReadExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

		SampleType[] records;	
		
		records = (SampleType[]) engine.ReadFile("source.txt");
		
		// Now "records" array contains all the records in the
		// sourcefile and can be acceded like this:
		
		int sum = records[0].Field2 + records[1].Field2;
	}

The reader of the source stream.An array of the records in the Stream The max number of records to read. Int32.MaxValue or -1 to read all records.

Read a String and return an array of the contained records.

The string that contains the records.An array of the records in the String.

Read a String and return an array of the contained records.

The string that contains the records.An array of the records in the String. The max number of records to read. Int32.MaxValue or -1 to read all records.

Write an array of records to the specified file.

This method open, write and close the file (don't open or close the file before or after to call this method) This method overrides existing files. This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void WriteExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.WriteFile("destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

The file path to be write.The records to write (Can be an array, ArrayList, etc)True if the operation is successful. False otherwise.

Write the specified number of records from the array to a file.



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void WriteExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.WriteFile("destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

The file path to be write.The records to write (Can be an array, ArrayList, etc)The max number of array elements to write.True if the operation is successful. False otherwise.

Write an array of records to the specified Stream.

This method only uses the stream and don't close them after use it, you must do it. This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void WriteExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.WriteFile("destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

The writer of the source stream.The records to write (Can be an array, ArrayList, etc)True if the operation is successful. False otherwise.

Write the specified number of records in the array to the Stream.

This method only uses the stream and don't close them after use it, you must do it. This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void WriteExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.WriteFile("destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

The writer of the source stream.The records to write (Can be an array, ArrayList, etc)The max number of array elements to write.True if the operation is successful. False otherwise.

Write an array of records to an String and return it.

The records to write (Can be an array, ArrayList, etc)The resulting string after write the records.

Write an array of records to an String and return it.

The records to write (Can be an array, ArrayList, etc)The resulting string after write the records.The max number of array elements to write.True if the operation is successful. False otherwise.

Append a record to the specified file.

This method open, seek ends, write and close the file (don't open or close the file before or after to call this method) This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void AppendExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.AppendToFile("destination.txt", records);
		
		// Now the file contains have one more record at the end:
		// 
		// Hello World,12
		
	}

The file path to be written at end.The record to write.True if the operation is successful. False otherwise.

Append an array of records to the specified file.

This method open, seek ends, write and close the file (don't open or close the file before or after to call this method) This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void AppendExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.AppendToFile("destination.txt", records);
		
		// Now the file contains have one more record at the end:
		// 
		// Hello World,12
		
	}

The file path to be written at end.The records to write (Can be an array, ArrayList, etc)True if the operation is successful. False otherwise.

Read the records of the file and fill a DataTable with them

The file name. The DataTable with the read records.

Read the records of the file and fill a DataTable with them

The file name. The max number of records to read. Int32.MaxValue or -1 to read all records. The DataTable with the read records.

Read the records of a string and fill a DataTable with them.

The source string with the records. The DataTable with the read records.

Read the records of a string and fill a DataTable with them.

The source string with the records. The max number of records to read. Int32.MaxValue or -1 to read all records. The DataTable with the read records.

Read the records of the stream and fill a DataTable with them

The stream with the source records. The DataTable with the read records.

Read the records of the stream and fill a DataTable with them

The stream with the source records. The max number of records to read. Int32.MaxValue or -1 to read all records. The DataTable with the read records.

Called in read operations just before the record string is translated to a record.

Called in read operations just after the record was created from a record string.

Called in write operations just before the record is converted to a string to write it.

Called in write operations just after the record was converted to a string.

Allows to change some record layout options at runtime

Create a version of the exclusive for delimited records that allow you to change the delimiter an other options at runtime

Useful when you need to export or import the same info with 2 or more different delimiters. The record mapping class.

Allow changes in the record layout like delimiters and others common settings.

Is a version of the exclusive for delimited records that allow you to change the delimiter an other options at runtime

Useful when you need to export or import the same info with 2 or more different delimiters or little different options.

Quick Start GuideClass DiagramExamples of UseAttributes List This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void ReadExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

		SampleType[] records;	
		
		records = (SampleType[]) engine.ReadFile("source.txt");
		
		// Now "records" array contains all the records in the
		// sourcefile and can be acceded like this:
		
		int sum = records[0].Field2 + records[1].Field2;
	}

	
	public void WriteExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.WriteFile("destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

Initializes a new instance of the FileHelperEngine class with the specified type of records.

The record mapping class.

Initializes a new instance of the FileHelperEngine class with the specified type of records.

The record mapping class. The Encoding used by the engine.

Read a file and return an array of the contained records.

This method open, read and close the file (don't open or close the file before or after to call this method) This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void ReadExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

		SampleType[] records;	
		
		records = (SampleType[]) engine.ReadFile("source.txt");
		
		// Now "records" array contains all the records in the
		// sourcefile and can be acceded like this:
		
		int sum = records[0].Field2 + records[1].Field2;
	}

The file path to be read.An array of the records in the file

Read a file and return an array of the contained records.

This method open, read and close the file (don't open or close the file before or after to call this method) This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void ReadExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

		SampleType[] records;	
		
		records = (SampleType[]) engine.ReadFile("source.txt");
		
		// Now "records" array contains all the records in the
		// sourcefile and can be acceded like this:
		
		int sum = records[0].Field2 + records[1].Field2;
	}

The file path to be read.An array of the records in the file The max number of records to read. Int32.MaxValue or -1 to read all records.

Read a Stream and return an array of the contained records.

This method only uses the stream and dont close them after use it, you must do it. This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void ReadExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

		SampleType[] records;	
		
		records = (SampleType[]) engine.ReadFile("source.txt");
		
		// Now "records" array contains all the records in the
		// sourcefile and can be acceded like this:
		
		int sum = records[0].Field2 + records[1].Field2;
	}

The reader of the source stream.An array of the records in the Stream

Read a Stream and return an array of the contained records.

This method only uses the stream and dont close them after use it, you must do it. This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void ReadExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));

		SampleType[] records;	
		
		records = (SampleType[]) engine.ReadFile("source.txt");
		
		// Now "records" array contains all the records in the
		// sourcefile and can be acceded like this:
		
		int sum = records[0].Field2 + records[1].Field2;
	}

The reader of the source stream.An array of the records in the Stream The max number of records to read. Int32.MaxValue or -1 to read all records.

Read a String and return an array of the contained records.

The string that contains the records.An array of the records in the String.

Read a String and return an array of the contained records.

The string that contains the records.An array of the records in the String. The max number of records to read. Int32.MaxValue or -1 to read all records.

Write an array of records to the specified file.



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void WriteExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.WriteFile("destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

The file path to be write.The records to write (Can be an array, ArrayList, etc)True if the operation is successful. False otherwise.

Write the specified number of records from the array to a file.



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void WriteExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.WriteFile("destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

The file path to be write.The records to write (Can be an array, ArrayList, etc)The max number of array elements to write.True if the operation is successful. False otherwise.

Write an array of records to the specified Stream.

This method only uses the stream and don't close them after use it, you must do it. This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void WriteExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.WriteFile("destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

The writer of the source stream.The records to write (Can be an array, ArrayList, etc)True if the operation is successful. False otherwise.

Write the specified number of records in the array to the Stream.

This method only uses the stream and don't close them after use it, you must do it. This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void WriteExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.WriteFile("destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

The writer of the source stream.The records to write (Can be an array, ArrayList, etc)The max number of array elements to write.True if the operation is successful. False otherwise.

Write an array of records to an String and return it.

The records to write (Can be an array, ArrayList, etc)The resulting string after write the records.

Write an array of records to an String and return it.

The records to write (Can be an array, ArrayList, etc)The resulting string after write the records.The max number of array elements to write.True if the operation is successful. False otherwise.

Append a record to the specified file.

This method open, seek ends, write and close the file (don't open or close the file before or after to call this method) This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void AppendExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.AppendToFile("destination.txt", records);
		
		// Now the file contains have one more record at the end:
		// 
		// Hello World,12
		
	}

The file path to be written at end.The record to write.True if the operation is successful. False otherwise.

Append an array of records to the specified file.

This method open, seek ends, write and close the file (don't open or close the file before or after to call this method) This example show the basic use of the library with minimun code:



	using FileHelpers;
	
	// First declare the record class
		
	[Delimitedrecord("|")]
	public class SampleType
	{
		public string Field1;
		public int    Field2;
	}


	public void AppendExample()
	{
		FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
		
		SampleType[] records = new SampleType[1];

		records[0] = new SampleType();

		records[0].Field1 = "Hello World";
		records[0].Field2 = 12;

		engine.AppendToFile("destination.txt", records);
		
		// Now the file contains have one more record at the end:
		// 
		// Hello World,12
		
	}