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, FileHelperAsyncEngine and MultiRecordEngine.
Engines Diagram:
You must import always this namespace to work with the FileHelpers.
Go directly to the Engine classes FileHelperEngine, FileHelperAsyncEngine and MultiRecordEngine.
Engines Diagram:
Classes| Class | Description | |
|---|---|---|
 | BadUsageException | Indicates the wrong usage of the library. |
| BigFileSorter |
This class help to sort really big files using the External Sorting algorithm
http://en.wikipedia.org/wiki/External_sorting
|
| BigFileSorterSorterRecord |
Support record class for string sorting
|
| BigFileSorterT |
This class help to sort really big files using the External Sorting algorithm
http://en.wikipedia.org/wiki/External_sorting
|
| CommonEngine |
This class only has static methods to work with files and
strings (most of the common tools)
|
 | ConditionalRecordAttribute | Allow to declaratively set what records must be included or excluded while reading. |
| ConverterBase |
Base class to provide bi-directional
Field - String conversion.
|
| 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. |
| DelimitedField |
Define a field that is delimited, eg CSV and may be quoted
|
| DelimitedFileEngine |
This version of the FileHelperEngine is exclusively
for delimited records. It allows you to change the delimiter and
other options at runtime
|
| DelimitedFileEngineT |
A version of the FileHelperEngine exclusively for
delimited records. It allows you to change the delimiter and other
options at runtime
|
| DelimitedRecordAttribute | Indicates that this class represents a delimited record. |
| EngineBase | Abstract Base class for the engines of the library:
FileHelperEngine and
FileHelperAsyncEngine |
| ErrorInfo |
Contains error information of the FileHelperEngine class.
|
| ErrorManager |
This is the class that handles the errors of the engines process.
|
| EventEngineBaseT |
Base for engine events
|
| ExtensionsFileHelpers |
Set of Extension methods to be exposed to end users
of the FileHelpers API.
|
| FieldAlignAttribute | Indicates the AlignMode used for write operations. |
| FieldArrayLengthAttribute |
Allows you to set the length or bounds that the target array field must have.
|
| FieldAttribute | Base class of FieldFixedLengthAttribute and FieldDelimiterAttribute |
| FieldBase |
Base class for all Field Types.
Implements all the basic functionality of a field in a typed file.
|
| FieldCaptionAttribute | Indicates a different caption for this field, which overrides FieldFriendlyName when calling GetFileHeader. |
| FieldConverterAttribute | Indicates the ConverterKind used for read/write operations. |
| FieldDelimiterAttribute | Indicates a different delimiter for this field. |
| FieldFixedLengthAttribute | Indicates the length of a FixedLength field. |
| FieldHiddenAttribute | 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 FieldValueDiscardedAttribute |
| FieldIgnoredAttribute | Obsolete. Hides the field to the library. Obsolete: You must use [FieldHidden] |
| FieldInNewLineAttribute |
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.
|
| FieldNotEmptyAttribute |
Indicates that the target field cannot contain an empty string value.
This attribute is used for read.
|
| FieldNotInFileAttribute | Obsolete. Hides the field to the library. Obsolete: You must use [FieldHidden] |
| FieldNullValueAttribute |
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.
|
| FieldOptionalAttribute |
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.
|
| FieldOrderAttribute |
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.
|
| FieldQuotedAttribute |
Indicates that the field must be read and written as a Quoted String.
By default uses "" (double quotes)
|
| FieldTrimAttribute | Indicates the TrimMode used after reading to truncate the field. |
| FieldValueDiscardedAttribute | Discards the values for the target field.
Note: If the field is not on the source file you must use FieldHiddenAttribute |
| FileDiffEngineT |
Engine used to create diff files based on the
IComparableT interface.
|
| FileHelperAsyncEngine |
Async engine, reads records from file in background,
returns them record by record in foreground
|
| FileHelperAsyncEngineT | 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. |
| FileHelperEngine |
Basic engine to read record by record
|
| FileHelperEngineT | 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 DelimitedFileEngine or the FixedFileEngine if you need to change some options at runtime |
| FileHelpersException | Base class for all the library Exceptions. |
| FileTransformEngineTSource, TDestination |
This class allow you to convert the records of a file to a different record format.
|
| FixedFileEngine |
This version of the FileHelperEngine is exclusively for
fixed length records. It allows you to change options at runtime
|
| FixedFileEngineT |
This version of the FileHelperEngine is exclusively for
fixed length records. It allows you to change options at runtime
|
| FixedLengthField |
Fixed length field that has length and alignment
|
| FixedLengthRecordAttribute | Indicates that this class represents a fixed length record. |
| IgnoreCommentedLinesAttribute | Obsolete. Indicates that the engine must ignore commented lines while reading. |
| IgnoreEmptyLinesAttribute | Indicates that the engine will ignore the empty lines while reading. |
| IgnoreFirstAttribute | Indicates the number of lines at beginning of the file to be ignored. |
| IgnoreInheritedClassAttribute | Fields inherited from base classes will be ignored. |
| IgnoreLastAttribute |
The number of lines to be ignored at the end of the file.
|
| 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) |
| NullValueNotFoundException | Indicates the wrong usage of the library. |
| RecordIndexer |
A class to loop through the field values
|
| TypedRecordAttribute | Base class for the record types.. |
Interfaces| Interface | Description | |
|---|---|---|
 | IFileHelperAsyncEngineT |
Interface for the FileHelper Async Engine
|
| IFileHelperEngineT |
Interface for The fileHelpers generic engine
|
| IRecordReader |
Basic read record interface
|
| ITransformableT |
Interface used to provide record type transformations
|
Delegates| Delegate | Description | |
|---|---|---|
 | RecordTypeSelector |
Delegate that determines the Type of the current record (Master, Detail, Skip)
|
Enumerations| Enumeration | Description | |
|---|---|---|
 | AlignMode | Indicates the align of the field when the FileHelperEnginewrites the record. |
| ConverterKind |
Indicates the Conversion used in the FieldConverterAttribute.
|
| ErrorMode | Indicates the behavior when the engine classes like 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. |
| QuoteMode | Indicates the behavior of quoted fields. |
| RecordCondition | The condition used to include or exclude each record. |
| TrimMode |
Indicates the trimming behavior of the leading and trailing whitespace.
|