FileHelpers Namespace

The main namespace of the library.
You must import always this namespace to work with the FileHelpers.

Go directly to the Engine classes FileHelperEngine and FileHelperAsyncEngine. You can also check the CommonEngine for shortcuts to the common operations.

You can also check the advanced engines MultiRecordEngine, FileTransformEngine, the FileDiffEngine.
Engines Diagram:

Namespace hierarchy

Classes

Class	Description
AfterReadRecordEventArgs	Arguments for the AfterReadRecordHandler
AfterWriteRecordEventArgs	Arguments for the AfterWriteRecordHandler
BadUsageException	Indicates the wrong usage of the library.
BeforeReadRecordEventArgs	Arguments for the BeforeReadRecordHandler
BeforeWriteRecordEventArgs	Arguments for the BeforeWriteRecordHandler
CommonEngine	This class only have static methods to work with files and strings (the most common of them)
ConditionalRecordAttribute	Allow to declarative set what records must be included or excluded when reading.
ConverterBase	Base class to provide bidirectional Field - String convertion.
ConvertException	Indicates that a string value can't be converted to a dest type.
CsvEngine	A class to read generic CSV files delimited for any char.
CsvOptions	Class used to pass information to the CsvClassBuilder and the CsvEngine
DelimitedFileEngine	Is a version of the FileHelperEngine exclusive for delimited records that allow you to change the delimiter an other options at runtime
DelimitedRecordAttribute	Indicates that this class represents a delimited record.
DelimitedRecordOptions	This class allows you to set some options of the delimited records but at runtime. With this options the library is more flexible than never.
ErrorInfo	Contains error information of the FileHelperEngine class.
ErrorManager	This is the class that handles the errors of the engines process.
FieldAlignAttribute	Indicates the AlignMode used for write operations.
FieldConverterAttribute	Indicates the ConverterKind used for read/write operations.
FieldDelimiterAttribute	Indicates a diferent delimiter for this field.
FieldFixedLengthAttribute	Indicates the length of a FixedLength field.
FieldIgnoredAttribute	Indicates that the target field is completely ignored by the Engine (i.e. This field don´t exists for the library).
FieldInNewLineAttribute	Indicates the target field has a new line before his value (i.e. indicates that the records has multiple lines, and this field is in the begining of a line)
FieldNullValueAttribute	Indicates the value to assign to the field in the case of find a "NULL".
FieldOptionalAttribute	Indicates that the target field is included only under some circunstances.
FieldQuotedAttribute	Indicates that the field must be read and written like a Quoted String. (by default "")
FieldTrimAttribute	Indicates the TrimMode used after read to truncate the field.
FileDiffEngine	Engine used to create diff files based on the IComparableRecord interface.
FileHelperAsyncEngine	One of the main classes of the library. This engine is responsable to Read/Write the records One by One from/to files or streams.
FileHelperEngine	One of the main classes of the library. This engine is responsable to Read/Write the records at once from/to files or streams. You can use the DelimitedFileEngine or the FixedFileEngine if you need to change some options at runtime
FileHelpersException	Base class for all the library Exceptions.
FileTransformEngine	This class allow you to convert the records of a file to a different record format.
FixedFileEngine	Is a version of the FileHelperEngine exclusive for fixed length records that allow you to change the delimiter an other options at runtime
FixedLengthRecordAttribute	Indicates that this class represents a fixed length record.
FixedRecordOptions	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.
IgnoreCommentedLinesAttribute	Indicates that the engine must ignore commented lines while reading.
IgnoreEmptyLinesAttribute	Indicates that the engine must ignore the empty lines while reading.
IgnoreFirstAttribute	Indicates the number of first lines to be discarded.
IgnoreLastAttribute	Indicates the number of lines to be discarded at the end.
MultiRecordEngine	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 MasterDetailEngine)
ProgressEventArgs	Class used to notify the current progress position and other context info.
RecordOptions	This class allows you to set some options of the records but at runtime. With this options the library is more flexible than never.
RecordOptions.IgnoreCommentInfo	Indicates that the engine must ignore the lines with this comment marker.
RecordOptions.RecordConditionInfo	Allow to tell the engine what records must be included or excluded while reading.
TransformToRecordAttribute	With this attribute you can mark a method in the RecordClass that is the responsable of convert it to the specified.

Interfaces

Interface	Description
IComparableRecord	Used by the FileDiffEngine to compare records. Your record class must implement this interface if you like to work with it.
INotifyRead	Interface used to provide In record notification of read operations.
INotifyWrite	Interface used to provide In record notification of write operations.

Delegates

Delegate	Description
AfterReadRecordHandler	Called in read operations just after the record was created from a record string.
AfterWriteRecordHandler	Called in write operations just after the record was converted to a string.
BeforeReadRecordHandler	Called in read operations just before the record string is translated to a record.
BeforeWriteRecordHandler	Called in write operations just before the record is converted to a string to write it.
ProgressChangeHandler	Delegate used to notify progress to the user.
RecordTypeSelector	Delegate thats determines the Type of the current record (Master, Detail, Skip)

Enumerations

Enumeration	Description
AlignMode	Indicates the align of the field when the FileHelperEngine writes the record.
ConverterKind	Indicates the convertion used in the FieldConverterAttribute.
ErrorMode	Indicates the behavior when the FileHelperEngine class found an error.
FixedMode	Indicates the behavior when variable length records are found in a [FixedLengthRecordAttribute]. (Note: nothing in common with [FieldOptional])
MultilineMode	Indicates the behavior of multiline fields.
NetLanguage	Indicates the .NET Language
NetVisibility	Indicates the visibility of a member.
ProgressMode	Indicate the method used to calculate the current progress
QuoteMode	Indicates the behavior of quoted fields.
RecordCondition	The condition used to include or exclude each record.
TrimMode	Indicates the triming behavior of the trailing characters.


Overview - Downloads - Examples - News Feed - Contact Info -

FileHelpers Namespace

Classes

Interfaces

Delegates

Enumerations

See also