FileHelperEngineT Class |
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
Namespace: FileHelpers
The FileHelperEngineT type exposes the following members.
Name | Description | |
---|---|---|
FileHelperEngineT |
Initializes a new instance of the FileHelperEngine class with the specified type of records.
| |
FileHelperEngineT(Encoding) |
Initializes a new instance of the FileHelperEngine class with the specified type of records.
|
Name | Description | |
---|---|---|
Encoding |
The encoding to Read and Write the streams.
Default is the system's current ANSI code page.
(Inherited from EngineBase.) | |
ErrorManager | This is a common class that manages the errors of the library. (Inherited from EngineBase.) | |
ErrorMode |
Indicates the behavior of the engine when it finds an error.
{Shortcut for )
(Inherited from EngineBase.) | |
FooterText | The Read Footer in the last Read operation. If any. (Inherited from EngineBase.) | |
HeaderText | The Read Header in the last Read operation. If any. (Inherited from EngineBase.) | |
LineNumber | The current line number. (Inherited from EngineBase.) | |
NewLineForWrite |
Newline string to be used when engine writes to file.
Default is the system's newline setting (System.Environment.NewLine).
(Inherited from EngineBase.) | |
Options |
Allows you to change some record layout options at runtime
(Inherited from EngineBase.) | |
RecordType | Returns the type of records handled by this engine. (Inherited from EngineBase.) | |
TotalRecords | The total numbers of records in the last read/written file
(only works with whole read/write). (Inherited from EngineBase.) |
Name | Description | |
---|---|---|
AppendToFile(String, IEnumerableT) |
Append an array of records to the specified file.
| |
AppendToFile(String, T) |
Append a record to the specified file.
| |
GetFileHeader |
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
(Inherited from EngineBase.) | |
ReadFile(String) |
Read a file and return an array of the contained records.
| |
ReadFile(String, Int32) |
Read a file and return an array of the contained records.
| |
ReadFileAsDT(String) | Obsolete.
Read the records of the file and fill a DataTable with them
| |
ReadFileAsDT(String, Int32) | Obsolete.
Read the records of the file and fill a DataTable with them
| |
ReadFileAsList(String) | Obsolete.
Read a file and return an array of the contained records.
| |
ReadFileAsList(String, Int32) | Obsolete.
Read a file and return an array of the contained records.
| |
ReadStream(TextReader) |
Read a Stream and return an array of the contained records.
| |
ReadStream(TextReader, Int32) |
Read a Stream and return an array of the contained records.
| |
ReadStreamAsDT(TextReader) | Obsolete.
Read the records of the stream and fill a DataTable with them
| |
ReadStreamAsDT(TextReader, Int32) | Obsolete.
Read the records of the stream and fill a DataTable with them
| |
ReadStreamAsList | Obsolete.
Read a Stream and return an array of the contained records.
| |
ReadString(String) |
Read a String and return an array of the contained records.
| |
ReadString(String, Int32) |
Read a String and return an array of the contained records.
| |
ReadStringAsDT(String) | Obsolete.
Read the records of a string and fill a DataTable with them.
| |
ReadStringAsDT(String, Int32) | Obsolete.
Read the records of a string and fill a DataTable with them.
| |
ReadStringAsList(String) | Obsolete.
Read a String and return an array of the contained records.
| |
ReadStringAsList(String, Int32) | Obsolete.
Read a String and return an array of the contained records.
| |
WriteFile(String, IEnumerableT) |
Write an array of records to the specified file.
| |
WriteFile(String, IEnumerableT, Int32) |
Write the specified number of records from the array to a file.
| |
WriteStream(TextWriter, IEnumerableT) |
Write an array of records to the specified Stream.
| |
WriteStream(TextWriter, IEnumerableT, Int32) |
Write the specified number of records in the array to the Stream.
| |
WriteString(IEnumerableT) |
Write an array of records to an String and return it.
| |
WriteString(IEnumerableT, Int32) |
Write an array of records to an String and return it.
|
Name | Description | |
---|---|---|
AfterReadRecord |
Called in read operations just after the record was created from a
record string.
(Inherited from EventEngineBaseT.) | |
AfterWriteRecord |
Called in write operations just after the record was converted to a
string.
(Inherited from EventEngineBaseT.) | |
BeforeReadRecord |
Called in read operations just before the record string is
translated to a record.
(Inherited from EventEngineBaseT.) | |
BeforeWriteRecord |
Called in write operations just before the record is converted to a
string to write it.
(Inherited from EventEngineBaseT.) | |
Progress | Event handler called to notify progress. (Inherited from EngineBase.) |
You can set the ErrorMode of this class when found an error, and can retrieve them with the Errors 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:
using FileHelpers; // First declare the record class [Delimitedrecord("|")] public class SampleType { public string Field1; public int Field2; } public void ReadExample() { var engine = new FileHelperEngine<SampleType>()); var records = 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() { var engine = new FileHelperEngine<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 }