FileHelpers

Indicates the used for write operations.

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

Uses the ' ' char to align.

The position of the alignment.

You can indicate the align char.

The position of the alignment. The character used to align.

The position of the alignment.

The character used to align.

This class only have static methods to work with files and strings in the common way.

Used to read a file without instanciate the engine.
This is feature limited method try to use the non static methods.

The record class. The file name The read records.

Used to read a string without instanciate the engine.
This is feature limited method try to use the non static methods.

The record class. The input string. The read records.

Used to write a file without instanciate the engine.
This is feature limited method try to use the non static methods.

The record class. The file name The records to write

Used to write a string without instanciate the engine.
This is feature limited method try to use the non static methods.

The record class. The records to write The string with the writen records.

This class implements the and is the base class for Data Base storages.

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 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.

Creates an instance of this class.

Creates an instance of the RecordInfo class. This method is used because hte constructor of the record info is internal.

The class passed to the RecordInfo constructor. A RecordInfo instance.

Returns the class that represent the records in the file.

The Object responsable for manage the errors.

This method recives the fields values as an array and must return a record object.

The record fields values. The record object.

Must return the Select Sql used to Fetch the records to Extract.

The SQL statement.

Must return a SQL string with the insert statement for the records.

The record to insert. The Sql string to used to insert the record.

Must create an abstract connection object.

An Abstract Connection Object.

Must create an abstract command object.

An Abstract Command Object.

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.

Returns the class that represent the records in the file.

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

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.

An internal class used to store information about the Record Type.

Is public to provide extensibility of DataSorage from outside the library.

The unique constructor for this class. It needs the subyacent record class.

The Type of the record class.

Internal.

Returns a record formed with the passed values.

The source Values. A record formed with the passed values.

Get an object[] of the values in the fields of the passed record.

The source record. An object[] of the values in the fields.

The Number of no ignored fields in the record class.

Indicates if the Record Info has fields of type Date

This is used externally by the ExcelStorage.

Class that provides static methods that returns a default Converter to the basic types.

Used by the .

Returns a Byte Converter.

The that performs the convertion.

Returns a Int16 Converter.

The that performs the convertion.

Returns a Int32 Converter.

The that performs the convertion.

Returns a Int64 Converter.

The that performs the convertion.

Returns a Int16 Converter.

The that performs the convertion.

Returns a Int32 Converter.

The that performs the convertion.

Returns a Int64 Converter.

The that performs the convertion.

Returns a Date Converter. Uses the default format "ddMMyyyy".

The that performs the convertion.

Returns a Date Converter. Uses the specified format.

The format used to convert from/to a string. The that performs the convertion.

Returns a Boolean Converter.

The that performs the convertion.

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.

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 Detail if the selector string is found.

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

Base class for the two engines of the library: and

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

The record mapping class.

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

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.

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 selector 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) 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. 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. 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. 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. 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. 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) 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) 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.

Helper Class to manipulate Strings.

Used to extract a quoted string and de-escape the quote char.

Source string The quoted char. An output parameter of the index of the end of the string. The estracted string

Used to generate a quoted string and escape the quote char.

Source string The quoted char. The quoted string

Removes the blank characters (space, tabs, etc) from the string.

The string to be parsed. A string thats results of remove the blanks chars from the source string.

Used to extract a quoted string and de-escape the quote char.

Source string The quoted char. An output parameter of the index of the end of the string. The estracted string

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



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


	public void ReadExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginReadFile(@"C:\source.txt");
	    
	    while( engine.ReadNext() != null )
	    {
	       record = (SampleType) engine.LastRecord;
	       
	       // put your code here !!!!
	       Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
	    
	    }
	    
	    engine.EndsRead();
	}

	
	public void WriteExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginWriteFile(@"C:\source.txt");
	    
	    record.Field1 = "Primer Registro";
	    record.Field2 = 1;
	    engine.WriteNext(record);
	    
	    record.Field1 = "Segundo Registro";
	    record.Field2 = 2;
	    engine.WriteNext(record);

	    engine.EndsWrite();
	}

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

The record mapping class.

Open a specified stream and seek to the first record.

This method only seek to the first record. To read record by record use method. When you stop to read the file you must call method. The TextReader of the stream.True if the stream is succefully opened. False otherway. This example show the basic use of the async methods in the FileHelperAsymcEngine:



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


	public void ReadExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginReadFile(@"C:\source.txt");
	    
	    while( engine.ReadNext() != null )
	    {
	       record = (SampleType) engine.LastRecord;
	       
	       // put your code here !!!!
	       Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
	    
	    }
	    
	    engine.EndsRead();
	}

Open a specified file and seek to the first record.

This method only open the file. To read record by record use method. When you stop to read the file you must call method. The file path to be read.True if the file is succefully opened. False otherway. This example show the basic use of the async methods in the FileHelperAsymcEngine:



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


	public void ReadExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginReadFile(@"C:\source.txt");
	    
	    while( engine.ReadNext() != null )
	    {
	       record = (SampleType) engine.LastRecord;
	       
	       // put your code here !!!!
	       Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
	    
	    }
	    
	    engine.EndsRead();
	}

Reads the next record of a file opened with the or method.

This method not only returns the current record, also moves to the next. If the end of file is reached this method return null. The current record of the opened file. This example show the basic use of the async methods in the FileHelperAsymcEngine:



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


	public void ReadExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginReadFile(@"C:\source.txt");
	    
	    while( engine.ReadNext() != null )
	    {
	       record = (SampleType) engine.LastRecord;
	       
	       // put your code here !!!!
	       Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
	    
	    }
	    
	    engine.EndsRead();
	}

Reads the specified number of records from a file or stream opened with the or method.

If there are less records in the source, read to the end. The number of records to read. If there are less records in the source, read to the end.The nexts records of the opened file or stream.

If any, close all opened stream readers.

This method must be called when you finish to process a file to dispose the opened streams. This example show the basic use of the async methods in the FileHelperAsymcEngine:



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


	public void ReadExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginReadFile(@"C:\source.txt");
	    
	    while( engine.ReadNext() != null )
	    {
	       record = (SampleType) engine.LastRecord;
	       
	       // put your code here !!!!
	       Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
	    
	    }
	    
	    engine.EndsRead();
	}

Set the stream to be used in the operation.

When you finish to write to the file you must call method. To stream to writes to.True if the operation is successful. False otherwise. This example show the basic use of the async methods in the FileHelperAsymcEngine:



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


	public void WriteExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginWriteFile(@"C:\source.txt");
	    
	    record.Field1 = "Primer Registro";
	    record.Field2 = 1;
	    engine.WriteNext(record);
	    
	    record.Field1 = "Segundo Registro";
	    record.Field2 = 2;
	    engine.WriteNext(record);

	    engine.EndsWrite();
	}

Open a file to write it. If exist override it.

When you finish to write to the file you must call method. The file path to be opened to write.True if the operation is successful. False otherwise. This example show the basic use of the async methods in the FileHelperAsymcEngine:



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


	public void WriteExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginWriteFile(@"C:\source.txt");
	    
	    record.Field1 = "Primer Registro";
	    record.Field2 = 1;
	    engine.WriteNext(record);
	    
	    record.Field1 = "Segundo Registro";
	    record.Field2 = 2;
	    engine.WriteNext(record);

	    engine.EndsWrite();
	}

Open a file to Append to the end.

This method open and seek ends the file. When you finish to append to the file you must call method. The file path to be opened to write at the end.True if the operation is successful. False otherwise.

Write the next record to a file or stream opened with , or method.

The record to write. This example show the basic use of the async methods in the FileHelperAsymcEngine:



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


	public void WriteExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginWriteFile(@"C:\source.txt");
	    
	    record.Field1 = "Primer Registro";
	    record.Field2 = 1;
	    engine.WriteNext(record);
	    
	    record.Field1 = "Segundo Registro";
	    record.Field2 = 2;
	    engine.WriteNext(record);

	    engine.EndsWrite();
	}

Write the nexts records to a file or stream opened with , or method.

The records to write.

If any, close all opened stream writers.

This method must be called when you finish to process a file to dispose the opened streams. This example show the basic use of the async methods in the FileHelperAsymcEngine:



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


	public void WriteExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginWriteFile(@"C:\source.txt");
	    
	    record.Field1 = "Primer Registro";
	    record.Field2 = 1;
	    engine.WriteNext(record);
	    
	    record.Field1 = "Segundo Registro";
	    record.Field2 = 2;
	    engine.WriteNext(record);

	    engine.EndsWrite();
	}

Contains the last Record read by the method.

This example show the basic use of the async methods in the FileHelperAsymcEngine:



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


	public void ReadExample()
	{
		SampleType record;	

		FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));

	    engine.BeginReadFile(@"C:\source.txt");
	    
	    while( engine.ReadNext() != null )
	    {
	       record = (SampleType) engine.LastRecord;
	       
	       // put your code here !!!!
	       Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
	    
	    }
	    
	    engine.EndsRead();
	}

Indicates the the target field is ignored by the Engine AND NOT IS IN THE FILE.

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

Indicates the the target field is ignored by the Engine AND NOT IS IN THE FILE.

Indicates the length of a FixedLength field.

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

Indicates the length of a FixedLength field.

The length of the field.

The String Length of the record defined inside a class with the .

Indicates that this class represents a fixed length 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 fixed length record.

Indicates the wrong usage of the library.

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.

Creates an instance of an BadUsageException.

The exception Message

Creates an instance of an BadUsageException.

The exception Message The inner exception.

This class implements the for plain text files.

Create an instance of this class to work with the specified type.

The record class. The target filename.

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.

Returns the class that represent the records in the file.

The engine behind the FileStorage.

The target file name.

Indicates the behavior of quoted fields.

This is a base class that implements the for Microsoft Access Files.

Must create an abstract connection object.

An Abstract Connection Object.

Must create an abstract command object.

An Abstract Command Object.

The complete path to the access database.

The password to the access database.

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.

This is a base class that implements the for Microsoft SqlServer.

Must create an abstract connection object.

An Abstract Connection Object.

Must create an abstract command object.

An Abstract Command Object.

The server name or IP.

The name of the database.

The user name used to logon to the SqlServer.

Leave empty for WIndows Authentication.

The user pass used to logon to the SqlServer.

Leave empty for WIndows Authentication.

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.

Class used to notify the current progress position and other context info.

The current progress position. Check also the ProgressMode property.

The total when the progress finish. (-1 means undefined)

The ProgressMode used.

Delegate used to notify progress to the user.

Indicates the used for read/write operations.

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

Indicates the used for read/write ops.

The used for the transformations.

Indicates the used for read/write ops.

The used for the transformations. The first param pased directly to the Converter Constructor.

Indicates the used for read/write ops.

The used for the transformations. The first param pased directly to the Converter Constructor. The second param pased directly to the Converter Constructor.

Indicates the used for read/write ops.

The used for the transformations. The first param pased directly to the Converter Constructor. The second param pased directly to the Converter Constructor. The third param pased directly to the Converter Constructor.

Indicates a custom implementation.

The Type of your custom converter. A list of params pased directly to your converter constructor.

Indicates a custom implementation.

The Type of your custom converter.

The used to performs the string to records and record to string operations.

Indicates the used after read to truncate the field.

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

Indicates the used after read to truncate the field. By default trims the blank spaces and tabs.

The used after read.

Indicates the used after read to truncate the field.

The used after read. A list of chars used to trim.

The chars to Trim.

The Trim behavior.

Indicates the number of lines to be discarded at the end.

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

Indicates that the last line must be discarded.

Indicates the number of last lines to be ignored at the end.

The number of lines to be discarded at end.

The number of lines to be ignored at end.

Indicates that the target field is included only under some circunstances.

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

Indicates that the target field is included only under some circunstances.

Indicates the align of the field when the writes the record.

Aligns the field to the left.

Aligns the field to the center.

Aligns the field to the right.

Indicates the number of first lines to be discarded.

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

Indicates that the first line must be discarded.

Indicates the number of first lines to be ignored.

The number of first lines to be discarded.

The number of first lines to be ignored.

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

Indicates that this class represents a delimited record.

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

This is the class that handles the errors of the library process.

This is shared by the FileHelper Engine and all the DataStorage.

Initializes a new instance of the class.

Initializes a new instance of the class. with the specified .

Indicates the error behavior of the class.

Clears the error collection.

Add the specified ErrorInfo to the contained collection.

Saves the contained errors to the specified file.

The file that contains the errors.

Saves the contained errors to the specified file.

The file that contains the errors. The header line of the errors file.

Load errors from a file.

The file that contains the errors.

Is an array of that contains the errors of the last operation in this class.

Indicates the behavior of the when it found an error.

Number of contained errors.

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)

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



	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(@"C:\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(@"C:\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.

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(@"C:\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 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(@"C:\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 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. 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(@"C:\destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

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.



	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(@"C:\destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

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. 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(@"C:\destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

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. 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(@"C:\destination.txt", records);
		
		// Now the file contains the created record in this format:
		// 
		// Hello World,12
		
	}

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) 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(@"C:\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(@"C:\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 array of records to write.True if the operation is successful. False otherwise.

Indicates the convertion used in the .

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

Convert from/to Boolean values.

Convert from/to Byte values.

Convert from/to Int16 values.

Convert from/to Int32 values.

Convert from/to Int64 values.

Convert from/to Decimal values.

Convert from/to Double values.

Convert from/to Single values.

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 the behavior when the class found an error.

Default value, this simple Rethrow the original exception.

Add an to the array of .

Simply ignores the exception an continue.

With this attribute you can mark a method in the RecordClass that is the responsable of convert it to the specified.

The target of the convertion.

The target type of the convertion

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

Indicates a diferent delimiter for this field.

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

Indicates the triming behavior of the trailing characters.

No triming is performed.

The field is trimed in both sides.

The field is trimed in the left.

The field is trimed in the right.

Indicates that a string value can't be converted to a dest type.

The destination type.

The source string.

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. True if the operation is successful. False otherwise.

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 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 has the responsability to enable the bidirectional transformation. File <-> File (with different record class)

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.

The source file. The destination file. The transformed records in the destFile.

Transform the contents of the sourceFile and write them to the destFile.

The source file. The destination file. The transformed records in the destFile.

The source record Type.

The destination record Type.

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.

Indicate the method used to calculate the current progress

Notify the percent completed.

Notify the Record completed.

Notify the bytes readed.

Dont call to the progress handler.

Indicates the value to assign to the field in the case of find a "NULL".

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

Indicates directly the null value.

The value to assign in the "NULL" case.

Indicates a type and a string to be converted to that type.

The type of the null value. The string to be converted to the specified type.

The null value used when the file has a null string in the record position.

Indicates that the field must be read and written like a Quoted String. (by default "")

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

Indicates that the field must be read and written like a Quoted String. (by default "")

Indicates that the field must be read and written like a "Quoted String" (that can be optional).

Indicates if the handling of optionals in the quoted field.

Indicates that the field must be read and written like a Quoted String.

The char used to quote the string.

Indicates that the field must be read and written like a Quoted String (that can be optional).

The char used to quote the string. Indicates if the handling of optionals in the quoted field.

Indicates that the field must be read and written like a Quoted String (that can be optional).

The char used to quote the string. Indicates if the handling of optionals in the quoted field.

Indicates that the field must be read and written like a Quoted String (that can be optional).

The char used to quote the string.

Indicates if the Quoted char can be optional (default is false)

The char used to quote the string.