MasterDetailEngine Class |
Read a master detail file, eg Orders followed by detail records
Inheritance HierarchySystemObject
FileHelpersEngineBase
FileHelpers.MasterDetailMasterDetailEngineObject, Object
FileHelpers.MasterDetailMasterDetailEngine
FileHelpersEngineBase
FileHelpers.MasterDetailMasterDetailEngineObject, Object
FileHelpers.MasterDetailMasterDetailEngine
Namespace: FileHelpers.MasterDetail
Assembly: FileHelpers (in FileHelpers.dll) Version: 3.2.6
SyntaxThe MasterDetailEngine type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MasterDetailEngine(Type, Type) |
Initializes a new instance of the MasterDetailEngine class with the specified type of records.
|
| MasterDetailEngine(Type, Type, MasterDetailSelector) |
Initializes a new instance of the MasterDetailEngine class with the specified type of records.
|
| MasterDetailEngine(Type, Type, CommonSelector, String) |
Initializes a new instance of the MasterDetailEngine class with the specified type of records.
|
Properties| 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.) |
| MasterOptions |
Allows you to change some record layout options at runtime
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| MasterType |
the type of the master records handled by this engine.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| 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.) |
| RecordSelector |
The MasterDetailSelector to get the RecordAction (only for read operations)
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| 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.) |
Methods| Name | Description | |
|---|---|---|
 | AppendToFile(String, MasterDetailsTMaster, TDetail) |
Append a record to the specified file.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| AppendToFile(String, IEnumerableMasterDetailsTMaster, TDetail) |
Append an array of records to the specified file.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| 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 |
Read a file and return an array of the contained records.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| ReadStream |
Read a Stream and return an array of the contained records.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| ReadString |
Read a String and return an array of the contained records.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| WriteFile(String, IEnumerableMasterDetailsTMaster, TDetail) |
Write an array of records to the specified file.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| WriteFile(String, IEnumerableMasterDetailsTMaster, TDetail, Int32) |
Write the specified number of records from the array to a file.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| WriteStream(TextWriter, IEnumerableMasterDetailsTMaster, TDetail) |
Write an array of records to the specified Stream.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| WriteStream(TextWriter, IEnumerableMasterDetailsTMaster, TDetail, Int32) |
Write the specified number of records in the array to the Stream.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| WriteString(IEnumerableMasterDetailsTMaster, TDetail) |
Write an array of records to an String and return it.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
| WriteString(IEnumerableMasterDetailsTMaster, TDetail, Int32) |
Write an array of records to an String and return it.
(Inherited from MasterDetailEngineTMaster, TDetail.) |
Events| Name | Description | |
|---|---|---|
 | Progress | Event handler called to notify progress. (Inherited from EngineBase.) |
See Also