MasterDetailEngineTMaster, TDetail Class

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.

[Missing <include> target documentation in 'T:FileHelpers.MasterDetail.MasterDetailEngine`2'. File: 'Examples.xml' Path: 'doc/examples/MasterDetailEngine/*']

Inheritance Hierarchy

SystemObject
  FileHelpersEngineBase
    FileHelpers.MasterDetailMasterDetailEngineTMaster, TDetail
      FileHelpers.MasterDetailMasterDetailEngine

Namespace: FileHelpers.MasterDetail
Assembly: FileHelpers (in FileHelpers.dll) Version: 3.2.6

Syntax

Copy

public class MasterDetailEngine<TMaster, TDetail> : EngineBase
where TMaster : class
where TDetail : class

Public Class MasterDetailEngine(Of TMaster As Class, TDetail As Class)
	Inherits EngineBase

Type Parameters

TMaster: The Master Record Type
TDetail: The Detail Record Type

The MasterDetailEngineTMaster, TDetail type exposes the following members.

Constructors

	Name	Description
	MasterDetailEngineTMaster, TDetail	Initializes a new instance of the MasterDetailEngineTMaster, TDetail class
	MasterDetailEngineTMaster, TDetail(MasterDetailSelector)	Initializes a new instance of the MasterDetailEngineTMaster, TDetail class
	MasterDetailEngineTMaster, TDetail(CommonSelector, String)	Initializes a new instance of the MasterDetailEngineTMaster, TDetail class

Top

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
	MasterType	the type of the master records handled by this engine.
	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)
	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.)

Top

Methods

	Name	Description
	AppendToFile(String, MasterDetailsTMaster, TDetail)	Append a record to the specified file.
	AppendToFile(String, IEnumerableMasterDetailsTMaster, TDetail)	Append an array of records 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	Read a file and return an array of the contained records.
	ReadStream	Read a Stream and return an array of the contained records.
	ReadString	Read a String and return an array of the contained records.
	WriteFile(String, IEnumerableMasterDetailsTMaster, TDetail)	Write an array of records to the specified file.
	WriteFile(String, IEnumerableMasterDetailsTMaster, TDetail, Int32)	Write the specified number of records from the array to a file.
	WriteStream(TextWriter, IEnumerableMasterDetailsTMaster, TDetail)	Write an array of records to the specified Stream.
	WriteStream(TextWriter, IEnumerableMasterDetailsTMaster, TDetail, Int32)	Write the specified number of records in the array to the Stream.
	WriteString(IEnumerableMasterDetailsTMaster, TDetail)	Write an array of records to an String and return it.
	WriteString(IEnumerableMasterDetailsTMaster, TDetail, Int32)	Write an array of records to an String and return it.