FileHelpers [DelimitedRecord(",")] [ConditionalRecord(RecordCondition.ExcludeIfBegins, "//")] public class ConditionalType1 { // Using Regular Expressions example [DelimitedRecord(",")] [ConditionalRecord(RecordCondition.IncludeIfMatchRegex, ".*abc??")] public class ConditionalType3 {

Allow to declaratively show what records must be included or excluded

The condition used to include or exclude each record conditions The selector (match string) for the condition.

The condition used to include or exclude each record

The selector (match string) for the condition.

The string will have a condition, included, excluded start with etc

Base class of and

See the Complete Attributes List for more information and examples of each one.

Abstract class, see the derived classes.

Hides the field to the library, the library does not use the target field at all. Nor for read and write Note: If the field is in the record structure but you want to discard the values in that position use

See the complete attributes list for more information and examples of each one.

Indicates that the target field cannot contain an empty string value. This attribute is used for read.

See the complete attributes list for more information and examples of each one.

Discards the values for the target field. Note: If the field is not on the source file you must use

See the complete attributes list for more information and examples of each one.

Hides the field to the library. Obsolete: You must use [FieldHidden]

See the complete attributes list for more information and examples of each one.

Indicates the relative order of the current field. Note: If you use this property for one field you must to use it for all fields.

See the complete attributes list for more information and examples of each one.

Indicates the relative order of the current field. Note:If you use this property for one field you must to use it for all fields.

Indicates the relative order of the current field

The relative position order of this field.

Indicates that this class represents a delimited record.

See the complete attributes list for more information and examples of each one.

Base class for the record types..

See the complete attributes list for more information and examples of each one.

Abstract class, see inheritors.

Indicates that this class represents a delimited record.

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

The string used as a field separator.

Indicates the used for write operations.

See the complete attributes list for more information and examples of each one.

Uses the ' ' char to align.

The position of the alignment.

You can indicate the align character.

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

The position of the alignment.

The character used to align.

Allows you to set the length or bounds that the target array field must have.

Allows you to set the bounds that the target array field must have.

The lower bound The upper bound

Allow you to set the exact length that the target array field must have.

The exact length of the array field.

Array lower bound.

Array upper bound.

Indicates the used for read/write operations.

See the Complete attributes list for more information and examples of each one.

Indicates the used for read/write operations.

The used for the transformations.

Indicates the used for read/write operations.

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

Indicates the used for read/write operations.

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

Indicates the used for read/write operations.

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

Indicates the used for read/write operations.

The used for the transformations. An array of parameters passed directly to the Converter

Indicates a custom implementation.

The Type of your custom converter. The first param passed directly to the Converter Constructor.

Indicates a custom implementation.

The Type of your custom converter. The first param passed directly to the Converter Constructor. The second param passed directly to the Converter Constructor.

Indicates a custom implementation.

The Type of your custom converter. The first param passed directly to the Converter Constructor. The second param passed directly to the Converter Constructor. The third param passed directly to the Converter Constructor.

Indicates a custom implementation.

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

Indicates a custom implementation.

The Type of your custom converter.

The final concrete converter used for FieldToString and StringToField operations

The if a default converter is used

Indicates a different delimiter for this field.

See the complete attributes list for more information and examples of each one.

Indicates a different delimiter for this field.

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

Gets the Delimiter for this field

Indicates the length of a FixedLength field.

See the complete attributes list for more information and examples of each one.

Indicates the length of a Fixed Length field.

The length of the field.

Length of this Fixed Length field.

Hides the field to the library. Obsolete: You must use [FieldHidden]

See the complete attributes list for more information and examples of each one.

Indicates the target field has a new line before this value i.e. indicates that the records have multiple lines, and this field is in the beginning of a line.

See the complete attributes list for more information and examples of each one.

Indicates the target field has a new line before this value i.e. indicates that the records have multiple lines, and this field is in the beginning of a line.

Indicates the value to assign to the field in the case of a NULL value. A default value if none supplied in the field itself.

You must specify a string and a converter that can be converted to the type or an object of the correct type to be directly assigned. See the complete attributes list for more information and examples of each one.

Defines the default in event of a null value. Object must be of teh correct type

The value to assign the case of a NULL value.

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.

Default value for a null value.

Indicates that the target field might be on the source file. If it is not present then the value will be null (TODO: Check null) This attribute is used for read.

See the complete attributes list for more information and examples of each one.

Indicates that the field must be read and written as a Quoted String. By default uses "" (double quotes)

See the complete attributes list for more information and examples of each one.

Indicates that the field must be read and written as a Quoted String with double quotes.

Indicates that the field must be read and written as a Quoted String with the specified char.

The char used to quote the string.

Indicates that the field must be read and written as a "Quoted String" (that can be optional depending of the mode).

Indicates if the handling of optionals in the quoted field.

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

Indicates if the handling of optionals in the quoted field. Indicates if the field can span multiple lines.

Indicates that the field must be read and written as 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 as 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 if the field can span multiple lines.

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

Indicates if the field can span multiple lines.

The char used to quote the string.

Indicates if the handling of optionals in the quoted field.

Indicates if the field can span multiple lines.

Indicates the used after reading to truncate the field.

See the complete attributes list for more information and examples of each one.

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.

Indicates the used after read to truncate the field.

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

A string of chars used to trim.

The TrimMode used after read.

Indicates that this class represents a fixed length record.

See the complete attributes list for more information and examples of each one.

Indicates that this class represents a fixed length record. By default fixed length files require the records to have equal length. (ie the record length equals the sum of each field length.

Indicates that this class represents a fixed length record with the specified variable length record behavior.

The used for variable length records. By Default is FixedMode.ExactLength

Indicates the behavior when variable length records are found.

Indicates that the engine must ignore commented lines while reading.

See the complete attributes list for more information and examples of each one.

Indicates that the engine will ignore commented lines while reading. (The Comment Marker can have any number of spaces or tabs to the left)

The comment marker used to ignore the lines

Indicates that the engine will ignore commented lines while reading.

The comment marker used to ignore the lines Indicates if the comment can have spaces or tabs to the left (true by default)

Comment marker string

Can the comment marker have preceding spaces

Indicates that the engine will ignore the empty lines while reading.

See the complete attributes list for more information and examples of each one.

Indicates that the engine will ignore the empty lines while reading.

Indicates that the engine will ignore the empty lines while reading.

Ignore lines consisting of only whitespace.

Ignore lines consisting of only whitespace.

Indicates the number of lines at beginning of the file to be ignored.

Useful to ignore header records that you are not interested in. See the complete attributes list for more information and examples of each one.

Indicates that the first line of the file is ignored.

Indicates the number of lines at beginning of the file to be ignored.

The number of lines to be ignored.

The number of lines at beginning of the file to be ignored.

The number of lines to be ignored at the end of the file.

This is useful to discard trailer records from an incoming file. See the complete attributes list for more information and examples of each one.

Indicates that the last line of the file will be ignored.

Indicates the number of lines at end of the file that will be ignored.

The number of lines to be ignored at end of the file.

The number of lines to be ignored at end of the file.

Base class to provide bi-directional Field - String conversion.

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 just returns from.ToString(); The field values to convert. The string representing the field value.

Throws a ConvertException with the passed values

The source string. The custom error msg. Throw exception with values

Allow you to set the default Date Format used for the Converter. using the same CustomDateTimeFormat that is used in the .NET framework. By default: "ddMMyyyy"

If the class returns false the engines don't pass null values to the converter. If true the engines pass all the values to the converter.

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

Used by the .

Return culture information for with comma decimal separator or comma decimal separator

Decimal separator string Cultural information based on separator

Check the type of the field and then return a converter for that particular type

Field name to check Type of the field to check Converter for this particular field

Convert a numeric value with separators into a value

Culture information based on the separator

Type fo field being converted

Convert to a type given a decimal separator

type we are converting Separator

Convert the field to a string representation

Object to convert string representation

Convert a string to the object type

String to convert Object converted to

Convert a string into the return object required

Value to convert (string) Converted object

COnvert a string into a byte value

Convert a string to a byte value using the default decimal separator

Convert a string to a byte

decimal separator to use '.' or ','

Convert a string to a byte value

string to parse byte value

Convert a string to a short integer

Convert a number to a short integer

Convert a number to a short integer

Decimal separator

Parse a string to a short integer

string representing short integer short integer value

Unsigned integer converter

Unsigned integer converter

Unsigned integer converter with a decimal separator

dot or comma for to separate decimal

Convert a string to a unsigned integer value

String value to parse Unsigned integer object

Unsigned long converter

Unsigned long converter

Unsigned long with decimal separator

dot or comma for separator

Convert a string to an unsigned integer long

String value to convert Unsigned long value

Signed byte converter (8 bit signed integer)

Signed byte converter (8 bit signed integer)

Signed byte converter (8 bit signed integer)

dot or comma for separator

Convert a string to an signed byte

String value to convert Signed byte value

Convert a value to a short integer

Convert a value to a short integer

Convert a value to a short integer

dot or comma for separator

Convert a string to an short integer

String value to convert Short signed value

Convert a value to a integer

Convert a value to a integer

Convert a value to a integer

dot or comma for separator

Convert a string to an integer

String value to convert integer value

Convert a value to a long integer

Convert a value to a long integer

Convert a value to a long integer

dot or comma for separator

Convert a string to an integer long

String value to convert Long value

Convert a value to a decimal value

Convert a value to a decimal value

Convert a value to a decimal value

dot or comma for separator

Convert a string to a decimal

String value to convert decimal value

Convert a value to a single floating point

Convert a value to a single floating point

Convert a value to a single floating point

dot or comma for separator

Convert a string to an single precision floating point

String value to convert Single floating point value

Convert a value to a single floating point

Convert a value to a floating point

Convert a value to a floating point

dot or comma for separator

Convert a string to an floating point

String value to convert Floating point value

This Class is specialized version of the Double Converter The main difference being that it can handle % sign at the end of the number It gives a value which is basically number / 100.

Edited : Shreyas Narasimhan (17 March 2010)

Convert a value to a floating point from a percentage

Convert a value to a floating point from a percentage

dot or comma for separator

Convert a string to an floating point from percentage

String value to convert floating point value

Convert a value to a date time value

Convert a value to a date time value

Convert a value to a date time value

date format see .Net documentation

Convert a value to a date time value

date format see .Net documentation The culture used to parse the Dates

Convert a string to a date time value

String value to convert DateTime value

Convert a date time value to a string

DateTime value to convert string DateTime value

Convert a value to a date time value

Convert a value to a date time value using multiple formats

Convert a value to a date time value using multiple formats

Convert a date time value to a string

list of formats to try

Convert a date time value to a string

DateTime value to convert string DateTime value

Create a list of formats to pass to the DateTime tryparse function

string DateTime value

Convert a date time value to a string (uses first format for output

DateTime value to convert string DateTime value

Convert an input value to a boolean, allows for true false values

Simple boolean converter

Boolean converter with true false values

True string False string

convert a string to a boolean value

string to convert boolean value

Convert to a true false string

Allow characters to be converted to upper and lower case automatically.

default to not upper or lower case

Create a single character converter that does not upper or lower case result

Single character converter that optionally makes it upper (X) or lower case (x)

empty string for no upper or lower, x for lower case, X for Upper case

Extract the first character with optional upper or lower case

String contents Character (may be upper or lower case)

Convert from a character to a string for output

Character to convert from String containing the character

whether we upper or lower case the character on input

Don't change the case

Change to lower case

change to upper case

Convert a GUID to and from a field value

D or N or B or P (default is D: see Guid.ToString(string format))

Create a GUID converter with the default format code "D"

Create a GUID converter with formats as defined for GUID N, D, B or P

Format code for GUID

Convert a GUID string to a GUID object for the record object

String representation of the GUID GUID object or GUID empty

Output GUID as a string field

Guid object GUID as a string depending on format

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

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

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

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

Record information, whether it is delimited or other details

Get the position in the list of FieldName

name to look up Position in list

/Get the complete information about this field

FieldName to look up for information FieldInfo on the name

Is the input delimited or fixed length

Number of fields defined

List of fields in order read from record

Number of records to skip before starting processing (header records)

Number of records to skip when processing end of file (Trailer records)

Whether the Notify read event is set or something else needs to be notified of change

Whether the notify write event is hooked or something else needs to be notified on write

Buffer beginning size hint

Type of object to be created

Do we skip empty lines?

Do we skip lines that are visually empty, spaces only

String that prefixes a comment, eg a # in shell script

Can the comment marker be proceeded with spaces.

Selection condition when reading records, allows skipping unused data

Selection of records to process by regex

Selection of records to process by prefix

Cache of routines to handle various operations on the record

Read the attributes of the class and create an array of how to process the file

Class we are analysing

Create a list of fields we are extracting and set the size hint for record I/O

Parse the attributes on the class and create an ordered list of fields we are extracting from the record

Complete list of fields in class Type of record, fixed or delimited List of fields we are extracting

Check that once one field is optional all following fields are optional Check that arrays in the middle of a record are of fixed length

List of fields to extract

Sort fields by the order if supplied

List of fields to use

Confirm all fields are either ordered or unordered

Newest field Other fields we have found

Get the index number of the fieldname in the field list

Fieldname to search for Index in field list

Get field information base on name

name to find details for Field information

Return the record type information for the record

Type of object to create Record info for that type

Create an new instance of the record information

Deep copy of the RecordInfo class

Check whether the type implements the INotifyRead or INotifyWrite interfaces

Type to check interface Interface generic type we are checking for eg INotifyRead<> Whether we found interface

Hint about record size

Class we are defining

Do we skip empty lines?

Do we skip lines with completely blank lines

Comment prefix

Number of fields we are processing

List of fields and the extraction details

Number of lines to skip at beginning of file

Number of lines to skip at end of file

DO we need to issue a Notify read

Do we need to issue a Notify Write

Can the comment prefix have leading whitespace

Include or skip a record based upon a defined RecordCondition interface

Skip or include a record based upon a regular expression

Include or exclude a record based upon presence of a string

Operations are the functions that perform creation or extraction of data from objects these are created dynamically from the record conditions

Is this record layout delimited

Return the record information for the type

Type we want settings for Threadsafe Record Information (settings and functions)

A single field extracted from the 'record'

Record is defined by the way the data is input

Allows for the actual string to be overridden

The string value of the field extracted from the record

Contains the line of data read

Position of first character of the field in mLine.mLine

Position of last character of the field in mLine.mLine

Extract the rest of the line into my variable

Extract field from current position to specified position

Record information Position to extract to

Allow a default string or a specific string for this variable to be applied

Check that the value returned only has these specific characters in it

Sorted array of characters to check false if any character in value does not match

Length of the field

Very importat to avoid out of order reflection The CLR caches previous fields access to speed up reflection but can return the fields in wrong order Clearing the m_fieldInfoCache of the Cache property resolves the issue

Type of Object

Return file record by record

records already read

Read a Record handler forward, optionally skipping n lines and starting at a record number > 0

Reader to get records NUmber of lines to skip before reading

Read a Record handler forward, optionally skipping n lines and starting at a record number > 0

Reader to get records Number of lines to skip before reading Lines already read from file

Close the record reader, which should in turn close the stream

Number of lines in the buffer

Record number within the file - normally the line number

Basic read record interface

Read a record from the data source

A single record for parsing

close the interface and return

Collection of operations that we perform on a type, cached for reuse

Create a set of operations for a particular type

Record details we create objects off

Process a line and turn it into an object

Line of data to process Values to assign to object Object created or null if record skipped Could not convert data from input file

Extract fields from record and assign values to the object

Object to assign to Line of data Array of values extracted true if we processed the line and updated object

If we skip empty lines or it is a comment or is is excluded by settings

Input line we are testing True if line is skipped

Create a string of the object based on a record information supplied

Object to convert String representing the object

Assign a series of values out to a string based on file info layout

Values to write in order String representing values

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

Instance of the type. An object[] of the values in the fields.

Create a datatable based on a collection of records

Collection of records to process datatable representing all records in collection

Create a data table containing at most maxRecords (-1 is unlimitted)

Records to add to datatable Maximum number of records (-1 is all) Datatable based on record

Create an empty datatable based upon the record layout

Datatable defined based on the record definition

Extract the fieldinfo from the record info

array of fieldInfo

Copy one object to another based on field list

Record layout instance Copy of the handlers class is using

Record Info we use to parse the record and generate an object instance

Function to take and instance and return an array of objects Dynamically created when first used

function to create the object and assign the values to that object

First time through create a dynamic method to assign the data to the class object based on the fields

Create an instance of the object function

Create an object and assign

Values that are assigned to instance Instance of object initialised

Assign values to a known object

Record to assign Values to assign to the record

Extract the values from the object (function created based on FieldInfo

instance to extract from Values from the instance

Create an object (function created based upon a type)

New object

Creates a series of functions that directly access the classes rather than creating all the access methods every time we access data.

Create a delegate based on the field information that converts an object into an array of fields

Object type to be processed Fields we are extracting Delegate to convert object to fields

Get the default constructor for the class

class we are working on Constructor information

Create a dynamic function that assigns fields to the record

class we are basing assignment on LIst of fields to assign Function to create object and perform assignment

Assign fields to record type

Class to base function on List of fields to assign function that assigns only

Create a function that will create an instance of the class

class we want to create an instance of Function to create an instance

Create a function to get the field name from the object

Field information Function to directly get field

Get all the FieldInfo details from the class and optionally it's parents

Type we are interrogating IEnumerable list of fields in type

Create a database connector

Access connection May not work on Windows 7 because Jet is not installed by default

generic access connection string

Connect to a database with no password required

Database we want to connect to connection string

Connect to an access database with a password

database we want to connect to password for database connection string

connect to SQL server without userid and password

SQL server connection database name to connect to SQL server connection string

connect to SQL server with userid and password

SQL server connection database name to connect to Database password databsae user name SQL server connection string

This class is a common base class for both FileHelpers.DataLink.ExcelStorage (FileHelpers.ExcelStorage.dll) and FileHelpers.DataLink.ExcelNPOIStorage (FileHelpers.ExcelNPOIStorage.dll).

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

Raises the Progress Event

The Event Args

Returns the records from the DataSource (DB, Excel, etc)

The extracted records.

Returns the records from the DataSource (DB, Excel, etc)

The extracted records as a DataTable.

Inserts the records into the DataSource (DB, Excel, etc)

Records to insert.

The Object responsible for managing the errors.

Add an error to the ErrorCollection.

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

Creates an instance DataStorage for Type

Type of the record object

Returns a record created from an Array of values

The values used to created the record. The record created from 'values'

Returns an array of values based on a record.

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

Called to notify progress.

Returns the class that represent the records in the file.

The Object responsible for managing the errors.

The number of fields in the record class.

Create a new ExcelStorage to work with the specified type

The type of records.

Create a new ExcelStorage to work with the specified type

The type of records. The row of the first data cell. Begining in 1. The column of the first data cell. Begining in 1.

Create a new ExcelStorage to work with the specified type

The type of records. The row of the first data cell. Begining in 1. The column of the first data cell. Begining in 1. The file path to work with.

Indicates whether the given cell should be considered empty.

Determine if a given cell is empty.

Row index (1-based) Column index (1-based)

Indicates whether the given row should be considered empty.

Indicates whether the storage reader should stop reading the worksheet at the given row index.

The current row index (1-based)

Indicates whether the storage reader should data from the given row index.

The current row index (1-based)

Specifies the way links in the file are updated. By default the library never update the links

The Start Row where is the data. Starting at 1.

The Start Column where is the data. Starting at 1.

The numbers of header rows.

The Excel File Name.

The Excel Sheet Name, if empty means the current worksheet in the file.

Indicates what the Storage does if the file exist.

Indicates the source xls file to be used as template when write data.

Indicates the behavior to use when determining when to stop reading records from the source xls file.

Defines how many empty rows indicate when to stop reading records from the source xls file. Only applies when ExcelReadStopBehavior == ExcelReadStopBehavior.StopOnEmptyRow. Default behavior is stop after entountering at least 1 empty row.

List Of column headers

Specifies the way links in the file are updated.

Never update links for this workbook on opening

User specifies how links will be updated

Always update links for this workbook on opening

Specifies how to determine when to stop reading rows from Excel

First cell of the row being empty means we should stop reading

All cells in the row being empty means we should stop reading

This class has the responsibility 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.

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.

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.

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

The stream with the source records.

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 has the responsibility to enable the two directional transformation. DataStorage <-> DataStorage

Uses two types to accomplish this task.

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 first of the .

The second of the .

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

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

Default constructor.

The Record Type.

This method receives the fields values as an array and returns 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.

Return a SQL string with the insert statement for the records.

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

Create connection object for the datasource.

An Connection Object.

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

The extracted records.

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

The records to insert.

Get or set the SQL statement used to get the records.

Indicates if the underlying Connection allows more than one instruction per execute.

Delegate used to get the SQL for the insert or update statement.

Delegate used to fill the values of a new record from the db.

Indicates the max number of instruction for each execution. High numbers helps reduce the round trips to the db and so improves performance.

Define the Transaction Level used when inserting records.

The connection string used for this storage.

Creates a new AccessStorage.

The Type of the Records

Creates a new AccessStorage using the indicated file.

The Type of the Records The MS Access file.

Create the connection object.

An Abstract Connection Object.

The file full path of the Microsoft Access File.

The password for the access database.

Delegate used by the to get the SQL for the insert or update statement.

The record to insert The SQL string to insert the record.

Delegate used by the to fill the values of a new record from the db (you only need to assign the values.

The record to fill. The values read from the database, you need to use these to fill the record.

This class implements the for plain text files.

Engine to use for processing

Filename being written to

Create simple FileStorage object 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.

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

The records to insert.

The engine behind the FileStorage.

The target file name.

This is a base class that implements the storage for any DB with ADO.NET support.

The ADO.NET connection class

Creates an object that implements the storage for any DB with ADO.NET support.

The record type to use. The connection string to

Connect to a data source using the defined connection string

Database connection object

Do we get data in batches or single records

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

Create a new OleDbStorage based in the record type and in the connection string.

The Type of the records. The connection string used to create the OleDbConnection.

Must create an abstract connection object.

An Abstract Connection Object.

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

Create a new instance of the SqlServerStorage based on the record type provided.

The type of the record class.

Create a new instance of the SqlServerStorage based on the record type provided.

The type of the record class. The full connection string used to connect to the SQL server.

Create a new instance of the SqlServerStorage based on the record type provided (uses windows auth)

The type of the record class. The server name or IP of the sqlserver The database name into the server.

Create a new instance of the SqlServerStorage based on the record type provided (uses SqlServer auth)

The type of the record class. The server name or IP of the sqlserver The database name into the server. The SQL username to login into the server. The pass of the SQL username to login into the server.

Create a connection object to the database

SQL server Connection Object.

The server name or IP of the SqlServer

The name of the database.

The user name used to logon into the SqlServer. (leave empty for WindowsAuth)

The user pass used to logon into the SqlServer. (leave empty for WindowsAuth)

do we get groups of records or singularly

Define the different Modes of Transaction that are used by the

No transaction used.

Default Transaction Mode.

Chaos Level Transaction Mode.

ReadCommitted Transaction Mode.

ReadUnCommitted Transaction Mode.

Repeatable Transaction Mode.

Serializable Transaction Mode.

Create attributes in the specified language and return as text to paste into code

Attribute text is created here...

C# or Visual Basic

Create an attribute in the language selected

Do we have any attributes, do we have to start and close VB attributes?

Add an attribute, C# [att1] [att2], VB <att1,_att2

Return all of attributes as text, if first then it is empty

The MAIN class to work with runtime defined records.

Compiles the source code passed and returns the FIRST Type of the assembly. (Code in C#)

The Source Code of the class in C# The Type generated by runtime compilation of the class source.

Compiles the source code passed and returns the FIRST Type of the assembly.

The Source Code of the class in the specified language The Type generated by runtime compilation of the class source. One of the .NET Languages

Compiles the source code passed and returns the Type with the name className. (Code in C#)

The Source Code of the class in C# The Name of the Type that must be returned The Type generated by runtime compilation of the class source.

Compiles the source code passed and returns the Type with the name className.

The Source Code of the class in the specified language The Name of the Type that must be returned One of the .NET Languages List of assemblies to be added in the dynamic compilation The Type generated by runtime compilation of the class source.

Create a class from a source file.

The filename with the source of the class. The compiled class.

Create a class from a source file.

The filename with the source of the class. The language used to compile the class. The compiled class.

Create a class from a source file.

The filename with the source of the class. The name of the class to return. The compiled class.

Create a class from a source file.

The filename with the source of the class. The name of the class to return. The language used to compile the class. The compiled class.

Create a class from a encrypted source file with the default password

The filename with the source of the class. The compiled class.

Create a class from a encrypted source file with the default password

The filename with the source of the class. The language used to compile the class. The compiled class.

Create a class from a encrypted source file with the default password

The filename with the source of the class. The language used to compile the class. The name of the class to return. The compiled class.

Create a class from a encrypted source file with the given password

Edited by: Shreyas Narasimhan (17 March 2010) The filename with the source of the class. The name of the class to return. The language used to compile the class. The password used to decrypt the file

Create a class from a XML file generated with the Wizard or saved using the SaveToXml Method.

The filename with the XML definition. The compiled class.

Encrypt the class source code with the default password and write it to a file.

The file name to write to. The class source to write to

Encrypt the class source code with the given password and write it to a file.

Edited by: Shreyas Narasimhan (17 March 2010) The file name to write to The class source to write to The password with which to encrypt the file

Write the source code of the current class to a file. (In C#)

The file to write to.

Write the source code of the current class to a file. (In the specified language)

The file to write to. The .NET Language used to write the source code.

Write the ENCRYPTED source code of the current class to a file. (In C#)

The file to write to.

Write the ENCRYPTED source code of the current class to a file. (In C#)

The file to write to. The .NET Language used to write the source code.

Create a class with 'classname'

Name of class to create

Generate the runtime record class to be used by the engines.

The generated record class

Removes all the Fields of the current class.

List of all the fields in the class

Add a field to the class

Field details to add

Return the field at the specified index.

The index of the field. The field at the specified index.

Returns the ENCRYPTED code for the current class in the specified language.

The language for the return code. The ENCRYPTED code for the class that are currently building.

Returns the source code for the current class in the specified language.

The language for the return code. The Source Code for the class that are currently building.

Store the attributes for adding when we write the code to text

Where attributes are stored

Convert visibility type to word needed by the language

Language C# or Visual Basic Public, internal, protected, etc Visibility correct for the language

Get the sealed prefix, if needed

Language we are writing in nothing, sealed or NotInheritable

Add the namespace to the class details

Language type we are generating class text

Add the end of namespace to text

language we are generating class text to add to

Loads the XML representation of a ClassBuilder inheritor and return it. (for XML saved with SaveToXml method)

ClassBuilder inheritors: or The XML representation of the record class. A new instance of a ClassBuilder inheritor: or

Loads the XML representation of a ClassBuilder inheritor and return it. (for XML saved with SaveToXml method)

ClassBuilder inheritors: or The XML document with the representation of the record class. A new instance of a ClassBuilder inheritor: or

Loads the XML representation of a ClassBuilder inheritor and return it. (for XML saved with SaveToXml method)

ClassBuilder inheritors: or A file with the XML representation of the record class. A new instance of a ClassBuilder inheritor: or

Creates the XML representation of the current record class.

The representation of the current record class as xml string.

Saves to a file the XML representation of the current record class.

A file name to write to.

Saves to an Stream the XML representation of the current record class.

Stream to be written.

Save to a TextWriter the XML representation of the current record class.

The TextWriter for the output Stream.

write header information for this class

writer to write on

write any extra information for the class

writer to put xml on

read class elements from xml document

document to read from

read attribute information for class

Break down a class into a generic or a full type name

type to get type of Type of the class as a string

Returns the current fields of the class.

Returns the current number of fields.

Gets or sets the name of the Class.

Indicates the number of FIRST LINES or heading records to be ignored by the engines.

Indicates the number of LAST LINES or trailing records to be ignored by the engines.

Indicates that the engines must ignore the empty lines in the files.

Indicates if this ClassBuilder generates also the property accessors (Perfect for DataBinding)

Comment text placed above the class definition

The Visibility for the class.

Indicates if the generated class must be sealed.

The namespace used when creating the class.

Allow to tell the engine what records must be included or excluded while reading.

Indicates that the engine must ignore the lines with this comment marker.

Allow to tell the engine what records must be included or excluded while reading.

Allow to tell the engine what records must be included or excluded while reading.

The selector used by the .

Indicates that the engine must ignore the lines with this comment marker.

Indicates that the engine must ignore the lines with this comment marker. An empty string or null indicates that the engine does not look for comments

Indicates if the comment can have spaces or tabs at left (true by default)

Used to build the ConverterAttribute for the run time classes.

build a converter attribute for runtime class. Writes source code for attributes on class

serialize converter attribute details to XML

XML writer

get converter information for the class from serialised version

node to get attributes

Create the converter in source code

C# or Visual Basic Converter attribute in appropriate language

The ConverterKind to be used , like the one in the FieldConverterAttribute.

The type name of your custom converter.

The first argument passed to the converter.

The first argument passed to the converter.

The first argument passed to the converter.

Used to create classes that maps to CSV records (can be quoted, multiple lines, quoted, etc).

Used to create classes that maps to Delimited records.

Return the field at the specified index.

The index of the field. The field at the specified index.

Creates a new DelimitedClassBuilder.

The valid class name. The delimiter for that class.

Creates a new DelimitedClassBuilder.

The valid class name.

Creates a new DelimitedClassBuilder with the same structure than a DataTable.

The valid class name. The delimiter for that class. The DataTable from where to get the field names and types

Add a new Delimited field to the current class.

The Name of the field. The Type of the field. The just created field.

Add a new Delimited field to the current class.

The Name of the field. The Type of the field. (For generic of nullable types use the string overload, like "int?") The just created field.

Add a new Delimited string field to the current class.

The Name of the string field. The just created field.

Add a new Delimited field to the current class.

The field definition. The just added field.

Add any attributes to source (currently only the delimiter attribute)

Attributes storage area to add to class

Serialise the XML header

Writer to serialise to

Write any extra elements (not used)

extract delimited class details from xml

XML document to check delimited class information

Extract the class element from the XML document

XML to extract extra info from

Get the attributes off the XML element

Node to read

Adds n fields of type string, with the names "Field1", Field2", etc

The number of fields to add

The Delimiter that marks the end of each field.

Returns the current fields of the class.

Return the last added field. (use it reduce casts and code)

Creates a new DelimitedClassBuilder.

The valid class name. The delimiter for that class. A sample file from where to read the field names and number

Creates a new DelimitedClassBuilder.

The valid class name. The delimiter for that class. The number of fields in each record.

Creates a new DelimitedClassBuilder.

The specifications for the CSV file.

Add a new Delimited field to the current class.

The Name of the field. The Type of the field. The just created field.

Adds to the class the specified number of fields.

The number of fields to add.

Adds to the class the specified number of fields.

The prefix used for the fields. The number of fields to add.

Used to create fields that are part of a delimited record class.

Base class for the field converters

Create a field of Name with type

name of the field Type of the field

Create a field of name and type

Name of the field Type of the field

Create the field with attributes so that it can be added to the class

Language C# of Visual Basic Field as text

Allow child classes to add attributes at the right spot

Attributes added here Language C# or Visual Basic

Add the general attributes to the field

Attributes added here Language C# or Visual Basic

Parent class of this field

Serialise the FiledBuilder to XML

writer to add XML to

Write any attributes to the first element

Write any extra fields to the end of the XML

Writer to output XML to

Read the generic XML elements and store in the field details

Read field details from the main XML element

Node to read

Indicates the TrimMode for the field.

Indicates the trim chars used if TrimMode is set.

The position index inside the class.

Indicates that this field is at the beginning of a new line.

Indicates that this field must be ignored by the engine.

Discards the values for the target field.

Indicates that this field is optional.

Used to create the converter for the current field.

The name of the field.

The Type of the field

The null value of the field when their value not is in the file.

Indicates that the field cannot be empty.

Gets or sets the visibility of the field.

Create a field with name and type

Field Name to create Type of the field

Create a field with a name and a type

Field name to create Type of the field

Add the attributes to the code text for the class.

Where to add attributes to Language selected

Write any header attributes - not used

XML writer to add element to

Write the elements for this field to the XML

Read the elements from the XML document for this field

XML node to read elements from

Indicates if the field is quoted with some char. (works with QuoteMode and QuoteChar)

Indicates the char used to quote this field. (only used when FieldQuoted is true)

Indicates the QuoteMode for this field. (only used when FieldQuoted is true)

Indicates if this quoted field can span multiple lines. (only used when FieldQuoted is true)

Used to create Fixed Length fields and set their properties.

Create a fixed length field of name, length and type

Name of the field Length of field on file Type of the field

Create a fixed length field of name, length and type

Name of the field Length of field on file Type of the field

Add attributes to the field at the appropriate spot in the code

Add attributes to this Language to use, C# of Visual Basic

Serialise attributes for field to the XML

Write any extra elements to the code

XML writer to serialise to

Read the extra alignChar and alignMode elements back into the field details

Field Node from XML

The fixed length of the field.

The align of the field used for write operations.

The align char of the field used for write operations.

Used to create classes that maps to Fixed Length records.

Return the field at the specified index.

The index of the field. The field at the specified index.

Used to create classes that maps to Fixed Length records.

A valid class name.

Used to create classes that maps to Fixed Length records and automatically instantiate many string fields as values are passed in the lengths arg.

A valid class name. The lengths of the fields (one string field will be create for each length)

Used to create classes that maps to Fixed Length records with the same structure than a DataTable.

A valid class name. The DataTable from where to get the field names and types The initial length of all fields

Used to create classes that maps to Fixed Length records.

A valid class name. Indicates the behavior when variable length records are found.

Adds a new Fixed Length field.

The name of the field. The length of the field. The Type of the field. The just created field.

Adds a new Fixed Length field.

The name of the field. The length of the field. The Type of the field. (For generic of nullable types use the string overload, like "int?") The just created field.

Adds a new Fixed Length field.

The field definition. The just added field.

add attributes to the class text

write the fixed length XML to document

writer to put XML on

write any extra elements required

Set the length of each field at once.

The length of each field, must be the same that the number of fields.

read elements from XML for class

read attributes from element

node to read

load details of fixed length from XML

document to check fixed length details

Returns the current fields of the class.

Return the last added field. (use it reduce casts and code)

Indicates the behavior when variable length records are found

XML wrapper to make life a little easier

XML writer

XML reader

Open file in create more to add XML to it

Filename to create

Write XML onto this stream

writer to put XML onto

Open a file for reading XML

filename to read

Write an element with value in one hit

Name of XML element Value of element

Write an XML element, skipping value that is a default anyway

element name value of the element Default (or suppressed) value

Write an empty element, if the flag is true

element name do we write it

Write an attribute if the value is not the default

attribute name value to be written default value, if matched suppressed

Write an attribute onto an element

attribute to write value of the attribute

Close the writer to flush XML

Close the reader

Read the XML to the end of the element (skip attributes)

Base for engine events

Specific engine

Abstract Base class for the engines of the library: and

Create an engine on record type, with default encoding

Class to base engine on

Create and engine on type with specified encoding

Class to base engine on encoding of the file

Create an engine on the record info provided

Record information

Builds a line with the name of the fields, for a delimited files it uses the same delimiter, for a fixed length field it writes the fields names separated with tabs

field names structured for the heading of the file

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.

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

Reset back to the beginning

Raises the Progress Event

The Event Args

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 manages the errors of the library.

You can find complete information about the errors encountered while processing. For example, you can get the errors, their number and save them to a file, etc.

Indicates the behavior of the engine when it finds an error. {Shortcut for )

Event handler called to notify progress.

Determine whether a progress call is needed

Allows you to change some record layout options at runtime

Define an event based on an egine, based on a record

Type of the record

Define an event based on a record with a specific encoding

Type of the record Encoding specified

Event based upon supplied record information

Provide a hook to preprocess a record

Record details before read True if record to be skipped

Post process a record

Record read Type of record Has the line been updated so that the engine switches to this version Number of line in file true if record to be skipped

Before a write is executed perform this check to see if we want to modify or reject the record.

Instance to process Number of line within file true if record is to be dropped

After we have written a record, do we want to process it.

Line that will be output Record we are processing Record to be written

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.

Check whether we need to notify the read to anyone

Determine whether we have to run notify write on every iteration

Interface for the FileHelper Async Engine

Type of record to be read

Open a specified stream and seek to the first record.

This method only seeks to the first record. To read record by record use method. When you stop reading the file you must call method. The TextReader of the stream. This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

Open a specified file and seek to the first record.

This method only opens the file. To read record by record use the method. When you stop reading the file you must call method. The file path to be read.True if the file is successfully opened. False otherwise This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

Reads the next record of a file.

This method returns the current record and moves to the next. If the end of file is reached this method return null. The current record of the opened file. This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

Read the file to the end, returning an array of records

Records left to process

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

If there are less records than requested in the source, the file will be read to the end. The number of records to read. If there are less records than requested in the source, the file will be read to the end. The next records of the opened file or stream.

Save all the buffered data for write to the disk. Useful with opened async engines when you want to save pending values to disk. Expecially for engines used for logging.

Close all opened stream readers and writers (if any).

This method must be called when you finish processing a file to dispose of the opened streams. This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

Set the stream to be used in the operation.

When you finished writing to the file you must call the method. To stream to writes to. This example shows a simple example of 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("source.txt"); record.Field1 = "Primer Registro"; record.Field2 = 1; engine.WriteNext(record); record.Field1 = "Segundo Registro"; record.Field2 = 2; engine.WriteNext(record); engine.Close(); }

Open a file to write it. If the file exists the engine will over write it

When you finish writing to the file you must call the method. The file path to be opened for write. This example shows a simple example of 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("source.txt"); record.Field1 = "Primer Registro"; record.Field2 = 1; engine.WriteNext(record); record.Field1 = "Segundo Registro"; record.Field2 = 2; engine.WriteNext(record); engine.Close(); }

Open a file to Append to the end.

This method open and seek ends the file. When you finish appending to the file you must call method. The file path to be opened to write at the end.

Write the next record to a file or stream opened.

The record to write. This example shows a simple example of 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("source.txt"); record.Field1 = "Primer Registro"; record.Field2 = 1; engine.WriteNext(record); record.Field1 = "Segundo Registro"; record.Field2 = 2; engine.WriteNext(record); engine.Close(); }

Write the next records to a file or stream opened.

The records to write (Can be an array, ArrayList, etc)

Write the current record values in the buffer. You can use engine[0] or engine["YourField"] to set the values.

Contains the last Record read by the method.

This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

An array with the values of each field of the current record

Allows to change some record layout options at runtime

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.

Indicates the behavior of the engine when it found an error. (shortcut for ErrorManager.ErrorMode)

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.

Called to notify progress.

Interface for The fileHelpers generic engine

Type of object array to return

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

This method opens, reads and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 opens, reads and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 does not close them after using it, you must do it. This example shows a simple example of use of the library with a minimum of 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 does not close them after using it, you must do it. This example shows a simple example of use of the library with a minimum of 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 opens, writes and closes the file (don't open or close the file before or after calling this method) This method over writes any existing files. This example shows a simple example of use of the library with a minimum of 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.

This method opens, writes and closes the file (don't open or close the file before or after calling this method) This method over writes any existing files. This example shows a simple example of use of the library with a minimum of 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)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 shows a simple example of use of the library with a minimum of 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 does not close the stream after using it, you must do it. This example shows a simple example of use of the library with a minimum of 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 opens, seeks to the end, writes and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 opens, seeks to the end, writes and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 appended to.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

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.

Indicates the behavior of the engine when it found an error. (shortcut for ErrorManager.ErrorMode)

Called to notify progress.

Represents a record or field length indicator strategy

Least Significant Byte first (Little-Endian) integer

Most Significant Byte first (Big-Endian) integer

ASCII text numeric

Record read from the file for processing

The data inside the LIneInfo may be reset during processing, for example on read next line. Do not rely on this class containing all data from a record for all time. It is designed to read data sequentially.

Create a line info with data from line

Return part of line, Substring

Start position (zero offset) Number of characters to extract substring from line

Record read from reader

Reader that got the string

Where we are processing records from

List of whitespace characters that we want to skip

Debugger display string

If we have extracted more that the field contains.

True if end of line

Is there only whitespace left in the record?

True if only whitespace

delete leading whitespace from record

Delete any of these characters from beginning of the record

Move the record pointer along skipping these characters

Sorted array of character to skip

Check that the record begins with a value ignoring whitespace

String to check for True if record begins with

get The next line from the system and reset the line pointer to zero

Find the location of the next string in record

String we are looking for Position of the next one

Reset the string back to the original line and reset the line pointer

If the input is multi line, this will read next record and remove the original data Line to use

Extract a single field from the system

Amount of data left to process

Read a record that is delimited by a newline

Read a file line by line from the specified textreader

TextReader to read and process

Read a record from the file

unprocessed record

Close the reader

A class to loop through the field values

Get the record indexer, engine will load the lines into an array

Get the enumerator of the list

Get enumerator of the list

The number of fields in the record

Get the field value at the specified index.

The index of the field (zero based) The field value

Create an enumerator off an array of strings

Array to return one at a time

Position in enumerator, -1 to start

Create an enumerator off a string array

values to return one at a time

Clean up not needed

move the pointer along

Go back to the start

Get the current item we are working on

Get the current element

This class only has static methods to work with files and strings (most of the common tools)

Used to read a file without instantiating the engine.
This method has limited features. We recommend using the non static methods.

The record class. The file name The read records.

Used to read a file without instantiating the engine.
This method has limited features. We recommend using the non static methods.

The record class. The file name The max number of records to read. Int32.MaxValue or -1 to read all records. The read records.

Used to read a file as a DataTable without instantiating the engine.
This method has limited features. We recommend using the non static methods.

The record class. The file name The DataTable representing all the read records.

Used to read a file as a DataTable without instantiating the engine.
This method has limited features. We recommend using the non static methods.

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

Used to read a file without instantiating the engine.
This method has limited features. We recommend using the non static methods.

The file name The read records.

Used to read a file without instantiating the engine.
This method has limited features. We recommend using the non static methods.

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

Used to read a string without instantiating the engine.
This method has limited features. We recommend using the non static methods.

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

Used to read a string without instantiating the engine.
This method has limited features. We recommend using the non static methods.

The record class. The input string. The max number of records to read. Int32.MaxValue or -1 to read all records. The read records.

Used to read a string without instantiating the engine.
This method has limited features. We recommend using the non static methods.

The input string. The read records.

Used to write a file without instantiating the engine.
This method has limited features. We recommend using the non static methods.

The file name The records to write (Can be an array, List, etc)

Used to write a string without instantiating the engine.
This method has limited features. We recommend using the non static methods.

The records to write (Can be an array, List, etc) The string with the written records.

Faster way to Transform the records of type sourceType in the sourceFile in records of type destType and write them to the destFile.

The file with records to be transformed The destination file with the transformed records The number of transformed records

Transform the records of type sourceType in the sourceFile in records of type destType and write them to the destFile. (but returns the transformed records) WARNING: this is a slower method that the TransformFileAssync.

The file with records to be transformed The destination file with the transformed records The transformed records.

Read the contents of a file and sort the records.

Record Class (remember that need to implement the IComparer interface, or you can use SortFileByfield) The file to read.

Sort the contents of the source file and write them to the destination file.

Record Class (remember that need to implement the IComparable interface or use the SortFileByfield instead) The source file. The destination File.

Sort the content of a File using the field name provided

The class for each record of the file. The name of the field used to sort the file. The sort direction. The source file. The destination File.

Sort the Record Array using the field name provided. (for advanced sorting use SortRecords)

The field name. The records Array.

Sort the Record Array using the field name provided. (for advanced sorting use SortRecords)

The field name. The records Array. The direction of the sort. True means Ascending.

Sort the Record Array. The records must be of a Type that implements the IComparable interface.

The records Array.

Converts any collection of records to a DataTable using reflection. WARNING: this methods returns null if the number of records is 0, pass the Type of the records to get an empty DataTable.

The records to be converted to a DataTable The DataTable containing the records as DataRows

Converts any collection of records to a DataTable using reflection. WARNING: this methods returns null if the number of records is 0, pass the Type of the records to get an empty DataTable.

The records to be converted to a DataTable The max number of records to add to the DataTable. -1 for all. The DataTable containing the records as DataRows

Converts any collection of records to a DataTable using reflection. If the number of records is 0 this methods returns an empty DataTable with the columns based on the fields of the Type.

The records to be converted to a DataTable The DataTable containing the records as DataRows The type of the inner records.

Converts any collection of records to a DataTable using reflection. If the number of records is 0 this methods returns an empty DataTable with the columns based on the fields of the Type.

The records to be converted to a DataTable The DataTable containing the records as DataRows The max number of records to add to the DataTable. -1 for all. The type of the inner records.

Reads the file1 and file2 using the recordType and write it to destinationFile

Merge the contents of 2 files and write them sorted to a destination file.

The record Type. File with contents to be merged. File with contents to be merged. The name of the field used to sort the records. The destination file. The merged and sorted records.

Merge the contents of 2 files and write them sorted to a destination file.

The record Type. File with contents to be merged. File with contents to be merged. The name of the field used to sort the records. Indicate the order of sort. The destination file. The merged and sorted records.

Merge the contents of 2 files and write them sorted to a destination file.

The record Type. File with contents to be merged. File with contents to be merged. The destination file. The merged and sorted records.

Simply dumps the DataTable contents to a delimited file using a ',' as delimiter.

The source Data Table The destination file.

Simply dumps the DataTable contents to a delimited file. Only allows to set the delimiter.

The source Data Table The destination file. The delimiter used to write the file

Simply dumps the DataTable contents to a delimited file. Only allows to set the delimiter.

The source Data Table The destination file. The options used to write the file

Reads a CSV File and return their contents as DataTable (The file must have the field names in the first row)

The delimiter for each field The file to read. The contents of the file as a DataTable

Reads a CSV File and return their contents as DataTable (The file must have the field names in the first row)

The name of the record class The delimiter for each field The file to read. The contents of the file as a DataTable

Reads a Csv File and return their contents as DataTable

The name of the record class The delimiter for each field The file to read. Indicates if the file contains a header with the field names. The contents of the file as a DataTable

Reads a Csv File and return their contents as DataTable

The file to read. The options used to create the record mapping class. The contents of the file as a DataTable

This method allow to remove the duplicated records from an array.

The array with the records to be checked. An array with the result of remove the duplicate records from the source array.

Shortcut method to read the first n lines of a text file.

The file name The number of lines to read. The first n lines of the file.

Shortcut method to read the first n lines of a text file as array.

The file name The number of lines to read. The first n lines of the file.

Shortcut method to read the first n lines of a text file as array.

The file name The number of lines to read. The Encoding used to read the file The first n lines of the file.

Shortcut method to read the first n lines of a text file as array.

The text reader name The number of lines to read. The Encoding used to read the file The first n lines of the file.

A fast way to read record by record a CSV file delimited by ','. The fields can be quoted.

The CSV file to read An enumeration of

A fast way to read record by record a CSV file with a custom delimiter. The fields can be quoted.

The CSV file to read The field delimiter. An enumeration of

A fast way to read record by record a CSV file with a custom delimiter. The fields can be quoted.

The CSV file to read The field delimiter. The number of header lines in the CSV file An enumeration of

A fast way to read record by record a CSV file with a custom delimiter. The fields can be quoted.

The CSV file to read The field delimiter. The file An enumeration of

A fast way to read record by record a CSV file with a custom delimiter. The fields can be quoted.

The CSV file to read The field delimiter. The file The number of header lines in the CSV file An enumeration of

A fast way to sort a big file. For more options you need to instantiate the BigFileSorter class instead of using static methods

A fast way to sort a big file. For more options you need to instantiate the BigFileSorter class instead of using static methods

Compare one field to another

Compare object 1 to object 2

First object to test Second object to test 0 if equal, -1 if x < y, 1 otherwise

A class to read generic CSV files delimited for any char.

Basic engine to read record by record

One of the main classes of the library. This engine is responsible 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

You can set the of this class when found an error, and can retrieve them with the property. See in the Class Diagram and in the Quick Start Guide for more Info. Or you can browse the Examples section for more code. Engines Diagram: Quick Start GuideClass DiagramExamples of UseAttributes List This example shows a simple example of use of the library with a minimum of 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 } The record type.

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

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

The Encoding used by the engine.

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

The Encoding used by the engine. Type of record we are reading

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

Record information

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

This method opens, reads and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 opens, reads and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 file and return an array of the contained records.

This method opens, reads and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 opens, reads and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 does not close them after using it, you must do it. This example shows a simple example of use of the library with a minimum of 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 does not close them after using it, you must do it. This example shows a simple example of use of the library with a minimum of 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 Stream and return an array of the contained records.

This method only uses the stream and does not close them after using it, you must do it. This example shows a simple example of use of the library with a minimum of 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.

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 opens, writes and closes the file (don't open or close the file before or after calling this method) This method over writes any existing files. This example shows a simple example of use of the library with a minimum of 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.

This method opens, writes and closes the file (don't open or close the file before or after calling this method) This method over writes any existing files. This example shows a simple example of use of the library with a minimum of 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)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 shows a simple example of use of the library with a minimum of 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 does not close the stream after using it, you must do it. This example shows a simple example of use of the library with a minimum of 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 opens, seeks to the end, writes and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 opens, seeks to the end, writes and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 appended to.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.

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

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

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

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

Record information on new type

Reads a CSV File and return their contents as DataTable (The file must have the field names in the first row)

The delimiter for each field The file to read. The contents of the file as a DataTable

Reads a CSV File and return their contents as DataTable (The file must have the field names in the first row)

The name of the record class The delimiter for each field The file to read. The contents of the file as a DataTable

Reads a CSV File and return their contents as DataTable

The name of the record class The delimiter for each field The file to read. Indicates if the file contains a header with the field names. The contents of the file as a DataTable

Reads a CSV File and return their contents as DataTable

The name of the record class The delimiter for each field The file to read. Indicates if the file contains a header with the field names. Indicates if blank lines in the file should not be included in the returned DataTable The contents of the file as a DataTable

Reads a CSV File and return their contents as DataTable

The file to read. The options used to create the record mapping class. The contents of the file as a DataTable

Simply dumps the DataTable contents to a delimited file using a ',' as delimiter.

The source Data Table The destination file.

Simply dumps the DataTable contents to a delimited file using a ',' as delimiter.

The source Data Table The destination file. The delimiter to be used on the file

Simply dumps the DataTable contents to a delimited file. Only allows to set the delimiter.

The source Data Table The destination file. The options used to write the file

Create a CsvEngine using the specified sample file with their headers. With this constructor will ignore the first line of the file. Use CsvOptions overload.

The name of the record class The delimiter for each field A sample file with a header that contains the names of the fields.

Create a CsvEngine using the specified number of fields. With this constructor will ignore the first line of the file. Use CsvOptions overload.

The name of the record class The delimiter for each field The number of fields of each record

Create a CsvEngine using the specified sample file with their headers.

The options used to create the record mapping class.

This version of the is exclusively for delimited records. It allows you to change the delimiter and other options at runtime

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

Create a version of the exclusively for delimited records. It allows you to change the delimiter and other options at runtime

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

Create a delimited engine of record type and encoding

Type of record to read Encoding of each record

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

A version of the exclusively for delimited records. It allows you to change the delimiter and other options at runtime

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

Create a version of the exclusively for delimited records. It allows you to change the delimiter and other options at runtime

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

Create a Delimited engine with file type of Encoding

Type of encoding on file

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

Engine used to create diff files based on the interface.

The record type.

Creates a new

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 records. A file with records. 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 records and write them to a destination file. (record not in first file but in second will be written to the third)

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

Async engine, reads records from file in background, returns them record by record in foreground

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

You can set the of this class to find out when there is an error. Retrieve them with the property. See in the Class Diagram and in the Quick Start Guide for more Info. Or you can browse the Examples Section for more code. Quick Start GuideClass DiagramExamples of UseAttributes List This example shows a simple example 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); } public void WriteExample() { SampleType record; FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType)); engine.BeginWriteFile("source.txt"); record.Field1 = "Primer Registro"; record.Field2 = 1; engine.WriteNext(record); record.Field1 = "Segundo Registro"; record.Field2 = 2; engine.WriteNext(record); engine.Close(); } The record type.

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

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

Type of object to be handled.

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

The encoding used by the Engine.

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

The encoding used by the Engine. Type of record to read

Open a specified stream and seek to the first record.

This method only seeks to the first record. To read record by record use method. When you stop reading the file you must call method. The TextReader of the stream. This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

Open a specified file and seek to the first record.

This method only opens the file. To read record by record use the method. When you stop reading the file you must call method. The file path to be read.True if the file is successfully opened. False otherwise This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

Open a specified file and seek to the first record.

This method only opens the file. To read record by record use the method. When you stop reading the file you must call method. The file path to be read.True if the file is successfully opened. False otherwise This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); } Buffer size to read

Reads the next record of a file.

This method returns the current record and moves to the next. If the end of file is reached this method return null. The current record of the opened file. This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

Return array of object for all data to end of the file

Array of objects created from data on file

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

If there are less records than requested in the source, the file will be read to the end. The number of records to read. If there are less records than requested in the source, the file will be read to the end. The next records of the opened file or stream.

Save all the buffered data for write to the disk. Useful to opened async engines that wants to save pending values to disk or for engines used for logging.

Close all opened stream readers and writers (if any).

This method must be called when you finish processing a file to dispose of the opened streams. This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

Set the stream to be used in the operation.

When you finished writing to the file you must call the method. To stream to writes to. This example shows a simple example of 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("source.txt"); record.Field1 = "Primer Registro"; record.Field2 = 1; engine.WriteNext(record); record.Field1 = "Segundo Registro"; record.Field2 = 2; engine.WriteNext(record); engine.Close(); }

Open a file to write it. If the file exists the engine will over write it

When you finish writing to the file you must call the method. The file path to be opened for write. This example shows a simple example of 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("source.txt"); record.Field1 = "Primer Registro"; record.Field2 = 1; engine.WriteNext(record); record.Field1 = "Segundo Registro"; record.Field2 = 2; engine.WriteNext(record); engine.Close(); }

Open a file to write it. If the file exists the engine will over write it

When you finish writing to the file you must call the method. The file path to be opened for write. This example shows a simple example of 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("source.txt"); record.Field1 = "Primer Registro"; record.Field2 = 1; engine.WriteNext(record); record.Field1 = "Segundo Registro"; record.Field2 = 2; engine.WriteNext(record); engine.Close(); } Size of the write buffer

Begin the append to an existing file

Filename to append to Object to append TODO: ???

Open a file to Append to the end.

This method open and seek ends the file. When you finish appending to the file you must call method. The file path to be opened to write at the end. Size of the buffer for writing

Write the next record to a file or stream opened.

The record to write. This example shows a simple example of 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("source.txt"); record.Field1 = "Primer Registro"; record.Field2 = 1; engine.WriteNext(record); record.Field1 = "Segundo Registro"; record.Field2 = 2; engine.WriteNext(record); engine.Close(); }

Write the next records to a file or stream opened.

The records to write (Can be an array, ArrayList, etc)

Write the current record values in the buffer. You can use engine[0] or engine["YourField"] to set the values.

Allows to loop record by record in the engine

The enumerator

Returns an enumerator that iterates through a collection.

An object that can be used to iterate through the collection. 2

Release Resources

Destructor

Contains the last Record read by the method.

This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

An array with the values of each field of the current record

Get a field value of the current records.

The index of the field.

Get a field value of the current records.

The name of the field (case sensitive)

Indicates the current state of the engine.

Indicates the State of an engine

The Engine is closed

The Engine is reading a file, string or stream

The Engine is writing a file, string or stream

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

Type of object to be handled.

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

Type of object to be handled. The encoding used by the Engine.

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

The source record type. The destination record type.

Create a new FileTransformEngine.

Transform the contents of the sourceFile and write them to the destFile.(use only if you need the array of the transformed records, TransformFileFast 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 uses less memory, best choice for big files)

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

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

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

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

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

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

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

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

Indicates the behavior of the engine when an error is found.

Allow access the of the engine used to read the source file, is null before any file is transformed

Allow access the of the engine used to write the destination file, is null before any file is transformed

The source record Type.

The destination record Type.

The Encoding of the Source File.

The Encoding of the Destination File.

This version of the is exclusively for fixed length records. It allows you to change options at runtime

Useful when you need to export or import the same info with slightly different options.

This version of the is exclusively for fixed length records. It allows you to change options at runtime

Useful when you need to export or import the same info with slightly different options. The record mapping class.

Read a record with fixed length fields

record type to read Encoding to use

Allow changes some fixed length options and others common settings.

This version of the is exclusively for fixed length records. It allows you to change options at runtime

Useful when you need to export or import the same info with slightly different options.

Creates a version of the exclusively for fixed length records that allow you to change options at runtime

Useful when you need to export or import the same info with slightly different options.

Creates a version of the exclusively for fixed length records that allow you to change options at runtime

Useful when you need to export or import the same info with slightly different options. Encoding of file to be read

Allow changes some fixed length options and others common settings.

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

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

This engine allows you to parse and write files that contain records of different types and that are in a linear relationship (for Master-Detail check the )

Create a new instance of the MultiRecordEngine

The Types of the records that this engine can handle.

Create a new instance of the MultiRecordEngine

The Types of the records that this engine can handle. Used only in read operations. The selector indicates to the engine what Type to use in each read line.

Read a File and returns the records.

The file with the records. The read records of different types all mixed.

Read an array of objects from a stream

Stream we are reading from Array of objects

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

This method only uses the stream and does not close the stream after using it, you must do it. This example shows a simple example of use of the library with a minimum of 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 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 opens, writes and closes the file (don't open or close the file before or after calling this method) This method over writes existing files. This example shows a simple example of use of the library with a minimum of 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.

This method opens, writes and closes the file (don't open or close the file before or after calling this method) This method over writes existing files. This example shows a simple example of use of the library with a minimum of 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)The max number of array elements to write.True if the operation is successful. False otherwise.

Write the records to a file

Where data is written records to write to the file

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

This method only uses the stream and does not close the stream after using it, you must do it. This example shows a simple example of use of the library with a minimum of 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 opens, seeks to the end, writes and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 opens, seeks to the end, writes and closes the file (don't open or close the file before or after calling this method) This example shows a simple example of use of the library with a minimum of 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 a generic file as delimited by newlines

Text reader

Method used to use this engine in Async mode. Work together with . (Remember to call Close after read the data)

The source Reader.

Method used to use this engine in Async mode. Work together with . (Remember to call Close after read the data)

The source file.

Method used to use this engine in Async mode. Work together with . (Remember to call Close after read the data)

The source String

Save all the buffered data for write to the disk. Useful to long opened async engines that wants to save pending values or for engines used for logging.

Close the underlining Readers and Writers. (if any)

Reads the next record from the source

The record just read

Read a defined number of records from the source

The count of records to read An Array with all the read record objects

Allows to loop record by record in the engine

The Enumerator

Release Resources

Destructor

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

The record to write.

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

The records to write (Can be an array, ArrayList, etc)

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.

Open a file for write operations. If exist the engine override it. You can use or to write records.

When you finish to write to the file you must call method. The file path to be opened for write.

Open a file to be appended at the end.

This method open and seek to the end 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.

The Selector used by the engine in Read operations to determine the Type to use.

Contains the last Record read by the method.

This example shows a simple example of 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("source.txt"); while( engine.ReadNext() != null ) { record = (SampleType) engine.LastRecord; // put your code here !!!! Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString()); } engine.Close(); }

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 Conversion used in the .

Null Converter.

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

Convert from or to Boolean values. Params: arg1 is the TRUE string Params: arg2 is the FALSE string

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

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

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

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

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

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

Convert from or to Double values. Understands Percent '%' symbol and if present returns number /100 only while reading Params: arg1 is the decimal separator, by default '.'

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

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

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

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

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

Convert from or to Date values using more than one valid format. Params: arg1 is a string with the main date format. This format is the unique used for write. Params: arg2 is a string with another valid read format. Params: arg3 is a string with another valid read format.

Convert from or to Char values. Params: arg1 is a string with "" for default behavior, "x" for make the char ToLower or "X" for make it ToUpper.

Convert from/to Guid values. Params: arg1 is a string with one of the Guid.ToString() formats: "N", "D", "B", or "P" "N" -> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx "D" -> xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx "B" -> {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} "P" -> (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Indicates the behavior when the engine classes like class found an error.

Default value, this simply Rethrow the original exception.

Add an to the array of .

Simply ignores the exception and continues

Indicates the behavior when variable length records are found in a []. (Note: nothing in common with [FieldOptional])

The records must have the length equals to the sum of each field length. Default Behavior.

The records can contain more chars after the last field

The records can contain less chars. Based on the combination with FieldOptional the records can contain less fields in the last, or if it is marked as optional, in the previous field.

The records can contain more or less chars in the last field

Indicates the behavior of multiline fields.

The engine can handle multiline values for read or write.

The engine can handle multiline values only for read.

The engine can handle multiline values only for write.

The engine don't allow multiline values for this field.

Indicates the .NET Language

The C#.NET Language

The VB.NET Language

Indicates the visibility of a member.

Public visibility.

Internal visibility. (Friend in VB.NET)

Protected visibility.

Private visibility.

Indicates the behavior of quoted fields.

The engines expects that the field must always be surrounded with quotes when reading and always adds the quotes when writing.

The engine can handle a field even if it is not surrounded with quotes while reading but it always add the quotes when writing.

The engine always expects a quote when read and it will only add the quotes when writing only if the field contains quotes, new lines or the separator char.

The engine can handle a field even if it is not surrounded with quotes while reading and it will only add the quotes when writing if the field contains quotes, new lines or the separator char.

The condition used to include or exclude each record.

No Condition, Include it always.

Include the record if it contains the selector string.

Include the record if it begins with selector string.

Include the record if it ends with selector string.

Include the record if it begins and ends with selector string.

Include the record if it matches the regular expression passed as selector.

Exclude the record if it contains the selector string.

Exclude the record if it begins with selector string.

Exclude the record if it ends with selector string.

Exclude the record if it begins and ends with selector string.

Exclude the record if it matches the regular expression passed as selector.

Indicates the trimming behavior of the leading and trailing whitespace.

No trimming is performed.

The field is trimmed on both sides.

The field is trimmed on the left.

The field is trimmed on the right.

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.

Basic constructor of the exception.

Message of the exception. The line number where the problem was found The column number where the problem was found

Creates an instance of an BadUsageException.

The exception Message

Creates an instance of an BadUsageException.

The exception Message The line number where the problem was found The column number where the problem was found

Creates an instance of an BadUsageException.

The exception Message Line to display in message

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

Create a new ConvertException object

The value to convert. The destination Type.

Create a new ConvertException object

The value to convert. The destination Type. Additional info of the error.

Create a new ConvertException object

The value to convert. The destination Type. Additional info of the error. The estimated column number. The line where the error was found. The name of the field with the error The Inner Exception

The destination type.

The value that can't be converted. (null for unknown)

Extra info about the error.

The message without the Line, Column and FieldName.

The name of the field related to the exception. (null for unknown)

The line where the error was found. (-1 is unknown)

The estimate column where the error was found. (-1 is unknown)

Contains error information of the class.

Contains error information of the class.

Line number of the error

The string of the record of the error.

The exception that indicates the error.

The line number of the error

The string of the record of the error.

The exception that indicates the error.

Converter exception

Convert a field definition to a string

Convert exception object Field as a string or null

Convert a general exception to a string

exception to convert Exception from field

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

All the engines and DataStorage utilities contains an ErrorManager.

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.

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.

Returns an enumerator that iterates through a collection.

An object that can be used to iterate through the collection. 2

Maximum number of recorded errors. After this limit is reached, successive errors are ignored.

Default error limit is 10000.

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.

Default error mode is ThrowException.

Number of contained errors.

Indicates if contains one or more errors.

Indicates the wrong usage of the library.

Creates an instance of an NullValueNotFoundException.

The exception Message

Creates an instance of an NullValueNotFoundException.

The exception Message The line number where the problem was found The column number where the problem was found

Creates an instance of an NullValueNotFoundException.

The exception Message Line to display in message

Exception with error information of the run time compilation.

Compilation exception happen loading a dynamic class

Message for the error Source code reference??? Errors from compiler

The source code that generates the Exception

The errors returned from the compiler.

Arguments for the

Base class of and

Event args to signal engine failures

Define an event message for an engine

Engine type Line number error occurred

The engine that raise the event

The current line number.

Create a read event argument, contains line number and record read

Engine used to parse data record to be analysed record count read

The record line just read.

Whether the RecordLine property has been written-to.

Set this property to true if you want to bypass the current record.

Record before being parsed by the engine

Engine that will analyse the record Record read from the source record number read

Arguments for the

Record before being parsed by the engine

Engine that will analyse the record Object to be created Record read from the source record number read

The current record that was just assigned not yet filled

Arguments for the

Base class of and

Write events are based on this

Engine parsing data Record number

Check record just before processing.

Engine that will parse record line number to be parsed

Set this property as true if you want to bypass the current record.

Arguments for the

Object type we are writing from

Check record just before processing.

Engine that will parse record object to be created line number to be parsed

The current record.

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

The engine that generates the event. The event data.

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

The engine that generates the event. The event data.

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

The engine that generates the event. The event data.

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

The engine that generates the event. The event data.

Arguments for the

After the record is read, allow details to be inspected.

Engine that parsed the record Record that was analysed Was it changed before Record number read

Arguments for the

After the record is read, allow details to be inspected.

Engine that parsed the record Record that was analysed Was it changed before Object created Record number read

The current record.

Arguments for the

Record parsed after engine has finished

engine that created the record Record number of the record LIne to be written

The line to be written to the destination. WARNING: you can change the line value and the engines will write it to the destination.

Arguments for the

Record parsed after engine has finished

engine that created the record object created Record number of the record LIne to be written

The current record.

Define a field that is delimited, eg CSV and may be quoted

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

Check the Attributes on the field and return a structure containing the settings for this file.

Information about this field Type of record we are reading Null if not used

Create a field base without any configuration

Create a field base from a fieldinfo object Verify the settings against the actual field to ensure it will work.

Field Info Object

Extract the string from the underlying data, removes quotes characters for example

Line to parse data from Slightly processed string from the data

Create a text block containing the field from definition

Append string to output Field we are adding Indicates if we are processing last field

Convert a field value to a string representation

Object containing data String representation of field

Get the data out of the records

Line handler containing text

Create field object after extracting the string from the underlying input data

Information extracted? Underlying input data Object to assign to field

Convert a null value into a representation, allows for a null value override

input line to read, used for error messages Null value for object

Get the null value that represent a discarded value

null value of discard?

Convert a field value into a write able value

object value to convert converted value

convert field to string value and assign to a string builder buffer for output

buffer to collect record value to convert

Copy the field object

a complete copy of the Field object

Add the extra details that derived classes create

field clone of right type

type of object to be created, eg DateTime

Provider to convert to and from text

Number of extra characters used, delimiters and quote characters

Field type of an array or it is just fieldType. What actual object will be created

Is this field an array?

Array must have this many entries

Array may have this many entries, if equal to ArrayMinLength then it is a fixed length array

Seems to be duplicate of FieldTypeInternal except it is ONLY set for an array

Am I the first field in an array list

Am I the last field in the array list

Do we process this field but not store the value

Unused!

Value to use if input is null or empty

Are we a simple string field we can just assign to

Details about the extraction criteria

indicates whether we trim leading and/or trailing whitespace

Character to chop off front and / rear of the string

The field may not be present on the input data (line not long enough)

The next field along is optional, optimise processing next records

Set from the FieldInNewLIneAtribute. This field begins on a new line of the file

Order of the field in the file layout

Can null be assigned to this value type, for example not int or DateTime

Name of the field without extra characters (eg property)

The field must be not be empty

Fieldname of the field we are storing

Create an empty delimited field structure

Create a delimited field with defined separator

field info structure field separator

Extract the field from the delimited file, removing separators and quotes and any duplicate quotes within the record

line containing record input Extract information

Output the field string adding delimiters and any required quotes

buffer to add field to value object to add Indicates if we are processing last field

create a field base class and populate the delimited values base class will add its own values

fieldbase ready to be populated with extra info

Set the separator string

Also sets the discard count

allow a quoted multiline format

whether quotes are optional for read and / or write

quote character around field (and repeated within it)

Fixed length field that has length and alignment

Simple fixed length field constructor

Create a fixed length field from field information

Field definitions Length of this field Alignment, left or right

Get the value from the record

line to extract from Information extracted from record

Create a fixed length string representation (pad it out or truncate it)

buffer to add field to value we are updating with Indicates if we are processing last field

Create a clone of the fixed length record ready to get updated by the base settings

new fixed length field definition just like this one minus the base settings

Field length of this field in the record

Alignment of this record

Whether we allow more or less characters to be handled

Collect statistic for the different delimitters

Create delimitter statistics

delimitter we are testing with average number of fields maximum fields found minimum fields found standard deviation

Max fields

Miminum fields found

Average number of fields found per record

delimiter we are testing data with

Standard deviation with the data

Provides a suggestion to the about the records in the file

No Info about the file format

The file is likely to be of fixed length records

The file is likely to be of delimited records

The file is likely to be of records delimited by a tab character

The file is likely to be of records delimited by a semicolon character

The file is likely to be of records delimited by a comma character

Find the number of delimiters in a class

If we use this quote character and this delimitter how many fields do we get

Line we are testing against delimiter for fields quote value number of fields

skip data until we have matching quote

line to test quote char to use string after field This logic does not handle two quotes in a row. The logic that calls this will call the same code again to get the next chunk between delimitters anyway so it is not needed

Describes the format of a record

A number between 0 to 100 that indicates how acurate is the Record Format

A number between 0 to 100 that indicates how acurate is the Record Format

The for the current format.

The casted version of the or null if other builder.

The casted version of the or null if other builder.

Utility class used to auto detect the record format, the number of fields, the type, etc.

Initializes a new instance of the class.

Tries to detect the possible formats of the file using the

The file to be used as sample data The possible of the file.

Tries to detect the possible formats of the file using the

The files to be used as sample data The possible of the file.

Tries to detect the possible formats of the file using the

The files to be used as sample data The possible of the file.

Calculate statistics based on sample data for the delimitter supplied

Provides a suggestion to the about the records in the file

The number of lines of each file to be used as sample data.

The encoding to Read and Write the streams.

Default is the system's current ANSI code page.

Indicates if the sample file has headers

Used to calculate when a file has fixed length records. Between 0.0 - 1.0 (Default 0.01)

Gets or sets the quoted char.

The quoted char.

start and length of fixed length column

start position of column

Length of column

Collection of statistics about fields found

Maximum number of fields found

Mimumim number of fields found

Average number of delimiters foudn per line

Calculated deviation

Total analysed lines

Get the first attribute that matches the type specification (not inherited)

Type of attribute to find Member info to look at for attributes attribute or null

Get the first attribute of this type (or its children)

Type of attribute member info containing attributes Found attribute or null

Worker to get attributes from MemberInfo details

Type to create Member Info details Allow inherited version of attribute? Attribute found or null

Locate an attribute and perform an Action on it, do nothing if you don't find it

Type of attribute we are looking for Field type we are analysing action we want to perform

Helpers that work with conditions to make them easier to write

Test whether string begins with another string

string to test value we want to check for true if string begins with the selector

Test whether string ends with another string

string to test value we want to check for true if string ends with the selector

Test whether string contains with another string

string to test value we want to check for true if string contains the selector

Test whether string begins and ends with another string

string to test value we want to check for true if string begins and ends with the selector

extensions to help with types

Is this type any sort of numeric

Class used to pass information to the and the

Create a CSV Wrapper using the specified number of fields.

The name of the record class The delimiter for each field The number of fields of each record

Create a CSV Wrapper using the specified number of fields.

The name of the record class The delimiter for each field The number of fields of each record The number of lines to use as header

Create a CSV Wrapper using the specified sample file with their headers.

The name of the record class The delimiter for each field A sample file with a header that contains the names of the fields.

Create a CSV Wrapper using the specified sample file with their headers.

The name of the record class The delimiter for each field A sample file with a header that contains the names of the fields. The delimiter for the header line

Convert a field to a string

object we want to convert string representation of the string

A sample file from where to read the field names and number.

The delimiter for each field.

The delimiter for each file name in the header.

The name used for the record class (a valid .NET class).

The prefix used when you only specified the number of fields

The number of fields that the file contains.

The number of header lines

The DateFormat used to read and write DateTime values

The Decimal Separator used to read and write doubles, singles and decimal values

Encoding used when handling the CSV files.

Should blank lines in the source file be left out of the final result?

add validation exceptions

Check the string is null or empty and throw an exception

value to test name of parameter to check

Check that parameter is not null or empty and throw an exception

value to check parameter name

Check that parameter is not null and throw an exception

value to check parameter name

check that parameter 1 is different from parameter 2

value 1 to test name of value 1 value 2 to test name of vlaue 2

Check an integer value is positive (0 or greater)

Integer to test

Validate that the identifier is valid for the language

Validate that the identifier is valid for the language

Name of identifier Is Valid

Validate that the identifier is valid for the language

Name of identifier Is it a type statement, allows for dots, ? for nullable, etc Is Valid

open a stream with optional trim extra blank lines

Filename to open encoding of the file do we trim blank lines from end? do we close stream after trimming Buffer size to read TextWriter ready to write to

Helper classes for strings

New line variable

Extract a string from a quoted string, allows for doubling the quotes for example 'o''clock'

Line to extract from (with extra info) Quote char to remove can we have a new line in middle of string Extracted information

Convert a string to a string with quotes around it, if the quote appears within the string it is doubled

Where string is added String to be added quote character to use, eg "

Remove leading blanks and blanks after the plus or minus sign from a string to allow it to be parsed by ToInt or other converters

source to trim String without blanks This logic is used to handle strings line " + 21 " from input data (returns "+21 "). The integer convert would fail because of the extra blanks so this logic trims them

Create an invariant culture comparison operator

Comparison operations

replace the one string with another, and keep doing it

Original string Value to replace value to replace with String with all multiple occurrences replaced

convert a string into a valid identifier

Original string valid identifier Original_string

Replace string with another ignoring the case of the string

Original string string to replace string to insert string with values replaced

String replace with a comparison function, eg OridinalIgnoreCase

Original string Value to be replaced value to replace with Comparison type (enum) String with values replaced

Indicates whether a specified string is null, empty, or consists only of white-space characters.

The string to test. true if the parameter is null, empty, or consists only of white-space characters.

Determines whether the beginning of this string instance matches the specified string ignoring white spaces at the start.

source string. The string to compare. string comparison type.

Interface used to provide In record notification of read operations.

private class SampleType: INotifyRead, INotifyWrite { .... public void AfterRead(AfterReadEventArgs e) { // Your Code Here } public void BeforeWrite(BeforeReadEventArgs e) { // Your Code Here } }

Method called by the engines before fill the info of the record and after read the source line.

The Event Info

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

The Event Info

Interface used to provide record type transformations

Method called to transform the current record to Type T.

Used by the FileDiffEngine to compare records. Your record class must implement this interface if you like to work with it.

Compare two records and return true if are equal.

The other record. Returns true only if the records are equals.

Interface used to provide In record notification of write operations.

private class SampleType: INotifyRead, INotifyWrite { .... public void AfterRead(BeforeWriteEventArgs e) { // Your Code Here } public void BeforeWrite(AfterWriteEventArgs e) { // Your Code Here } }

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

The Event Info

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

The Event Info

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.

Read a master detail file, eg Orders followed by detail records

One of the main classes of the library. This engine is responsible for reading and writing Master-Details records to or from files or streams.

You can set the of this class to defined how to handle an error. Errors can be retrieved with the property if set appropriately. See in the Class Diagram and in the Quick Start Guide for more Info. Or you can browse the Examples Section for more code. Quick Start GuideClass DiagramExamples of UseAttributes List The Master Record Type The Detail Record Type

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

This method opens, reads and closes the file (don't open or close the file before or after calling 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 instantiate 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 does not close it after using 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 instantiate 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 opens, writes and closes the file (don't open or close the file before or after calling this method) This method over writes any existing file. 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 instantiate 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 opens, writes and closes the file (don't open or close the file before or after calling this method) This method over writes 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 instantiate 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 does not close it after using 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 instantiate 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 does not close it after using 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 instantiate 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 opens, seek to the end, writes and closes the file (don't open or close the file before or after calling 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 instantiate 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 opens, seek to the end, writes and closes the file (don't open or close the file before or after calling 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 instantiate 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.

Allows you to change some record layout options at runtime

the type of the master records handled by this engine.

The to get the (only for read operations)

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

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 (only for read operations)

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 (only for read operations) The string passed as the selector.

Records are read which one is the master and the following records are details, eg an order and the items ordered.

This class contains information of a Master record and its 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.

The canonical empty MasterDetail object.

Master record for this group

An Array with the Detail records.

Returns a canonical empty MasterDetail object.

The Master record.

An Array with the Detail records.

records which have master and details

Master record Collection of detail records

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.

Base class of all messages

Messages may have substitution of $var$ applied

Create a message for given text

Text of the message, may have $var$ variables

Convert the source text using substitution

Send message out with conversion applied

message after substitution

Base of messages without substitution

Message text after substitution happens

This class allows you to set some options of the delimited records at runtime. With options the library is more flexible.

This class allows you to set some options of the records at runtime. With these options the library is now more flexible than ever.

This class allows you to set some options of the records at runtime. With these options the library is now more flexible than ever.

Record information

Allows the creating of a record string of the given record. Is useful when your want to log errors to a plan text file or database

The record that will be transformed to string The string representation of the current record

The number of fields of the record type.

Returns an string array with the fields names. Note : Do NOT change the values of the array, clone it first if needed

An string array with the fields names.

Returns a Type[] array with the fields types. Note : Do NOT change the values of the array, clone it first if needed

An Type[] array with the fields types.

Indicates the number of first lines to be discarded.

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

Indicates that the engine must ignore the empty lines while reading.

Used to tell the engine which records must be included or excluded while reading.

Indicates that the engine must ignore the lines with this comment marker.

Used to tell the engine which records must be included or excluded while reading.

Used to tell the engine which records must be included or excluded while reading.

Record information

The condition used to include or exclude records.

The selector used by the .

Indicates that the engine must ignore the lines with this comment marker.

Indicates that the engine must ignore the lines with this comment marker.

Record information

Indicates that the engine must ignore the lines with this comment marker. An empty string or null indicates that the engine doesn't look for comments

Indicates if the comment can have spaces or tabs at left (true by default)

This class allows you to set some options of the delimited records at runtime. With options the library is more flexible.

Record information

The delimiter used to identify each field in the data.

This class allows you to set some options of the fixed length records but at runtime. With this options the library is more flexible than never.

This class allows you to set some options of the fixed length records but at runtime. With this options the library is more flexible than never.

Record information

Indicates the behavior when variable length records are found in a []. (Note: nothing in common with [FieldOptional])

The sum of the individual field lengths.

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

Create a progress event argument

Current record in file Total records in file

Create a progress event argument

Current record in file Total number of records in file Current position in bytes Total bytes in file

Percentage of the file complete (estimate or completion time)

Number of the record being processed

Total records in the file (-1 is unknown)

Current position in the file

Total bytes in the file

Fields inherited from base classes will be ignored.

See the complete attributes list for more information and examples of each one.

Fields inherited from base classes will be ignored.

This class help to sort really big files using the External Sorting algorithm http://en.wikipedia.org/wiki/External_sorting

This class help to sort really big files using the External Sorting algorithm http://en.wikipedia.org/wiki/External_sorting

Type of record to sort

Default block size, 10 meg

Maximum block size, 50 meg

Minimum block size 2 meg

set the default encoding to the default encoding for C#

Comparison operator for this sort

Sort big files using the External Sorting algorithm

Sort a large file

block size for sort to work on

Large file sorter

Encoding of the file

Large file sorter

Encoding of the file Size of the blocks in bytes

Large file sorter specifying the comparison operator

Comparison operator Encoding of the file Block size to work on

Sort a file from one filename to another filename

Handles very large files File to read in File to write out

Create a StreamWriter given the filename and buffer size

Filename to write Buffer size StreamWriter object

Create a part of a file, files are split into chunks for sort processing

Filename (prefix) This chunk number revised filename to write

Large files are sorted in chunk then merged together in the final process

list of chunks to merge output filename The header of the destinationFile The footer of the destinationFile

The directory for the temp files (by the default the same directory as sourceFile)

The Size of each block that will be sorted in memory which are later merged together

Indicates if the temporary files will be deleted (True by default)

The Encoding used to read and write the files

Indicates if the Sorter run a GC.Collect() after sort and write each part. Default is true.

Create a big file sorter with the minimum buffer size

Create a big file sorter using the block size

Block size to work on

Create a big file sorter using and encoding

Encoding of the file

Create a big file sorter using comparison operator

Comparison operator

Create a big file sorter with a comparison operator and block size

Comparison operator Block size to work on file

Create a bug file sorter

Comparison operator encoding of the file Block size to work on

Create a record sorter based on string value

string sorter to convert new record comparison sorter

Support record class for string sorting

Value of the string

Compare to the sorter record

Record to compare Comparison

One sorted 'chunk' of an input file.

object type we are sorting

encoding of the file filename of the chunk do we remove file after afterwards

Move to the next record along, sets current

close engine and if requested delete the file

Enable reading a string as a stream

String we are analysing

Create a stream based on the string

Close the stream

Close the stream and release resources

Peek at the next byte along in the stream

Next character as an integer

Read the next byte along in the string

next character as an integer

Replaces text into the buffer at index for count characters

An array of Unicode characters to which characters in this instance are copied. The index in destination at which the copy operation begins. The number of characters in this instance to copy to destination. number of characters actually copied

Read a line from the buffer

Line without line end

Read the buffer to the end

String containing all remaining text

Length of the stream

Position within the stream

Calculate statistics on stream, position and total size

Position within the stream -1 is beginning

Length of the stream -1 is unknown

Provide as much information about the input stream as we can, size and position

reader we are analysing

Provide as much information about the output stream as we can, size and position

writer we are analysing

Position within the stream

Total number of bytes within the stream

Delegate to the stream values returned

Encapsulate stream reader provide some extra caching, and byte by byte read

Create stream reader to be initialised later

Create a stream reader on a text file (assume UTF8)

filename to reader

Create a stream reader specifying path and encoding

path to the filename encoding of the file

Open a file for reading allowing encoding, detecting type and buffersize

Filename to read Encoding of file, eg UTF8 Detect type of file from contents Buffer size for the read

Close the stream, cleanup

Open the file and check the first few bytes for Unicode encoding values

Discard all data inside the internal buffer

clean up the stream object

first call or second

Return the byte at the current position

byte at current position or -1 on error

Read a byte from the stream

Position within the file

Is the stream able to be closed

What is the streams current encoding

What is the underlying stream on input file

Check that the stream has ended, all data read