filehelpers 2.0.0.0.20100812
Sign up to get free protection for your applications and to get access to all the features.
- data/docs/FileHelpers - Documentation.chm +0 -0
- data/lib/DotNet 1.1 PPC/FileHelpersPPC.dll +0 -0
- data/lib/DotNet 1.1 PPC/FileHelpersPPC.xml +1874 -0
- data/lib/DotNet 1.1/FileHelpers.ExcelStorage.dll +0 -0
- data/lib/DotNet 1.1/FileHelpers.ExcelStorage.xml +121 -0
- data/lib/DotNet 1.1/FileHelpers.dll +0 -0
- data/lib/DotNet 1.1/FileHelpers.xml +4325 -0
- data/lib/DotNet 1.1/Interop.Excel.dll +0 -0
- data/lib/DotNet 1.1/Interop.Office.dll +0 -0
- data/lib/DotNet 2.0 PPC/FileHelpersPPC.dll +0 -0
- data/lib/DotNet 2.0 PPC/FileHelpersPPC.xml +1874 -0
- data/lib/DotNet 2.0/FileHelpers.ExcelStorage.dll +0 -0
- data/lib/DotNet 2.0/FileHelpers.ExcelStorage.xml +121 -0
- data/lib/DotNet 2.0/FileHelpers.dll +0 -0
- data/lib/DotNet 2.0/FileHelpers.xml +5923 -0
- data/lib/DotNet 2.0/Interop.Excel.dll +0 -0
- data/lib/DotNet 2.0/Interop.Office.dll +0 -0
- data/lib/Mono 1.2/FileHelpers.dll +0 -0
- data/lib/Mono 1.2/FileHelpers.xml +5923 -0
- data/lib/Mono 1.2/Readme.txt +17 -0
- metadata +88 -0
|
Binary file
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<doc>
|
|
3
|
+
<assembly>
|
|
4
|
+
<name>FileHelpers.ExcelStorage</name>
|
|
5
|
+
</assembly>
|
|
6
|
+
<members>
|
|
7
|
+
<member name="T:FileHelpers.DataLink.ExcelBadUsageException">
|
|
8
|
+
<summary>Indicates the wrong usage of the ExcelStorage of the library.</summary>
|
|
9
|
+
</member>
|
|
10
|
+
<member name="M:FileHelpers.DataLink.ExcelBadUsageException.#ctor(System.String)">
|
|
11
|
+
<summary>Creates an instance of an ExcelBadUsageException.</summary>
|
|
12
|
+
<param name="message">The exception Message</param>
|
|
13
|
+
</member>
|
|
14
|
+
<member name="T:FileHelpers.DataLink.ExcelDataLink">
|
|
15
|
+
<summary>
|
|
16
|
+
This class has the responsability to enable the two directional
|
|
17
|
+
transformation.
|
|
18
|
+
<list type="bullet">
|
|
19
|
+
<item> Excel <-> DataStorage</item>
|
|
20
|
+
</list>
|
|
21
|
+
<para><b>WARNING you need to have installed Microsoft Excel 2000 or newer to use this feature.</b></para>
|
|
22
|
+
<para><b>To use this class you need to reference the FileHelpers.ExcelStorage.dll file.</b></para>
|
|
23
|
+
</summary>
|
|
24
|
+
<remarks>
|
|
25
|
+
<para>Uses an <see cref="P:FileHelpers.DataLink.ExcelDataLink.DataStorage"/> to accomplish this task.</para>
|
|
26
|
+
</remarks>
|
|
27
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
28
|
+
<seealso href="class_diagram.html">Class Diagram</seealso>
|
|
29
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
30
|
+
<seealso href="example_datalink.html">Example of the DataLink</seealso>
|
|
31
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
32
|
+
</member>
|
|
33
|
+
<member name="M:FileHelpers.DataLink.ExcelDataLink.#ctor(FileHelpers.DataLink.DataStorage)">
|
|
34
|
+
<summary>Create a new instance of the class.</summary>
|
|
35
|
+
<param name="provider">The <see cref="T:FileHelpers.DataLink.DataStorage"/> used to performs the transformation.</param>
|
|
36
|
+
</member>
|
|
37
|
+
<member name="M:FileHelpers.DataLink.ExcelDataLink.ExtractToExcel(System.String)">
|
|
38
|
+
<summary>
|
|
39
|
+
Extract records from the data source and insert them to the specified file using the DataLinkProvider <see cref="M:FileHelpers.DataLink.DataStorage.ExtractRecords"/> method.
|
|
40
|
+
</summary>
|
|
41
|
+
<param name="fileName">The files where the records be written.</param>
|
|
42
|
+
<returns>True if the operation is successful. False otherwise.</returns>
|
|
43
|
+
</member>
|
|
44
|
+
<member name="M:FileHelpers.DataLink.ExcelDataLink.InsertFromExcel(System.String)">
|
|
45
|
+
<summary>Extract records from a file and insert them to the data source using the DataLinkProvider <see cref="M:FileHelpers.DataLink.DataStorage.InsertRecords(System.Object[])"/> method.</summary>
|
|
46
|
+
<param name="excelFileName">The file with the source records.</param>
|
|
47
|
+
<returns>True if the operation is successful. False otherwise.</returns>
|
|
48
|
+
</member>
|
|
49
|
+
<member name="P:FileHelpers.DataLink.ExcelDataLink.ExcelStorage">
|
|
50
|
+
<summary> The internal <see cref="T:FileHelpers.FileHelperEngine"/> used to the file or stream ops. </summary>
|
|
51
|
+
</member>
|
|
52
|
+
<member name="P:FileHelpers.DataLink.ExcelDataLink.DataStorage">
|
|
53
|
+
<summary> The internal <see cref="T:FileHelpers.DataLink.DataStorage"/> used to the link ops. </summary>
|
|
54
|
+
</member>
|
|
55
|
+
<member name="P:FileHelpers.DataLink.ExcelDataLink.LastExtractedRecords">
|
|
56
|
+
<summary>
|
|
57
|
+
An array of the last records extracted from the data source to a file.
|
|
58
|
+
</summary>
|
|
59
|
+
</member>
|
|
60
|
+
<member name="P:FileHelpers.DataLink.ExcelDataLink.LastInsertedRecords">
|
|
61
|
+
<summary>
|
|
62
|
+
An array of the last records inserted in the data source that comes from a file.
|
|
63
|
+
</summary>
|
|
64
|
+
</member>
|
|
65
|
+
<member name="T:FileHelpers.DataLink.ExcelStorage">
|
|
66
|
+
<summary><para>This class implements the <see cref="T:FileHelpers.DataLink.DataStorage"/> for Microsoft Excel Files.</para>
|
|
67
|
+
<para><b>WARNING you need to have installed Microsoft Excel 2000 or newer to use this feature.</b></para>
|
|
68
|
+
<para><b>To use this class you need to reference the FileHelpers.ExcelStorage.dll file.</b></para>
|
|
69
|
+
</summary>
|
|
70
|
+
<remmarks><b>This class is contained in the FileHelpers.ExcelStorage.dll and need the Interop.Office.dll and Interop.Excel.dll to work correctly.</b></remmarks>
|
|
71
|
+
</member>
|
|
72
|
+
<member name="M:FileHelpers.DataLink.ExcelStorage.#ctor(System.Type)">
|
|
73
|
+
<summary>Create a new ExcelStorage to work with the specified type</summary>
|
|
74
|
+
<param name="recordType">The type of records.</param>
|
|
75
|
+
</member>
|
|
76
|
+
<member name="M:FileHelpers.DataLink.ExcelStorage.#ctor(System.Type,System.Int32,System.Int32)">
|
|
77
|
+
<summary>Create a new ExcelStorage to work with the specified type</summary>
|
|
78
|
+
<param name="recordType">The type of records.</param>
|
|
79
|
+
<param name="startRow">The row of the first data cell. Begining in 1.</param>
|
|
80
|
+
<param name="startCol">The column of the first data cell. Begining in 1.</param>
|
|
81
|
+
</member>
|
|
82
|
+
<member name="M:FileHelpers.DataLink.ExcelStorage.#ctor(System.Type,System.String,System.Int32,System.Int32)">
|
|
83
|
+
<summary>Create a new ExcelStorage to work with the specified type</summary>
|
|
84
|
+
<param name="recordType">The type of records.</param>
|
|
85
|
+
<param name="startRow">The row of the first data cell. Begining in 1.</param>
|
|
86
|
+
<param name="startCol">The column of the first data cell. Begining in 1.</param>
|
|
87
|
+
<param name="fileName">The file path to work with.</param>
|
|
88
|
+
</member>
|
|
89
|
+
<member name="M:FileHelpers.DataLink.ExcelStorage.InsertRecords(System.Object[])">
|
|
90
|
+
<summary>Insert all the records in the specified Excel File.</summary>
|
|
91
|
+
<param name="records">The records to insert.</param>
|
|
92
|
+
</member>
|
|
93
|
+
<member name="M:FileHelpers.DataLink.ExcelStorage.ExtractRecords">
|
|
94
|
+
<summary>Returns the records extracted from Excel file.</summary>
|
|
95
|
+
<returns>The extracted records.</returns>
|
|
96
|
+
</member>
|
|
97
|
+
<member name="P:FileHelpers.DataLink.ExcelStorage.StartRow">
|
|
98
|
+
<summary>The Start Row where is the data. Starting at 1.</summary>
|
|
99
|
+
</member>
|
|
100
|
+
<member name="P:FileHelpers.DataLink.ExcelStorage.StartColumn">
|
|
101
|
+
<summary>The Start Column where is the data. Starting at 1.</summary>
|
|
102
|
+
</member>
|
|
103
|
+
<member name="P:FileHelpers.DataLink.ExcelStorage.HeaderRows">
|
|
104
|
+
<summary>The numbers of header rows.</summary>
|
|
105
|
+
</member>
|
|
106
|
+
<member name="P:FileHelpers.DataLink.ExcelStorage.FileName">
|
|
107
|
+
<summary>The Excel File Name.</summary>
|
|
108
|
+
</member>
|
|
109
|
+
<member name="P:FileHelpers.DataLink.ExcelStorage.SheetName">
|
|
110
|
+
<summary>The Excel Sheet Name, if empty means the current worksheet in the file.</summary>
|
|
111
|
+
</member>
|
|
112
|
+
<member name="P:FileHelpers.DataLink.ExcelStorage.OverrideFile">
|
|
113
|
+
<summary>Indicates what the Storage does if the file exist.</summary>
|
|
114
|
+
</member>
|
|
115
|
+
<member name="P:FileHelpers.DataLink.ExcelStorage.TemplateFile">
|
|
116
|
+
<summary>
|
|
117
|
+
Indicates the source xls file to be used as template when write data.
|
|
118
|
+
</summary>
|
|
119
|
+
</member>
|
|
120
|
+
</members>
|
|
121
|
+
</doc>
|
|
Binary file
|
|
@@ -0,0 +1,4325 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<doc>
|
|
3
|
+
<assembly>
|
|
4
|
+
<name>FileHelpers</name>
|
|
5
|
+
</assembly>
|
|
6
|
+
<members>
|
|
7
|
+
<member name="T:FileHelpers.ConditionalRecordAttribute">
|
|
8
|
+
<summary>Allow to declarative set what records must be included or excluded when reading.</summary>
|
|
9
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
10
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
11
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
12
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
13
|
+
</member>
|
|
14
|
+
<member name="M:FileHelpers.ConditionalRecordAttribute.#ctor(FileHelpers.RecordCondition,System.String)">
|
|
15
|
+
<summary>Allow to declarative show what records must be included or excluded</summary>
|
|
16
|
+
<param name="condition">The condition used to include or exclude each record</param>
|
|
17
|
+
<param name="selector">The selector for the condition.</param>
|
|
18
|
+
</member>
|
|
19
|
+
<member name="T:FileHelpers.DelimitedRecordAttribute">
|
|
20
|
+
<summary>Indicates that this class represents a delimited record. </summary>
|
|
21
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
22
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
23
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
24
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
25
|
+
</member>
|
|
26
|
+
<member name="T:FileHelpers.TypedRecordAttribute">
|
|
27
|
+
<summary>Base class for the record types..</summary>
|
|
28
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
29
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
30
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
31
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
32
|
+
</member>
|
|
33
|
+
<member name="M:FileHelpers.TypedRecordAttribute.#ctor">
|
|
34
|
+
<summary>Abstract class, see inheritors.</summary>
|
|
35
|
+
</member>
|
|
36
|
+
<member name="M:FileHelpers.DelimitedRecordAttribute.#ctor(System.String)">
|
|
37
|
+
<summary>Indicates that this class represents a delimited record. </summary>
|
|
38
|
+
<param name="delimiter">The separator string used to split the fields of the record.</param>
|
|
39
|
+
</member>
|
|
40
|
+
<member name="T:FileHelpers.FieldAlignAttribute">
|
|
41
|
+
<summary>Indicates the <see cref="T:FileHelpers.AlignMode"/> used for <b>write</b> operations.</summary>
|
|
42
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
43
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
44
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
45
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
46
|
+
</member>
|
|
47
|
+
<member name="M:FileHelpers.FieldAlignAttribute.#ctor(FileHelpers.AlignMode)">
|
|
48
|
+
<summary>Uses the ' ' char to align.</summary>
|
|
49
|
+
<param name="align">The position of the alignment.</param>
|
|
50
|
+
</member>
|
|
51
|
+
<member name="M:FileHelpers.FieldAlignAttribute.#ctor(FileHelpers.AlignMode,System.Char)">
|
|
52
|
+
<summary>You can indicate the align char.</summary>
|
|
53
|
+
<param name="align">The position of the alignment.</param>
|
|
54
|
+
<param name="alignChar">The character used to align.</param>
|
|
55
|
+
</member>
|
|
56
|
+
<member name="F:FileHelpers.FieldAlignAttribute.Align">
|
|
57
|
+
<summary>The position of the alignment.</summary>
|
|
58
|
+
</member>
|
|
59
|
+
<member name="F:FileHelpers.FieldAlignAttribute.AlignChar">
|
|
60
|
+
<summary>The character used to align.</summary>
|
|
61
|
+
</member>
|
|
62
|
+
<member name="T:FileHelpers.FieldAttribute">
|
|
63
|
+
<summary>Base class of <see cref="T:FileHelpers.FieldFixedLengthAttribute"/> and <see cref="T:FileHelpers.FieldDelimiterAttribute"/></summary>
|
|
64
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
65
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
66
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
67
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
68
|
+
</member>
|
|
69
|
+
<member name="M:FileHelpers.FieldAttribute.#ctor">
|
|
70
|
+
<summary>Abstract class, see the inheritors.</summary>
|
|
71
|
+
</member>
|
|
72
|
+
<member name="T:FileHelpers.FieldConverterAttribute">
|
|
73
|
+
<summary>Indicates the <see cref="T:FileHelpers.ConverterKind"/> used for read/write operations.</summary>
|
|
74
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
75
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
76
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
77
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
78
|
+
</member>
|
|
79
|
+
<member name="M:FileHelpers.FieldConverterAttribute.#ctor(FileHelpers.ConverterKind)">
|
|
80
|
+
<summary>Indicates the <see cref="T:FileHelpers.ConverterKind"/> used for read/write ops. </summary>
|
|
81
|
+
<param name="converter">The <see cref="T:FileHelpers.ConverterKind"/> used for the transformations.</param>
|
|
82
|
+
</member>
|
|
83
|
+
<member name="M:FileHelpers.FieldConverterAttribute.#ctor(FileHelpers.ConverterKind,System.String)">
|
|
84
|
+
<summary>Indicates the <see cref="T:FileHelpers.ConverterKind"/> used for read/write ops. </summary>
|
|
85
|
+
<param name="converter">The <see cref="T:FileHelpers.ConverterKind"/> used for the transformations.</param>
|
|
86
|
+
<param name="arg1">The first param pased directly to the Converter Constructor.</param>
|
|
87
|
+
</member>
|
|
88
|
+
<member name="M:FileHelpers.FieldConverterAttribute.#ctor(FileHelpers.ConverterKind,System.String,System.String)">
|
|
89
|
+
<summary>Indicates the <see cref="T:FileHelpers.ConverterKind"/> used for read/write ops. </summary>
|
|
90
|
+
<param name="converter">The <see cref="T:FileHelpers.ConverterKind"/> used for the transformations.</param>
|
|
91
|
+
<param name="arg1">The first param pased directly to the Converter Constructor.</param>
|
|
92
|
+
<param name="arg2">The second param pased directly to the Converter Constructor.</param>
|
|
93
|
+
</member>
|
|
94
|
+
<member name="M:FileHelpers.FieldConverterAttribute.#ctor(FileHelpers.ConverterKind,System.String,System.String,System.String)">
|
|
95
|
+
<summary>Indicates the <see cref="T:FileHelpers.ConverterKind"/> used for read/write ops. </summary>
|
|
96
|
+
<param name="converter">The <see cref="T:FileHelpers.ConverterKind"/> used for the transformations.</param>
|
|
97
|
+
<param name="arg1">The first param pased directly to the Converter Constructor.</param>
|
|
98
|
+
<param name="arg2">The second param pased directly to the Converter Constructor.</param>
|
|
99
|
+
<param name="arg3">The third param pased directly to the Converter Constructor.</param>
|
|
100
|
+
</member>
|
|
101
|
+
<member name="M:FileHelpers.FieldConverterAttribute.#ctor(System.Type,System.String)">
|
|
102
|
+
<summary>Indicates the <see cref="T:FileHelpers.ConverterKind"/> used for read/write ops. </summary>
|
|
103
|
+
<param name="customConverter">The Type of your custom converter.</param>
|
|
104
|
+
<param name="arg1">The first param pased directly to the Converter Constructor.</param>
|
|
105
|
+
</member>
|
|
106
|
+
<member name="M:FileHelpers.FieldConverterAttribute.#ctor(System.Type,System.String,System.String)">
|
|
107
|
+
<summary>Indicates the <see cref="T:FileHelpers.ConverterKind"/> used for read/write ops. </summary>
|
|
108
|
+
<param name="customConverter">The Type of your custom converter.</param>
|
|
109
|
+
<param name="arg1">The first param pased directly to the Converter Constructor.</param>
|
|
110
|
+
<param name="arg2">The second param pased directly to the Converter Constructor.</param>
|
|
111
|
+
</member>
|
|
112
|
+
<member name="M:FileHelpers.FieldConverterAttribute.#ctor(System.Type,System.String,System.String,System.String)">
|
|
113
|
+
<summary>Indicates the <see cref="T:FileHelpers.ConverterKind"/> used for read/write ops. </summary>
|
|
114
|
+
<param name="customConverter">The Type of your custom converter.</param>
|
|
115
|
+
<param name="arg1">The first param pased directly to the Converter Constructor.</param>
|
|
116
|
+
<param name="arg2">The second param pased directly to the Converter Constructor.</param>
|
|
117
|
+
<param name="arg3">The third param pased directly to the Converter Constructor.</param>
|
|
118
|
+
</member>
|
|
119
|
+
<member name="M:FileHelpers.FieldConverterAttribute.#ctor(System.Type,System.Object[])">
|
|
120
|
+
<summary>Indicates a custom <see cref="T:FileHelpers.ConverterBase"/> implementation.</summary>
|
|
121
|
+
<param name="customConverter">The Type of your custom converter.</param>
|
|
122
|
+
<param name="args">A list of params pased directly to your converter constructor.</param>
|
|
123
|
+
</member>
|
|
124
|
+
<member name="M:FileHelpers.FieldConverterAttribute.#ctor(System.Type)">
|
|
125
|
+
<summary>Indicates a custom <see cref="T:FileHelpers.ConverterBase"/> implementation.</summary>
|
|
126
|
+
<param name="customConverter">The Type of your custom converter.</param>
|
|
127
|
+
</member>
|
|
128
|
+
<member name="T:FileHelpers.FieldDelimiterAttribute">
|
|
129
|
+
<summary>Indicates a diferent delimiter for this field. </summary>
|
|
130
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
131
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
132
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
133
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
134
|
+
</member>
|
|
135
|
+
<member name="M:FileHelpers.FieldDelimiterAttribute.#ctor(System.String)">
|
|
136
|
+
<summary>Indicates a diferent delimiter for this field. </summary>
|
|
137
|
+
<param name="separator">The separator string used to split the fields of the record.</param>
|
|
138
|
+
</member>
|
|
139
|
+
<member name="T:FileHelpers.FieldFixedLengthAttribute">
|
|
140
|
+
<summary>Indicates the length of a FixedLength field.</summary>
|
|
141
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
142
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
143
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
144
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
145
|
+
</member>
|
|
146
|
+
<member name="M:FileHelpers.FieldFixedLengthAttribute.#ctor(System.Int32)">
|
|
147
|
+
<summary>Indicates the length of a FixedLength field.</summary>
|
|
148
|
+
<param name="length">The length of the field.</param>
|
|
149
|
+
</member>
|
|
150
|
+
<member name="T:FileHelpers.FieldIgnoredAttribute">
|
|
151
|
+
<summary>Indicates that the target field is completely ignored by the Engine (i.e. This field don´t exists for the library).</summary>
|
|
152
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
153
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
154
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
155
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
156
|
+
</member>
|
|
157
|
+
<member name="M:FileHelpers.FieldIgnoredAttribute.#ctor">
|
|
158
|
+
<summary>Indicates that the target field is ignored by the Engine AND NOT IS IN THE FILE.</summary>
|
|
159
|
+
</member>
|
|
160
|
+
<member name="T:FileHelpers.FieldInNewLineAttribute">
|
|
161
|
+
<summary>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)</summary>
|
|
162
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
163
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
164
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
165
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
166
|
+
</member>
|
|
167
|
+
<member name="M:FileHelpers.FieldInNewLineAttribute.#ctor">
|
|
168
|
+
<summary>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)</summary>
|
|
169
|
+
</member>
|
|
170
|
+
<member name="T:FileHelpers.FieldNullValueAttribute">
|
|
171
|
+
<summary>Indicates the value to assign to the field in the case of find a "NULL".</summary>
|
|
172
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
173
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
174
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
175
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
176
|
+
</member>
|
|
177
|
+
<member name="M:FileHelpers.FieldNullValueAttribute.#ctor(System.Object)">
|
|
178
|
+
<summary>Indicates directly the null value.</summary>
|
|
179
|
+
<param name="nullValue">The value to assign in the "NULL" case.</param>
|
|
180
|
+
</member>
|
|
181
|
+
<member name="M:FileHelpers.FieldNullValueAttribute.#ctor(System.Type,System.String)">
|
|
182
|
+
<summary>Indicates a type and a string to be converted to that type.</summary>
|
|
183
|
+
<param name="type">The type of the null value.</param>
|
|
184
|
+
<param name="nullValue">The string to be converted to the specified type.</param>
|
|
185
|
+
</member>
|
|
186
|
+
<member name="T:FileHelpers.FieldOptionalAttribute">
|
|
187
|
+
<summary>Indicates that the target field is included only under some circunstances.</summary>
|
|
188
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
189
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
190
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
191
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
192
|
+
</member>
|
|
193
|
+
<member name="M:FileHelpers.FieldOptionalAttribute.#ctor">
|
|
194
|
+
<summary>Indicates that the target field is included only under some circunstances.</summary>
|
|
195
|
+
</member>
|
|
196
|
+
<member name="T:FileHelpers.FieldQuotedAttribute">
|
|
197
|
+
<summary>Indicates that the field must be read and written like a Quoted String. (by default "")</summary>
|
|
198
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
199
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
200
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
201
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
202
|
+
</member>
|
|
203
|
+
<member name="M:FileHelpers.FieldQuotedAttribute.#ctor">
|
|
204
|
+
<summary>Indicates that the field must be read and written like a Quoted String with double quotes.</summary>
|
|
205
|
+
</member>
|
|
206
|
+
<member name="M:FileHelpers.FieldQuotedAttribute.#ctor(System.Char)">
|
|
207
|
+
<summary>Indicates that the field must be read and written like a Quoted String with the specified char.</summary>
|
|
208
|
+
<param name="quoteChar">The char used to quote the string.</param>
|
|
209
|
+
</member>
|
|
210
|
+
<member name="M:FileHelpers.FieldQuotedAttribute.#ctor(FileHelpers.QuoteMode)">
|
|
211
|
+
<summary>Indicates that the field must be read and written like a "Quoted String" (that can be optional depending of the mode).</summary>
|
|
212
|
+
<param name="mode">Indicates if the handling of optionals in the quoted field.</param>
|
|
213
|
+
</member>
|
|
214
|
+
<member name="M:FileHelpers.FieldQuotedAttribute.#ctor(FileHelpers.QuoteMode,FileHelpers.MultilineMode)">
|
|
215
|
+
<summary>Indicates that the field must be read and written like a Quoted String (that can be optional).</summary>
|
|
216
|
+
<param name="mode">Indicates if the handling of optionals in the quoted field.</param>
|
|
217
|
+
<param name="multiline">Indicates if the field can span multiple lines.</param>
|
|
218
|
+
</member>
|
|
219
|
+
<member name="M:FileHelpers.FieldQuotedAttribute.#ctor(System.Char,FileHelpers.QuoteMode)">
|
|
220
|
+
<summary>Indicates that the field must be read and written like a Quoted String (that can be optional).</summary>
|
|
221
|
+
<param name="quoteChar">The char used to quote the string.</param>
|
|
222
|
+
<param name="mode">Indicates if the handling of optionals in the quoted field.</param>
|
|
223
|
+
</member>
|
|
224
|
+
<member name="M:FileHelpers.FieldQuotedAttribute.#ctor(System.Char,FileHelpers.QuoteMode,FileHelpers.MultilineMode)">
|
|
225
|
+
<summary>Indicates that the field must be read and written like a Quoted String (that can be optional).</summary>
|
|
226
|
+
<param name="quoteChar">The char used to quote the string.</param>
|
|
227
|
+
<param name="mode">Indicates if the handling of optionals in the quoted field.</param>
|
|
228
|
+
<param name="multiline">Indicates if the field can span multiple lines.</param>
|
|
229
|
+
</member>
|
|
230
|
+
<member name="M:FileHelpers.FieldQuotedAttribute.#ctor(FileHelpers.MultilineMode)">
|
|
231
|
+
<summary>Indicates that the field must be read and written like a Quoted String with double quotes.</summary>
|
|
232
|
+
<param name="multiline">Indicates if the field can span multiple lines.</param>
|
|
233
|
+
</member>
|
|
234
|
+
<member name="T:FileHelpers.FieldTrimAttribute">
|
|
235
|
+
<summary>Indicates the <see cref="F:FileHelpers.FieldTrimAttribute.TrimMode"/> used after read to truncate the field. </summary>
|
|
236
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
237
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
238
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
239
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
240
|
+
</member>
|
|
241
|
+
<member name="M:FileHelpers.FieldTrimAttribute.#ctor(FileHelpers.TrimMode)">
|
|
242
|
+
<summary>Indicates the <see cref="F:FileHelpers.FieldTrimAttribute.TrimMode"/> used after read to truncate the field. By default trims the blank spaces and tabs.</summary>
|
|
243
|
+
<param name="mode">The <see cref="F:FileHelpers.FieldTrimAttribute.TrimMode"/> used after read.</param>
|
|
244
|
+
</member>
|
|
245
|
+
<member name="M:FileHelpers.FieldTrimAttribute.#ctor(FileHelpers.TrimMode,System.Char[])">
|
|
246
|
+
<summary>Indicates the <see cref="F:FileHelpers.FieldTrimAttribute.TrimMode"/> used after read to truncate the field. </summary>
|
|
247
|
+
<param name="mode">The <see cref="F:FileHelpers.FieldTrimAttribute.TrimMode"/> used after read.</param>
|
|
248
|
+
<param name="chars">A list of chars used to trim.</param>
|
|
249
|
+
</member>
|
|
250
|
+
<member name="M:FileHelpers.FieldTrimAttribute.#ctor(FileHelpers.TrimMode,System.String)">
|
|
251
|
+
<summary>Indicates the <see cref="F:FileHelpers.FieldTrimAttribute.TrimMode"/> used after read to truncate the field. </summary>
|
|
252
|
+
<param name="mode">The <see cref="F:FileHelpers.FieldTrimAttribute.TrimMode"/> used after read.</param>
|
|
253
|
+
<param name="trimChars">A string of chars used to trim.</param>
|
|
254
|
+
</member>
|
|
255
|
+
<member name="T:FileHelpers.FixedLengthRecordAttribute">
|
|
256
|
+
<summary>Indicates that this class represents a fixed length record.</summary>
|
|
257
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
258
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
259
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
260
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
261
|
+
</member>
|
|
262
|
+
<member name="M:FileHelpers.FixedLengthRecordAttribute.#ctor">
|
|
263
|
+
<summary>Indicates that this class represents a fixed length record. By default requieres that the records has the length equals to the sum of each field length.</summary>
|
|
264
|
+
</member>
|
|
265
|
+
<member name="M:FileHelpers.FixedLengthRecordAttribute.#ctor(FileHelpers.FixedMode)">
|
|
266
|
+
<summary>Indicates that this class represents a fixed length record with the specified variable record behavior.</summary>
|
|
267
|
+
<param name="mode">The <see cref="T:FileHelpers.FixedMode"/> used for variable length records.</param>
|
|
268
|
+
</member>
|
|
269
|
+
<member name="T:FileHelpers.IgnoreCommentedLinesAttribute">
|
|
270
|
+
<summary>Indicates that the engine must ignore commented lines while reading.</summary>
|
|
271
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
272
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
273
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
274
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
275
|
+
</member>
|
|
276
|
+
<member name="M:FileHelpers.IgnoreCommentedLinesAttribute.#ctor(System.String)">
|
|
277
|
+
<summary>Indicates that the engine must ignore commented lines while reading. (The Comment Marker can appear in any place with spaces or tabs at his left)</summary>
|
|
278
|
+
<param name="commentMarker">The comment marker used to ignore the lines</param>
|
|
279
|
+
</member>
|
|
280
|
+
<member name="M:FileHelpers.IgnoreCommentedLinesAttribute.#ctor(System.String,System.Boolean)">
|
|
281
|
+
<summary>Indicates that the engine must ignore commented lines while reading.</summary>
|
|
282
|
+
<param name="commentMarker">The comment marker used to ignore the lines</param>
|
|
283
|
+
<param name="anyPlace">Indicates if the comment can have spaces or tabs at left (true by default)</param>
|
|
284
|
+
</member>
|
|
285
|
+
<member name="T:FileHelpers.IgnoreEmptyLinesAttribute">
|
|
286
|
+
<summary>Indicates that the engine must ignore the empty lines while reading.</summary>
|
|
287
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
288
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
289
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
290
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
291
|
+
</member>
|
|
292
|
+
<member name="M:FileHelpers.IgnoreEmptyLinesAttribute.#ctor">
|
|
293
|
+
<summary>Indicates that the engine must ignore the empty lines while reading.</summary>
|
|
294
|
+
</member>
|
|
295
|
+
<member name="M:FileHelpers.IgnoreEmptyLinesAttribute.#ctor(System.Boolean)">
|
|
296
|
+
<summary>Indicates that the engine must ignore the empty lines while reading.</summary>
|
|
297
|
+
<param name="ignoreSpaces">Indicates if also must ignore lines with spaces.</param>
|
|
298
|
+
</member>
|
|
299
|
+
<member name="T:FileHelpers.IgnoreFirstAttribute">
|
|
300
|
+
<summary>Indicates the number of first lines to be discarded.</summary>
|
|
301
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
302
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
303
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
304
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
305
|
+
</member>
|
|
306
|
+
<member name="M:FileHelpers.IgnoreFirstAttribute.#ctor">
|
|
307
|
+
<summary>Indicates that the first line must be discarded.</summary>
|
|
308
|
+
</member>
|
|
309
|
+
<member name="M:FileHelpers.IgnoreFirstAttribute.#ctor(System.Int32)">
|
|
310
|
+
<summary>Indicates the number of first lines to be ignored.</summary>
|
|
311
|
+
<param name="numberOfLines">The number of first lines to be discarded.</param>
|
|
312
|
+
</member>
|
|
313
|
+
<member name="T:FileHelpers.IgnoreLastAttribute">
|
|
314
|
+
<summary>Indicates the number of lines to be discarded at the end.</summary>
|
|
315
|
+
<remarks>See the <a href="attributes.html">Complete Attributes List</a> for more clear info and examples of each one.</remarks>
|
|
316
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
317
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
318
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
319
|
+
</member>
|
|
320
|
+
<member name="M:FileHelpers.IgnoreLastAttribute.#ctor">
|
|
321
|
+
<summary>Indicates that the last line must be discarded.</summary>
|
|
322
|
+
</member>
|
|
323
|
+
<member name="M:FileHelpers.IgnoreLastAttribute.#ctor(System.Int32)">
|
|
324
|
+
<summary>Indicates the number of last lines to be ignored at the end.</summary>
|
|
325
|
+
<param name="numberOfLines">The number of lines to be discarded at end.</param>
|
|
326
|
+
</member>
|
|
327
|
+
<member name="T:FileHelpers.TransformToRecordAttribute">
|
|
328
|
+
<summary>With this attribute you can mark a method in the RecordClass that is the responsable of convert it to the specified.</summary>
|
|
329
|
+
</member>
|
|
330
|
+
<member name="M:FileHelpers.TransformToRecordAttribute.#ctor(System.Type)">
|
|
331
|
+
<summary>With this attribute you can mark a method in the RecordClass that is the responsable of convert it to the specified.</summary>
|
|
332
|
+
<param name="targetType">The target of the convertion.</param>
|
|
333
|
+
</member>
|
|
334
|
+
<member name="T:FileHelpers.ConverterBase">
|
|
335
|
+
<summary>
|
|
336
|
+
Base class to provide bidirectional
|
|
337
|
+
Field - String convertion.
|
|
338
|
+
</summary>
|
|
339
|
+
</member>
|
|
340
|
+
<member name="M:FileHelpers.ConverterBase.StringToField(System.String)">
|
|
341
|
+
<summary>
|
|
342
|
+
Convert a string in the file to a field value.
|
|
343
|
+
</summary>
|
|
344
|
+
<param name="from">The string to convert.</param>
|
|
345
|
+
<returns>The field value.</returns>
|
|
346
|
+
</member>
|
|
347
|
+
<member name="M:FileHelpers.ConverterBase.FieldToString(System.Object)">
|
|
348
|
+
<summary>
|
|
349
|
+
Convert a field value to an string to write this to the file.
|
|
350
|
+
</summary>
|
|
351
|
+
<remarks>The basic implementation performs a: from.ToString();</remarks>
|
|
352
|
+
<param name="from">The field values to convert.</param>
|
|
353
|
+
<returns>The string representing the field value.</returns>
|
|
354
|
+
</member>
|
|
355
|
+
<member name="M:FileHelpers.ConverterBase.ThrowConvertException(System.String,System.String)">
|
|
356
|
+
<summary>
|
|
357
|
+
Thorws a ConvertException with the passed values
|
|
358
|
+
</summary>
|
|
359
|
+
<param name="from">The source string.</param>
|
|
360
|
+
<param name="errorMsg">The custom error msg.</param>
|
|
361
|
+
</member>
|
|
362
|
+
<member name="P:FileHelpers.ConverterBase.DefaultDateTimeFormat">
|
|
363
|
+
<summary>
|
|
364
|
+
<para>Allow you to set the default Date Format used for the converter.</para>
|
|
365
|
+
<para>With the same format that the .NET framework.</para>
|
|
366
|
+
<para>By default: "ddMMyyyy"</para>
|
|
367
|
+
</summary>
|
|
368
|
+
</member>
|
|
369
|
+
<member name="P:FileHelpers.ConverterBase.CustomNullHandling">
|
|
370
|
+
<summary>If the class retures false the engines don´t pass null values to the converter. If true the engines pass all the values to the converter.</summary>
|
|
371
|
+
</member>
|
|
372
|
+
<member name="T:FileHelpers.ConvertHelpers">
|
|
373
|
+
<summary>Class that provides static methods that returns a default <see cref="T:FileHelpers.ConverterBase">Converter</see> to the basic types.</summary>
|
|
374
|
+
<remarks>Used by the <see cref="T:FileHelpers.FieldConverterAttribute"/>.</remarks>
|
|
375
|
+
</member>
|
|
376
|
+
<member name="T:FileHelpers.RecordInfo">
|
|
377
|
+
<summary>An internal class used to store information about the Record Type.</summary>
|
|
378
|
+
<remarks>Is public to provide extensibility of DataSorage from outside the library.</remarks>
|
|
379
|
+
</member>
|
|
380
|
+
<member name="M:FileHelpers.RecordInfo.#ctor(System.Type)">
|
|
381
|
+
<summary>The unique constructor for this class. It needs the subyacent record class.</summary>
|
|
382
|
+
<param name="recordType">The Type of the record class.</param>
|
|
383
|
+
</member>
|
|
384
|
+
<member name="M:FileHelpers.RecordInfo.ValuesToRecord(System.Object[])">
|
|
385
|
+
<summary>Returns a record formed with the passed values.</summary>
|
|
386
|
+
<param name="values">The source Values.</param>
|
|
387
|
+
<returns>A record formed with the passed values.</returns>
|
|
388
|
+
</member>
|
|
389
|
+
<member name="M:FileHelpers.RecordInfo.RecordToValues(System.Object)">
|
|
390
|
+
<summary>Get an object[] of the values in the fields of the passed record.</summary>
|
|
391
|
+
<param name="record">The source record.</param>
|
|
392
|
+
<returns>An object[] of the values in the fields.</returns>
|
|
393
|
+
</member>
|
|
394
|
+
<member name="T:FileHelpers.DataLink.AccessStorage">
|
|
395
|
+
<summary>This is a base class that implements the <see cref="T:FileHelpers.DataLink.DataStorage"/> for Microsoft Access Files.</summary>
|
|
396
|
+
</member>
|
|
397
|
+
<member name="T:FileHelpers.DataLink.DatabaseStorage">
|
|
398
|
+
<summary>This class implements the <see cref="T:FileHelpers.DataLink.DataStorage"/> and is the base class for Data Base storages.</summary>
|
|
399
|
+
</member>
|
|
400
|
+
<member name="T:FileHelpers.DataLink.DataStorage">
|
|
401
|
+
<summary>Base class for all the Storage classes of the library or the custom Storage classes.</summary>
|
|
402
|
+
</member>
|
|
403
|
+
<member name="M:FileHelpers.DataLink.DataStorage.Notify(FileHelpers.ProgressChangeHandler,FileHelpers.ProgressMode,System.Int32,System.Int32)">
|
|
404
|
+
<summary>For internal Use.</summary>
|
|
405
|
+
<param name="handler"></param>
|
|
406
|
+
<param name="mode"></param>
|
|
407
|
+
<param name="current"></param>
|
|
408
|
+
<param name="total"></param>
|
|
409
|
+
</member>
|
|
410
|
+
<member name="F:FileHelpers.DataLink.DataStorage.mProgressMode">
|
|
411
|
+
<summary>Indicates the way to notify the progress.</summary>
|
|
412
|
+
</member>
|
|
413
|
+
<member name="F:FileHelpers.DataLink.DataStorage.mNotifyHandler">
|
|
414
|
+
<summary>You method handler used to notify progress.</summary>
|
|
415
|
+
</member>
|
|
416
|
+
<member name="M:FileHelpers.DataLink.DataStorage.SetProgressHandler(FileHelpers.ProgressChangeHandler)">
|
|
417
|
+
<summary>Set the handler to the engine used to notify progress into the operations.</summary>
|
|
418
|
+
<param name="handler">The <see cref="T:FileHelpers.ProgressChangeHandler"/></param>
|
|
419
|
+
</member>
|
|
420
|
+
<member name="M:FileHelpers.DataLink.DataStorage.SetProgressHandler(FileHelpers.ProgressChangeHandler,FileHelpers.ProgressMode)">
|
|
421
|
+
<summary>Set the handler to the engine used to notify progress into the operations.</summary>
|
|
422
|
+
<param name="handler">Your <see cref="T:FileHelpers.ProgressChangeHandler"/> method.</param>
|
|
423
|
+
<param name="mode">The <see cref="T:FileHelpers.ProgressMode"/> to use.</param>
|
|
424
|
+
</member>
|
|
425
|
+
<member name="M:FileHelpers.DataLink.DataStorage.ExtractRecords">
|
|
426
|
+
<summary>Must Return the records from the DataSource (DB, Excel, etc)</summary>
|
|
427
|
+
<returns>The extracted records.</returns>
|
|
428
|
+
</member>
|
|
429
|
+
<member name="M:FileHelpers.DataLink.DataStorage.ExtractRecordsAsDT">
|
|
430
|
+
<summary>Must Return the records from the DataSource (DB, Excel, etc)</summary>
|
|
431
|
+
<returns>The extracted records.</returns>
|
|
432
|
+
</member>
|
|
433
|
+
<member name="M:FileHelpers.DataLink.DataStorage.InsertRecords(System.Object[])">
|
|
434
|
+
<summary>Must Insert the records in a DataSource (DB, Excel, etc)</summary>
|
|
435
|
+
<param name="records">The records to insert.</param>
|
|
436
|
+
</member>
|
|
437
|
+
<member name="F:FileHelpers.DataLink.DataStorage.mErrorManager">
|
|
438
|
+
<summary>The Object responsable for manage the errors.</summary>
|
|
439
|
+
</member>
|
|
440
|
+
<member name="M:FileHelpers.DataLink.DataStorage.AddError(System.Int32,System.Exception,System.String)">
|
|
441
|
+
<summary>Add an error to the ErrorCollection.</summary>
|
|
442
|
+
<param name="lineNumber">The line when the error occurs.</param>
|
|
443
|
+
<param name="ex">The exception throwed, can be null.</param>
|
|
444
|
+
<param name="recordLine">The record values</param>
|
|
445
|
+
</member>
|
|
446
|
+
<member name="M:FileHelpers.DataLink.DataStorage.#ctor(System.Type)">
|
|
447
|
+
<summary>Creates an instance of this class.</summary>
|
|
448
|
+
</member>
|
|
449
|
+
<member name="M:FileHelpers.DataLink.DataStorage.ValuesToRecord(System.Object[])">
|
|
450
|
+
<summary>Returns a record created from an Array of values</summary>
|
|
451
|
+
<param name="values">The values used to created the record.</param>
|
|
452
|
+
<returns>The just created record.</returns>
|
|
453
|
+
</member>
|
|
454
|
+
<member name="M:FileHelpers.DataLink.DataStorage.RecordToValues(System.Object)">
|
|
455
|
+
<summary>Returns an array of value based on a record.</summary>
|
|
456
|
+
<param name="record">The source record.</param>
|
|
457
|
+
<returns>An array with the values of each field</returns>
|
|
458
|
+
</member>
|
|
459
|
+
<member name="P:FileHelpers.DataLink.DataStorage.RecordType">
|
|
460
|
+
<summary>Returns the class that represent the records in the file.</summary>
|
|
461
|
+
</member>
|
|
462
|
+
<member name="P:FileHelpers.DataLink.DataStorage.ErrorManager">
|
|
463
|
+
<summary>The Object responsable for manage the errors.</summary>
|
|
464
|
+
</member>
|
|
465
|
+
<member name="P:FileHelpers.DataLink.DataStorage.RecordFieldCount">
|
|
466
|
+
<summary>The number of fields in the record class.</summary>
|
|
467
|
+
</member>
|
|
468
|
+
<member name="M:FileHelpers.DataLink.DatabaseStorage.#ctor(System.Type)">
|
|
469
|
+
<summary>Default constructor.</summary>
|
|
470
|
+
<param name="recordType">The Record Type.</param>
|
|
471
|
+
</member>
|
|
472
|
+
<member name="M:FileHelpers.DataLink.DatabaseStorage.FillRecord(System.Object[])">
|
|
473
|
+
<summary>This method recives the fields values as an array and must return a record object.</summary>
|
|
474
|
+
<param name="fieldValues">The record fields values.</param>
|
|
475
|
+
<returns>The record object.</returns>
|
|
476
|
+
</member>
|
|
477
|
+
<member name="M:FileHelpers.DataLink.DatabaseStorage.GetSelectSql">
|
|
478
|
+
<summary>Must return the Select Sql used to Fetch the records to Extract.</summary>
|
|
479
|
+
<returns>The SQL statement.</returns>
|
|
480
|
+
</member>
|
|
481
|
+
<member name="M:FileHelpers.DataLink.DatabaseStorage.GetInsertSql(System.Object)">
|
|
482
|
+
<summary>Must return a SQL string with the insert statement for the records.</summary>
|
|
483
|
+
<param name="record">The record to insert.</param>
|
|
484
|
+
<returns>The Sql string to used to insert the record.</returns>
|
|
485
|
+
</member>
|
|
486
|
+
<member name="M:FileHelpers.DataLink.DatabaseStorage.CreateConnection">
|
|
487
|
+
<summary>Must create an abstract connection object.</summary>
|
|
488
|
+
<returns>An Abstract Connection Object.</returns>
|
|
489
|
+
</member>
|
|
490
|
+
<member name="M:FileHelpers.DataLink.DatabaseStorage.ExtractRecords">
|
|
491
|
+
<summary>Must Return the records from the DataSource (DB, Excel, etc)</summary>
|
|
492
|
+
<returns>The extracted records.</returns>
|
|
493
|
+
</member>
|
|
494
|
+
<member name="M:FileHelpers.DataLink.DatabaseStorage.InsertRecords(System.Object[])">
|
|
495
|
+
<summary>Must Insert the records in a DataSource (DB, Excel, etc)</summary>
|
|
496
|
+
<param name="records">The records to insert.</param>
|
|
497
|
+
</member>
|
|
498
|
+
<member name="P:FileHelpers.DataLink.DatabaseStorage.SelectSql">
|
|
499
|
+
<summary>Indicates the Sql statment used to get the records.</summary>
|
|
500
|
+
</member>
|
|
501
|
+
<member name="P:FileHelpers.DataLink.DatabaseStorage.ExecuteInBatch">
|
|
502
|
+
<summary>Indicates if the underlaying Conexion allow more than one instruction per execute.</summary>
|
|
503
|
+
</member>
|
|
504
|
+
<member name="P:FileHelpers.DataLink.DatabaseStorage.InsertSqlCallback">
|
|
505
|
+
<summary>Delegate used to get the SQL for the insert or update statement.</summary>
|
|
506
|
+
</member>
|
|
507
|
+
<member name="P:FileHelpers.DataLink.DatabaseStorage.FillRecordCallback">
|
|
508
|
+
<summary>Delegate used to fill the values of a new record from the db.</summary>
|
|
509
|
+
</member>
|
|
510
|
+
<member name="P:FileHelpers.DataLink.DatabaseStorage.ExecuteInBatchSize">
|
|
511
|
+
<summary>Indicates the max number of instruction of each execution. High numbers help reduce the round trips to the db and so help tp improve performance.</summary>
|
|
512
|
+
</member>
|
|
513
|
+
<member name="P:FileHelpers.DataLink.DatabaseStorage.TransactionMode">
|
|
514
|
+
<summary>
|
|
515
|
+
Define the Transaction Level used when inserting records.
|
|
516
|
+
</summary>
|
|
517
|
+
</member>
|
|
518
|
+
<member name="P:FileHelpers.DataLink.DatabaseStorage.ConnectionString">
|
|
519
|
+
<summary>
|
|
520
|
+
The connection string used for this storage.
|
|
521
|
+
</summary>
|
|
522
|
+
</member>
|
|
523
|
+
<member name="M:FileHelpers.DataLink.AccessStorage.#ctor(System.Type)">
|
|
524
|
+
<summary>Creates a new AccessStorage.</summary>
|
|
525
|
+
<param name="recordType">The Type of the Records</param>
|
|
526
|
+
</member>
|
|
527
|
+
<member name="M:FileHelpers.DataLink.AccessStorage.#ctor(System.Type,System.String)">
|
|
528
|
+
<summary>Creates a new AccessStorage using the indicated file.</summary>
|
|
529
|
+
<param name="recordType">The Type of the Records</param>
|
|
530
|
+
<param name="accessFile">The MS Access file.</param>
|
|
531
|
+
</member>
|
|
532
|
+
<member name="M:FileHelpers.DataLink.AccessStorage.CreateConnection">
|
|
533
|
+
<summary>Must create an abstract connection object.</summary>
|
|
534
|
+
<returns>An Abstract Connection Object.</returns>
|
|
535
|
+
</member>
|
|
536
|
+
<member name="P:FileHelpers.DataLink.AccessStorage.AccessFileName">
|
|
537
|
+
<summary>The file full path of the Microsoft Access File.</summary>
|
|
538
|
+
</member>
|
|
539
|
+
<member name="P:FileHelpers.DataLink.AccessStorage.AccessFilePassword">
|
|
540
|
+
<summary>The password to the access database.</summary>
|
|
541
|
+
</member>
|
|
542
|
+
<member name="T:FileHelpers.DataLink.InsertSqlHandler">
|
|
543
|
+
<summary>Delegate used by the <see cref="T:FileHelpers.DataLink.DatabaseStorage"/> to get the SQL for the insert or update statement.</summary>
|
|
544
|
+
<param name="record">The record to insert</param>
|
|
545
|
+
<return>The Sql string to insert the record.</return>
|
|
546
|
+
</member>
|
|
547
|
+
<member name="T:FileHelpers.DataLink.FillRecordHandler">
|
|
548
|
+
<summary>Delegate used by the <see cref="T:FileHelpers.DataLink.DatabaseStorage"/> to fill the values of a new record from the db (you only need to assing hte values.</summary>
|
|
549
|
+
<param name="record">The record to fill.</param>
|
|
550
|
+
<param name="fieldValues">The values read from the database, you need to use these to fill the record.</param>
|
|
551
|
+
</member>
|
|
552
|
+
<member name="T:FileHelpers.DataLink.FileStorage">
|
|
553
|
+
<summary>This class implements the <see cref="T:FileHelpers.DataLink.DataStorage"/> for plain text files.</summary>
|
|
554
|
+
</member>
|
|
555
|
+
<member name="M:FileHelpers.DataLink.FileStorage.#ctor(System.Type,System.String)">
|
|
556
|
+
<summary>Create an instance of this class to work with the specified type.</summary>
|
|
557
|
+
<param name="type">The record class.</param>
|
|
558
|
+
<param name="fileName">The target filename.</param>
|
|
559
|
+
</member>
|
|
560
|
+
<member name="M:FileHelpers.DataLink.FileStorage.ExtractRecords">
|
|
561
|
+
<summary>Must Return the records from the DataSource (DB, Excel, etc)</summary>
|
|
562
|
+
<returns>The extracted records.</returns>
|
|
563
|
+
</member>
|
|
564
|
+
<member name="M:FileHelpers.DataLink.FileStorage.InsertRecords(System.Object[])">
|
|
565
|
+
<summary>Must Insert the records in a DataSource (DB, Excel, etc)</summary>
|
|
566
|
+
<param name="records">The records to insert.</param>
|
|
567
|
+
</member>
|
|
568
|
+
<member name="P:FileHelpers.DataLink.FileStorage.Engine">
|
|
569
|
+
<summary>The engine behind the FileStorage.</summary>
|
|
570
|
+
</member>
|
|
571
|
+
<member name="P:FileHelpers.DataLink.FileStorage.FileName">
|
|
572
|
+
<summary>The target file name.</summary>
|
|
573
|
+
</member>
|
|
574
|
+
<member name="T:FileHelpers.DataLink.OleDbStorage">
|
|
575
|
+
<summary>This is a base class that implements the <see cref="T:FileHelpers.DataLink.DataStorage"/> for Microsoft Access Files.</summary>
|
|
576
|
+
</member>
|
|
577
|
+
<member name="M:FileHelpers.DataLink.OleDbStorage.#ctor(System.Type,System.String)">
|
|
578
|
+
<summary>
|
|
579
|
+
Create a new OleDbStorage based in the record type and in the connection string.
|
|
580
|
+
</summary>
|
|
581
|
+
<param name="recordType">The Type of the records.</param>
|
|
582
|
+
<param name="oleDbConnString">The conection string used to create the OleDbConnection.</param>
|
|
583
|
+
</member>
|
|
584
|
+
<member name="M:FileHelpers.DataLink.OleDbStorage.CreateConnection">
|
|
585
|
+
<summary>Must create an abstract connection object.</summary>
|
|
586
|
+
<returns>An Abstract Connection Object.</returns>
|
|
587
|
+
</member>
|
|
588
|
+
<member name="T:FileHelpers.DataLink.SqlServerStorage">
|
|
589
|
+
<summary>This is a base class that implements the <see cref="T:FileHelpers.DataLink.DataStorage"/> for Microsoft SqlServer.</summary>
|
|
590
|
+
</member>
|
|
591
|
+
<member name="M:FileHelpers.DataLink.SqlServerStorage.#ctor(System.Type)">
|
|
592
|
+
<summary>Create a new instance of the SqlServerStorage based on the record type provided.</summary>
|
|
593
|
+
<param name="recordType">The type of the record class.</param>
|
|
594
|
+
</member>
|
|
595
|
+
<member name="M:FileHelpers.DataLink.SqlServerStorage.#ctor(System.Type,System.String)">
|
|
596
|
+
<summary>Create a new instance of the SqlServerStorage based on the record type provided.</summary>
|
|
597
|
+
<param name="recordType">The type of the record class.</param>
|
|
598
|
+
<param name="connectionStr">The full conection string used to connect to the sql server.</param>
|
|
599
|
+
</member>
|
|
600
|
+
<member name="M:FileHelpers.DataLink.SqlServerStorage.#ctor(System.Type,System.String,System.String)">
|
|
601
|
+
<summary>Create a new instance of the SqlServerStorage based on the record type provided (uses windows auth)</summary>
|
|
602
|
+
<param name="recordType">The type of the record class.</param>
|
|
603
|
+
<param name="server">The server name or IP of the sqlserver</param>
|
|
604
|
+
<param name="database">The database name into the server.</param>
|
|
605
|
+
</member>
|
|
606
|
+
<member name="M:FileHelpers.DataLink.SqlServerStorage.#ctor(System.Type,System.String,System.String,System.String,System.String)">
|
|
607
|
+
<summary>Create a new instance of the SqlServerStorage based on the record type provided (uses SqlServer auth)</summary>
|
|
608
|
+
<param name="recordType">The type of the record class.</param>
|
|
609
|
+
<param name="server">The server name or IP of the sqlserver</param>
|
|
610
|
+
<param name="database">The database name into the server.</param>
|
|
611
|
+
<param name="user">The sql username to login into the server.</param>
|
|
612
|
+
<param name="pass">The pass of the sql username to login into the server.</param>
|
|
613
|
+
</member>
|
|
614
|
+
<member name="M:FileHelpers.DataLink.SqlServerStorage.CreateConnection">
|
|
615
|
+
<summary>Must create an abstract connection object.</summary>
|
|
616
|
+
<returns>An Abstract Connection Object.</returns>
|
|
617
|
+
</member>
|
|
618
|
+
<member name="P:FileHelpers.DataLink.SqlServerStorage.ServerName">
|
|
619
|
+
<summary> The server name or IP of the SqlServer </summary>
|
|
620
|
+
</member>
|
|
621
|
+
<member name="P:FileHelpers.DataLink.SqlServerStorage.DatabaseName">
|
|
622
|
+
<summary> The name of the database. </summary>
|
|
623
|
+
</member>
|
|
624
|
+
<member name="P:FileHelpers.DataLink.SqlServerStorage.UserName">
|
|
625
|
+
<summary> The user name used to logon into the SqlServer. (leave empty for WindowsAuth)</summary>
|
|
626
|
+
</member>
|
|
627
|
+
<member name="P:FileHelpers.DataLink.SqlServerStorage.UserPass">
|
|
628
|
+
<summary> The user pass used to logon into the SqlServer. (leave empty for WindowsAuth)</summary>
|
|
629
|
+
</member>
|
|
630
|
+
<member name="P:FileHelpers.DataLink.SqlServerStorage.ExecuteInBatch">
|
|
631
|
+
<summary></summary>
|
|
632
|
+
</member>
|
|
633
|
+
<member name="T:FileHelpers.DataLink.FileDataLink">
|
|
634
|
+
<summary>
|
|
635
|
+
This class has the responsability to enable the two directional
|
|
636
|
+
transformation.
|
|
637
|
+
<list type="bullet">
|
|
638
|
+
<item> File <-> DataStorage </item>
|
|
639
|
+
</list>
|
|
640
|
+
</summary>
|
|
641
|
+
<remarks>
|
|
642
|
+
<para>Uses an <see cref="P:FileHelpers.DataLink.FileDataLink.DataStorage"/> to accomplish this task.</para>
|
|
643
|
+
<para>See in the <a href="class_diagram.html">Class Diagram</a> and in the <a href="example_datalink.html">DataLink Sample</a> for more Info.</para>
|
|
644
|
+
</remarks>
|
|
645
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
646
|
+
<seealso href="class_diagram.html">Class Diagram</seealso>
|
|
647
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
648
|
+
<seealso href="example_datalink.html">Example of the DataLink</seealso>
|
|
649
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
650
|
+
</member>
|
|
651
|
+
<member name="M:FileHelpers.DataLink.FileDataLink.#ctor(FileHelpers.DataLink.DataStorage)">
|
|
652
|
+
<summary>Create a new instance of the class.</summary>
|
|
653
|
+
<param name="provider">The <see cref="T:FileHelpers.DataLink.DataStorage"/> used to performs the transformation.</param>
|
|
654
|
+
</member>
|
|
655
|
+
<member name="M:FileHelpers.DataLink.FileDataLink.ExtractToFile(System.String)">
|
|
656
|
+
<summary>
|
|
657
|
+
Extract records from the data source and insert them to the specified file using the DataLinkProvider <see cref="M:FileHelpers.DataLink.DataStorage.ExtractRecords"/> method.
|
|
658
|
+
</summary>
|
|
659
|
+
<param name="fileName">The files where the records be written.</param>
|
|
660
|
+
<returns>True if the operation is successful. False otherwise.</returns>
|
|
661
|
+
</member>
|
|
662
|
+
<member name="M:FileHelpers.DataLink.FileDataLink.ExtractToStream(System.IO.StreamWriter)">
|
|
663
|
+
<summary>
|
|
664
|
+
Extract records from the data source and insert them to the specified stream using the DataLinkProvider <see cref="M:FileHelpers.DataLink.DataStorage.ExtractRecords"/> method.
|
|
665
|
+
</summary>
|
|
666
|
+
<param name="writer">The stream where the records be written.</param>
|
|
667
|
+
<returns>The extracted records</returns>
|
|
668
|
+
</member>
|
|
669
|
+
<member name="M:FileHelpers.DataLink.FileDataLink.InsertFromFile(System.String)">
|
|
670
|
+
<summary>Extract records from a file and insert them to the data source using the DataLinkProvider <see cref="M:FileHelpers.DataLink.DataStorage.InsertRecords(System.Object[])"/> method.</summary>
|
|
671
|
+
<param name="fileName">The file with the source records.</param>
|
|
672
|
+
<returns>True if the operation is successful. False otherwise.</returns>
|
|
673
|
+
</member>
|
|
674
|
+
<member name="M:FileHelpers.DataLink.FileDataLink.InsertFromStream(System.IO.StreamReader)">
|
|
675
|
+
<summary>Extract records from a stream and insert them to the data source using the DataLinkProvider <see cref="M:FileHelpers.DataLink.DataStorage.InsertRecords(System.Object[])"/> method.</summary>
|
|
676
|
+
<param name="reader">The stream with the source records.</param>
|
|
677
|
+
<returns>True if the operation is successful. False otherwise.</returns>
|
|
678
|
+
</member>
|
|
679
|
+
<member name="M:FileHelpers.DataLink.FileDataLink.EasyExtractToFile(FileHelpers.DataLink.DataStorage,System.String)">
|
|
680
|
+
<summary>The short way to Extract the records from a DataStorage to a file</summary>
|
|
681
|
+
<param name="storage">The DataStorage from where get the records</param>
|
|
682
|
+
<param name="filename">The file where to write the records to.</param>
|
|
683
|
+
<returns>The Extracted records.</returns>
|
|
684
|
+
</member>
|
|
685
|
+
<member name="M:FileHelpers.DataLink.FileDataLink.EasyInsertFromFile(FileHelpers.DataLink.DataStorage,System.String)">
|
|
686
|
+
<summary>The short way to Insert Records from a file to a DataStorage</summary>
|
|
687
|
+
<param name="storage">The DataStorage where store the records.</param>
|
|
688
|
+
<param name="filename">The file with the SourceRecords</param>
|
|
689
|
+
<returns>The Inserted records</returns>
|
|
690
|
+
</member>
|
|
691
|
+
<member name="P:FileHelpers.DataLink.FileDataLink.FileHelperEngine">
|
|
692
|
+
<summary> The internal <see cref="T:FileHelpers.FileHelperEngine"/> used to the file or stream ops. </summary>
|
|
693
|
+
</member>
|
|
694
|
+
<member name="P:FileHelpers.DataLink.FileDataLink.DataStorage">
|
|
695
|
+
<summary> The internal <see cref="T:FileHelpers.DataLink.IDataLinkProvider"/> used to the link ops. </summary>
|
|
696
|
+
</member>
|
|
697
|
+
<member name="P:FileHelpers.DataLink.FileDataLink.LastExtractedRecords">
|
|
698
|
+
<summary>
|
|
699
|
+
An array of the last records extracted from the data source to a file.
|
|
700
|
+
</summary>
|
|
701
|
+
</member>
|
|
702
|
+
<member name="P:FileHelpers.DataLink.FileDataLink.LastInsertedRecords">
|
|
703
|
+
<summary>
|
|
704
|
+
An array of the last records inserted in the data source that comes from a file.
|
|
705
|
+
</summary>
|
|
706
|
+
</member>
|
|
707
|
+
<member name="T:FileHelpers.DataLink.GenericDataLink">
|
|
708
|
+
<summary>
|
|
709
|
+
This class has the responsability to enable the two directional
|
|
710
|
+
transformation.
|
|
711
|
+
<list type="bullet">
|
|
712
|
+
<item> DataStorage <-> DataStorage </item>
|
|
713
|
+
</list>
|
|
714
|
+
</summary>
|
|
715
|
+
<remarks>
|
|
716
|
+
<para>Uses two <see cref="T:FileHelpers.DataLink.DataStorage"/> to accomplish this task.</para>
|
|
717
|
+
</remarks>
|
|
718
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
719
|
+
<seealso href="class_diagram.html">Class Diagram</seealso>
|
|
720
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
721
|
+
<seealso href="example_datalink.html">Example of the DataLink</seealso>
|
|
722
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
723
|
+
</member>
|
|
724
|
+
<member name="M:FileHelpers.DataLink.GenericDataLink.#ctor(FileHelpers.DataLink.DataStorage,FileHelpers.DataLink.DataStorage)">
|
|
725
|
+
<summary>Create a new instance of the class.</summary>
|
|
726
|
+
<param name="provider1">The First <see cref="T:FileHelpers.DataLink.DataStorage"/> used to insert/extract records .</param>
|
|
727
|
+
<param name="provider2">The Second <see cref="T:FileHelpers.DataLink.DataStorage"/> used to insert/extract records .</param>
|
|
728
|
+
</member>
|
|
729
|
+
<member name="M:FileHelpers.DataLink.GenericDataLink.CopyDataFrom1To2">
|
|
730
|
+
<summary>Extract the records from DataStorage1 and Insert them to the DataStorage2.</summary>
|
|
731
|
+
<returns>The Copied records.</returns>
|
|
732
|
+
</member>
|
|
733
|
+
<member name="M:FileHelpers.DataLink.GenericDataLink.CopyDataFrom2To1">
|
|
734
|
+
<summary>Extract the records from DataStorage2 and Insert them to the DataStorage1.</summary>
|
|
735
|
+
<returns>The Copied records.</returns>
|
|
736
|
+
</member>
|
|
737
|
+
<member name="P:FileHelpers.DataLink.GenericDataLink.DataStorage1">
|
|
738
|
+
<summary>The fisrt <see cref="T:FileHelpers.DataLink.DataStorage"/> of the <see cref="T:FileHelpers.DataLink.GenericDataLink"/>.</summary>
|
|
739
|
+
</member>
|
|
740
|
+
<member name="P:FileHelpers.DataLink.GenericDataLink.DataStorage2">
|
|
741
|
+
<summary>The second <see cref="T:FileHelpers.DataLink.DataStorage"/> of the <see cref="T:FileHelpers.DataLink.GenericDataLink"/>.</summary>
|
|
742
|
+
</member>
|
|
743
|
+
<member name="T:FileHelpers.CommonEngine">
|
|
744
|
+
<summary>This class only have <b>static methods</b> to work with files and strings (the most common of them)</summary>
|
|
745
|
+
</member>
|
|
746
|
+
<member name="M:FileHelpers.CommonEngine.ReadFile(System.Type,System.String)">
|
|
747
|
+
<summary>
|
|
748
|
+
Used to read a file without instanciate the engine.<br />
|
|
749
|
+
<b>This is feature limited method try to use the non static methods.</b>
|
|
750
|
+
</summary>
|
|
751
|
+
<param name="recordClass">The record class.</param>
|
|
752
|
+
<param name="fileName">The file name</param>
|
|
753
|
+
<returns>The read records.</returns>
|
|
754
|
+
</member>
|
|
755
|
+
<member name="M:FileHelpers.CommonEngine.ReadFile(System.Type,System.String,System.Int32)">
|
|
756
|
+
<summary>
|
|
757
|
+
Used to read a file without instanciate the engine.<br />
|
|
758
|
+
<b>This is feature limited method try to use the non static methods.</b>
|
|
759
|
+
</summary>
|
|
760
|
+
<param name="recordClass">The record class.</param>
|
|
761
|
+
<param name="fileName">The file name</param>
|
|
762
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
763
|
+
<returns>The read records.</returns>
|
|
764
|
+
</member>
|
|
765
|
+
<member name="M:FileHelpers.CommonEngine.ReadFileAsDT(System.Type,System.String)">
|
|
766
|
+
<summary>
|
|
767
|
+
Used to read a file as a DataTable without instanciate the engine.<br />
|
|
768
|
+
<b>This is feature limited method try to use the non static methods.</b>
|
|
769
|
+
</summary>
|
|
770
|
+
<param name="recordClass">The record class.</param>
|
|
771
|
+
<param name="fileName">The file name</param>
|
|
772
|
+
<returns>The datatable representing all the read records.</returns>
|
|
773
|
+
</member>
|
|
774
|
+
<member name="M:FileHelpers.CommonEngine.ReadFileAsDT(System.Type,System.String,System.Int32)">
|
|
775
|
+
<summary>
|
|
776
|
+
Used to read a file as a DataTable without instanciate the engine.<br />
|
|
777
|
+
<b>This is feature limited method try to use the non static methods.</b>
|
|
778
|
+
</summary>
|
|
779
|
+
<param name="recordClass">The record class.</param>
|
|
780
|
+
<param name="fileName">The file name</param>
|
|
781
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
782
|
+
<returns>The datatable representing all the read records.</returns>
|
|
783
|
+
</member>
|
|
784
|
+
<member name="M:FileHelpers.CommonEngine.ReadString(System.Type,System.String)">
|
|
785
|
+
<summary>
|
|
786
|
+
Used to read a string without instanciate the engine.<br />
|
|
787
|
+
<b>This is feature limited method try to use the non static methods.</b>
|
|
788
|
+
</summary>
|
|
789
|
+
<param name="recordClass">The record class.</param>
|
|
790
|
+
<param name="input">The input string.</param>
|
|
791
|
+
<returns>The read records.</returns>
|
|
792
|
+
</member>
|
|
793
|
+
<member name="M:FileHelpers.CommonEngine.ReadString(System.Type,System.String,System.Int32)">
|
|
794
|
+
<summary>
|
|
795
|
+
Used to read a string without instanciate the engine.<br />
|
|
796
|
+
<b>This is feature limited method try to use the non static methods.</b>
|
|
797
|
+
</summary>
|
|
798
|
+
<param name="recordClass">The record class.</param>
|
|
799
|
+
<param name="input">The input string.</param>
|
|
800
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
801
|
+
<returns>The read records.</returns>
|
|
802
|
+
</member>
|
|
803
|
+
<member name="M:FileHelpers.CommonEngine.WriteFile(System.Type,System.String,System.Collections.IEnumerable)">
|
|
804
|
+
<summary>
|
|
805
|
+
Used to write a file without instanciate the engine.<br />
|
|
806
|
+
<b>This is feature limited method try to use the non static methods.</b>
|
|
807
|
+
</summary>
|
|
808
|
+
<param name="recordClass">The record class.</param>
|
|
809
|
+
<param name="fileName">The file name</param>
|
|
810
|
+
<param name="records">The records to write (Can be an array, ArrayList, etc)</param>
|
|
811
|
+
</member>
|
|
812
|
+
<member name="M:FileHelpers.CommonEngine.WriteString(System.Type,System.Collections.IEnumerable)">
|
|
813
|
+
<summary>
|
|
814
|
+
Used to write a string without instanciate the engine.<br />
|
|
815
|
+
<b>This is feature limited method try to use the non static methods.</b>
|
|
816
|
+
</summary>
|
|
817
|
+
<param name="recordClass">The record class.</param>
|
|
818
|
+
<param name="records">The records to write (Can be an array, ArrayList, etc)</param>
|
|
819
|
+
<returns>The string with the writen records.</returns>
|
|
820
|
+
</member>
|
|
821
|
+
<member name="M:FileHelpers.CommonEngine.TransformFileAsync(System.String,System.Type,System.String,System.Type)">
|
|
822
|
+
<summary><b>Faster way</b> to Transform the records of type sourceType in the sourceFile in records of type destType and write them to the destFile.</summary>
|
|
823
|
+
<param name="sourceType">The Type of the records in the source File.</param>
|
|
824
|
+
<param name="destType">The Type of the records in the dest File.</param>
|
|
825
|
+
<param name="sourceFile">The file with records to be transformed</param>
|
|
826
|
+
<param name="destFile">The destination file with the transformed records</param>
|
|
827
|
+
<returns>The number of transformed records</returns>
|
|
828
|
+
</member>
|
|
829
|
+
<member name="M:FileHelpers.CommonEngine.TransformFile(System.String,System.Type,System.String,System.Type)">
|
|
830
|
+
<summary>Transform the records of type sourceType in the sourceFile in records of type destType and write them to the destFile. (but returns the transformed records) WARNING: this is a slower method that the TransformFileAssync.</summary>
|
|
831
|
+
<param name="sourceType">The Type of the records in the source File.</param>
|
|
832
|
+
<param name="destType">The Type of the records in the dest File.</param>
|
|
833
|
+
<param name="sourceFile">The file with records to be transformed</param>
|
|
834
|
+
<param name="destFile">The destination file with the transformed records</param>
|
|
835
|
+
<returns>The transformed records.</returns>
|
|
836
|
+
</member>
|
|
837
|
+
<member name="M:FileHelpers.CommonEngine.ReadSortedFile(System.Type,System.String)">
|
|
838
|
+
<summary>
|
|
839
|
+
Read the contents of a file and sort the records.
|
|
840
|
+
</summary>
|
|
841
|
+
<param name="recordClass">Record Class (remember that need to implement the IComparer interface, or you can use SortFileByfield)</param>
|
|
842
|
+
<param name="fileName">The file to read.</param>
|
|
843
|
+
</member>
|
|
844
|
+
<member name="M:FileHelpers.CommonEngine.SortFile(System.Type,System.String,System.String)">
|
|
845
|
+
<summary>
|
|
846
|
+
Sort the contents of the source file and write them to the destination file.
|
|
847
|
+
</summary>
|
|
848
|
+
<param name="recordClass">Record Class (remember that need to implement the IComparable interface or use the SortFileByfield instead)</param>
|
|
849
|
+
<param name="sourceFile">The source file.</param>
|
|
850
|
+
<param name="sortedFile">The destination File.</param>
|
|
851
|
+
</member>
|
|
852
|
+
<member name="M:FileHelpers.CommonEngine.SortFileByField(System.Type,System.String,System.Boolean,System.String,System.String)">
|
|
853
|
+
<summary>
|
|
854
|
+
Sort the content of a File using the field name provided
|
|
855
|
+
</summary>
|
|
856
|
+
<param name="recordClass">The class for each record of the file.</param>
|
|
857
|
+
<param name="fieldName">The name of the field used to sort the file.</param>
|
|
858
|
+
<param name="asc">The sort direction.</param>
|
|
859
|
+
<param name="sourceFile">The source file.</param>
|
|
860
|
+
<param name="sortedFile">The destination File.</param>
|
|
861
|
+
</member>
|
|
862
|
+
<member name="M:FileHelpers.CommonEngine.SortRecordsByField(System.Object[],System.String)">
|
|
863
|
+
<summary>
|
|
864
|
+
Sort the Record Array based in the field name provided. (for advanced sorting use SortRecords)
|
|
865
|
+
</summary>
|
|
866
|
+
<param name="fieldName">The field name.</param>
|
|
867
|
+
<param name="records">The records Array.</param>
|
|
868
|
+
</member>
|
|
869
|
+
<member name="M:FileHelpers.CommonEngine.SortRecordsByField(System.Object[],System.String,System.Boolean)">
|
|
870
|
+
<summary>
|
|
871
|
+
Sort the Record Array based in the field name provided. (for advanced sorting use SortRecords)
|
|
872
|
+
</summary>
|
|
873
|
+
<param name="fieldName">The field name.</param>
|
|
874
|
+
<param name="records">The records Array.</param>
|
|
875
|
+
<param name="ascending">The direction of the sort. True means Ascending.</param>
|
|
876
|
+
</member>
|
|
877
|
+
<member name="M:FileHelpers.CommonEngine.SortRecords(System.Object[])">
|
|
878
|
+
<summary>
|
|
879
|
+
Sort the Record Array. The records must be of a Type that implements the IComparable interface.
|
|
880
|
+
</summary>
|
|
881
|
+
<param name="records">The records Array.</param>
|
|
882
|
+
</member>
|
|
883
|
+
<member name="M:FileHelpers.CommonEngine.RecordsToDataTable(System.Collections.ICollection)">
|
|
884
|
+
<summary>Converts any collection of records to a DataTebla using reflection. WARNING: this methods returns null if the number of records is 0, pass the Type of the records to get an empty DataTable.</summary>
|
|
885
|
+
<param name="records">The records to be converted to a DataTable</param>
|
|
886
|
+
<returns>The datatable containing the records as DataRows</returns>
|
|
887
|
+
</member>
|
|
888
|
+
<member name="M:FileHelpers.CommonEngine.RecordsToDataTable(System.Collections.ICollection,System.Int32)">
|
|
889
|
+
<summary>Converts any collection of records to a DataTebla using reflection. WARNING: this methods returns null if the number of records is 0, pass the Type of the records to get an empty DataTable.</summary>
|
|
890
|
+
<param name="records">The records to be converted to a DataTable</param>
|
|
891
|
+
<param name="maxRecords">The max number of records to add to the datatable. -1 for all.</param>
|
|
892
|
+
<returns>The datatable containing the records as DataRows</returns>
|
|
893
|
+
</member>
|
|
894
|
+
<member name="M:FileHelpers.CommonEngine.RecordsToDataTable(System.Collections.ICollection,System.Type)">
|
|
895
|
+
<summary>Converts any collection of records to a DataTebla using reflection. If the number of records is 0 this methods returns an empty DataTable with the columns based on the fields of the Type.</summary>
|
|
896
|
+
<param name="records">The records to be converted to a DataTable</param>
|
|
897
|
+
<returns>The datatable containing the records as DataRows</returns>
|
|
898
|
+
<param name="recordType">The type of the inner records.</param>
|
|
899
|
+
</member>
|
|
900
|
+
<member name="M:FileHelpers.CommonEngine.RecordsToDataTable(System.Collections.ICollection,System.Type,System.Int32)">
|
|
901
|
+
<summary>Converts any collection of records to a DataTebla using reflection. If the number of records is 0 this methods returns an empty DataTable with the columns based on the fields of the Type.</summary>
|
|
902
|
+
<param name="records">The records to be converted to a DataTable</param>
|
|
903
|
+
<returns>The datatable containing the records as DataRows</returns>
|
|
904
|
+
<param name="maxRecords">The max number of records to add to the datatable. -1 for all.</param>
|
|
905
|
+
<param name="recordType">The type of the inner records.</param>
|
|
906
|
+
</member>
|
|
907
|
+
<member name="M:FileHelpers.CommonEngine.MergeFiles(System.Type,System.String,System.String,System.String)">
|
|
908
|
+
<summary>
|
|
909
|
+
Reads the file1 and file2 using the recordType and write it to destinationFile
|
|
910
|
+
</summary>
|
|
911
|
+
</member>
|
|
912
|
+
<member name="M:FileHelpers.CommonEngine.MergeAndSortFile(System.Type,System.String,System.String,System.String,System.String)">
|
|
913
|
+
<summary>
|
|
914
|
+
Merge the contents of 2 files and write them sorted to a destination file.
|
|
915
|
+
</summary>
|
|
916
|
+
<param name="recordType">The record Type.</param>
|
|
917
|
+
<param name="file1">File with contents to be merged.</param>
|
|
918
|
+
<param name="file2">File with contents to be merged.</param>
|
|
919
|
+
<param name="field">The name of the field used to sort the records.</param>
|
|
920
|
+
<param name="destFile">The destination file.</param>
|
|
921
|
+
<returns>The merged and sorted records.</returns>
|
|
922
|
+
</member>
|
|
923
|
+
<member name="M:FileHelpers.CommonEngine.MergeAndSortFile(System.Type,System.String,System.String,System.String,System.String,System.Boolean)">
|
|
924
|
+
<summary>
|
|
925
|
+
Merge the contents of 2 files and write them sorted to a destination file.
|
|
926
|
+
</summary>
|
|
927
|
+
<param name="recordType">The record Type.</param>
|
|
928
|
+
<param name="file1">File with contents to be merged.</param>
|
|
929
|
+
<param name="file2">File with contents to be merged.</param>
|
|
930
|
+
<param name="field">The name of the field used to sort the records.</param>
|
|
931
|
+
<param name="ascending">Indicate the order of sort.</param>
|
|
932
|
+
<param name="destFile">The destination file.</param>
|
|
933
|
+
<returns>The merged and sorted records.</returns>
|
|
934
|
+
</member>
|
|
935
|
+
<member name="M:FileHelpers.CommonEngine.MergeAndSortFile(System.Type,System.String,System.String,System.String)">
|
|
936
|
+
<summary>
|
|
937
|
+
Merge the contents of 2 files and write them sorted to a destination file.
|
|
938
|
+
</summary>
|
|
939
|
+
<param name="recordType">The record Type.</param>
|
|
940
|
+
<param name="file1">File with contents to be merged.</param>
|
|
941
|
+
<param name="file2">File with contents to be merged.</param>
|
|
942
|
+
<param name="destFile">The destination file.</param>
|
|
943
|
+
<returns>The merged and sorted records.</returns>
|
|
944
|
+
</member>
|
|
945
|
+
<member name="M:FileHelpers.CommonEngine.DataTableToCsv(System.Data.DataTable,System.String)">
|
|
946
|
+
<summary>Simply dumps the DataTable contents to a delimited file using a ',' as delimiter.</summary>
|
|
947
|
+
<param name="dt">The source Data Table</param>
|
|
948
|
+
<param name="filename">The destination file.</param>
|
|
949
|
+
</member>
|
|
950
|
+
<member name="M:FileHelpers.CommonEngine.DataTableToCsv(System.Data.DataTable,System.String,System.Char)">
|
|
951
|
+
<summary>Simply dumps the DataTable contents to a delimited file. Only allows to set the delimiter.</summary>
|
|
952
|
+
<param name="dt">The source Data Table</param>
|
|
953
|
+
<param name="filename">The destination file.</param>
|
|
954
|
+
<param name="delimiter">The delimiter used to write the file</param>
|
|
955
|
+
</member>
|
|
956
|
+
<member name="M:FileHelpers.CommonEngine.DataTableToCsv(System.Data.DataTable,System.String,FileHelpers.CsvOptions)">
|
|
957
|
+
<summary>Simply dumps the DataTable contents to a delimited file. Only allows to set the delimiter.</summary>
|
|
958
|
+
<param name="dt">The source Data Table</param>
|
|
959
|
+
<param name="filename">The destination file.</param>
|
|
960
|
+
<param name="options">The options used to write the file</param>
|
|
961
|
+
</member>
|
|
962
|
+
<member name="M:FileHelpers.CommonEngine.CsvToDataTable(System.String,System.Char)">
|
|
963
|
+
<summary>Reads a Csv File and return their contents as DataTable (The file must have the field names in the first row)</summary>
|
|
964
|
+
<param name="delimiter">The delimiter for each field</param>
|
|
965
|
+
<param name="filename">The file to read.</param>
|
|
966
|
+
<returns>The contents of the file as a DataTable</returns>
|
|
967
|
+
</member>
|
|
968
|
+
<member name="M:FileHelpers.CommonEngine.CsvToDataTable(System.String,System.String,System.Char)">
|
|
969
|
+
<summary>Reads a Csv File and return their contents as DataTable (The file must have the field names in the first row)</summary>
|
|
970
|
+
<param name="classname">The name of the record class</param>
|
|
971
|
+
<param name="delimiter">The delimiter for each field</param>
|
|
972
|
+
<param name="filename">The file to read.</param>
|
|
973
|
+
<returns>The contents of the file as a DataTable</returns>
|
|
974
|
+
</member>
|
|
975
|
+
<member name="M:FileHelpers.CommonEngine.CsvToDataTable(System.String,System.String,System.Char,System.Boolean)">
|
|
976
|
+
<summary>Reads a Csv File and return their contents as DataTable</summary>
|
|
977
|
+
<param name="classname">The name of the record class</param>
|
|
978
|
+
<param name="delimiter">The delimiter for each field</param>
|
|
979
|
+
<param name="filename">The file to read.</param>
|
|
980
|
+
<param name="hasHeader">Indicates if the file contains a header with the field names.</param>
|
|
981
|
+
<returns>The contents of the file as a DataTable</returns>
|
|
982
|
+
</member>
|
|
983
|
+
<member name="M:FileHelpers.CommonEngine.CsvToDataTable(System.String,FileHelpers.CsvOptions)">
|
|
984
|
+
<summary>Reads a Csv File and return their contents as DataTable</summary>
|
|
985
|
+
<param name="filename">The file to read.</param>
|
|
986
|
+
<param name="options">The options used to create the record mapping class.</param>
|
|
987
|
+
<returns>The contents of the file as a DataTable</returns>
|
|
988
|
+
</member>
|
|
989
|
+
<member name="M:FileHelpers.CommonEngine.RemoveDuplicateRecords(FileHelpers.IComparableRecord[])">
|
|
990
|
+
<summary>
|
|
991
|
+
This method allow to remove the duplicated records from an array.
|
|
992
|
+
</summary>
|
|
993
|
+
<param name="arr">The array with the records to be checked.</param>
|
|
994
|
+
<returns>An array with the result of remove the duplicate records from the source array.</returns>
|
|
995
|
+
</member>
|
|
996
|
+
<member name="M:FileHelpers.CommonEngine.RawReadAllFile(System.String)">
|
|
997
|
+
<summary>
|
|
998
|
+
Shortcut method to read all the text in a file.
|
|
999
|
+
</summary>
|
|
1000
|
+
<param name="file">The file name</param>
|
|
1001
|
+
<returns>The contents of the files</returns>
|
|
1002
|
+
</member>
|
|
1003
|
+
<member name="M:FileHelpers.CommonEngine.RawReadFirstLines(System.String,System.Int32)">
|
|
1004
|
+
<summary>
|
|
1005
|
+
Shortcut method to read the first n lines of a text file.
|
|
1006
|
+
</summary>
|
|
1007
|
+
<param name="file">The file name</param>
|
|
1008
|
+
<param name="lines">The number of lines to read.</param>
|
|
1009
|
+
<returns>The first n lines of the file.</returns>
|
|
1010
|
+
</member>
|
|
1011
|
+
<member name="T:FileHelpers.CsvEngine">
|
|
1012
|
+
<summary>A class to read generic CSV files delimited for any char.</summary>
|
|
1013
|
+
</member>
|
|
1014
|
+
<member name="T:FileHelpers.FileHelperEngine">
|
|
1015
|
+
<summary>
|
|
1016
|
+
<para><b>One of the main classes of the library.</b></para>
|
|
1017
|
+
<para>This engine is responsable to Read/Write the records <b>at once</b> from/to files or streams.</para>
|
|
1018
|
+
<para>You can use the <see cref="T:FileHelpers.DelimitedFileEngine"/> or the <see cref="T:FileHelpers.FixedFileEngine"/> if you need to change some options at runtime</para>
|
|
1019
|
+
</summary><remarks>
|
|
1020
|
+
<para>You can set the <see cref="P:FileHelpers.ErrorManager.ErrorMode"/> of this class when found an error, and can retrive them with the <see cref="P:FileHelpers.ErrorManager.Errors"/> property.</para>
|
|
1021
|
+
<para>See in the <a href="class_diagram.html">Class Diagram</a> and in the <a href="quick_start.html">Quick Start Guide</a> for more Info.</para>
|
|
1022
|
+
<para>Or you can browse the <a href="examples.html">Examples Seccion</a> for more code.</para>
|
|
1023
|
+
<para>Engines Diagram:</para>
|
|
1024
|
+
<para><center><img src="diag_engines.gif"/></center></para>
|
|
1025
|
+
</remarks><seealso href="quick_start.html">Quick Start Guide</seealso><seealso href="class_diagram.html">Class Diagram</seealso><seealso href="examples.html">Examples of Use</seealso><seealso href="attributes.html">Attributes List</seealso>
|
|
1026
|
+
<example>
|
|
1027
|
+
This example show the basic use of the library with minimun code:
|
|
1028
|
+
<code>
|
|
1029
|
+
<textarea name="code" class="c#">
|
|
1030
|
+
|
|
1031
|
+
using FileHelpers;
|
|
1032
|
+
|
|
1033
|
+
// First declare the record class
|
|
1034
|
+
|
|
1035
|
+
[Delimitedrecord("|")]
|
|
1036
|
+
public class SampleType
|
|
1037
|
+
{
|
|
1038
|
+
public string Field1;
|
|
1039
|
+
public int Field2;
|
|
1040
|
+
}
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
public void ReadExample()
|
|
1044
|
+
{
|
|
1045
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1046
|
+
|
|
1047
|
+
SampleType[] records;
|
|
1048
|
+
|
|
1049
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
1050
|
+
|
|
1051
|
+
// Now "records" array contains all the records in the
|
|
1052
|
+
// sourcefile and can be acceded like this:
|
|
1053
|
+
|
|
1054
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
1055
|
+
}
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
public void WriteExample()
|
|
1059
|
+
{
|
|
1060
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1061
|
+
|
|
1062
|
+
SampleType[] records = new SampleType[1];
|
|
1063
|
+
|
|
1064
|
+
records[0] = new SampleType();
|
|
1065
|
+
|
|
1066
|
+
records[0].Field1 = "Hello World";
|
|
1067
|
+
records[0].Field2 = 12;
|
|
1068
|
+
|
|
1069
|
+
engine.WriteFile("destination.txt", records);
|
|
1070
|
+
|
|
1071
|
+
// Now the file contains the created record in this format:
|
|
1072
|
+
//
|
|
1073
|
+
// Hello World,12
|
|
1074
|
+
|
|
1075
|
+
}
|
|
1076
|
+
|
|
1077
|
+
</textarea>
|
|
1078
|
+
</code> </example>
|
|
1079
|
+
</member>
|
|
1080
|
+
<member name="T:FileHelpers.EngineBase">
|
|
1081
|
+
<summary>Base class for the two engines of the library: <see cref="T:FileHelpers.FileHelperEngine"/> and <see cref="T:FileHelpers.FileHelperAsyncEngine"/></summary>
|
|
1082
|
+
</member>
|
|
1083
|
+
<member name="F:FileHelpers.EngineBase.mErrorManager">
|
|
1084
|
+
<summary>This is a common class that manage the errors of the library.</summary>
|
|
1085
|
+
</member>
|
|
1086
|
+
<member name="F:FileHelpers.EngineBase.mProgressMode">
|
|
1087
|
+
<summary></summary>
|
|
1088
|
+
</member>
|
|
1089
|
+
<member name="F:FileHelpers.EngineBase.mNotifyHandler">
|
|
1090
|
+
<summary></summary>
|
|
1091
|
+
</member>
|
|
1092
|
+
<member name="M:FileHelpers.EngineBase.SetProgressHandler(FileHelpers.ProgressChangeHandler)">
|
|
1093
|
+
<summary>Set the handler to the engine used to notify progress into the operations.</summary>
|
|
1094
|
+
<param name="handler">The <see cref="T:FileHelpers.ProgressChangeHandler"/></param>
|
|
1095
|
+
</member>
|
|
1096
|
+
<member name="M:FileHelpers.EngineBase.SetProgressHandler(FileHelpers.ProgressChangeHandler,FileHelpers.ProgressMode)">
|
|
1097
|
+
<summary>Set the handler to the engine used to notify progress into the operations.</summary>
|
|
1098
|
+
<param name="handler">Your <see cref="T:FileHelpers.ProgressChangeHandler"/> method.</param>
|
|
1099
|
+
<param name="mode">The <see cref="T:FileHelpers.ProgressMode"/> to use.</param>
|
|
1100
|
+
</member>
|
|
1101
|
+
<member name="P:FileHelpers.EngineBase.LineNumber">
|
|
1102
|
+
<summary>The current line number.</summary>
|
|
1103
|
+
</member>
|
|
1104
|
+
<member name="P:FileHelpers.EngineBase.TotalRecords">
|
|
1105
|
+
<summary>The total numbers of records in the last read/written file (only works with whole read/write).</summary>
|
|
1106
|
+
</member>
|
|
1107
|
+
<member name="P:FileHelpers.EngineBase.RecordType">
|
|
1108
|
+
<summary>Returns the type of records handled by this engine.</summary>
|
|
1109
|
+
</member>
|
|
1110
|
+
<member name="P:FileHelpers.EngineBase.HeaderText">
|
|
1111
|
+
<summary>The read header in the last read operation. If any.</summary>
|
|
1112
|
+
</member>
|
|
1113
|
+
<member name="P:FileHelpers.EngineBase.FooterText">
|
|
1114
|
+
<summary>The read footer in the last read operation. If any.</summary>
|
|
1115
|
+
</member>
|
|
1116
|
+
<member name="P:FileHelpers.EngineBase.Encoding">
|
|
1117
|
+
<summary>The encoding to Read and Write the streams.</summary>
|
|
1118
|
+
<remarks>Default is the system's current ANSI code page.</remarks>
|
|
1119
|
+
<value>Default is the system's current ANSI code page.</value>
|
|
1120
|
+
</member>
|
|
1121
|
+
<member name="P:FileHelpers.EngineBase.ErrorManager">
|
|
1122
|
+
<summary>This is a common class that manage the errors of the library.</summary>
|
|
1123
|
+
<remarks>You can, for example, get the errors, their number, Save them to a file, etc.</remarks>
|
|
1124
|
+
</member>
|
|
1125
|
+
<member name="M:FileHelpers.FileHelperEngine.#ctor(System.Type)">
|
|
1126
|
+
<summary>
|
|
1127
|
+
Initializes a new instance of the FileHelperEngine class with the specified type of records.
|
|
1128
|
+
</summary><param name="recordType">The record mapping class.</param>
|
|
1129
|
+
</member>
|
|
1130
|
+
<member name="M:FileHelpers.FileHelperEngine.#ctor(System.Type,System.Text.Encoding)">
|
|
1131
|
+
<summary>
|
|
1132
|
+
Initializes a new instance of the FileHelperEngine class with the specified type of records.
|
|
1133
|
+
</summary><param name="recordType">The record mapping class.</param>
|
|
1134
|
+
<param name="encoding">The Encoding used by the engine.</param>
|
|
1135
|
+
</member>
|
|
1136
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadFile(System.String)">
|
|
1137
|
+
<summary>
|
|
1138
|
+
Read a file and return an array of the contained records.
|
|
1139
|
+
</summary><remarks>
|
|
1140
|
+
This method open, read and close the file (don't open or close the file before or after to call this method)
|
|
1141
|
+
</remarks><example>
|
|
1142
|
+
This example show the basic use of the library with minimun code:
|
|
1143
|
+
<code>
|
|
1144
|
+
<textarea name="code" class="c#">
|
|
1145
|
+
|
|
1146
|
+
using FileHelpers;
|
|
1147
|
+
|
|
1148
|
+
// First declare the record class
|
|
1149
|
+
|
|
1150
|
+
[Delimitedrecord("|")]
|
|
1151
|
+
public class SampleType
|
|
1152
|
+
{
|
|
1153
|
+
public string Field1;
|
|
1154
|
+
public int Field2;
|
|
1155
|
+
}
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
public void ReadExample()
|
|
1159
|
+
{
|
|
1160
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1161
|
+
|
|
1162
|
+
SampleType[] records;
|
|
1163
|
+
|
|
1164
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
1165
|
+
|
|
1166
|
+
// Now "records" array contains all the records in the
|
|
1167
|
+
// sourcefile and can be acceded like this:
|
|
1168
|
+
|
|
1169
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
1170
|
+
}
|
|
1171
|
+
|
|
1172
|
+
</textarea>
|
|
1173
|
+
</code>
|
|
1174
|
+
</example><param name="fileName">The file path to be read.</param><returns>An array of the records in the file</returns>
|
|
1175
|
+
</member>
|
|
1176
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadFile(System.String,System.Int32)">
|
|
1177
|
+
<summary>
|
|
1178
|
+
Read a file and return an array of the contained records.
|
|
1179
|
+
</summary><remarks>
|
|
1180
|
+
This method open, read and close the file (don't open or close the file before or after to call this method)
|
|
1181
|
+
</remarks><example>
|
|
1182
|
+
This example show the basic use of the library with minimun code:
|
|
1183
|
+
<code>
|
|
1184
|
+
<textarea name="code" class="c#">
|
|
1185
|
+
|
|
1186
|
+
using FileHelpers;
|
|
1187
|
+
|
|
1188
|
+
// First declare the record class
|
|
1189
|
+
|
|
1190
|
+
[Delimitedrecord("|")]
|
|
1191
|
+
public class SampleType
|
|
1192
|
+
{
|
|
1193
|
+
public string Field1;
|
|
1194
|
+
public int Field2;
|
|
1195
|
+
}
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
public void ReadExample()
|
|
1199
|
+
{
|
|
1200
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1201
|
+
|
|
1202
|
+
SampleType[] records;
|
|
1203
|
+
|
|
1204
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
1205
|
+
|
|
1206
|
+
// Now "records" array contains all the records in the
|
|
1207
|
+
// sourcefile and can be acceded like this:
|
|
1208
|
+
|
|
1209
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
1210
|
+
}
|
|
1211
|
+
|
|
1212
|
+
</textarea>
|
|
1213
|
+
</code>
|
|
1214
|
+
</example><param name="fileName">The file path to be read.</param><returns>An array of the records in the file</returns>
|
|
1215
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
1216
|
+
</member>
|
|
1217
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadStream(System.IO.TextReader)">
|
|
1218
|
+
<summary>
|
|
1219
|
+
Read a Stream and return an array of the contained records.
|
|
1220
|
+
</summary><remarks>
|
|
1221
|
+
This method only uses the stream and dont close them after use it, you must do it.
|
|
1222
|
+
</remarks><example>
|
|
1223
|
+
This example show the basic use of the library with minimun code:
|
|
1224
|
+
<code>
|
|
1225
|
+
<textarea name="code" class="c#">
|
|
1226
|
+
|
|
1227
|
+
using FileHelpers;
|
|
1228
|
+
|
|
1229
|
+
// First declare the record class
|
|
1230
|
+
|
|
1231
|
+
[Delimitedrecord("|")]
|
|
1232
|
+
public class SampleType
|
|
1233
|
+
{
|
|
1234
|
+
public string Field1;
|
|
1235
|
+
public int Field2;
|
|
1236
|
+
}
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
public void ReadExample()
|
|
1240
|
+
{
|
|
1241
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1242
|
+
|
|
1243
|
+
SampleType[] records;
|
|
1244
|
+
|
|
1245
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
1246
|
+
|
|
1247
|
+
// Now "records" array contains all the records in the
|
|
1248
|
+
// sourcefile and can be acceded like this:
|
|
1249
|
+
|
|
1250
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
1251
|
+
}
|
|
1252
|
+
|
|
1253
|
+
</textarea>
|
|
1254
|
+
</code>
|
|
1255
|
+
</example><param name="reader">The reader of the source stream.</param><returns>An array of the records in the Stream</returns>
|
|
1256
|
+
</member>
|
|
1257
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadStream(System.IO.TextReader,System.Int32)">
|
|
1258
|
+
<summary>
|
|
1259
|
+
Read a Stream and return an array of the contained records.
|
|
1260
|
+
</summary><remarks>
|
|
1261
|
+
This method only uses the stream and dont close them after use it, you must do it.
|
|
1262
|
+
</remarks><example>
|
|
1263
|
+
This example show the basic use of the library with minimun code:
|
|
1264
|
+
<code>
|
|
1265
|
+
<textarea name="code" class="c#">
|
|
1266
|
+
|
|
1267
|
+
using FileHelpers;
|
|
1268
|
+
|
|
1269
|
+
// First declare the record class
|
|
1270
|
+
|
|
1271
|
+
[Delimitedrecord("|")]
|
|
1272
|
+
public class SampleType
|
|
1273
|
+
{
|
|
1274
|
+
public string Field1;
|
|
1275
|
+
public int Field2;
|
|
1276
|
+
}
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
public void ReadExample()
|
|
1280
|
+
{
|
|
1281
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1282
|
+
|
|
1283
|
+
SampleType[] records;
|
|
1284
|
+
|
|
1285
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
1286
|
+
|
|
1287
|
+
// Now "records" array contains all the records in the
|
|
1288
|
+
// sourcefile and can be acceded like this:
|
|
1289
|
+
|
|
1290
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
1291
|
+
}
|
|
1292
|
+
|
|
1293
|
+
</textarea>
|
|
1294
|
+
</code>
|
|
1295
|
+
</example><param name="reader">The reader of the source stream.</param><returns>An array of the records in the Stream</returns>
|
|
1296
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
1297
|
+
</member>
|
|
1298
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadString(System.String)">
|
|
1299
|
+
<summary>
|
|
1300
|
+
Read a String and return an array of the contained records.
|
|
1301
|
+
</summary><param name="source">The string that contains the records.</param><returns>An array of the records in the String.</returns>
|
|
1302
|
+
</member>
|
|
1303
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadString(System.String,System.Int32)">
|
|
1304
|
+
<summary>
|
|
1305
|
+
Read a String and return an array of the contained records.
|
|
1306
|
+
</summary><param name="source">The string that contains the records.</param><returns>An array of the records in the String.</returns>
|
|
1307
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
1308
|
+
</member>
|
|
1309
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteFile(System.String,System.Collections.IEnumerable)">
|
|
1310
|
+
<summary>
|
|
1311
|
+
Write an array of records to the specified file.
|
|
1312
|
+
</summary><remarks>
|
|
1313
|
+
<para>This method open, write and close the file (don't open or close the file before or after to call this method)</para>
|
|
1314
|
+
<para>This method overrides existing files.</para>
|
|
1315
|
+
</remarks><example>
|
|
1316
|
+
This example show the basic use of the library with minimun code:
|
|
1317
|
+
<code>
|
|
1318
|
+
<textarea name="code" class="c#">
|
|
1319
|
+
|
|
1320
|
+
using FileHelpers;
|
|
1321
|
+
|
|
1322
|
+
// First declare the record class
|
|
1323
|
+
|
|
1324
|
+
[Delimitedrecord("|")]
|
|
1325
|
+
public class SampleType
|
|
1326
|
+
{
|
|
1327
|
+
public string Field1;
|
|
1328
|
+
public int Field2;
|
|
1329
|
+
}
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
public void WriteExample()
|
|
1333
|
+
{
|
|
1334
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1335
|
+
|
|
1336
|
+
SampleType[] records = new SampleType[1];
|
|
1337
|
+
|
|
1338
|
+
records[0] = new SampleType();
|
|
1339
|
+
|
|
1340
|
+
records[0].Field1 = "Hello World";
|
|
1341
|
+
records[0].Field2 = 12;
|
|
1342
|
+
|
|
1343
|
+
engine.WriteFile("destination.txt", records);
|
|
1344
|
+
|
|
1345
|
+
// Now the file contains the created record in this format:
|
|
1346
|
+
//
|
|
1347
|
+
// Hello World,12
|
|
1348
|
+
|
|
1349
|
+
}
|
|
1350
|
+
|
|
1351
|
+
</textarea>
|
|
1352
|
+
</code>
|
|
1353
|
+
</example><param name="fileName">The file path to be write.</param><param name="records">The records to write (Can be an array, ArrayList, etc)</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
1354
|
+
</member>
|
|
1355
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteFile(System.String,System.Collections.IEnumerable,System.Int32)">
|
|
1356
|
+
<summary>
|
|
1357
|
+
Write the specified number of records from the array to a file.
|
|
1358
|
+
</summary><remarks>
|
|
1359
|
+
<para>This method open, write and close the file (don't open or close the file before or after to call this method)</para>
|
|
1360
|
+
<para>This method overrides existing files.</para>
|
|
1361
|
+
</remarks><example>
|
|
1362
|
+
This example show the basic use of the library with minimun code:
|
|
1363
|
+
<code>
|
|
1364
|
+
<textarea name="code" class="c#">
|
|
1365
|
+
|
|
1366
|
+
using FileHelpers;
|
|
1367
|
+
|
|
1368
|
+
// First declare the record class
|
|
1369
|
+
|
|
1370
|
+
[Delimitedrecord("|")]
|
|
1371
|
+
public class SampleType
|
|
1372
|
+
{
|
|
1373
|
+
public string Field1;
|
|
1374
|
+
public int Field2;
|
|
1375
|
+
}
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
public void WriteExample()
|
|
1379
|
+
{
|
|
1380
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1381
|
+
|
|
1382
|
+
SampleType[] records = new SampleType[1];
|
|
1383
|
+
|
|
1384
|
+
records[0] = new SampleType();
|
|
1385
|
+
|
|
1386
|
+
records[0].Field1 = "Hello World";
|
|
1387
|
+
records[0].Field2 = 12;
|
|
1388
|
+
|
|
1389
|
+
engine.WriteFile("destination.txt", records);
|
|
1390
|
+
|
|
1391
|
+
// Now the file contains the created record in this format:
|
|
1392
|
+
//
|
|
1393
|
+
// Hello World,12
|
|
1394
|
+
|
|
1395
|
+
}
|
|
1396
|
+
|
|
1397
|
+
</textarea>
|
|
1398
|
+
</code>
|
|
1399
|
+
</example><param name="fileName">The file path to be write.</param><param name="records">The records to write (Can be an array, ArrayList, etc)</param><param name="maxRecords">The max number of array elements to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
1400
|
+
</member>
|
|
1401
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteStream(System.IO.TextWriter,System.Collections.IEnumerable)">
|
|
1402
|
+
<summary>
|
|
1403
|
+
Write an array of records to the specified Stream.
|
|
1404
|
+
</summary><remarks>
|
|
1405
|
+
This method only uses the stream and don't close them after use it, you must do it.
|
|
1406
|
+
</remarks><example>
|
|
1407
|
+
This example show the basic use of the library with minimun code:
|
|
1408
|
+
<code>
|
|
1409
|
+
<textarea name="code" class="c#">
|
|
1410
|
+
|
|
1411
|
+
using FileHelpers;
|
|
1412
|
+
|
|
1413
|
+
// First declare the record class
|
|
1414
|
+
|
|
1415
|
+
[Delimitedrecord("|")]
|
|
1416
|
+
public class SampleType
|
|
1417
|
+
{
|
|
1418
|
+
public string Field1;
|
|
1419
|
+
public int Field2;
|
|
1420
|
+
}
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
public void WriteExample()
|
|
1424
|
+
{
|
|
1425
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1426
|
+
|
|
1427
|
+
SampleType[] records = new SampleType[1];
|
|
1428
|
+
|
|
1429
|
+
records[0] = new SampleType();
|
|
1430
|
+
|
|
1431
|
+
records[0].Field1 = "Hello World";
|
|
1432
|
+
records[0].Field2 = 12;
|
|
1433
|
+
|
|
1434
|
+
engine.WriteFile("destination.txt", records);
|
|
1435
|
+
|
|
1436
|
+
// Now the file contains the created record in this format:
|
|
1437
|
+
//
|
|
1438
|
+
// Hello World,12
|
|
1439
|
+
|
|
1440
|
+
}
|
|
1441
|
+
|
|
1442
|
+
</textarea>
|
|
1443
|
+
</code>
|
|
1444
|
+
</example><param name="writer">The writer of the source stream.</param><param name="records">The records to write (Can be an array, ArrayList, etc)</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
1445
|
+
</member>
|
|
1446
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteStream(System.IO.TextWriter,System.Collections.IEnumerable,System.Int32)">
|
|
1447
|
+
<summary>
|
|
1448
|
+
Write the specified number of records in the array to the Stream.
|
|
1449
|
+
</summary><remarks>
|
|
1450
|
+
This method only uses the stream and don't close them after use it, you must do it.
|
|
1451
|
+
</remarks><example>
|
|
1452
|
+
This example show the basic use of the library with minimun code:
|
|
1453
|
+
<code>
|
|
1454
|
+
<textarea name="code" class="c#">
|
|
1455
|
+
|
|
1456
|
+
using FileHelpers;
|
|
1457
|
+
|
|
1458
|
+
// First declare the record class
|
|
1459
|
+
|
|
1460
|
+
[Delimitedrecord("|")]
|
|
1461
|
+
public class SampleType
|
|
1462
|
+
{
|
|
1463
|
+
public string Field1;
|
|
1464
|
+
public int Field2;
|
|
1465
|
+
}
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
public void WriteExample()
|
|
1469
|
+
{
|
|
1470
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1471
|
+
|
|
1472
|
+
SampleType[] records = new SampleType[1];
|
|
1473
|
+
|
|
1474
|
+
records[0] = new SampleType();
|
|
1475
|
+
|
|
1476
|
+
records[0].Field1 = "Hello World";
|
|
1477
|
+
records[0].Field2 = 12;
|
|
1478
|
+
|
|
1479
|
+
engine.WriteFile("destination.txt", records);
|
|
1480
|
+
|
|
1481
|
+
// Now the file contains the created record in this format:
|
|
1482
|
+
//
|
|
1483
|
+
// Hello World,12
|
|
1484
|
+
|
|
1485
|
+
}
|
|
1486
|
+
|
|
1487
|
+
</textarea>
|
|
1488
|
+
</code>
|
|
1489
|
+
</example><param name="writer">The writer of the source stream.</param><param name="records">The records to write (Can be an array, ArrayList, etc)</param><param name="maxRecords">The max number of array elements to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
1490
|
+
</member>
|
|
1491
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteString(System.Collections.IEnumerable)">
|
|
1492
|
+
<summary>
|
|
1493
|
+
Write an array of records to an String and return it.
|
|
1494
|
+
</summary><param name="records">The records to write (Can be an array, ArrayList, etc)</param><returns>The resulting string after write the records.</returns>
|
|
1495
|
+
</member>
|
|
1496
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteString(System.Collections.IEnumerable,System.Int32)">
|
|
1497
|
+
<summary>
|
|
1498
|
+
Write an array of records to an String and return it.
|
|
1499
|
+
</summary><param name="records">The records to write (Can be an array, ArrayList, etc)</param><returns>The resulting string after write the records.</returns><param name="maxRecords">The max number of array elements to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
1500
|
+
</member>
|
|
1501
|
+
<member name="M:FileHelpers.FileHelperEngine.AppendToFile(System.String,System.Object)">
|
|
1502
|
+
<summary>
|
|
1503
|
+
Append a record to the specified file.
|
|
1504
|
+
</summary><remarks>
|
|
1505
|
+
This method open, seek ends, write and close the file (don't open or close the file before or after to call this method)
|
|
1506
|
+
</remarks><example>
|
|
1507
|
+
This example show the basic use of the library with minimun code:
|
|
1508
|
+
<code>
|
|
1509
|
+
<textarea name="code" class="c#">
|
|
1510
|
+
|
|
1511
|
+
using FileHelpers;
|
|
1512
|
+
|
|
1513
|
+
// First declare the record class
|
|
1514
|
+
|
|
1515
|
+
[Delimitedrecord("|")]
|
|
1516
|
+
public class SampleType
|
|
1517
|
+
{
|
|
1518
|
+
public string Field1;
|
|
1519
|
+
public int Field2;
|
|
1520
|
+
}
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
public void AppendExample()
|
|
1524
|
+
{
|
|
1525
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1526
|
+
|
|
1527
|
+
SampleType[] records = new SampleType[1];
|
|
1528
|
+
|
|
1529
|
+
records[0] = new SampleType();
|
|
1530
|
+
|
|
1531
|
+
records[0].Field1 = "Hello World";
|
|
1532
|
+
records[0].Field2 = 12;
|
|
1533
|
+
|
|
1534
|
+
engine.AppendToFile("destination.txt", records);
|
|
1535
|
+
|
|
1536
|
+
// Now the file contains have one more record at the end:
|
|
1537
|
+
//
|
|
1538
|
+
// Hello World,12
|
|
1539
|
+
|
|
1540
|
+
}
|
|
1541
|
+
|
|
1542
|
+
</textarea>
|
|
1543
|
+
</code>
|
|
1544
|
+
</example><param name="fileName">The file path to be written at end.</param><param name="record">The record to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
1545
|
+
</member>
|
|
1546
|
+
<member name="M:FileHelpers.FileHelperEngine.AppendToFile(System.String,System.Collections.IEnumerable)">
|
|
1547
|
+
<summary>
|
|
1548
|
+
Append an array of records to the specified file.
|
|
1549
|
+
</summary><remarks>
|
|
1550
|
+
This method open, seek ends, write and close the file (don't open or close the file before or after to call this method)
|
|
1551
|
+
</remarks><example>
|
|
1552
|
+
This example show the basic use of the library with minimun code:
|
|
1553
|
+
<code>
|
|
1554
|
+
<textarea name="code" class="c#">
|
|
1555
|
+
|
|
1556
|
+
using FileHelpers;
|
|
1557
|
+
|
|
1558
|
+
// First declare the record class
|
|
1559
|
+
|
|
1560
|
+
[Delimitedrecord("|")]
|
|
1561
|
+
public class SampleType
|
|
1562
|
+
{
|
|
1563
|
+
public string Field1;
|
|
1564
|
+
public int Field2;
|
|
1565
|
+
}
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
public void AppendExample()
|
|
1569
|
+
{
|
|
1570
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
1571
|
+
|
|
1572
|
+
SampleType[] records = new SampleType[1];
|
|
1573
|
+
|
|
1574
|
+
records[0] = new SampleType();
|
|
1575
|
+
|
|
1576
|
+
records[0].Field1 = "Hello World";
|
|
1577
|
+
records[0].Field2 = 12;
|
|
1578
|
+
|
|
1579
|
+
engine.AppendToFile("destination.txt", records);
|
|
1580
|
+
|
|
1581
|
+
// Now the file contains have one more record at the end:
|
|
1582
|
+
//
|
|
1583
|
+
// Hello World,12
|
|
1584
|
+
|
|
1585
|
+
}
|
|
1586
|
+
|
|
1587
|
+
</textarea>
|
|
1588
|
+
</code>
|
|
1589
|
+
</example><param name="fileName">The file path to be written at end.</param><param name="records">The records to write (Can be an array, ArrayList, etc)</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
1590
|
+
</member>
|
|
1591
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadFileAsDT(System.String)">
|
|
1592
|
+
<summary>
|
|
1593
|
+
Read the records of the file and fill a DataTable with them
|
|
1594
|
+
</summary>
|
|
1595
|
+
<param name="fileName">The file name.</param>
|
|
1596
|
+
<returns>The DataTable with the read records.</returns>
|
|
1597
|
+
</member>
|
|
1598
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadFileAsDT(System.String,System.Int32)">
|
|
1599
|
+
<summary>
|
|
1600
|
+
Read the records of the file and fill a DataTable with them
|
|
1601
|
+
</summary>
|
|
1602
|
+
<param name="fileName">The file name.</param>
|
|
1603
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
1604
|
+
<returns>The DataTable with the read records.</returns>
|
|
1605
|
+
</member>
|
|
1606
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadStringAsDT(System.String)">
|
|
1607
|
+
<summary>
|
|
1608
|
+
Read the records of a string and fill a DataTable with them.
|
|
1609
|
+
</summary>
|
|
1610
|
+
<param name="source">The source string with the records.</param>
|
|
1611
|
+
<returns>The DataTable with the read records.</returns>
|
|
1612
|
+
</member>
|
|
1613
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadStringAsDT(System.String,System.Int32)">
|
|
1614
|
+
<summary>
|
|
1615
|
+
Read the records of a string and fill a DataTable with them.
|
|
1616
|
+
</summary>
|
|
1617
|
+
<param name="source">The source string with the records.</param>
|
|
1618
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
1619
|
+
<returns>The DataTable with the read records.</returns>
|
|
1620
|
+
</member>
|
|
1621
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadStreamAsDT(System.IO.TextReader)">
|
|
1622
|
+
<summary>
|
|
1623
|
+
Read the records of the stream and fill a DataTable with them
|
|
1624
|
+
</summary>
|
|
1625
|
+
<param name="reader">The stream with the source records.</param>
|
|
1626
|
+
<returns>The DataTable with the read records.</returns>
|
|
1627
|
+
</member>
|
|
1628
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadStreamAsDT(System.IO.TextReader,System.Int32)">
|
|
1629
|
+
<summary>
|
|
1630
|
+
Read the records of the stream and fill a DataTable with them
|
|
1631
|
+
</summary>
|
|
1632
|
+
<param name="reader">The stream with the source records.</param>
|
|
1633
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
1634
|
+
<returns>The DataTable with the read records.</returns>
|
|
1635
|
+
</member>
|
|
1636
|
+
<member name="E:FileHelpers.FileHelperEngine.BeforeReadRecord">
|
|
1637
|
+
<summary>Called in read operations just before the record string is translated to a record.</summary>
|
|
1638
|
+
</member>
|
|
1639
|
+
<member name="E:FileHelpers.FileHelperEngine.AfterReadRecord">
|
|
1640
|
+
<summary>Called in read operations just after the record was created from a record string.</summary>
|
|
1641
|
+
</member>
|
|
1642
|
+
<member name="E:FileHelpers.FileHelperEngine.BeforeWriteRecord">
|
|
1643
|
+
<summary>Called in write operations just before the record is converted to a string to write it.</summary>
|
|
1644
|
+
</member>
|
|
1645
|
+
<member name="E:FileHelpers.FileHelperEngine.AfterWriteRecord">
|
|
1646
|
+
<summary>Called in write operations just after the record was converted to a string.</summary>
|
|
1647
|
+
</member>
|
|
1648
|
+
<member name="P:FileHelpers.FileHelperEngine.Options">
|
|
1649
|
+
<summary>
|
|
1650
|
+
Allows to change some record layout options at runtime
|
|
1651
|
+
</summary>
|
|
1652
|
+
</member>
|
|
1653
|
+
<member name="M:FileHelpers.CsvEngine.CsvToDataTable(System.String,System.Char)">
|
|
1654
|
+
<summary>Reads a Csv File and return their contents as DataTable (The file must have the field names in the first row)</summary>
|
|
1655
|
+
<param name="delimiter">The delimiter for each field</param>
|
|
1656
|
+
<param name="filename">The file to read.</param>
|
|
1657
|
+
<returns>The contents of the file as a DataTable</returns>
|
|
1658
|
+
</member>
|
|
1659
|
+
<member name="M:FileHelpers.CsvEngine.CsvToDataTable(System.String,System.String,System.Char)">
|
|
1660
|
+
<summary>Reads a Csv File and return their contents as DataTable (The file must have the field names in the first row)</summary>
|
|
1661
|
+
<param name="classname">The name of the record class</param>
|
|
1662
|
+
<param name="delimiter">The delimiter for each field</param>
|
|
1663
|
+
<param name="filename">The file to read.</param>
|
|
1664
|
+
<returns>The contents of the file as a DataTable</returns>
|
|
1665
|
+
</member>
|
|
1666
|
+
<member name="M:FileHelpers.CsvEngine.CsvToDataTable(System.String,System.String,System.Char,System.Boolean)">
|
|
1667
|
+
<summary>Reads a Csv File and return their contents as DataTable</summary>
|
|
1668
|
+
<param name="classname">The name of the record class</param>
|
|
1669
|
+
<param name="delimiter">The delimiter for each field</param>
|
|
1670
|
+
<param name="filename">The file to read.</param>
|
|
1671
|
+
<param name="hasHeader">Indicates if the file contains a header with the field names.</param>
|
|
1672
|
+
<returns>The contents of the file as a DataTable</returns>
|
|
1673
|
+
</member>
|
|
1674
|
+
<member name="M:FileHelpers.CsvEngine.CsvToDataTable(System.String,FileHelpers.CsvOptions)">
|
|
1675
|
+
<summary>Reads a Csv File and return their contents as DataTable</summary>
|
|
1676
|
+
<param name="filename">The file to read.</param>
|
|
1677
|
+
<param name="options">The options used to create the record mapping class.</param>
|
|
1678
|
+
<returns>The contents of the file as a DataTable</returns>
|
|
1679
|
+
</member>
|
|
1680
|
+
<member name="M:FileHelpers.CsvEngine.DataTableToCsv(System.Data.DataTable,System.String)">
|
|
1681
|
+
<summary>Simply dumps the DataTable contents to a delimited file using a ',' as delimiter.</summary>
|
|
1682
|
+
<param name="dt">The source Data Table</param>
|
|
1683
|
+
<param name="filename">The destination file.</param>
|
|
1684
|
+
</member>
|
|
1685
|
+
<member name="M:FileHelpers.CsvEngine.DataTableToCsv(System.Data.DataTable,System.String,FileHelpers.CsvOptions)">
|
|
1686
|
+
<summary>Simply dumps the DataTable contents to a delimited file. Only allows to set the delimiter.</summary>
|
|
1687
|
+
<param name="dt">The source Data Table</param>
|
|
1688
|
+
<param name="filename">The destination file.</param>
|
|
1689
|
+
<param name="options">The options used to write the file</param>
|
|
1690
|
+
</member>
|
|
1691
|
+
<member name="M:FileHelpers.CsvEngine.#ctor(System.String,System.Char,System.String)">
|
|
1692
|
+
<summary>Create a CsvEngine using the specified sample file with their headers.</summary>
|
|
1693
|
+
<param name="className">The name of the record class</param>
|
|
1694
|
+
<param name="delimiter">The delimiter for each field</param>
|
|
1695
|
+
<param name="sampleFile">A sample file with a header that contains the names of the fields.</param>
|
|
1696
|
+
</member>
|
|
1697
|
+
<member name="M:FileHelpers.CsvEngine.#ctor(System.String,System.Char,System.Int32)">
|
|
1698
|
+
<summary>Create a CsvEngine using the specified number of fields.</summary>
|
|
1699
|
+
<param name="className">The name of the record class</param>
|
|
1700
|
+
<param name="delimiter">The delimiter for each field</param>
|
|
1701
|
+
<param name="numberOfFields">The number of fields of each record</param>
|
|
1702
|
+
</member>
|
|
1703
|
+
<member name="M:FileHelpers.CsvEngine.#ctor(FileHelpers.CsvOptions)">
|
|
1704
|
+
<summary>Create a CsvEngine using the specified sample file with their headers.</summary>
|
|
1705
|
+
<param name="options">The options used to create the record mapping class.</param>
|
|
1706
|
+
</member>
|
|
1707
|
+
<member name="T:FileHelpers.DelimitedFileEngine">
|
|
1708
|
+
<summary>
|
|
1709
|
+
Is a version of the <see cref="T:FileHelpers.FileHelperEngine"/> exclusive for
|
|
1710
|
+
delimited records that allow you to change the delimiter an other options at runtime
|
|
1711
|
+
</summary>
|
|
1712
|
+
<remarks>
|
|
1713
|
+
Useful when you need to export or import the same info with 2 or more different delimiters or little different options.
|
|
1714
|
+
</remarks>
|
|
1715
|
+
</member>
|
|
1716
|
+
<member name="M:FileHelpers.DelimitedFileEngine.#ctor(System.Type)">
|
|
1717
|
+
<summary>
|
|
1718
|
+
Create a version of the <see cref="T:FileHelpers.FileHelperEngine"/> exclusive for
|
|
1719
|
+
delimited records that allow you to change the delimiter an other options at runtime
|
|
1720
|
+
</summary>
|
|
1721
|
+
<remarks>
|
|
1722
|
+
Useful when you need to export or import the same info with 2 or more different delimiters.
|
|
1723
|
+
</remarks>
|
|
1724
|
+
<param name="recordType">The record mapping class.</param>
|
|
1725
|
+
</member>
|
|
1726
|
+
<member name="P:FileHelpers.DelimitedFileEngine.Options">
|
|
1727
|
+
<summary>Allow changes in the record layout like delimiters and others common settings.</summary>
|
|
1728
|
+
</member>
|
|
1729
|
+
<member name="T:FileHelpers.FileDiffEngine">
|
|
1730
|
+
<summary>Engine used to create diff files based on the <see cref="T:FileHelpers.IComparableRecord"/> interface.</summary>
|
|
1731
|
+
</member>
|
|
1732
|
+
<member name="M:FileHelpers.FileDiffEngine.#ctor(System.Type)">
|
|
1733
|
+
<summary>
|
|
1734
|
+
Creates a new <see cref="T:FileHelpers.FileDiffEngine"/>
|
|
1735
|
+
</summary>
|
|
1736
|
+
<param name="recordType">The record type class that implements the <see cref="T:FileHelpers.IComparableRecord"/> interface.</param>
|
|
1737
|
+
</member>
|
|
1738
|
+
<member name="M:FileHelpers.FileDiffEngine.OnlyNewRecords(System.String,System.String)">
|
|
1739
|
+
<summary>Returns the records in newFile that not are in the sourceFile</summary>
|
|
1740
|
+
<param name="sourceFile">The file with the old records.</param>
|
|
1741
|
+
<param name="newFile">The file with the new records.</param>
|
|
1742
|
+
<returns>The records in newFile that not are in the sourceFile</returns>
|
|
1743
|
+
</member>
|
|
1744
|
+
<member name="M:FileHelpers.FileDiffEngine.OnlyMissingRecords(System.String,System.String)">
|
|
1745
|
+
<summary>Returns the records in newFile that not are in the sourceFile</summary>
|
|
1746
|
+
<param name="sourceFile">The file with the old records.</param>
|
|
1747
|
+
<param name="newFile">The file with the new records.</param>
|
|
1748
|
+
<returns>The records in newFile that not are in the sourceFile</returns>
|
|
1749
|
+
</member>
|
|
1750
|
+
<member name="M:FileHelpers.FileDiffEngine.OnlyDuplicatedRecords(System.String,System.String)">
|
|
1751
|
+
<summary>
|
|
1752
|
+
Returns the duplicated records in both files.
|
|
1753
|
+
</summary>
|
|
1754
|
+
<param name="file1">A file with record.</param>
|
|
1755
|
+
<param name="file2">A file with record.</param>
|
|
1756
|
+
<returns>The records that appear in both files.</returns>
|
|
1757
|
+
</member>
|
|
1758
|
+
<member name="M:FileHelpers.FileDiffEngine.OnlyNoDuplicatedRecords(System.String,System.String)">
|
|
1759
|
+
<summary>
|
|
1760
|
+
Returns the NON duplicated records in both files.
|
|
1761
|
+
</summary>
|
|
1762
|
+
<param name="file1">A file with record.</param>
|
|
1763
|
+
<param name="file2">A file with record.</param>
|
|
1764
|
+
<returns>The records that NOT appear in both files.</returns>
|
|
1765
|
+
</member>
|
|
1766
|
+
<member name="M:FileHelpers.FileDiffEngine.WriteNewRecords(System.String,System.String,System.String)">
|
|
1767
|
+
<summary>Read the source file, the new file, get the new records and write them to a destination file.</summary>
|
|
1768
|
+
<param name="sourceFile">The file with the source records.</param>
|
|
1769
|
+
<param name="newFile">The file with the new records.</param>
|
|
1770
|
+
<param name="destFile">The destination file.</param>
|
|
1771
|
+
<returns>The new records on the new file.</returns>
|
|
1772
|
+
</member>
|
|
1773
|
+
<member name="T:FileHelpers.FileHelperAsyncEngine">
|
|
1774
|
+
<summary>
|
|
1775
|
+
<para><b>One of the main classes of the library.</b></para>
|
|
1776
|
+
<para>This engine is responsable to Read/Write the records <b>One by One</b> from/to files or streams.</para>
|
|
1777
|
+
</summary><remarks>
|
|
1778
|
+
<para>You can set the <see cref="P:FileHelpers.ErrorManager.ErrorMode"/> of this class when found an error, and can retrive them with the <see cref="P:FileHelpers.ErrorManager.Errors"/> property.</para>
|
|
1779
|
+
<para>See in the <a href="class_diagram.html">Class Diagram</a> and in the <a href="quick_start.html">Quick Start Guide</a> for more Info.</para>
|
|
1780
|
+
<para>Or you can browse the <a href="examples.html">Examples Seccion</a> for more code.</para>
|
|
1781
|
+
</remarks><seealso href="quick_start.html">Quick Start Guide</seealso><seealso href="class_diagram.html">Class Diagram</seealso><seealso href="examples.html">Examples of Use</seealso><seealso href="attributes.html">Attributes List</seealso>
|
|
1782
|
+
<example>
|
|
1783
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1784
|
+
<code>
|
|
1785
|
+
<textarea name="code" class="c#">
|
|
1786
|
+
|
|
1787
|
+
using FileHelpers;
|
|
1788
|
+
|
|
1789
|
+
// First declare the record class
|
|
1790
|
+
|
|
1791
|
+
[Delimitedrecord("|")]
|
|
1792
|
+
public class SampleType
|
|
1793
|
+
{
|
|
1794
|
+
public string Field1;
|
|
1795
|
+
public int Field2;
|
|
1796
|
+
}
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
public void ReadExample()
|
|
1800
|
+
{
|
|
1801
|
+
SampleType record;
|
|
1802
|
+
|
|
1803
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1804
|
+
|
|
1805
|
+
engine.BeginReadFile("source.txt");
|
|
1806
|
+
|
|
1807
|
+
while( engine.ReadNext() != null )
|
|
1808
|
+
{
|
|
1809
|
+
record = (SampleType) engine.LastRecord;
|
|
1810
|
+
|
|
1811
|
+
// put your code here !!!!
|
|
1812
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
1813
|
+
|
|
1814
|
+
}
|
|
1815
|
+
|
|
1816
|
+
engine.Close();
|
|
1817
|
+
}
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
public void WriteExample()
|
|
1821
|
+
{
|
|
1822
|
+
SampleType record;
|
|
1823
|
+
|
|
1824
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1825
|
+
|
|
1826
|
+
engine.BeginWriteFile("source.txt");
|
|
1827
|
+
|
|
1828
|
+
record.Field1 = "Primer Registro";
|
|
1829
|
+
record.Field2 = 1;
|
|
1830
|
+
engine.WriteNext(record);
|
|
1831
|
+
|
|
1832
|
+
record.Field1 = "Segundo Registro";
|
|
1833
|
+
record.Field2 = 2;
|
|
1834
|
+
engine.WriteNext(record);
|
|
1835
|
+
|
|
1836
|
+
engine.Close();
|
|
1837
|
+
}
|
|
1838
|
+
|
|
1839
|
+
</textarea>
|
|
1840
|
+
</code>
|
|
1841
|
+
</example>
|
|
1842
|
+
</member>
|
|
1843
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.#ctor(System.Type)">
|
|
1844
|
+
<summary>
|
|
1845
|
+
Initializes a new instance of the FileHelperEngine class with the specified type of records.
|
|
1846
|
+
</summary><param name="recordType">The record mapping class.</param>
|
|
1847
|
+
</member>
|
|
1848
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.#ctor(System.Type,System.Text.Encoding)">
|
|
1849
|
+
<summary>
|
|
1850
|
+
Initializes a new instance of the FileHelperEngine class with the specified type of records.
|
|
1851
|
+
</summary><param name="recordType">The record mapping class.</param>
|
|
1852
|
+
<param name="encoding">The encoding used by the Engine.</param>
|
|
1853
|
+
</member>
|
|
1854
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginReadStream(System.IO.TextReader)">
|
|
1855
|
+
<summary>
|
|
1856
|
+
Open a specified stream and seek to the first record.
|
|
1857
|
+
</summary><remarks>
|
|
1858
|
+
<para>This method only seek to the first record.</para>
|
|
1859
|
+
<para>To read record by record use <b><see cref="M:FileHelpers.FileHelperAsyncEngine.ReadNext"/></b> method.</para>
|
|
1860
|
+
<para>When you stop to read the file you must call <b><see cref="M:FileHelpers.FileHelperAsyncEngine.Close"/></b> method.</para>
|
|
1861
|
+
</remarks><param name="reader">The TextReader of the stream.</param><example>
|
|
1862
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1863
|
+
<code>
|
|
1864
|
+
<textarea name="code" class="c#">
|
|
1865
|
+
|
|
1866
|
+
using FileHelpers;
|
|
1867
|
+
|
|
1868
|
+
// First declare the record class
|
|
1869
|
+
|
|
1870
|
+
[Delimitedrecord("|")]
|
|
1871
|
+
public class SampleType
|
|
1872
|
+
{
|
|
1873
|
+
public string Field1;
|
|
1874
|
+
public int Field2;
|
|
1875
|
+
}
|
|
1876
|
+
|
|
1877
|
+
|
|
1878
|
+
public void ReadExample()
|
|
1879
|
+
{
|
|
1880
|
+
SampleType record;
|
|
1881
|
+
|
|
1882
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1883
|
+
|
|
1884
|
+
engine.BeginReadFile("source.txt");
|
|
1885
|
+
|
|
1886
|
+
while( engine.ReadNext() != null )
|
|
1887
|
+
{
|
|
1888
|
+
record = (SampleType) engine.LastRecord;
|
|
1889
|
+
|
|
1890
|
+
// put your code here !!!!
|
|
1891
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
1892
|
+
|
|
1893
|
+
}
|
|
1894
|
+
|
|
1895
|
+
engine.Close();
|
|
1896
|
+
}
|
|
1897
|
+
|
|
1898
|
+
</textarea>
|
|
1899
|
+
</code>
|
|
1900
|
+
</example>
|
|
1901
|
+
</member>
|
|
1902
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginReadFile(System.String)">
|
|
1903
|
+
<summary>
|
|
1904
|
+
Open a specified file and seek to the first record.
|
|
1905
|
+
</summary><remarks>
|
|
1906
|
+
<para>This method only open the file.</para>
|
|
1907
|
+
<para>To read record by record use <b><see cref="M:FileHelpers.FileHelperAsyncEngine.ReadNext"/></b> method.</para>
|
|
1908
|
+
<para>When you stop to read the file you must call <b><see cref="M:FileHelpers.FileHelperAsyncEngine.Close"/></b> method.</para>
|
|
1909
|
+
</remarks><param name="fileName">The file path to be read.</param><returns>True if the file is succefully opened. False otherway.</returns><example>
|
|
1910
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1911
|
+
<code>
|
|
1912
|
+
<textarea name="code" class="c#">
|
|
1913
|
+
|
|
1914
|
+
using FileHelpers;
|
|
1915
|
+
|
|
1916
|
+
// First declare the record class
|
|
1917
|
+
|
|
1918
|
+
[Delimitedrecord("|")]
|
|
1919
|
+
public class SampleType
|
|
1920
|
+
{
|
|
1921
|
+
public string Field1;
|
|
1922
|
+
public int Field2;
|
|
1923
|
+
}
|
|
1924
|
+
|
|
1925
|
+
|
|
1926
|
+
public void ReadExample()
|
|
1927
|
+
{
|
|
1928
|
+
SampleType record;
|
|
1929
|
+
|
|
1930
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1931
|
+
|
|
1932
|
+
engine.BeginReadFile("source.txt");
|
|
1933
|
+
|
|
1934
|
+
while( engine.ReadNext() != null )
|
|
1935
|
+
{
|
|
1936
|
+
record = (SampleType) engine.LastRecord;
|
|
1937
|
+
|
|
1938
|
+
// put your code here !!!!
|
|
1939
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
1940
|
+
|
|
1941
|
+
}
|
|
1942
|
+
|
|
1943
|
+
engine.Close();
|
|
1944
|
+
}
|
|
1945
|
+
|
|
1946
|
+
</textarea>
|
|
1947
|
+
</code>
|
|
1948
|
+
</example>
|
|
1949
|
+
</member>
|
|
1950
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginReadString(System.String)">
|
|
1951
|
+
<!-- No matching elements were found for the following include tag --><include file="FileHelperAsyncEngine.docs.xml" path="doc/BeginReadString/*"/>
|
|
1952
|
+
</member>
|
|
1953
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.ReadNext">
|
|
1954
|
+
<summary>
|
|
1955
|
+
Reads the next record of a file opened with the <see cref="M:FileHelpers.FileHelperAsyncEngine.BeginReadFile(System.String)"/> or <see cref="M:FileHelpers.FileHelperAsyncEngine.BeginReadStream(System.IO.TextReader)"/> method.
|
|
1956
|
+
</summary><remarks>
|
|
1957
|
+
<para>This method not only returns the current record, also moves to the next.</para>
|
|
1958
|
+
<para>If the end of file is reached this method return <b>null</b>.</para>
|
|
1959
|
+
</remarks><returns>The current record of the opened file.</returns><example>
|
|
1960
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1961
|
+
<code>
|
|
1962
|
+
<textarea name="code" class="c#">
|
|
1963
|
+
|
|
1964
|
+
using FileHelpers;
|
|
1965
|
+
|
|
1966
|
+
// First declare the record class
|
|
1967
|
+
|
|
1968
|
+
[Delimitedrecord("|")]
|
|
1969
|
+
public class SampleType
|
|
1970
|
+
{
|
|
1971
|
+
public string Field1;
|
|
1972
|
+
public int Field2;
|
|
1973
|
+
}
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
public void ReadExample()
|
|
1977
|
+
{
|
|
1978
|
+
SampleType record;
|
|
1979
|
+
|
|
1980
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1981
|
+
|
|
1982
|
+
engine.BeginReadFile("source.txt");
|
|
1983
|
+
|
|
1984
|
+
while( engine.ReadNext() != null )
|
|
1985
|
+
{
|
|
1986
|
+
record = (SampleType) engine.LastRecord;
|
|
1987
|
+
|
|
1988
|
+
// put your code here !!!!
|
|
1989
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
1990
|
+
|
|
1991
|
+
}
|
|
1992
|
+
|
|
1993
|
+
engine.Close();
|
|
1994
|
+
}
|
|
1995
|
+
|
|
1996
|
+
</textarea>
|
|
1997
|
+
</code>
|
|
1998
|
+
</example>
|
|
1999
|
+
</member>
|
|
2000
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.ReadNexts(System.Int32)">
|
|
2001
|
+
<summary>
|
|
2002
|
+
Reads the specified number of records from a file or stream opened with the <see cref="M:FileHelpers.FileHelperAsyncEngine.BeginReadFile(System.String)"/> or <see cref="M:FileHelpers.FileHelperAsyncEngine.BeginReadStream(System.IO.TextReader)"/> method.
|
|
2003
|
+
</summary><remarks>
|
|
2004
|
+
If there are less records in the source, read to the end.
|
|
2005
|
+
</remarks><param name="numberOfRecords">The number of records to read. If there are less records in the source, read to the end.</param><returns>The nexts records of the opened file or stream.</returns>
|
|
2006
|
+
</member>
|
|
2007
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.Flush">
|
|
2008
|
+
<summary>
|
|
2009
|
+
Save all the buffered data for write to the disk.
|
|
2010
|
+
Useful to long opened async engines that wants to save pending values or for engines used for logging.
|
|
2011
|
+
</summary>
|
|
2012
|
+
</member>
|
|
2013
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.Close">
|
|
2014
|
+
<summary>
|
|
2015
|
+
Close all opened stream readers and writters (if any).
|
|
2016
|
+
</summary><remarks>
|
|
2017
|
+
<para>This method must be called when you finish to process a file to dispose the opened streams.</para>
|
|
2018
|
+
</remarks><example>
|
|
2019
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
2020
|
+
<code>
|
|
2021
|
+
<textarea name="code" class="c#">
|
|
2022
|
+
|
|
2023
|
+
using FileHelpers;
|
|
2024
|
+
|
|
2025
|
+
// First declare the record class
|
|
2026
|
+
|
|
2027
|
+
[Delimitedrecord("|")]
|
|
2028
|
+
public class SampleType
|
|
2029
|
+
{
|
|
2030
|
+
public string Field1;
|
|
2031
|
+
public int Field2;
|
|
2032
|
+
}
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
public void ReadExample()
|
|
2036
|
+
{
|
|
2037
|
+
SampleType record;
|
|
2038
|
+
|
|
2039
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
2040
|
+
|
|
2041
|
+
engine.BeginReadFile("source.txt");
|
|
2042
|
+
|
|
2043
|
+
while( engine.ReadNext() != null )
|
|
2044
|
+
{
|
|
2045
|
+
record = (SampleType) engine.LastRecord;
|
|
2046
|
+
|
|
2047
|
+
// put your code here !!!!
|
|
2048
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
2049
|
+
|
|
2050
|
+
}
|
|
2051
|
+
|
|
2052
|
+
engine.Close();
|
|
2053
|
+
}
|
|
2054
|
+
|
|
2055
|
+
</textarea>
|
|
2056
|
+
</code>
|
|
2057
|
+
</example>
|
|
2058
|
+
</member>
|
|
2059
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginWriteStream(System.IO.TextWriter)">
|
|
2060
|
+
<summary>
|
|
2061
|
+
Set the stream to be used in the <see cref="M:FileHelpers.FileHelperAsyncEngine.WriteNext(System.Object)"/> operation.
|
|
2062
|
+
</summary><remarks>
|
|
2063
|
+
<para>When you finish to write to the file you must call <b><see cref="M:FileHelpers.FileHelperAsyncEngine.Close"/></b> method.</para>
|
|
2064
|
+
</remarks><param name="writer">To stream to writes to.</param><example>
|
|
2065
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
2066
|
+
<code>
|
|
2067
|
+
<textarea name="code" class="c#">
|
|
2068
|
+
|
|
2069
|
+
using FileHelpers;
|
|
2070
|
+
|
|
2071
|
+
// First declare the record class
|
|
2072
|
+
|
|
2073
|
+
[Delimitedrecord("|")]
|
|
2074
|
+
public class SampleType
|
|
2075
|
+
{
|
|
2076
|
+
public string Field1;
|
|
2077
|
+
public int Field2;
|
|
2078
|
+
}
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
public void WriteExample()
|
|
2082
|
+
{
|
|
2083
|
+
SampleType record;
|
|
2084
|
+
|
|
2085
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
2086
|
+
|
|
2087
|
+
engine.BeginWriteFile("source.txt");
|
|
2088
|
+
|
|
2089
|
+
record.Field1 = "Primer Registro";
|
|
2090
|
+
record.Field2 = 1;
|
|
2091
|
+
engine.WriteNext(record);
|
|
2092
|
+
|
|
2093
|
+
record.Field1 = "Segundo Registro";
|
|
2094
|
+
record.Field2 = 2;
|
|
2095
|
+
engine.WriteNext(record);
|
|
2096
|
+
|
|
2097
|
+
engine.Close();
|
|
2098
|
+
}
|
|
2099
|
+
|
|
2100
|
+
</textarea>
|
|
2101
|
+
</code>
|
|
2102
|
+
</example>
|
|
2103
|
+
</member>
|
|
2104
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginWriteFile(System.String)">
|
|
2105
|
+
<summary>
|
|
2106
|
+
Open a file to write it. If exist the engine override it
|
|
2107
|
+
</summary><remarks>
|
|
2108
|
+
<para>When you finish to write to the file you must call <b><see cref="M:FileHelpers.FileHelperAsyncEngine.Close"/></b> method.</para>
|
|
2109
|
+
</remarks><param name="fileName">The file path to be opened to write.</param><example>
|
|
2110
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
2111
|
+
<code>
|
|
2112
|
+
<textarea name="code" class="c#">
|
|
2113
|
+
|
|
2114
|
+
using FileHelpers;
|
|
2115
|
+
|
|
2116
|
+
// First declare the record class
|
|
2117
|
+
|
|
2118
|
+
[Delimitedrecord("|")]
|
|
2119
|
+
public class SampleType
|
|
2120
|
+
{
|
|
2121
|
+
public string Field1;
|
|
2122
|
+
public int Field2;
|
|
2123
|
+
}
|
|
2124
|
+
|
|
2125
|
+
|
|
2126
|
+
public void WriteExample()
|
|
2127
|
+
{
|
|
2128
|
+
SampleType record;
|
|
2129
|
+
|
|
2130
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
2131
|
+
|
|
2132
|
+
engine.BeginWriteFile("source.txt");
|
|
2133
|
+
|
|
2134
|
+
record.Field1 = "Primer Registro";
|
|
2135
|
+
record.Field2 = 1;
|
|
2136
|
+
engine.WriteNext(record);
|
|
2137
|
+
|
|
2138
|
+
record.Field1 = "Segundo Registro";
|
|
2139
|
+
record.Field2 = 2;
|
|
2140
|
+
engine.WriteNext(record);
|
|
2141
|
+
|
|
2142
|
+
engine.Close();
|
|
2143
|
+
}
|
|
2144
|
+
|
|
2145
|
+
</textarea>
|
|
2146
|
+
</code>
|
|
2147
|
+
</example>
|
|
2148
|
+
</member>
|
|
2149
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginAppendToFile(System.String)">
|
|
2150
|
+
<summary>
|
|
2151
|
+
Open a file to Append to the end.
|
|
2152
|
+
</summary><remarks>
|
|
2153
|
+
<para>This method open and seek ends the file.</para>
|
|
2154
|
+
<para>When you finish to append to the file you must call <b><see cref="M:FileHelpers.FileHelperAsyncEngine.Close"/></b> method.</para>
|
|
2155
|
+
</remarks><param name="fileName">The file path to be opened to write at the end.</param>
|
|
2156
|
+
</member>
|
|
2157
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.WriteNext(System.Object)">
|
|
2158
|
+
<summary>
|
|
2159
|
+
Write the next record to a file or stream opened with <see cref="M:FileHelpers.FileHelperAsyncEngine.BeginWriteFile(System.String)"/>, <see cref="M:FileHelpers.FileHelperAsyncEngine.BeginWriteStream(System.IO.TextWriter)"/> or <see cref="M:FileHelpers.FileHelperAsyncEngine.BeginAppendToFile(System.String)"/> method.
|
|
2160
|
+
</summary><param name="record">The record to write.</param><example>
|
|
2161
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
2162
|
+
<code>
|
|
2163
|
+
<textarea name="code" class="c#">
|
|
2164
|
+
|
|
2165
|
+
using FileHelpers;
|
|
2166
|
+
|
|
2167
|
+
// First declare the record class
|
|
2168
|
+
|
|
2169
|
+
[Delimitedrecord("|")]
|
|
2170
|
+
public class SampleType
|
|
2171
|
+
{
|
|
2172
|
+
public string Field1;
|
|
2173
|
+
public int Field2;
|
|
2174
|
+
}
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
public void WriteExample()
|
|
2178
|
+
{
|
|
2179
|
+
SampleType record;
|
|
2180
|
+
|
|
2181
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
2182
|
+
|
|
2183
|
+
engine.BeginWriteFile("source.txt");
|
|
2184
|
+
|
|
2185
|
+
record.Field1 = "Primer Registro";
|
|
2186
|
+
record.Field2 = 1;
|
|
2187
|
+
engine.WriteNext(record);
|
|
2188
|
+
|
|
2189
|
+
record.Field1 = "Segundo Registro";
|
|
2190
|
+
record.Field2 = 2;
|
|
2191
|
+
engine.WriteNext(record);
|
|
2192
|
+
|
|
2193
|
+
engine.Close();
|
|
2194
|
+
}
|
|
2195
|
+
|
|
2196
|
+
</textarea>
|
|
2197
|
+
</code>
|
|
2198
|
+
</example>
|
|
2199
|
+
</member>
|
|
2200
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.WriteNexts(System.Collections.IEnumerable)">
|
|
2201
|
+
<summary>
|
|
2202
|
+
Write the nexts records to a file or stream opened with <see cref="M:FileHelpers.FileHelperAsyncEngine.BeginWriteFile(System.String)"/>, <see cref="M:FileHelpers.FileHelperAsyncEngine.BeginWriteStream(System.IO.TextWriter)"/> or <see cref="M:FileHelpers.FileHelperAsyncEngine.BeginAppendToFile(System.String)"/> method.
|
|
2203
|
+
</summary><param name="records">The records to write (Can be an array, ArrayList, etc)</param>
|
|
2204
|
+
</member>
|
|
2205
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.System#Collections#IEnumerable#GetEnumerator">
|
|
2206
|
+
<summary>Allows to loop record by record in the engine</summary>
|
|
2207
|
+
<returns>The enumerator</returns>
|
|
2208
|
+
</member>
|
|
2209
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.System#IDisposable#Dispose">
|
|
2210
|
+
<summary>Release Resources</summary>
|
|
2211
|
+
</member>
|
|
2212
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.Finalize">
|
|
2213
|
+
<summary>Destructor</summary>
|
|
2214
|
+
</member>
|
|
2215
|
+
<member name="P:FileHelpers.FileHelperAsyncEngine.LastRecord">
|
|
2216
|
+
<summary>Contains the last Record read by the <see cref="M:FileHelpers.FileHelperAsyncEngine.ReadNext"/> method.</summary><example>
|
|
2217
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
2218
|
+
<code>
|
|
2219
|
+
<textarea name="code" class="c#">
|
|
2220
|
+
|
|
2221
|
+
using FileHelpers;
|
|
2222
|
+
|
|
2223
|
+
// First declare the record class
|
|
2224
|
+
|
|
2225
|
+
[Delimitedrecord("|")]
|
|
2226
|
+
public class SampleType
|
|
2227
|
+
{
|
|
2228
|
+
public string Field1;
|
|
2229
|
+
public int Field2;
|
|
2230
|
+
}
|
|
2231
|
+
|
|
2232
|
+
|
|
2233
|
+
public void ReadExample()
|
|
2234
|
+
{
|
|
2235
|
+
SampleType record;
|
|
2236
|
+
|
|
2237
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
2238
|
+
|
|
2239
|
+
engine.BeginReadFile("source.txt");
|
|
2240
|
+
|
|
2241
|
+
while( engine.ReadNext() != null )
|
|
2242
|
+
{
|
|
2243
|
+
record = (SampleType) engine.LastRecord;
|
|
2244
|
+
|
|
2245
|
+
// put your code here !!!!
|
|
2246
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
2247
|
+
|
|
2248
|
+
}
|
|
2249
|
+
|
|
2250
|
+
engine.Close();
|
|
2251
|
+
}
|
|
2252
|
+
|
|
2253
|
+
</textarea>
|
|
2254
|
+
</code>
|
|
2255
|
+
</example>
|
|
2256
|
+
</member>
|
|
2257
|
+
<member name="T:FileHelpers.FileTransformEngine">
|
|
2258
|
+
<summary>
|
|
2259
|
+
This class allow you to convert the records of a file to a different record format.
|
|
2260
|
+
</summary>
|
|
2261
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
2262
|
+
<seealso href="class_diagram.html">Class Diagram</seealso>
|
|
2263
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
2264
|
+
<seealso href="example_datalink.html">Example of the DataLink</seealso>
|
|
2265
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
2266
|
+
</member>
|
|
2267
|
+
<member name="M:FileHelpers.FileTransformEngine.#ctor(System.Type,System.Type)">
|
|
2268
|
+
<summary>Create a new instance of the class.</summary>
|
|
2269
|
+
<param name="sourceType">The source record Type.</param>
|
|
2270
|
+
<param name="destType">The destination record Type.</param>
|
|
2271
|
+
</member>
|
|
2272
|
+
<member name="M:FileHelpers.FileTransformEngine.TransformFile(System.String,System.String)">
|
|
2273
|
+
<summary>Transform the contents of the sourceFile and write them to the destFile.(use only if you need the array of the transformed records, TransformFileAsync is faster)</summary>
|
|
2274
|
+
<param name="sourceFile">The source file.</param>
|
|
2275
|
+
<param name="destFile">The destination file.</param>
|
|
2276
|
+
<returns>The transformed records.</returns>
|
|
2277
|
+
</member>
|
|
2278
|
+
<member name="M:FileHelpers.FileTransformEngine.TransformFileAsync(System.String,System.String)">
|
|
2279
|
+
<summary>Transform the contents of the sourceFile and write them to the destFile. (faster and use less memory, best choice for big files)</summary>
|
|
2280
|
+
<param name="sourceFile">The source file.</param>
|
|
2281
|
+
<param name="destFile">The destination file.</param>
|
|
2282
|
+
<returns>The number of transformed records.</returns>
|
|
2283
|
+
</member>
|
|
2284
|
+
<member name="M:FileHelpers.FileTransformEngine.TransformRecords(System.Object[])">
|
|
2285
|
+
<summary>Transform an array of records from the source type to the destination type</summary>
|
|
2286
|
+
<param name="sourceRecords">An array of the source records.</param>
|
|
2287
|
+
<returns>The transformed records.</returns>
|
|
2288
|
+
</member>
|
|
2289
|
+
<member name="M:FileHelpers.FileTransformEngine.ReadAndTransformRecords(System.String)">
|
|
2290
|
+
<summary>Transform a file that contains source records to an array of the destination type</summary>
|
|
2291
|
+
<param name="sourceFile">A file containing the source records.</param>
|
|
2292
|
+
<returns>The transformed records.</returns>
|
|
2293
|
+
</member>
|
|
2294
|
+
<member name="P:FileHelpers.FileTransformEngine.SourceType">
|
|
2295
|
+
<summary>The source record Type.</summary>
|
|
2296
|
+
</member>
|
|
2297
|
+
<member name="P:FileHelpers.FileTransformEngine.DestinationType">
|
|
2298
|
+
<summary>The destination record Type.</summary>
|
|
2299
|
+
</member>
|
|
2300
|
+
<member name="P:FileHelpers.FileTransformEngine.SourceEncoding">
|
|
2301
|
+
<summary>The Encoding of the Source File.</summary>
|
|
2302
|
+
</member>
|
|
2303
|
+
<member name="P:FileHelpers.FileTransformEngine.DestinationEncoding">
|
|
2304
|
+
<summary>The Encoding of the Destination File.</summary>
|
|
2305
|
+
</member>
|
|
2306
|
+
<member name="T:FileHelpers.FixedFileEngine">
|
|
2307
|
+
<summary>
|
|
2308
|
+
Is a version of the <see cref="T:FileHelpers.FileHelperEngine"/> exclusive for
|
|
2309
|
+
fixed length records that allow you to change the delimiter an other options at runtime
|
|
2310
|
+
</summary>
|
|
2311
|
+
<remarks>
|
|
2312
|
+
Useful when you need to export or import the same info with little different options.
|
|
2313
|
+
</remarks>
|
|
2314
|
+
</member>
|
|
2315
|
+
<member name="M:FileHelpers.FixedFileEngine.#ctor(System.Type)">
|
|
2316
|
+
<summary>
|
|
2317
|
+
Creates a version of the <see cref="T:FileHelpers.FileHelperEngine"/> exclusive for
|
|
2318
|
+
fixed length records that allow you to change the delimiter an other options at runtime
|
|
2319
|
+
</summary>
|
|
2320
|
+
<remarks>
|
|
2321
|
+
Useful when you need to export or import the same info with little different options.
|
|
2322
|
+
</remarks>
|
|
2323
|
+
<param name="recordType">The record mapping class.</param>
|
|
2324
|
+
</member>
|
|
2325
|
+
<member name="P:FileHelpers.FixedFileEngine.Options">
|
|
2326
|
+
<summary>Allow changes some fixed length options and others common settings.</summary>
|
|
2327
|
+
</member>
|
|
2328
|
+
<member name="T:FileHelpers.RecordTypeSelector">
|
|
2329
|
+
<summary>
|
|
2330
|
+
Delegate thats determines the Type of the current record (Master, Detail, Skip)
|
|
2331
|
+
</summary>
|
|
2332
|
+
<param name="recordString">The string of the current record.</param>
|
|
2333
|
+
<param name="engine">The engine that calls the selector.</param>
|
|
2334
|
+
<returns>the action used for the current record (Master, Detail, Skip)</returns>
|
|
2335
|
+
</member>
|
|
2336
|
+
<member name="T:FileHelpers.MultiRecordEngine">
|
|
2337
|
+
<summary><para>This engine allows you to parse and write files that contain
|
|
2338
|
+
records of different types and that are in a linear relationship</para>
|
|
2339
|
+
<para>(for Master-Detail check the <see cref="T:FileHelpers.MasterDetail.MasterDetailEngine"/>)</para>
|
|
2340
|
+
</summary>
|
|
2341
|
+
<seealso href="quick_start.html">Quick Start Guide</seealso>
|
|
2342
|
+
<seealso href="class_diagram.html">Class Diagram</seealso>
|
|
2343
|
+
<seealso href="examples.html">Examples of Use</seealso>
|
|
2344
|
+
<seealso href="example_datalink.html">Example of the DataLink</seealso>
|
|
2345
|
+
<seealso href="attributes.html">Attributes List</seealso>
|
|
2346
|
+
</member>
|
|
2347
|
+
<member name="M:FileHelpers.MultiRecordEngine.#ctor(System.Type[])">
|
|
2348
|
+
<summary>Create a new instance of the MultiRecordEngine</summary>
|
|
2349
|
+
<param name="recordTypes">The Types of the records that this engine can handle.</param>
|
|
2350
|
+
</member>
|
|
2351
|
+
<member name="M:FileHelpers.MultiRecordEngine.#ctor(FileHelpers.RecordTypeSelector,System.Type[])">
|
|
2352
|
+
<summary>Create a new instance of the MultiRecordEngine</summary>
|
|
2353
|
+
<param name="recordTypes">The Types of the records that this engine can handle.</param>
|
|
2354
|
+
<param name="recordSelector">Used only in read operations. The selector indicates to the engine what Type to use in each read line.</param>
|
|
2355
|
+
</member>
|
|
2356
|
+
<member name="M:FileHelpers.MultiRecordEngine.ReadFile(System.String)">
|
|
2357
|
+
<summary>
|
|
2358
|
+
Read a File and returns the records.
|
|
2359
|
+
</summary>
|
|
2360
|
+
<param name="fileName">The file with the records.</param>
|
|
2361
|
+
<returns>The read records of the differents types all mixed.</returns>
|
|
2362
|
+
</member>
|
|
2363
|
+
<member name="M:FileHelpers.MultiRecordEngine.ReadStream(System.IO.TextReader)">
|
|
2364
|
+
<summary>
|
|
2365
|
+
Read a Stream and return an array of the contained records.
|
|
2366
|
+
</summary><remarks>
|
|
2367
|
+
This method only uses the stream and dont close them after use it, you must do it.
|
|
2368
|
+
</remarks><example>
|
|
2369
|
+
This example show the basic use of the library with minimun code:
|
|
2370
|
+
<code>
|
|
2371
|
+
<textarea name="code" class="c#">
|
|
2372
|
+
|
|
2373
|
+
using FileHelpers;
|
|
2374
|
+
|
|
2375
|
+
// First declare the record class
|
|
2376
|
+
|
|
2377
|
+
[Delimitedrecord("|")]
|
|
2378
|
+
public class SampleType
|
|
2379
|
+
{
|
|
2380
|
+
public string Field1;
|
|
2381
|
+
public int Field2;
|
|
2382
|
+
}
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
public void ReadExample()
|
|
2386
|
+
{
|
|
2387
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
2388
|
+
|
|
2389
|
+
SampleType[] records;
|
|
2390
|
+
|
|
2391
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
2392
|
+
|
|
2393
|
+
// Now "records" array contains all the records in the
|
|
2394
|
+
// sourcefile and can be acceded like this:
|
|
2395
|
+
|
|
2396
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
2397
|
+
}
|
|
2398
|
+
|
|
2399
|
+
</textarea>
|
|
2400
|
+
</code>
|
|
2401
|
+
</example><param name="reader">The reader of the source stream.</param><returns>An array of the records in the Stream</returns>
|
|
2402
|
+
</member>
|
|
2403
|
+
<member name="M:FileHelpers.MultiRecordEngine.ReadString(System.String)">
|
|
2404
|
+
<summary>
|
|
2405
|
+
Read a String and return an array of the contained records.
|
|
2406
|
+
</summary><param name="source">The string that contains the records.</param><returns>An array of the records in the String.</returns>
|
|
2407
|
+
</member>
|
|
2408
|
+
<member name="M:FileHelpers.MultiRecordEngine.WriteFile(System.String,System.Collections.IEnumerable)">
|
|
2409
|
+
<summary>
|
|
2410
|
+
Write an array of records to the specified file.
|
|
2411
|
+
</summary><remarks>
|
|
2412
|
+
<para>This method open, write and close the file (don't open or close the file before or after to call this method)</para>
|
|
2413
|
+
<para>This method overrides existing files.</para>
|
|
2414
|
+
</remarks><example>
|
|
2415
|
+
This example show the basic use of the library with minimun code:
|
|
2416
|
+
<code>
|
|
2417
|
+
<textarea name="code" class="c#">
|
|
2418
|
+
|
|
2419
|
+
using FileHelpers;
|
|
2420
|
+
|
|
2421
|
+
// First declare the record class
|
|
2422
|
+
|
|
2423
|
+
[Delimitedrecord("|")]
|
|
2424
|
+
public class SampleType
|
|
2425
|
+
{
|
|
2426
|
+
public string Field1;
|
|
2427
|
+
public int Field2;
|
|
2428
|
+
}
|
|
2429
|
+
|
|
2430
|
+
|
|
2431
|
+
public void WriteExample()
|
|
2432
|
+
{
|
|
2433
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
2434
|
+
|
|
2435
|
+
SampleType[] records = new SampleType[1];
|
|
2436
|
+
|
|
2437
|
+
records[0] = new SampleType();
|
|
2438
|
+
|
|
2439
|
+
records[0].Field1 = "Hello World";
|
|
2440
|
+
records[0].Field2 = 12;
|
|
2441
|
+
|
|
2442
|
+
engine.WriteFile("destination.txt", records);
|
|
2443
|
+
|
|
2444
|
+
// Now the file contains the created record in this format:
|
|
2445
|
+
//
|
|
2446
|
+
// Hello World,12
|
|
2447
|
+
|
|
2448
|
+
}
|
|
2449
|
+
|
|
2450
|
+
</textarea>
|
|
2451
|
+
</code>
|
|
2452
|
+
</example><param name="fileName">The file path to be write.</param><param name="records">The records to write (Can be an array, ArrayList, etc)</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
2453
|
+
</member>
|
|
2454
|
+
<member name="M:FileHelpers.MultiRecordEngine.WriteFile(System.String,System.Collections.IEnumerable,System.Int32)">
|
|
2455
|
+
<summary>
|
|
2456
|
+
Write the specified number of records from the array to a file.
|
|
2457
|
+
</summary><remarks>
|
|
2458
|
+
<para>This method open, write and close the file (don't open or close the file before or after to call this method)</para>
|
|
2459
|
+
<para>This method overrides existing files.</para>
|
|
2460
|
+
</remarks><example>
|
|
2461
|
+
This example show the basic use of the library with minimun code:
|
|
2462
|
+
<code>
|
|
2463
|
+
<textarea name="code" class="c#">
|
|
2464
|
+
|
|
2465
|
+
using FileHelpers;
|
|
2466
|
+
|
|
2467
|
+
// First declare the record class
|
|
2468
|
+
|
|
2469
|
+
[Delimitedrecord("|")]
|
|
2470
|
+
public class SampleType
|
|
2471
|
+
{
|
|
2472
|
+
public string Field1;
|
|
2473
|
+
public int Field2;
|
|
2474
|
+
}
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
public void WriteExample()
|
|
2478
|
+
{
|
|
2479
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
2480
|
+
|
|
2481
|
+
SampleType[] records = new SampleType[1];
|
|
2482
|
+
|
|
2483
|
+
records[0] = new SampleType();
|
|
2484
|
+
|
|
2485
|
+
records[0].Field1 = "Hello World";
|
|
2486
|
+
records[0].Field2 = 12;
|
|
2487
|
+
|
|
2488
|
+
engine.WriteFile("destination.txt", records);
|
|
2489
|
+
|
|
2490
|
+
// Now the file contains the created record in this format:
|
|
2491
|
+
//
|
|
2492
|
+
// Hello World,12
|
|
2493
|
+
|
|
2494
|
+
}
|
|
2495
|
+
|
|
2496
|
+
</textarea>
|
|
2497
|
+
</code>
|
|
2498
|
+
</example><param name="fileName">The file path to be write.</param><param name="records">The records to write (Can be an array, ArrayList, etc)</param><param name="maxRecords">The max number of array elements to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
2499
|
+
</member>
|
|
2500
|
+
<member name="M:FileHelpers.MultiRecordEngine.WriteStream(System.IO.TextWriter,System.Collections.IEnumerable)">
|
|
2501
|
+
<summary>
|
|
2502
|
+
Write the records to a file
|
|
2503
|
+
</summary>
|
|
2504
|
+
<param name="writer"></param>
|
|
2505
|
+
<param name="records"></param>
|
|
2506
|
+
</member>
|
|
2507
|
+
<member name="M:FileHelpers.MultiRecordEngine.WriteStream(System.IO.TextWriter,System.Collections.IEnumerable,System.Int32)">
|
|
2508
|
+
<summary>
|
|
2509
|
+
Write the specified number of records in the array to the Stream.
|
|
2510
|
+
</summary><remarks>
|
|
2511
|
+
This method only uses the stream and don't close them after use it, you must do it.
|
|
2512
|
+
</remarks><example>
|
|
2513
|
+
This example show the basic use of the library with minimun code:
|
|
2514
|
+
<code>
|
|
2515
|
+
<textarea name="code" class="c#">
|
|
2516
|
+
|
|
2517
|
+
using FileHelpers;
|
|
2518
|
+
|
|
2519
|
+
// First declare the record class
|
|
2520
|
+
|
|
2521
|
+
[Delimitedrecord("|")]
|
|
2522
|
+
public class SampleType
|
|
2523
|
+
{
|
|
2524
|
+
public string Field1;
|
|
2525
|
+
public int Field2;
|
|
2526
|
+
}
|
|
2527
|
+
|
|
2528
|
+
|
|
2529
|
+
public void WriteExample()
|
|
2530
|
+
{
|
|
2531
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
2532
|
+
|
|
2533
|
+
SampleType[] records = new SampleType[1];
|
|
2534
|
+
|
|
2535
|
+
records[0] = new SampleType();
|
|
2536
|
+
|
|
2537
|
+
records[0].Field1 = "Hello World";
|
|
2538
|
+
records[0].Field2 = 12;
|
|
2539
|
+
|
|
2540
|
+
engine.WriteFile("destination.txt", records);
|
|
2541
|
+
|
|
2542
|
+
// Now the file contains the created record in this format:
|
|
2543
|
+
//
|
|
2544
|
+
// Hello World,12
|
|
2545
|
+
|
|
2546
|
+
}
|
|
2547
|
+
|
|
2548
|
+
</textarea>
|
|
2549
|
+
</code>
|
|
2550
|
+
</example><param name="writer">The writer of the source stream.</param><param name="records">The records to write (Can be an array, ArrayList, etc)</param><param name="maxRecords">The max number of array elements to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
2551
|
+
</member>
|
|
2552
|
+
<member name="M:FileHelpers.MultiRecordEngine.WriteString(System.Collections.IEnumerable)">
|
|
2553
|
+
<summary>
|
|
2554
|
+
Write an array of records to an String and return it.
|
|
2555
|
+
</summary><param name="records">The records to write (Can be an array, ArrayList, etc)</param><returns>The resulting string after write the records.</returns>
|
|
2556
|
+
</member>
|
|
2557
|
+
<member name="M:FileHelpers.MultiRecordEngine.WriteString(System.Collections.IEnumerable,System.Int32)">
|
|
2558
|
+
<summary>
|
|
2559
|
+
Write an array of records to an String and return it.
|
|
2560
|
+
</summary><param name="records">The records to write (Can be an array, ArrayList, etc)</param><returns>The resulting string after write the records.</returns><param name="maxRecords">The max number of array elements to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
2561
|
+
</member>
|
|
2562
|
+
<member name="M:FileHelpers.MultiRecordEngine.AppendToFile(System.String,System.Object)">
|
|
2563
|
+
<summary>
|
|
2564
|
+
Append a record to the specified file.
|
|
2565
|
+
</summary><remarks>
|
|
2566
|
+
This method open, seek ends, write and close the file (don't open or close the file before or after to call this method)
|
|
2567
|
+
</remarks><example>
|
|
2568
|
+
This example show the basic use of the library with minimun code:
|
|
2569
|
+
<code>
|
|
2570
|
+
<textarea name="code" class="c#">
|
|
2571
|
+
|
|
2572
|
+
using FileHelpers;
|
|
2573
|
+
|
|
2574
|
+
// First declare the record class
|
|
2575
|
+
|
|
2576
|
+
[Delimitedrecord("|")]
|
|
2577
|
+
public class SampleType
|
|
2578
|
+
{
|
|
2579
|
+
public string Field1;
|
|
2580
|
+
public int Field2;
|
|
2581
|
+
}
|
|
2582
|
+
|
|
2583
|
+
|
|
2584
|
+
public void AppendExample()
|
|
2585
|
+
{
|
|
2586
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
2587
|
+
|
|
2588
|
+
SampleType[] records = new SampleType[1];
|
|
2589
|
+
|
|
2590
|
+
records[0] = new SampleType();
|
|
2591
|
+
|
|
2592
|
+
records[0].Field1 = "Hello World";
|
|
2593
|
+
records[0].Field2 = 12;
|
|
2594
|
+
|
|
2595
|
+
engine.AppendToFile("destination.txt", records);
|
|
2596
|
+
|
|
2597
|
+
// Now the file contains have one more record at the end:
|
|
2598
|
+
//
|
|
2599
|
+
// Hello World,12
|
|
2600
|
+
|
|
2601
|
+
}
|
|
2602
|
+
|
|
2603
|
+
</textarea>
|
|
2604
|
+
</code>
|
|
2605
|
+
</example><param name="fileName">The file path to be written at end.</param><param name="record">The record to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
2606
|
+
</member>
|
|
2607
|
+
<member name="M:FileHelpers.MultiRecordEngine.AppendToFile(System.String,System.Collections.IEnumerable)">
|
|
2608
|
+
<summary>
|
|
2609
|
+
Append an array of records to the specified file.
|
|
2610
|
+
</summary><remarks>
|
|
2611
|
+
This method open, seek ends, write and close the file (don't open or close the file before or after to call this method)
|
|
2612
|
+
</remarks><example>
|
|
2613
|
+
This example show the basic use of the library with minimun code:
|
|
2614
|
+
<code>
|
|
2615
|
+
<textarea name="code" class="c#">
|
|
2616
|
+
|
|
2617
|
+
using FileHelpers;
|
|
2618
|
+
|
|
2619
|
+
// First declare the record class
|
|
2620
|
+
|
|
2621
|
+
[Delimitedrecord("|")]
|
|
2622
|
+
public class SampleType
|
|
2623
|
+
{
|
|
2624
|
+
public string Field1;
|
|
2625
|
+
public int Field2;
|
|
2626
|
+
}
|
|
2627
|
+
|
|
2628
|
+
|
|
2629
|
+
public void AppendExample()
|
|
2630
|
+
{
|
|
2631
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
2632
|
+
|
|
2633
|
+
SampleType[] records = new SampleType[1];
|
|
2634
|
+
|
|
2635
|
+
records[0] = new SampleType();
|
|
2636
|
+
|
|
2637
|
+
records[0].Field1 = "Hello World";
|
|
2638
|
+
records[0].Field2 = 12;
|
|
2639
|
+
|
|
2640
|
+
engine.AppendToFile("destination.txt", records);
|
|
2641
|
+
|
|
2642
|
+
// Now the file contains have one more record at the end:
|
|
2643
|
+
//
|
|
2644
|
+
// Hello World,12
|
|
2645
|
+
|
|
2646
|
+
}
|
|
2647
|
+
|
|
2648
|
+
</textarea>
|
|
2649
|
+
</code>
|
|
2650
|
+
</example><param name="fileName">The file path to be written at end.</param><param name="records">The records to write (Can be an array, ArrayList, etc)</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
2651
|
+
</member>
|
|
2652
|
+
<member name="M:FileHelpers.MultiRecordEngine.BeginReadStream(System.IO.TextReader)">
|
|
2653
|
+
<summary>
|
|
2654
|
+
Method used to use this engine in Async mode. Work together with <see cref="M:FileHelpers.MultiRecordEngine.ReadNext"/>. (Remember to call Close after read the data)
|
|
2655
|
+
</summary>
|
|
2656
|
+
<param name="reader">The source Reader.</param>
|
|
2657
|
+
</member>
|
|
2658
|
+
<member name="M:FileHelpers.MultiRecordEngine.BeginReadFile(System.String)">
|
|
2659
|
+
<summary>
|
|
2660
|
+
Method used to use this engine in Async mode. Work together with <see cref="M:FileHelpers.MultiRecordEngine.ReadNext"/>. (Remember to call Close after read the data)
|
|
2661
|
+
</summary>
|
|
2662
|
+
<param name="fileName">The source file.</param>
|
|
2663
|
+
</member>
|
|
2664
|
+
<member name="M:FileHelpers.MultiRecordEngine.BeginReadString(System.String)">
|
|
2665
|
+
<summary>
|
|
2666
|
+
Method used to use this engine in Async mode. Work together with <see cref="M:FileHelpers.MultiRecordEngine.ReadNext"/>. (Remember to call Close after read the data)
|
|
2667
|
+
</summary>
|
|
2668
|
+
<param name="sourceData">The source String</param>
|
|
2669
|
+
</member>
|
|
2670
|
+
<member name="M:FileHelpers.MultiRecordEngine.Flush">
|
|
2671
|
+
<summary>
|
|
2672
|
+
Save all the buffered data for write to the disk.
|
|
2673
|
+
Useful to long opened async engines that wants to save pending values or for engines used for logging.
|
|
2674
|
+
</summary>
|
|
2675
|
+
</member>
|
|
2676
|
+
<member name="M:FileHelpers.MultiRecordEngine.Close">
|
|
2677
|
+
<summary>
|
|
2678
|
+
Close the underlining Readers and Writers. (if any)
|
|
2679
|
+
</summary>
|
|
2680
|
+
</member>
|
|
2681
|
+
<member name="M:FileHelpers.MultiRecordEngine.ReadNext">
|
|
2682
|
+
<summary>
|
|
2683
|
+
Reads the next record of a file opened with the <see cref="M:FileHelpers.MultiRecordEngine.BeginReadFile(System.String)"/> or <see cref="M:FileHelpers.MultiRecordEngine.BeginReadStream(System.IO.TextReader)"/> method.
|
|
2684
|
+
</summary><remarks>
|
|
2685
|
+
<para>This method not only returns the current record, also moves to the next.</para>
|
|
2686
|
+
<para>If the end of file is reached this method return <b>null</b>.</para>
|
|
2687
|
+
</remarks><returns>The current record of the opened file.</returns><example>
|
|
2688
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
2689
|
+
<code>
|
|
2690
|
+
<textarea name="code" class="c#">
|
|
2691
|
+
|
|
2692
|
+
using FileHelpers;
|
|
2693
|
+
|
|
2694
|
+
// First declare the record class
|
|
2695
|
+
|
|
2696
|
+
[Delimitedrecord("|")]
|
|
2697
|
+
public class SampleType
|
|
2698
|
+
{
|
|
2699
|
+
public string Field1;
|
|
2700
|
+
public int Field2;
|
|
2701
|
+
}
|
|
2702
|
+
|
|
2703
|
+
|
|
2704
|
+
public void ReadExample()
|
|
2705
|
+
{
|
|
2706
|
+
SampleType record;
|
|
2707
|
+
|
|
2708
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
2709
|
+
|
|
2710
|
+
engine.BeginReadFile("source.txt");
|
|
2711
|
+
|
|
2712
|
+
while( engine.ReadNext() != null )
|
|
2713
|
+
{
|
|
2714
|
+
record = (SampleType) engine.LastRecord;
|
|
2715
|
+
|
|
2716
|
+
// put your code here !!!!
|
|
2717
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
2718
|
+
|
|
2719
|
+
}
|
|
2720
|
+
|
|
2721
|
+
engine.Close();
|
|
2722
|
+
}
|
|
2723
|
+
|
|
2724
|
+
</textarea>
|
|
2725
|
+
</code>
|
|
2726
|
+
</example>
|
|
2727
|
+
</member>
|
|
2728
|
+
<member name="M:FileHelpers.MultiRecordEngine.ReadNexts(System.Int32)">
|
|
2729
|
+
<summary>
|
|
2730
|
+
Reads the specified number of records from a file or stream opened with the <see cref="M:FileHelpers.MultiRecordEngine.BeginReadFile(System.String)"/> or <see cref="M:FileHelpers.MultiRecordEngine.BeginReadStream(System.IO.TextReader)"/> method.
|
|
2731
|
+
</summary><remarks>
|
|
2732
|
+
If there are less records in the source, read to the end.
|
|
2733
|
+
</remarks><param name="numberOfRecords">The number of records to read. If there are less records in the source, read to the end.</param><returns>The nexts records of the opened file or stream.</returns>
|
|
2734
|
+
</member>
|
|
2735
|
+
<member name="M:FileHelpers.MultiRecordEngine.System#Collections#IEnumerable#GetEnumerator">
|
|
2736
|
+
<summary>Allows to loop record by record in the engine</summary>
|
|
2737
|
+
<returns>The Enumerator</returns>
|
|
2738
|
+
</member>
|
|
2739
|
+
<member name="M:FileHelpers.MultiRecordEngine.System#IDisposable#Dispose">
|
|
2740
|
+
<summary>
|
|
2741
|
+
Release Resources
|
|
2742
|
+
</summary>
|
|
2743
|
+
</member>
|
|
2744
|
+
<member name="M:FileHelpers.MultiRecordEngine.Finalize">
|
|
2745
|
+
<summary>Destructor</summary>
|
|
2746
|
+
</member>
|
|
2747
|
+
<member name="M:FileHelpers.MultiRecordEngine.WriteNext(System.Object)">
|
|
2748
|
+
<summary>Write the next record to a file or stream opened with <see cref="M:FileHelpers.MultiRecordEngine.BeginWriteFile(System.String)"/>, <see cref="M:FileHelpers.MultiRecordEngine.BeginWriteStream(System.IO.TextWriter)"/> or <see cref="M:FileHelpers.MultiRecordEngine.BeginAppendToFile(System.String)"/> method.</summary>
|
|
2749
|
+
<param name="record">The record to write.</param>
|
|
2750
|
+
</member>
|
|
2751
|
+
<member name="M:FileHelpers.MultiRecordEngine.WriteNexts(System.Collections.IEnumerable)">
|
|
2752
|
+
<summary>Write the nexts records to a file or stream opened with <see cref="M:FileHelpers.MultiRecordEngine.BeginWriteFile(System.String)"/>, <see cref="M:FileHelpers.MultiRecordEngine.BeginWriteStream(System.IO.TextWriter)"/> or <see cref="M:FileHelpers.MultiRecordEngine.BeginAppendToFile(System.String)"/> method.</summary>
|
|
2753
|
+
<param name="records">The records to write (Can be an array, ArrayList, etc)</param>
|
|
2754
|
+
</member>
|
|
2755
|
+
<member name="M:FileHelpers.MultiRecordEngine.BeginWriteStream(System.IO.TextWriter)">
|
|
2756
|
+
<summary>Set the stream to be used in the <see cref="M:FileHelpers.MultiRecordEngine.WriteNext(System.Object)"/> operation.</summary>
|
|
2757
|
+
<remarks><para>When you finish to write to the file you must call <b><see cref="M:FileHelpers.MultiRecordEngine.Close"/></b> method.</para></remarks>
|
|
2758
|
+
<param name="writer">To stream to writes to.</param>
|
|
2759
|
+
</member>
|
|
2760
|
+
<member name="M:FileHelpers.MultiRecordEngine.BeginWriteFile(System.String)">
|
|
2761
|
+
<summary>Open a file for write operations. If exist the engine override it. You can use <see cref="M:FileHelpers.MultiRecordEngine.WriteNext(System.Object)"/> or <see cref="M:FileHelpers.MultiRecordEngine.WriteNexts(System.Collections.IEnumerable)"/> to write records.</summary>
|
|
2762
|
+
<remarks><para>When you finish to write to the file you must call <b><see cref="M:FileHelpers.MultiRecordEngine.Close"/></b> method.</para></remarks>
|
|
2763
|
+
<param name="fileName">The file path to be opened for write.</param>
|
|
2764
|
+
</member>
|
|
2765
|
+
<member name="M:FileHelpers.MultiRecordEngine.BeginAppendToFile(System.String)">
|
|
2766
|
+
<summary>Open a file to be appended at the end.</summary>
|
|
2767
|
+
<remarks><para>This method open and seek to the end the file.</para>
|
|
2768
|
+
<para>When you finish to append to the file you must call <b><see cref="M:FileHelpers.MultiRecordEngine.Close"/></b> method.</para></remarks>
|
|
2769
|
+
<param name="fileName">The file path to be opened to write at the end.</param>
|
|
2770
|
+
</member>
|
|
2771
|
+
<member name="P:FileHelpers.MultiRecordEngine.RecordSelector">
|
|
2772
|
+
<summary>
|
|
2773
|
+
The Selector used by the engine in Read operations to determine the Type to use.
|
|
2774
|
+
</summary>
|
|
2775
|
+
</member>
|
|
2776
|
+
<member name="E:FileHelpers.MultiRecordEngine.BeforeReadRecord">
|
|
2777
|
+
<summary>Called in read operations just before the record string is translated to a record.</summary>
|
|
2778
|
+
</member>
|
|
2779
|
+
<member name="E:FileHelpers.MultiRecordEngine.AfterReadRecord">
|
|
2780
|
+
<summary>Called in read operations just after the record was created from a record string.</summary>
|
|
2781
|
+
</member>
|
|
2782
|
+
<member name="E:FileHelpers.MultiRecordEngine.BeforeWriteRecord">
|
|
2783
|
+
<summary>Called in write operations just before the record is converted to a string to write it.</summary>
|
|
2784
|
+
</member>
|
|
2785
|
+
<member name="E:FileHelpers.MultiRecordEngine.AfterWriteRecord">
|
|
2786
|
+
<summary>Called in write operations just after the record was converted to a string.</summary>
|
|
2787
|
+
</member>
|
|
2788
|
+
<member name="P:FileHelpers.MultiRecordEngine.LastRecord">
|
|
2789
|
+
<summary>Contains the last Record read by the <see cref="M:FileHelpers.MultiRecordEngine.ReadNext"/> method.</summary><example>
|
|
2790
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
2791
|
+
<code>
|
|
2792
|
+
<textarea name="code" class="c#">
|
|
2793
|
+
|
|
2794
|
+
using FileHelpers;
|
|
2795
|
+
|
|
2796
|
+
// First declare the record class
|
|
2797
|
+
|
|
2798
|
+
[Delimitedrecord("|")]
|
|
2799
|
+
public class SampleType
|
|
2800
|
+
{
|
|
2801
|
+
public string Field1;
|
|
2802
|
+
public int Field2;
|
|
2803
|
+
}
|
|
2804
|
+
|
|
2805
|
+
|
|
2806
|
+
public void ReadExample()
|
|
2807
|
+
{
|
|
2808
|
+
SampleType record;
|
|
2809
|
+
|
|
2810
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
2811
|
+
|
|
2812
|
+
engine.BeginReadFile("source.txt");
|
|
2813
|
+
|
|
2814
|
+
while( engine.ReadNext() != null )
|
|
2815
|
+
{
|
|
2816
|
+
record = (SampleType) engine.LastRecord;
|
|
2817
|
+
|
|
2818
|
+
// put your code here !!!!
|
|
2819
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
2820
|
+
|
|
2821
|
+
}
|
|
2822
|
+
|
|
2823
|
+
engine.Close();
|
|
2824
|
+
}
|
|
2825
|
+
|
|
2826
|
+
</textarea>
|
|
2827
|
+
</code>
|
|
2828
|
+
</example>
|
|
2829
|
+
</member>
|
|
2830
|
+
<member name="T:FileHelpers.AlignMode">
|
|
2831
|
+
<summary>Indicates the align of the field when the <see cref="T:FileHelpers.FileHelperEngine"/> <b>writes</b> the record.</summary>
|
|
2832
|
+
</member>
|
|
2833
|
+
<member name="F:FileHelpers.AlignMode.Left">
|
|
2834
|
+
<summary>Aligns the field to the left.</summary>
|
|
2835
|
+
</member>
|
|
2836
|
+
<member name="F:FileHelpers.AlignMode.Center">
|
|
2837
|
+
<summary>Aligns the field to the center.</summary>
|
|
2838
|
+
</member>
|
|
2839
|
+
<member name="F:FileHelpers.AlignMode.Right">
|
|
2840
|
+
<summary>Aligns the field to the right.</summary>
|
|
2841
|
+
</member>
|
|
2842
|
+
<member name="T:FileHelpers.ConverterKind">
|
|
2843
|
+
<summary>Indicates the convertion used in the <see cref="T:FileHelpers.FieldConverterAttribute"/>.</summary>
|
|
2844
|
+
</member>
|
|
2845
|
+
<member name="F:FileHelpers.ConverterKind.None">
|
|
2846
|
+
<summary>Null Converter.</summary>
|
|
2847
|
+
</member>
|
|
2848
|
+
<member name="F:FileHelpers.ConverterKind.Date">
|
|
2849
|
+
<summary>
|
|
2850
|
+
<para>Convert from/to <b>Date</b> values.</para>
|
|
2851
|
+
<para>Params: arg1 is the <b>string</b> with the date format.</para>
|
|
2852
|
+
</summary>
|
|
2853
|
+
</member>
|
|
2854
|
+
<member name="F:FileHelpers.ConverterKind.Boolean">
|
|
2855
|
+
<summary>Convert from/to <b>Boolean</b> values.</summary>
|
|
2856
|
+
</member>
|
|
2857
|
+
<member name="F:FileHelpers.ConverterKind.Byte">
|
|
2858
|
+
<summary>
|
|
2859
|
+
<para>Convert from/to <b>Byte</b> values.</para>
|
|
2860
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2861
|
+
</summary>
|
|
2862
|
+
</member>
|
|
2863
|
+
<member name="F:FileHelpers.ConverterKind.Int16">
|
|
2864
|
+
<summary>
|
|
2865
|
+
<para>Convert from/to <b>Int16 or short</b> values.</para>
|
|
2866
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2867
|
+
</summary>
|
|
2868
|
+
</member>
|
|
2869
|
+
<member name="F:FileHelpers.ConverterKind.Int32">
|
|
2870
|
+
<summary>
|
|
2871
|
+
<para>Convert from/to <b>Int32 or int</b> values.</para>
|
|
2872
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2873
|
+
</summary>
|
|
2874
|
+
</member>
|
|
2875
|
+
<member name="F:FileHelpers.ConverterKind.Int64">
|
|
2876
|
+
<summary>
|
|
2877
|
+
<para>Convert from/to <b>Int64 or long</b> values.</para>
|
|
2878
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2879
|
+
</summary>
|
|
2880
|
+
</member>
|
|
2881
|
+
<member name="F:FileHelpers.ConverterKind.Decimal">
|
|
2882
|
+
<summary>
|
|
2883
|
+
<para>Convert from/to <b>Decimal</b> values.</para>
|
|
2884
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2885
|
+
</summary>
|
|
2886
|
+
</member>
|
|
2887
|
+
<member name="F:FileHelpers.ConverterKind.Double">
|
|
2888
|
+
<summary>
|
|
2889
|
+
<para>Convert from/to <b>Double</b> values.</para>
|
|
2890
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2891
|
+
</summary>
|
|
2892
|
+
</member>
|
|
2893
|
+
<member name="F:FileHelpers.ConverterKind.Single">
|
|
2894
|
+
<summary>
|
|
2895
|
+
<para>Convert from/to <b>Single</b> values.</para>
|
|
2896
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2897
|
+
</summary>
|
|
2898
|
+
</member>
|
|
2899
|
+
<member name="F:FileHelpers.ConverterKind.SByte">
|
|
2900
|
+
<summary>
|
|
2901
|
+
<para>Convert from/to <b>Byte</b> values.</para>
|
|
2902
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2903
|
+
</summary>
|
|
2904
|
+
</member>
|
|
2905
|
+
<member name="F:FileHelpers.ConverterKind.UInt16">
|
|
2906
|
+
<summary>
|
|
2907
|
+
<para>Convert from/to <b>UInt16 or unsigned short</b> values.</para>
|
|
2908
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2909
|
+
</summary>
|
|
2910
|
+
</member>
|
|
2911
|
+
<member name="F:FileHelpers.ConverterKind.UInt32">
|
|
2912
|
+
<summary>
|
|
2913
|
+
<para>Convert from/to <b>UInt32 or unsigned int</b> values.</para>
|
|
2914
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2915
|
+
</summary>
|
|
2916
|
+
</member>
|
|
2917
|
+
<member name="F:FileHelpers.ConverterKind.UInt64">
|
|
2918
|
+
<summary>
|
|
2919
|
+
<para>Convert from/to <b>UInt64 or unsigned long</b> values.</para>
|
|
2920
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
2921
|
+
</summary>
|
|
2922
|
+
</member>
|
|
2923
|
+
<member name="T:FileHelpers.ErrorMode">
|
|
2924
|
+
<summary>Indicates the behavior when the <see cref="T:FileHelpers.FileHelperEngine"/> class found an error.</summary>
|
|
2925
|
+
</member>
|
|
2926
|
+
<member name="F:FileHelpers.ErrorMode.ThrowException">
|
|
2927
|
+
<summary>Default value, this simple Rethrow the original exception.</summary>
|
|
2928
|
+
</member>
|
|
2929
|
+
<member name="F:FileHelpers.ErrorMode.SaveAndContinue">
|
|
2930
|
+
<summary>Add an <see cref="T:FileHelpers.ErrorInfo"/> to the array of <see cref="P:FileHelpers.ErrorManager.Errors"/>.</summary>
|
|
2931
|
+
</member>
|
|
2932
|
+
<member name="F:FileHelpers.ErrorMode.IgnoreAndContinue">
|
|
2933
|
+
<summary>Simply ignores the exception an continue.</summary>
|
|
2934
|
+
</member>
|
|
2935
|
+
<member name="T:FileHelpers.FixedMode">
|
|
2936
|
+
<summary>Indicates the behavior when variable length records are found in a [<see cref="T:FileHelpers.FixedLengthRecordAttribute"/>]. (Note: nothing in common with [FieldOptional])</summary>
|
|
2937
|
+
</member>
|
|
2938
|
+
<member name="F:FileHelpers.FixedMode.ExactLength">
|
|
2939
|
+
<summary>The records must have the length equals to the sum of each field length.</summary>
|
|
2940
|
+
</member>
|
|
2941
|
+
<member name="F:FileHelpers.FixedMode.AllowMoreChars">
|
|
2942
|
+
<summary>The records can contain less chars in the last field.</summary>
|
|
2943
|
+
</member>
|
|
2944
|
+
<member name="F:FileHelpers.FixedMode.AllowLessChars">
|
|
2945
|
+
<summary>The records can contain more chars in the last field.</summary>
|
|
2946
|
+
</member>
|
|
2947
|
+
<member name="F:FileHelpers.FixedMode.AllowVariableLength">
|
|
2948
|
+
<summary>The records can contain more or less chars in the last field.</summary>
|
|
2949
|
+
</member>
|
|
2950
|
+
<member name="T:FileHelpers.MultilineMode">
|
|
2951
|
+
<summary>Indicates the behavior of multiline fields.</summary>
|
|
2952
|
+
</member>
|
|
2953
|
+
<member name="F:FileHelpers.MultilineMode.AllowForBoth">
|
|
2954
|
+
<summary>The engine can handle multiline values for read or write.</summary>
|
|
2955
|
+
</member>
|
|
2956
|
+
<member name="F:FileHelpers.MultilineMode.AllowForRead">
|
|
2957
|
+
<summary>The engine can handle multiline values only for read.</summary>
|
|
2958
|
+
</member>
|
|
2959
|
+
<member name="F:FileHelpers.MultilineMode.AllowForWrite">
|
|
2960
|
+
<summary>The engine can handle multiline values only for write.</summary>
|
|
2961
|
+
</member>
|
|
2962
|
+
<member name="F:FileHelpers.MultilineMode.NotAllow">
|
|
2963
|
+
<summary>The engine don´t allow multiline values for this field.</summary>
|
|
2964
|
+
</member>
|
|
2965
|
+
<member name="T:FileHelpers.NetLanguage">
|
|
2966
|
+
<summary>Indicates the .NET Language</summary>
|
|
2967
|
+
</member>
|
|
2968
|
+
<member name="F:FileHelpers.NetLanguage.CSharp">
|
|
2969
|
+
<summary>The C#.NET Language</summary>
|
|
2970
|
+
</member>
|
|
2971
|
+
<member name="F:FileHelpers.NetLanguage.VbNet">
|
|
2972
|
+
<summary>The VB.NET Language</summary>
|
|
2973
|
+
</member>
|
|
2974
|
+
<member name="T:FileHelpers.NetVisibility">
|
|
2975
|
+
<summary>Indicates the visibility of a member.</summary>
|
|
2976
|
+
</member>
|
|
2977
|
+
<member name="F:FileHelpers.NetVisibility.Public">
|
|
2978
|
+
<summary>Public visivility.</summary>
|
|
2979
|
+
</member>
|
|
2980
|
+
<member name="F:FileHelpers.NetVisibility.Internal">
|
|
2981
|
+
<summary>Internal visivility. (Friend in VB.NET)</summary>
|
|
2982
|
+
</member>
|
|
2983
|
+
<member name="F:FileHelpers.NetVisibility.Protected">
|
|
2984
|
+
<summary>Protected visivility.</summary>
|
|
2985
|
+
</member>
|
|
2986
|
+
<member name="F:FileHelpers.NetVisibility.Private">
|
|
2987
|
+
<summary>Private visivility.</summary>
|
|
2988
|
+
</member>
|
|
2989
|
+
<member name="T:FileHelpers.ProgressMode">
|
|
2990
|
+
<summary>Indicate the method used to calculate the current progress</summary>
|
|
2991
|
+
</member>
|
|
2992
|
+
<member name="F:FileHelpers.ProgressMode.NotifyPercent">
|
|
2993
|
+
<summary>Notify the percent completed.</summary>
|
|
2994
|
+
</member>
|
|
2995
|
+
<member name="F:FileHelpers.ProgressMode.NotifyRecords">
|
|
2996
|
+
<summary>Notify the Record completed.</summary>
|
|
2997
|
+
</member>
|
|
2998
|
+
<member name="F:FileHelpers.ProgressMode.NotifyBytes">
|
|
2999
|
+
<summary>Notify the bytes readed.</summary>
|
|
3000
|
+
</member>
|
|
3001
|
+
<member name="F:FileHelpers.ProgressMode.DontNotify">
|
|
3002
|
+
<summary>Dont call to the progress handler.</summary>
|
|
3003
|
+
</member>
|
|
3004
|
+
<member name="T:FileHelpers.QuoteMode">
|
|
3005
|
+
<summary>Indicates the behavior of quoted fields.</summary>
|
|
3006
|
+
</member>
|
|
3007
|
+
<member name="F:FileHelpers.QuoteMode.AlwaysQuoted">
|
|
3008
|
+
<summary>The engine always expects a quote when read and always adds the quotes when write.</summary>
|
|
3009
|
+
</member>
|
|
3010
|
+
<member name="F:FileHelpers.QuoteMode.OptionalForRead">
|
|
3011
|
+
<summary>The engine expects or not a quote when read and always adds the quotes when write.</summary>
|
|
3012
|
+
</member>
|
|
3013
|
+
<member name="F:FileHelpers.QuoteMode.OptionalForWrite">
|
|
3014
|
+
<summary>The engine always expects a quote when read and adds the quotes when write only if the field contains: quotes, new lines or the separator char.</summary>
|
|
3015
|
+
</member>
|
|
3016
|
+
<member name="F:FileHelpers.QuoteMode.OptionalForBoth">
|
|
3017
|
+
<summary>The engine expects or not a quote when read and adds the quotes when write only if the field contains: quotes, new lines or the separator char.</summary>
|
|
3018
|
+
</member>
|
|
3019
|
+
<member name="T:FileHelpers.RecordCondition">
|
|
3020
|
+
<summary>The condition used to include or exclude each record.</summary>
|
|
3021
|
+
</member>
|
|
3022
|
+
<member name="F:FileHelpers.RecordCondition.None">
|
|
3023
|
+
<summary>No Condition, Include it always.</summary>
|
|
3024
|
+
</member>
|
|
3025
|
+
<member name="F:FileHelpers.RecordCondition.IncludeIfContains">
|
|
3026
|
+
<summary>Include the record if it contains the selector string.</summary>
|
|
3027
|
+
</member>
|
|
3028
|
+
<member name="F:FileHelpers.RecordCondition.IncludeIfBegins">
|
|
3029
|
+
<summary>Include the record if it begins with selector string.</summary>
|
|
3030
|
+
</member>
|
|
3031
|
+
<member name="F:FileHelpers.RecordCondition.IncludeIfEnds">
|
|
3032
|
+
<summary>Include the record if it ends with selector string.</summary>
|
|
3033
|
+
</member>
|
|
3034
|
+
<member name="F:FileHelpers.RecordCondition.IncludeIfEnclosed">
|
|
3035
|
+
<summary>Include the record if it begins and ends with selector string.</summary>
|
|
3036
|
+
</member>
|
|
3037
|
+
<member name="F:FileHelpers.RecordCondition.IncludeIfMatchRegex">
|
|
3038
|
+
<summary>Include the record if it matchs the regular expression passed as selector.</summary>
|
|
3039
|
+
</member>
|
|
3040
|
+
<member name="F:FileHelpers.RecordCondition.ExcludeIfContains">
|
|
3041
|
+
<summary>Exclude the record if it contains the selector string.</summary>
|
|
3042
|
+
</member>
|
|
3043
|
+
<member name="F:FileHelpers.RecordCondition.ExcludeIfBegins">
|
|
3044
|
+
<summary>Exclude the record if it begins with selector string.</summary>
|
|
3045
|
+
</member>
|
|
3046
|
+
<member name="F:FileHelpers.RecordCondition.ExcludeIfEnds">
|
|
3047
|
+
<summary>Exclude the record if it ends with selector string.</summary>
|
|
3048
|
+
</member>
|
|
3049
|
+
<member name="F:FileHelpers.RecordCondition.ExcludeIfEnclosed">
|
|
3050
|
+
<summary>Exclude the record if it begins and ends with selector string.</summary>
|
|
3051
|
+
</member>
|
|
3052
|
+
<member name="F:FileHelpers.RecordCondition.ExcludeIfMatchRegex">
|
|
3053
|
+
<summary>Exclude the record if it matchs the regular expression passed as selector.</summary>
|
|
3054
|
+
</member>
|
|
3055
|
+
<member name="T:FileHelpers.DataLink.TransactionMode">
|
|
3056
|
+
<summary>
|
|
3057
|
+
Define the diferent Modes of Transaction that uses the <see cref="T:FileHelpers.DataLink.DatabaseStorage"/>
|
|
3058
|
+
</summary>
|
|
3059
|
+
</member>
|
|
3060
|
+
<member name="F:FileHelpers.DataLink.TransactionMode.NoTransaction">
|
|
3061
|
+
<summary>No transaction used.</summary>
|
|
3062
|
+
</member>
|
|
3063
|
+
<member name="F:FileHelpers.DataLink.TransactionMode.UseDefault">
|
|
3064
|
+
<summary>Default Transaction Mode.</summary>
|
|
3065
|
+
</member>
|
|
3066
|
+
<member name="F:FileHelpers.DataLink.TransactionMode.UseChaosLevel">
|
|
3067
|
+
<summary>Chaos Level Transaction Mode.</summary>
|
|
3068
|
+
</member>
|
|
3069
|
+
<member name="F:FileHelpers.DataLink.TransactionMode.UseReadCommitted">
|
|
3070
|
+
<summary>ReadCommitted Transaction Mode.</summary>
|
|
3071
|
+
</member>
|
|
3072
|
+
<member name="F:FileHelpers.DataLink.TransactionMode.UseReadUnCommitted">
|
|
3073
|
+
<summary>ReadUnCommitted Transaction Mode.</summary>
|
|
3074
|
+
</member>
|
|
3075
|
+
<member name="F:FileHelpers.DataLink.TransactionMode.UseRepeatableRead">
|
|
3076
|
+
<summary>Repeatable Transaction Mode.</summary>
|
|
3077
|
+
</member>
|
|
3078
|
+
<member name="F:FileHelpers.DataLink.TransactionMode.UseSerializable">
|
|
3079
|
+
<summary>Serializable Transaction Mode.</summary>
|
|
3080
|
+
</member>
|
|
3081
|
+
<member name="T:FileHelpers.TrimMode">
|
|
3082
|
+
<summary>Indicates the triming behavior of the trailing characters.</summary>
|
|
3083
|
+
</member>
|
|
3084
|
+
<member name="F:FileHelpers.TrimMode.None">
|
|
3085
|
+
<summary>No triming is performed.</summary>
|
|
3086
|
+
</member>
|
|
3087
|
+
<member name="F:FileHelpers.TrimMode.Both">
|
|
3088
|
+
<summary>The field is trimed in both sides.</summary>
|
|
3089
|
+
</member>
|
|
3090
|
+
<member name="F:FileHelpers.TrimMode.Left">
|
|
3091
|
+
<summary>The field is trimed in the left.</summary>
|
|
3092
|
+
</member>
|
|
3093
|
+
<member name="F:FileHelpers.TrimMode.Right">
|
|
3094
|
+
<summary>The field is trimed in the right.</summary>
|
|
3095
|
+
</member>
|
|
3096
|
+
<member name="T:FileHelpers.BadUsageException">
|
|
3097
|
+
<summary>Indicates the wrong usage of the library.</summary>
|
|
3098
|
+
</member>
|
|
3099
|
+
<member name="T:FileHelpers.FileHelpersException">
|
|
3100
|
+
<summary>Base class for all the library Exceptions.</summary>
|
|
3101
|
+
</member>
|
|
3102
|
+
<member name="M:FileHelpers.FileHelpersException.#ctor(System.String)">
|
|
3103
|
+
<summary>Basic constructor of the exception.</summary>
|
|
3104
|
+
<param name="message">Message of the exception.</param>
|
|
3105
|
+
</member>
|
|
3106
|
+
<member name="M:FileHelpers.FileHelpersException.#ctor(System.String,System.Exception)">
|
|
3107
|
+
<summary>Basic constructor of the exception.</summary>
|
|
3108
|
+
<param name="message">Message of the exception.</param>
|
|
3109
|
+
<param name="innerEx">The inner Exception.</param>
|
|
3110
|
+
</member>
|
|
3111
|
+
<member name="M:FileHelpers.BadUsageException.#ctor(System.String)">
|
|
3112
|
+
<summary>Creates an instance of an BadUsageException.</summary>
|
|
3113
|
+
<param name="message">The exception Message</param>
|
|
3114
|
+
</member>
|
|
3115
|
+
<member name="T:FileHelpers.ConvertException">
|
|
3116
|
+
<summary>
|
|
3117
|
+
Indicates that a string value can't be converted to a dest type.
|
|
3118
|
+
</summary>
|
|
3119
|
+
</member>
|
|
3120
|
+
<member name="M:FileHelpers.ConvertException.#ctor(System.String,System.Type)">
|
|
3121
|
+
<summary>
|
|
3122
|
+
Create a new ConvertException object
|
|
3123
|
+
</summary>
|
|
3124
|
+
<param name="origValue">The value to convert.</param>
|
|
3125
|
+
<param name="destType">The destination Type.</param>
|
|
3126
|
+
</member>
|
|
3127
|
+
<member name="M:FileHelpers.ConvertException.#ctor(System.String,System.Type,System.String)">
|
|
3128
|
+
<summary>
|
|
3129
|
+
Create a new ConvertException object
|
|
3130
|
+
</summary>
|
|
3131
|
+
<param name="origValue">The value to convert.</param>
|
|
3132
|
+
<param name="destType">The destination Type.</param>
|
|
3133
|
+
<param name="extraInfo">Aditional info of the error.</param>
|
|
3134
|
+
</member>
|
|
3135
|
+
<member name="M:FileHelpers.ConvertException.#ctor(System.String,System.Type,System.String,System.Int32,System.Int32,System.String)">
|
|
3136
|
+
<summary>
|
|
3137
|
+
Create a new ConvertException object
|
|
3138
|
+
</summary>
|
|
3139
|
+
<param name="origValue">The value to convert.</param>
|
|
3140
|
+
<param name="destType">The destination Type.</param>
|
|
3141
|
+
<param name="extraInfo">Aditional info of the error.</param>
|
|
3142
|
+
<param name="columnNumber">The estimated column number.</param>
|
|
3143
|
+
<param name="lineNumber">The line where the error was found.</param>
|
|
3144
|
+
<param name="fieldName">The name of the field with the error</param>
|
|
3145
|
+
</member>
|
|
3146
|
+
<member name="P:FileHelpers.ConvertException.FieldType">
|
|
3147
|
+
<summary>The destination type.</summary>
|
|
3148
|
+
</member>
|
|
3149
|
+
<member name="P:FileHelpers.ConvertException.FieldStringValue">
|
|
3150
|
+
<summary>The value that cant be converterd. (null for unknown)</summary>
|
|
3151
|
+
</member>
|
|
3152
|
+
<member name="P:FileHelpers.ConvertException.MessageExtra">
|
|
3153
|
+
<summary>Extra info about the error.</summary>
|
|
3154
|
+
</member>
|
|
3155
|
+
<member name="P:FileHelpers.ConvertException.FieldName">
|
|
3156
|
+
<summary>The name of the field related to the exception. (null for unknown)</summary>
|
|
3157
|
+
</member>
|
|
3158
|
+
<member name="P:FileHelpers.ConvertException.LineNumber">
|
|
3159
|
+
<summary>The line where the error was found. (-1 is unknown)</summary>
|
|
3160
|
+
</member>
|
|
3161
|
+
<member name="P:FileHelpers.ConvertException.ColumnNumber">
|
|
3162
|
+
<summary>The estimate column where the error was found. (-1 is unknown)</summary>
|
|
3163
|
+
</member>
|
|
3164
|
+
<member name="T:FileHelpers.ErrorInfo">
|
|
3165
|
+
<summary>Contains error information of the <see cref="T:FileHelpers.FileHelperEngine"/> class.</summary>
|
|
3166
|
+
</member>
|
|
3167
|
+
<member name="P:FileHelpers.ErrorInfo.LineNumber">
|
|
3168
|
+
<summary>The line number of the error</summary>
|
|
3169
|
+
</member>
|
|
3170
|
+
<member name="P:FileHelpers.ErrorInfo.RecordString">
|
|
3171
|
+
<summary>The string of the record of the error.</summary>
|
|
3172
|
+
</member>
|
|
3173
|
+
<member name="P:FileHelpers.ErrorInfo.ExceptionInfo">
|
|
3174
|
+
<summary>The exception that indicates the error.</summary>
|
|
3175
|
+
</member>
|
|
3176
|
+
<member name="T:FileHelpers.ErrorManager">
|
|
3177
|
+
<summary>This is the class that handles the errors of the engines process.</summary>
|
|
3178
|
+
<remarks>All the engines and DataStorages contains a ErrorManager.</remarks>
|
|
3179
|
+
</member>
|
|
3180
|
+
<member name="M:FileHelpers.ErrorManager.#ctor">
|
|
3181
|
+
<summary>Initializes a new instance of the <see cref="T:FileHelpers.ErrorManager"/> class.</summary>
|
|
3182
|
+
</member>
|
|
3183
|
+
<member name="M:FileHelpers.ErrorManager.#ctor(FileHelpers.ErrorMode)">
|
|
3184
|
+
<summary>Initializes a new instance of the <see cref="T:FileHelpers.ErrorManager"/> class. with the specified <see cref="P:FileHelpers.ErrorManager.ErrorMode"/>.</summary>
|
|
3185
|
+
<param name="mode">Indicates the error behavior of the class.</param>
|
|
3186
|
+
</member>
|
|
3187
|
+
<member name="M:FileHelpers.ErrorManager.ClearErrors">
|
|
3188
|
+
<summary>Clears the error collection.</summary>
|
|
3189
|
+
</member>
|
|
3190
|
+
<member name="M:FileHelpers.ErrorManager.AddError(FileHelpers.ErrorInfo)">
|
|
3191
|
+
<summary>Add the specified ErrorInfo to the contained collection.</summary>
|
|
3192
|
+
<param name="error"></param>
|
|
3193
|
+
</member>
|
|
3194
|
+
<member name="M:FileHelpers.ErrorManager.AddErrors(FileHelpers.ErrorManager)">
|
|
3195
|
+
<summary>Add the specified ErrorInfo to the contained collection.</summary>
|
|
3196
|
+
</member>
|
|
3197
|
+
<member name="M:FileHelpers.ErrorManager.SaveErrors(System.String)">
|
|
3198
|
+
<summary>Saves the contained errors to the specified file.</summary>
|
|
3199
|
+
<param name="fileName">The file that contains the errors.</param>
|
|
3200
|
+
</member>
|
|
3201
|
+
<member name="M:FileHelpers.ErrorManager.SaveErrors(System.String,System.String)">
|
|
3202
|
+
<summary>Saves the contained errors to the specified file.</summary>
|
|
3203
|
+
<param name="fileName">The file that contains the errors.</param>
|
|
3204
|
+
<param name="header">The header line of the errors file.</param>
|
|
3205
|
+
</member>
|
|
3206
|
+
<member name="M:FileHelpers.ErrorManager.LoadErrors(System.String)">
|
|
3207
|
+
<summary>Load errors from a file.</summary>
|
|
3208
|
+
<param name="fileName">The file that contains the errors.</param>
|
|
3209
|
+
</member>
|
|
3210
|
+
<member name="P:FileHelpers.ErrorManager.Errors">
|
|
3211
|
+
<summary>Is an array of <see cref="T:FileHelpers.ErrorInfo"/> that contains the errors of the last operation in this class.</summary>
|
|
3212
|
+
</member>
|
|
3213
|
+
<member name="P:FileHelpers.ErrorManager.ErrorMode">
|
|
3214
|
+
<summary>Indicates the behavior of the <see cref="T:FileHelpers.FileHelperEngine"/> when it found an error.</summary>
|
|
3215
|
+
</member>
|
|
3216
|
+
<member name="P:FileHelpers.ErrorManager.ErrorCount">
|
|
3217
|
+
<summary>Number of contained errors.</summary>
|
|
3218
|
+
</member>
|
|
3219
|
+
<member name="P:FileHelpers.ErrorManager.HasErrors">
|
|
3220
|
+
<summary>Indicates if contains one or more errors.</summary>
|
|
3221
|
+
</member>
|
|
3222
|
+
<member name="T:FileHelpers.RunTime.RunTimeCompilationException">
|
|
3223
|
+
<summary>
|
|
3224
|
+
Exception with error information of the run time compilation.
|
|
3225
|
+
</summary>
|
|
3226
|
+
</member>
|
|
3227
|
+
<member name="P:FileHelpers.RunTime.RunTimeCompilationException.SourceCode">
|
|
3228
|
+
<summary>
|
|
3229
|
+
The source code that generates the Exception
|
|
3230
|
+
</summary>
|
|
3231
|
+
</member>
|
|
3232
|
+
<member name="P:FileHelpers.RunTime.RunTimeCompilationException.CompilerErrors">
|
|
3233
|
+
<summary>
|
|
3234
|
+
The errors returned from the compiler.
|
|
3235
|
+
</summary>
|
|
3236
|
+
</member>
|
|
3237
|
+
<member name="T:FileHelpers.BeforeReadRecordHandler">
|
|
3238
|
+
<summary>
|
|
3239
|
+
Called in read operations just before the record string is translated to a record.
|
|
3240
|
+
</summary>
|
|
3241
|
+
<param name="engine">The engine that generates the event.</param>
|
|
3242
|
+
<param name="e">The event data.</param>
|
|
3243
|
+
</member>
|
|
3244
|
+
<member name="T:FileHelpers.AfterReadRecordHandler">
|
|
3245
|
+
<summary>
|
|
3246
|
+
Called in read operations just after the record was created from a record string.
|
|
3247
|
+
</summary>
|
|
3248
|
+
<param name="engine">The engine that generates the event.</param>
|
|
3249
|
+
<param name="e">The event data.</param>
|
|
3250
|
+
</member>
|
|
3251
|
+
<member name="T:FileHelpers.BeforeWriteRecordHandler">
|
|
3252
|
+
<summary>
|
|
3253
|
+
Called in write operations just before the record is converted to a string to write it.
|
|
3254
|
+
</summary>
|
|
3255
|
+
<param name="engine">The engine that generates the event.</param>
|
|
3256
|
+
<param name="e">The event data.</param>
|
|
3257
|
+
</member>
|
|
3258
|
+
<member name="T:FileHelpers.AfterWriteRecordHandler">
|
|
3259
|
+
<summary>
|
|
3260
|
+
Called in write operations just after the record was converted to a string.
|
|
3261
|
+
</summary>
|
|
3262
|
+
<param name="engine">The engine that generates the event.</param>
|
|
3263
|
+
<param name="e">The event data.</param>
|
|
3264
|
+
</member>
|
|
3265
|
+
<member name="T:FileHelpers.ReadRecordEventArgs">
|
|
3266
|
+
<summary>Base class of <see cref="T:FileHelpers.BeforeReadRecordEventArgs"/> and <see cref="T:FileHelpers.AfterReadRecordEventArgs"/></summary>
|
|
3267
|
+
</member>
|
|
3268
|
+
<member name="P:FileHelpers.ReadRecordEventArgs.LineNumber">
|
|
3269
|
+
<summary>The current line number.</summary>
|
|
3270
|
+
</member>
|
|
3271
|
+
<member name="P:FileHelpers.ReadRecordEventArgs.RecordLine">
|
|
3272
|
+
<summary>The just read record line.</summary>
|
|
3273
|
+
</member>
|
|
3274
|
+
<member name="T:FileHelpers.BeforeReadRecordEventArgs">
|
|
3275
|
+
<summary>Arguments for the <see cref="T:FileHelpers.BeforeReadRecordHandler"/></summary>
|
|
3276
|
+
</member>
|
|
3277
|
+
<member name="P:FileHelpers.BeforeReadRecordEventArgs.SkipThisRecord">
|
|
3278
|
+
<summary>Set this property to true if you want to bypass the current line.</summary>
|
|
3279
|
+
</member>
|
|
3280
|
+
<member name="T:FileHelpers.AfterReadRecordEventArgs">
|
|
3281
|
+
<summary>Arguments for the <see cref="T:FileHelpers.AfterReadRecordHandler"/></summary>
|
|
3282
|
+
</member>
|
|
3283
|
+
<member name="P:FileHelpers.AfterReadRecordEventArgs.Record">
|
|
3284
|
+
<summary>The current record.</summary>
|
|
3285
|
+
</member>
|
|
3286
|
+
<member name="P:FileHelpers.AfterReadRecordEventArgs.SkipThisRecord">
|
|
3287
|
+
<summary>Set this property to true if you want to bypass the current record.</summary>
|
|
3288
|
+
</member>
|
|
3289
|
+
<member name="T:FileHelpers.WriteRecordEventArgs">
|
|
3290
|
+
<summary>Base class of <see cref="T:FileHelpers.BeforeWriteRecordEventArgs"/> and <see cref="T:FileHelpers.AfterWriteRecordEventArgs"/></summary>
|
|
3291
|
+
</member>
|
|
3292
|
+
<member name="P:FileHelpers.WriteRecordEventArgs.Record">
|
|
3293
|
+
<summary>The current record.</summary>
|
|
3294
|
+
</member>
|
|
3295
|
+
<member name="P:FileHelpers.WriteRecordEventArgs.LineNumber">
|
|
3296
|
+
<summary>The current line number.</summary>
|
|
3297
|
+
</member>
|
|
3298
|
+
<member name="T:FileHelpers.BeforeWriteRecordEventArgs">
|
|
3299
|
+
<summary>Arguments for the <see cref="T:FileHelpers.BeforeWriteRecordHandler"/></summary>
|
|
3300
|
+
</member>
|
|
3301
|
+
<member name="P:FileHelpers.BeforeWriteRecordEventArgs.SkipThisRecord">
|
|
3302
|
+
<summary>Set this property as true if you want to bypass the current record.</summary>
|
|
3303
|
+
</member>
|
|
3304
|
+
<member name="T:FileHelpers.AfterWriteRecordEventArgs">
|
|
3305
|
+
<summary>Arguments for the <see cref="T:FileHelpers.AfterWriteRecordHandler"/></summary>
|
|
3306
|
+
</member>
|
|
3307
|
+
<member name="P:FileHelpers.AfterWriteRecordEventArgs.RecordLine">
|
|
3308
|
+
<summary>The line to be written to the file. WARNING: you can change this and the engines will write it to the file.</summary>
|
|
3309
|
+
</member>
|
|
3310
|
+
<member name="T:FileHelpers.FieldBase">
|
|
3311
|
+
<summary>Base class for all Field Types. Implements all the basic functionality of a field in a typed file.</summary>
|
|
3312
|
+
</member>
|
|
3313
|
+
<member name="T:FileHelpers.CsvOptions">
|
|
3314
|
+
<summary>Class used to pass information to the <see cref="T:FileHelpers.RunTime.CsvClassBuilder"/> and the <see cref="T:FileHelpers.CsvEngine"/></summary>
|
|
3315
|
+
</member>
|
|
3316
|
+
<member name="M:FileHelpers.CsvOptions.#ctor(System.String,System.Char,System.Int32)">
|
|
3317
|
+
<summary>Create a Csv Wrapper using the specified number of fields.</summary>
|
|
3318
|
+
<param name="className">The name of the record class</param>
|
|
3319
|
+
<param name="delimiter">The delimiter for each field</param>
|
|
3320
|
+
<param name="numberOfFields">The number of fields of each record</param>
|
|
3321
|
+
</member>
|
|
3322
|
+
<member name="M:FileHelpers.CsvOptions.#ctor(System.String,System.Char,System.String)">
|
|
3323
|
+
<summary>Create a Csv Wrapper using the specified sample file with their headers.</summary>
|
|
3324
|
+
<param name="className">The name of the record class</param>
|
|
3325
|
+
<param name="delimiter">The delimiter for each field</param>
|
|
3326
|
+
<param name="sampleFile">A sample file with a header that contains the names of the fields.</param>
|
|
3327
|
+
</member>
|
|
3328
|
+
<member name="P:FileHelpers.CsvOptions.SampleFileName">
|
|
3329
|
+
<summary>A sample file from where to read the field names and number.</summary>
|
|
3330
|
+
</member>
|
|
3331
|
+
<member name="P:FileHelpers.CsvOptions.Delimiter">
|
|
3332
|
+
<summary>The delimiter for each field.</summary>
|
|
3333
|
+
</member>
|
|
3334
|
+
<member name="P:FileHelpers.CsvOptions.HeaderDelimiter">
|
|
3335
|
+
<summary>The delimiter for each fiel name in the header.</summary>
|
|
3336
|
+
</member>
|
|
3337
|
+
<member name="P:FileHelpers.CsvOptions.RecordClassName">
|
|
3338
|
+
<summary>The name used for the record class (a valid .NET class).</summary>
|
|
3339
|
+
</member>
|
|
3340
|
+
<member name="P:FileHelpers.CsvOptions.FieldsPrefix">
|
|
3341
|
+
<summary>The prefix used when you only specified the number of fields</summary>
|
|
3342
|
+
</member>
|
|
3343
|
+
<member name="P:FileHelpers.CsvOptions.NumberOfFields">
|
|
3344
|
+
<summary>The number of fields that the file contains.</summary>
|
|
3345
|
+
</member>
|
|
3346
|
+
<member name="P:FileHelpers.CsvOptions.HeaderLines">
|
|
3347
|
+
<summary>The number of header lines</summary>
|
|
3348
|
+
</member>
|
|
3349
|
+
<member name="P:FileHelpers.CsvOptions.DateFormat">
|
|
3350
|
+
<summary>The DateFormat used to read and write datetime values</summary>
|
|
3351
|
+
</member>
|
|
3352
|
+
<member name="P:FileHelpers.CsvOptions.DecimalSeparator">
|
|
3353
|
+
<summary>The Decimal Separator used to read and write doubles, singles and decimal values</summary>
|
|
3354
|
+
</member>
|
|
3355
|
+
<member name="P:FileHelpers.CsvOptions.Encoding">
|
|
3356
|
+
<summary>
|
|
3357
|
+
Encoding used when handling the CSV files.
|
|
3358
|
+
</summary>
|
|
3359
|
+
</member>
|
|
3360
|
+
<member name="T:FileHelpers.IComparableRecord">
|
|
3361
|
+
<summary>Used by the FileDiffEngine to compare records. Your record class must implement this interface if you like to work with it.</summary>
|
|
3362
|
+
</member>
|
|
3363
|
+
<member name="M:FileHelpers.IComparableRecord.IsEqualRecord(System.Object)">
|
|
3364
|
+
<summary>
|
|
3365
|
+
Compare two records and return true if are equal.
|
|
3366
|
+
</summary>
|
|
3367
|
+
<param name="record">The other record.</param>
|
|
3368
|
+
<returns>Returns true only if the records are equals.</returns>
|
|
3369
|
+
</member>
|
|
3370
|
+
<member name="T:FileHelpers.INotifyRead">
|
|
3371
|
+
<summary>
|
|
3372
|
+
Interface used to provide In record notification of read operations.
|
|
3373
|
+
</summary>
|
|
3374
|
+
<example>
|
|
3375
|
+
<code>
|
|
3376
|
+
private class SampleType: INotifyRead, INotifyWrite
|
|
3377
|
+
{ ....
|
|
3378
|
+
|
|
3379
|
+
public void AfterRead(EngineBase engine, string line)
|
|
3380
|
+
{
|
|
3381
|
+
// Your Code Here
|
|
3382
|
+
}
|
|
3383
|
+
public void BeforeWrite(EngineBase engine)
|
|
3384
|
+
{
|
|
3385
|
+
// Your Code Here
|
|
3386
|
+
}
|
|
3387
|
+
|
|
3388
|
+
}
|
|
3389
|
+
</code>
|
|
3390
|
+
</example>
|
|
3391
|
+
</member>
|
|
3392
|
+
<member name="M:FileHelpers.INotifyRead.AfterRead(FileHelpers.EngineBase,System.String)">
|
|
3393
|
+
<summary>
|
|
3394
|
+
Method called by the engines after read a record from the source data.
|
|
3395
|
+
</summary>
|
|
3396
|
+
<param name="engine">The engine that makes the call.</param>
|
|
3397
|
+
<param name="line">The source line.</param>
|
|
3398
|
+
</member>
|
|
3399
|
+
<member name="T:FileHelpers.INotifyWrite">
|
|
3400
|
+
<summary>
|
|
3401
|
+
Interface used to provide <b>In record notification of write operations.</b>
|
|
3402
|
+
</summary>
|
|
3403
|
+
<example>
|
|
3404
|
+
<code>
|
|
3405
|
+
private class SampleType: INotifyRead, INotifyWrite
|
|
3406
|
+
{ ....
|
|
3407
|
+
|
|
3408
|
+
public void AfterRead(EngineBase engine, string line)
|
|
3409
|
+
{
|
|
3410
|
+
// Your Code Here
|
|
3411
|
+
}
|
|
3412
|
+
public void BeforeWrite(EngineBase engine)
|
|
3413
|
+
{
|
|
3414
|
+
// Your Code Here
|
|
3415
|
+
}
|
|
3416
|
+
|
|
3417
|
+
}
|
|
3418
|
+
</code>
|
|
3419
|
+
</example>
|
|
3420
|
+
</member>
|
|
3421
|
+
<member name="M:FileHelpers.INotifyWrite.BeforeWrite(FileHelpers.EngineBase)">
|
|
3422
|
+
<summary>
|
|
3423
|
+
Method called by the engines before write a record to the destination stream.
|
|
3424
|
+
</summary>
|
|
3425
|
+
<param name="engine">The engine that makes the call.</param>
|
|
3426
|
+
</member>
|
|
3427
|
+
<member name="T:FileHelpers.MasterDetail.MasterDetailSelector">
|
|
3428
|
+
<summary>
|
|
3429
|
+
Delegate thats determines the Type of the current record (Master, Detail, Skip)
|
|
3430
|
+
</summary>
|
|
3431
|
+
<param name="recordString">The string of the current record.</param>
|
|
3432
|
+
<returns>the action used for the current record (Master, Detail, Skip)</returns>
|
|
3433
|
+
</member>
|
|
3434
|
+
<member name="T:FileHelpers.MasterDetail.CommonSelector">
|
|
3435
|
+
<summary>The Action taken when the selector string is found.</summary>
|
|
3436
|
+
</member>
|
|
3437
|
+
<member name="F:FileHelpers.MasterDetail.CommonSelector.MasterIfContains">
|
|
3438
|
+
<summary>Parse the current record as <b>Master</b> if the selector string is found.</summary>
|
|
3439
|
+
</member>
|
|
3440
|
+
<member name="F:FileHelpers.MasterDetail.CommonSelector.MasterIfBegins">
|
|
3441
|
+
<summary>Parse the current record as <b>Master</b> if the record starts with some string.</summary>
|
|
3442
|
+
</member>
|
|
3443
|
+
<member name="F:FileHelpers.MasterDetail.CommonSelector.MasterIfEnds">
|
|
3444
|
+
<summary>Parse the current record as <b>Master</b> if the record ends with some string.</summary>
|
|
3445
|
+
</member>
|
|
3446
|
+
<member name="F:FileHelpers.MasterDetail.CommonSelector.MasterIfEnclosed">
|
|
3447
|
+
<summary>Parse the current record as <b>Master</b> if the record begins and ends with some string.</summary>
|
|
3448
|
+
</member>
|
|
3449
|
+
<member name="F:FileHelpers.MasterDetail.CommonSelector.DetailIfContains">
|
|
3450
|
+
<summary>Parse the current record as <b>Detail</b> if the selector string is found.</summary>
|
|
3451
|
+
</member>
|
|
3452
|
+
<member name="F:FileHelpers.MasterDetail.CommonSelector.DetailIfBegins">
|
|
3453
|
+
<summary>Parse the current record as <b>Detail</b> if the record starts with some string.</summary>
|
|
3454
|
+
</member>
|
|
3455
|
+
<member name="F:FileHelpers.MasterDetail.CommonSelector.DetailIfEnds">
|
|
3456
|
+
<summary>Parse the current record as <b>Detail</b> if the record ends with some string.</summary>
|
|
3457
|
+
</member>
|
|
3458
|
+
<member name="F:FileHelpers.MasterDetail.CommonSelector.DetailIfEnclosed">
|
|
3459
|
+
<summary>Parse the current record as <b>Detail</b> if the record begins and ends with some string.</summary>
|
|
3460
|
+
</member>
|
|
3461
|
+
<member name="T:FileHelpers.MasterDetail.MasterDetailEngine">
|
|
3462
|
+
<summary>
|
|
3463
|
+
<para><b>One of the main classes of the library.</b></para>
|
|
3464
|
+
<para>This engine is responsable to Read/Write <b>Master-Details</b> records from/to files or streams.</para>
|
|
3465
|
+
</summary><remarks>
|
|
3466
|
+
<para>You can set the <see cref="P:FileHelpers.ErrorManager.ErrorMode"/> of this class when found an error, and can retrive them with the <see cref="P:FileHelpers.ErrorManager.Errors"/> property.</para>
|
|
3467
|
+
<para>See in the <a href="class_diagram.html">Class Diagram</a> and in the <a href="quick_start.html">Quick Start Guide</a> for more Info.</para>
|
|
3468
|
+
<para>Or you can browse the <a href="examples.html">Examples Seccion</a> for more code.</para>
|
|
3469
|
+
</remarks><seealso href="quick_start.html">Quick Start Guide</seealso><seealso href="class_diagram.html">Class Diagram</seealso><seealso href="examples.html">Examples of Use</seealso><seealso href="attributes.html">Attributes List</seealso>
|
|
3470
|
+
<!-- No matching elements were found for the following include tag --><include file="Examples.xml" path="doc/examples/MasterDetailEngine/*"/>
|
|
3471
|
+
</member>
|
|
3472
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.#ctor(System.Type,System.Type,FileHelpers.MasterDetail.MasterDetailSelector)">
|
|
3473
|
+
<summary>
|
|
3474
|
+
Initializes a new instance of the MasterDetailEngine class with the specified type of records.
|
|
3475
|
+
</summary><param name="masterType">The master record class.</param><param name="detailType">The detail record class.</param><param name="recordSelector">The <see cref="T:FileHelpers.MasterDetail.MasterDetailSelector"/> to get the <see cref="T:FileHelpers.MasterDetail.RecordAction"/>.</param>
|
|
3476
|
+
</member>
|
|
3477
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.#ctor(System.Type,System.Type,FileHelpers.MasterDetail.CommonSelector,System.String)">
|
|
3478
|
+
<summary>
|
|
3479
|
+
Initializes a new instance of the MasterDetailEngine class with the specified type of records.
|
|
3480
|
+
</summary><param name="masterType">The master record class.</param><param name="detailType">The detail record class.</param><param name="action">The <see cref="T:FileHelpers.MasterDetail.CommonSelector"/> used by the engine.</param><param name="selector">The string passed to the selector.</param>
|
|
3481
|
+
</member>
|
|
3482
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.ReadFile(System.String)">
|
|
3483
|
+
<summary>
|
|
3484
|
+
Read a file and return an array of the contained records.
|
|
3485
|
+
</summary><remarks>
|
|
3486
|
+
This method open, read and close the file (don't open or close the file before or after to call this method)
|
|
3487
|
+
</remarks><example>
|
|
3488
|
+
You need to define a Selector Method too:
|
|
3489
|
+
|
|
3490
|
+
<code>
|
|
3491
|
+
RecordAction ExampleSelector(string record)
|
|
3492
|
+
{
|
|
3493
|
+
if (Char.IsLetter(record[0]))
|
|
3494
|
+
return RecordAction.Master;
|
|
3495
|
+
else
|
|
3496
|
+
return RecordAction.Detail;
|
|
3497
|
+
}
|
|
3498
|
+
|
|
3499
|
+
</code>
|
|
3500
|
+
Finally you must to instanciate a MasterDetailEngine and Read/Write files:
|
|
3501
|
+
|
|
3502
|
+
<code>
|
|
3503
|
+
MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));
|
|
3504
|
+
|
|
3505
|
+
// to Read use:
|
|
3506
|
+
MasterDetail[] res = engine.ReadFile("TestIn.txt");
|
|
3507
|
+
|
|
3508
|
+
// to Write use:
|
|
3509
|
+
engine.WriteFile("TestOut.txt", res);
|
|
3510
|
+
|
|
3511
|
+
</code>
|
|
3512
|
+
</example><param name="fileName">The file path to be read.</param><returns>An array of the records in the file</returns>
|
|
3513
|
+
</member>
|
|
3514
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.ReadStream(System.IO.TextReader)">
|
|
3515
|
+
<summary>
|
|
3516
|
+
Read a Stream and return an array of the contained records.
|
|
3517
|
+
</summary><remarks>
|
|
3518
|
+
This method only uses the stream and dont close them after use it, you must do it.
|
|
3519
|
+
</remarks><example>
|
|
3520
|
+
You need to define a Selector Method too:
|
|
3521
|
+
|
|
3522
|
+
<code>
|
|
3523
|
+
RecordAction ExampleSelector(string record)
|
|
3524
|
+
{
|
|
3525
|
+
if (Char.IsLetter(record[0]))
|
|
3526
|
+
return RecordAction.Master;
|
|
3527
|
+
else
|
|
3528
|
+
return RecordAction.Detail;
|
|
3529
|
+
}
|
|
3530
|
+
|
|
3531
|
+
</code>
|
|
3532
|
+
Finally you must to instanciate a MasterDetailEngine and Read/Write files:
|
|
3533
|
+
|
|
3534
|
+
<code>
|
|
3535
|
+
MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));
|
|
3536
|
+
|
|
3537
|
+
// to Read use:
|
|
3538
|
+
MasterDetail[] res = engine.ReadFile("TestIn.txt");
|
|
3539
|
+
|
|
3540
|
+
// to Write use:
|
|
3541
|
+
engine.WriteFile("TestOut.txt", res);
|
|
3542
|
+
|
|
3543
|
+
</code>
|
|
3544
|
+
</example><param name="reader">The reader of the source stream.</param><returns>An array of the records in the Stream</returns>
|
|
3545
|
+
</member>
|
|
3546
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.ReadString(System.String)">
|
|
3547
|
+
<summary>
|
|
3548
|
+
Read a String and return an array of the contained records.
|
|
3549
|
+
</summary><param name="source">The string that contains the records.</param><returns>An array of the records in the String.</returns>
|
|
3550
|
+
</member>
|
|
3551
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.WriteFile(System.String,FileHelpers.MasterDetail.MasterDetails[])">
|
|
3552
|
+
<summary>
|
|
3553
|
+
Write an array of records to the specified file.
|
|
3554
|
+
</summary><remarks>
|
|
3555
|
+
<para>This method open, write and close the file (don't open or close the file before or after to call this method)</para>
|
|
3556
|
+
<para>This method overrides existing files.</para>
|
|
3557
|
+
</remarks><example>
|
|
3558
|
+
You need to define a Selector Method too:
|
|
3559
|
+
|
|
3560
|
+
<code>
|
|
3561
|
+
RecordAction ExampleSelector(string record)
|
|
3562
|
+
{
|
|
3563
|
+
if (Char.IsLetter(record[0]))
|
|
3564
|
+
return RecordAction.Master;
|
|
3565
|
+
else
|
|
3566
|
+
return RecordAction.Detail;
|
|
3567
|
+
}
|
|
3568
|
+
|
|
3569
|
+
</code>
|
|
3570
|
+
Finally you must to instanciate a MasterDetailEngine and Read/Write files:
|
|
3571
|
+
|
|
3572
|
+
<code>
|
|
3573
|
+
MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));
|
|
3574
|
+
|
|
3575
|
+
// to Read use:
|
|
3576
|
+
MasterDetail[] res = engine.ReadFile("TestIn.txt");
|
|
3577
|
+
|
|
3578
|
+
// to Write use:
|
|
3579
|
+
engine.WriteFile("TestOut.txt", res);
|
|
3580
|
+
|
|
3581
|
+
</code>
|
|
3582
|
+
</example><param name="fileName">The file path to be write.</param><param name="records">The array of records to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
3583
|
+
</member>
|
|
3584
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.WriteFile(System.String,FileHelpers.MasterDetail.MasterDetails[],System.Int32)">
|
|
3585
|
+
<summary>
|
|
3586
|
+
Write the specified number of records from the array to a file.
|
|
3587
|
+
</summary><remarks>
|
|
3588
|
+
<para>This method open, write and close the file (don't open or close the file before or after to call this method)</para>
|
|
3589
|
+
<para>This method overrides existing files.</para>
|
|
3590
|
+
</remarks><example>
|
|
3591
|
+
You need to define a Selector Method too:
|
|
3592
|
+
|
|
3593
|
+
<code>
|
|
3594
|
+
RecordAction ExampleSelector(string record)
|
|
3595
|
+
{
|
|
3596
|
+
if (Char.IsLetter(record[0]))
|
|
3597
|
+
return RecordAction.Master;
|
|
3598
|
+
else
|
|
3599
|
+
return RecordAction.Detail;
|
|
3600
|
+
}
|
|
3601
|
+
|
|
3602
|
+
</code>
|
|
3603
|
+
Finally you must to instanciate a MasterDetailEngine and Read/Write files:
|
|
3604
|
+
|
|
3605
|
+
<code>
|
|
3606
|
+
MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));
|
|
3607
|
+
|
|
3608
|
+
// to Read use:
|
|
3609
|
+
MasterDetail[] res = engine.ReadFile("TestIn.txt");
|
|
3610
|
+
|
|
3611
|
+
// to Write use:
|
|
3612
|
+
engine.WriteFile("TestOut.txt", res);
|
|
3613
|
+
|
|
3614
|
+
</code>
|
|
3615
|
+
</example><param name="fileName">The file path to be write.</param><param name="records">The array of records to write.</param><param name="maxRecords">The max number of array elements to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
3616
|
+
</member>
|
|
3617
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.WriteStream(System.IO.TextWriter,FileHelpers.MasterDetail.MasterDetails[])">
|
|
3618
|
+
<summary>
|
|
3619
|
+
Write an array of records to the specified Stream.
|
|
3620
|
+
</summary><remarks>
|
|
3621
|
+
This method only uses the stream and don't close them after use it, you must do it.
|
|
3622
|
+
</remarks><example>
|
|
3623
|
+
You need to define a Selector Method too:
|
|
3624
|
+
|
|
3625
|
+
<code>
|
|
3626
|
+
RecordAction ExampleSelector(string record)
|
|
3627
|
+
{
|
|
3628
|
+
if (Char.IsLetter(record[0]))
|
|
3629
|
+
return RecordAction.Master;
|
|
3630
|
+
else
|
|
3631
|
+
return RecordAction.Detail;
|
|
3632
|
+
}
|
|
3633
|
+
|
|
3634
|
+
</code>
|
|
3635
|
+
Finally you must to instanciate a MasterDetailEngine and Read/Write files:
|
|
3636
|
+
|
|
3637
|
+
<code>
|
|
3638
|
+
MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));
|
|
3639
|
+
|
|
3640
|
+
// to Read use:
|
|
3641
|
+
MasterDetail[] res = engine.ReadFile("TestIn.txt");
|
|
3642
|
+
|
|
3643
|
+
// to Write use:
|
|
3644
|
+
engine.WriteFile("TestOut.txt", res);
|
|
3645
|
+
|
|
3646
|
+
</code>
|
|
3647
|
+
</example><param name="writer">The writer of the source stream.</param><param name="records">The array of records to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
3648
|
+
</member>
|
|
3649
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.WriteStream(System.IO.TextWriter,FileHelpers.MasterDetail.MasterDetails[],System.Int32)">
|
|
3650
|
+
<summary>
|
|
3651
|
+
Write the specified number of records in the array to the Stream.
|
|
3652
|
+
</summary><remarks>
|
|
3653
|
+
This method only uses the stream and don't close them after use it, you must do it.
|
|
3654
|
+
</remarks><example>
|
|
3655
|
+
You need to define a Selector Method too:
|
|
3656
|
+
|
|
3657
|
+
<code>
|
|
3658
|
+
RecordAction ExampleSelector(string record)
|
|
3659
|
+
{
|
|
3660
|
+
if (Char.IsLetter(record[0]))
|
|
3661
|
+
return RecordAction.Master;
|
|
3662
|
+
else
|
|
3663
|
+
return RecordAction.Detail;
|
|
3664
|
+
}
|
|
3665
|
+
|
|
3666
|
+
</code>
|
|
3667
|
+
Finally you must to instanciate a MasterDetailEngine and Read/Write files:
|
|
3668
|
+
|
|
3669
|
+
<code>
|
|
3670
|
+
MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));
|
|
3671
|
+
|
|
3672
|
+
// to Read use:
|
|
3673
|
+
MasterDetail[] res = engine.ReadFile("TestIn.txt");
|
|
3674
|
+
|
|
3675
|
+
// to Write use:
|
|
3676
|
+
engine.WriteFile("TestOut.txt", res);
|
|
3677
|
+
|
|
3678
|
+
</code>
|
|
3679
|
+
</example><param name="writer">The writer of the source stream.</param><param name="records">The array of records to write.</param><param name="maxRecords">The max number of array elements to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
3680
|
+
</member>
|
|
3681
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.WriteString(FileHelpers.MasterDetail.MasterDetails[])">
|
|
3682
|
+
<summary>
|
|
3683
|
+
Write an array of records to an String and return it.
|
|
3684
|
+
</summary><param name="records">The array of records to write.</param><returns>The resulting string after write the records.</returns>
|
|
3685
|
+
</member>
|
|
3686
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.WriteString(FileHelpers.MasterDetail.MasterDetails[],System.Int32)">
|
|
3687
|
+
<summary>
|
|
3688
|
+
Write an array of records to an String and return it.
|
|
3689
|
+
</summary><param name="records">The array of records to write.</param><returns>The resulting string after write the records.</returns><param name="maxRecords">The max number of array elements to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
3690
|
+
</member>
|
|
3691
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.AppendToFile(System.String,FileHelpers.MasterDetail.MasterDetails)">
|
|
3692
|
+
<summary>
|
|
3693
|
+
Append a record to the specified file.
|
|
3694
|
+
</summary><remarks>
|
|
3695
|
+
This method open, seek ends, write and close the file (don't open or close the file before or after to call this method)
|
|
3696
|
+
</remarks><example>
|
|
3697
|
+
You need to define a Selector Method too:
|
|
3698
|
+
|
|
3699
|
+
<code>
|
|
3700
|
+
RecordAction ExampleSelector(string record)
|
|
3701
|
+
{
|
|
3702
|
+
if (Char.IsLetter(record[0]))
|
|
3703
|
+
return RecordAction.Master;
|
|
3704
|
+
else
|
|
3705
|
+
return RecordAction.Detail;
|
|
3706
|
+
}
|
|
3707
|
+
|
|
3708
|
+
</code>
|
|
3709
|
+
Finally you must to instanciate a MasterDetailEngine and Read/Write files:
|
|
3710
|
+
|
|
3711
|
+
<code>
|
|
3712
|
+
MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));
|
|
3713
|
+
|
|
3714
|
+
// to Read use:
|
|
3715
|
+
MasterDetail[] res = engine.ReadFile("TestIn.txt");
|
|
3716
|
+
|
|
3717
|
+
// to Write use:
|
|
3718
|
+
engine.WriteFile("TestOut.txt", res);
|
|
3719
|
+
|
|
3720
|
+
</code>
|
|
3721
|
+
</example><param name="fileName">The file path to be written at end.</param><param name="record">The record to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
3722
|
+
</member>
|
|
3723
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetailEngine.AppendToFile(System.String,FileHelpers.MasterDetail.MasterDetails[])">
|
|
3724
|
+
<summary>
|
|
3725
|
+
Append an array of records to the specified file.
|
|
3726
|
+
</summary><remarks>
|
|
3727
|
+
This method open, seek ends, write and close the file (don't open or close the file before or after to call this method)
|
|
3728
|
+
</remarks><example>
|
|
3729
|
+
You need to define a Selector Method too:
|
|
3730
|
+
|
|
3731
|
+
<code>
|
|
3732
|
+
RecordAction ExampleSelector(string record)
|
|
3733
|
+
{
|
|
3734
|
+
if (Char.IsLetter(record[0]))
|
|
3735
|
+
return RecordAction.Master;
|
|
3736
|
+
else
|
|
3737
|
+
return RecordAction.Detail;
|
|
3738
|
+
}
|
|
3739
|
+
|
|
3740
|
+
</code>
|
|
3741
|
+
Finally you must to instanciate a MasterDetailEngine and Read/Write files:
|
|
3742
|
+
|
|
3743
|
+
<code>
|
|
3744
|
+
MaterDetailEngine engine = new MaterDetailEngine(typeof(Customers), typeof(Orders), new MasterDetailSelector(ExampleSelector));
|
|
3745
|
+
|
|
3746
|
+
// to Read use:
|
|
3747
|
+
MasterDetail[] res = engine.ReadFile("TestIn.txt");
|
|
3748
|
+
|
|
3749
|
+
// to Write use:
|
|
3750
|
+
engine.WriteFile("TestOut.txt", res);
|
|
3751
|
+
|
|
3752
|
+
</code>
|
|
3753
|
+
</example><param name="fileName">The file path to be written at end.</param><param name="records">The array of records to write.</param><returns>True if the operation is successful. False otherwise.</returns>
|
|
3754
|
+
</member>
|
|
3755
|
+
<member name="P:FileHelpers.MasterDetail.MasterDetailEngine.MasterType">
|
|
3756
|
+
<summary>Returns the type of the master records handled by this engine.</summary>
|
|
3757
|
+
</member>
|
|
3758
|
+
<member name="T:FileHelpers.MasterDetail.MasterDetails">
|
|
3759
|
+
<summary>
|
|
3760
|
+
<para>This class contains information of a Master record an their Details records.</para>
|
|
3761
|
+
<para>This class is used for the Read and Write operations of the <see cref="T:FileHelpers.MasterDetail.MasterDetailEngine"/>.</para>
|
|
3762
|
+
</summary>
|
|
3763
|
+
</member>
|
|
3764
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetails.#ctor">
|
|
3765
|
+
<summary>Create an empty instance.</summary>
|
|
3766
|
+
</member>
|
|
3767
|
+
<member name="M:FileHelpers.MasterDetail.MasterDetails.#ctor(System.Object,System.Object[])">
|
|
3768
|
+
<summary>Create a new instance with the specified values.</summary>
|
|
3769
|
+
<param name="master">The master record.</param>
|
|
3770
|
+
<param name="details">The details record.</param>
|
|
3771
|
+
</member>
|
|
3772
|
+
<member name="P:FileHelpers.MasterDetail.MasterDetails.Empty">
|
|
3773
|
+
<summary>Returns a canonical empty MasterDetail object.</summary>
|
|
3774
|
+
</member>
|
|
3775
|
+
<member name="P:FileHelpers.MasterDetail.MasterDetails.Master">
|
|
3776
|
+
<summary>The Master record.</summary>
|
|
3777
|
+
</member>
|
|
3778
|
+
<member name="P:FileHelpers.MasterDetail.MasterDetails.Details">
|
|
3779
|
+
<summary>An Array with the Detail records.</summary>
|
|
3780
|
+
</member>
|
|
3781
|
+
<member name="T:FileHelpers.MasterDetail.RecordAction">
|
|
3782
|
+
<summary>Used with the <see cref="T:FileHelpers.MasterDetail.MasterDetailSelector"/> Delegate to determines the action used by the <see cref="T:FileHelpers.MasterDetail.MasterDetailEngine"/></summary>
|
|
3783
|
+
</member>
|
|
3784
|
+
<member name="F:FileHelpers.MasterDetail.RecordAction.Skip">
|
|
3785
|
+
<summary><b>Ignore</b> the current record.</summary>
|
|
3786
|
+
</member>
|
|
3787
|
+
<member name="F:FileHelpers.MasterDetail.RecordAction.Master">
|
|
3788
|
+
<summary>Use the current record as <b>Master</b>.</summary>
|
|
3789
|
+
</member>
|
|
3790
|
+
<member name="F:FileHelpers.MasterDetail.RecordAction.Detail">
|
|
3791
|
+
<summary>Use the current record as <b>Detail</b>.</summary>
|
|
3792
|
+
</member>
|
|
3793
|
+
<member name="T:FileHelpers.DelimitedRecordOptions">
|
|
3794
|
+
<summary>
|
|
3795
|
+
This class allows you to set some options of the delimited records but at runtime.
|
|
3796
|
+
With this options the library is more flexible than never.
|
|
3797
|
+
</summary>
|
|
3798
|
+
</member>
|
|
3799
|
+
<member name="T:FileHelpers.RecordOptions">
|
|
3800
|
+
<summary>
|
|
3801
|
+
This class allows you to set some options of the records but at runtime.
|
|
3802
|
+
With this options the library is more flexible than never.
|
|
3803
|
+
</summary>
|
|
3804
|
+
</member>
|
|
3805
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreFirstLines">
|
|
3806
|
+
<summary>Indicates the number of first lines to be discarded.</summary>
|
|
3807
|
+
</member>
|
|
3808
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreLastLines">
|
|
3809
|
+
<summary>Indicates the number of lines at the end of file to be discarded.</summary>
|
|
3810
|
+
</member>
|
|
3811
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreEmptyLines">
|
|
3812
|
+
<summary>Indicates that the engine must ignore the empty lines while reading.</summary>
|
|
3813
|
+
</member>
|
|
3814
|
+
<member name="P:FileHelpers.RecordOptions.RecordCondition">
|
|
3815
|
+
<summary>Allow to tell the engine what records must be included or excluded while reading.</summary>
|
|
3816
|
+
</member>
|
|
3817
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreCommentedLines">
|
|
3818
|
+
<summary>Indicates that the engine must ignore the lines with this comment marker.</summary>
|
|
3819
|
+
</member>
|
|
3820
|
+
<member name="T:FileHelpers.RecordOptions.RecordConditionInfo">
|
|
3821
|
+
<summary>Allow to tell the engine what records must be included or excluded while reading.</summary>
|
|
3822
|
+
</member>
|
|
3823
|
+
<member name="P:FileHelpers.RecordOptions.RecordConditionInfo.Condition">
|
|
3824
|
+
<summary>The condition used to include or exclude records.</summary>
|
|
3825
|
+
</member>
|
|
3826
|
+
<member name="P:FileHelpers.RecordOptions.RecordConditionInfo.Selector">
|
|
3827
|
+
<summary>The selector used by the <see cref="P:FileHelpers.RecordOptions.RecordCondition"/>.</summary>
|
|
3828
|
+
</member>
|
|
3829
|
+
<member name="T:FileHelpers.RecordOptions.IgnoreCommentInfo">
|
|
3830
|
+
<summary>Indicates that the engine must ignore the lines with this comment marker.</summary>
|
|
3831
|
+
</member>
|
|
3832
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreCommentInfo.CommentMarker">
|
|
3833
|
+
<summary>
|
|
3834
|
+
<para>Indicates that the engine must ignore the lines with this comment marker.</para>
|
|
3835
|
+
<para>An emty string or null indicates that the engine dont look for comments</para>
|
|
3836
|
+
</summary>
|
|
3837
|
+
</member>
|
|
3838
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreCommentInfo.InAnyPlace">
|
|
3839
|
+
<summary>Indicates if the comment can have spaces or tabs at left (true by default)</summary>
|
|
3840
|
+
</member>
|
|
3841
|
+
<member name="P:FileHelpers.DelimitedRecordOptions.Delimiter">
|
|
3842
|
+
<summary>
|
|
3843
|
+
The delimiter used to identify each field in the data.
|
|
3844
|
+
</summary>
|
|
3845
|
+
</member>
|
|
3846
|
+
<member name="T:FileHelpers.FixedRecordOptions">
|
|
3847
|
+
<summary>
|
|
3848
|
+
This class allows you to set some options of the fixed length records but at runtime.
|
|
3849
|
+
With this options the library is more flexible than never.
|
|
3850
|
+
</summary>
|
|
3851
|
+
</member>
|
|
3852
|
+
<member name="P:FileHelpers.FixedRecordOptions.FixedMode">
|
|
3853
|
+
<summary>Indicates the behavior when variable length records are found in a [<see cref="T:FileHelpers.FixedLengthRecordAttribute"/>]. (Note: nothing in common with [FieldOptional])</summary>
|
|
3854
|
+
</member>
|
|
3855
|
+
<member name="P:FileHelpers.FixedRecordOptions.RecordLength">
|
|
3856
|
+
<summary>
|
|
3857
|
+
The sum of the indivial field lengths.
|
|
3858
|
+
</summary>
|
|
3859
|
+
</member>
|
|
3860
|
+
<member name="T:FileHelpers.ProgressEventArgs">
|
|
3861
|
+
<summary>Class used to notify the current progress position and other context info.</summary>
|
|
3862
|
+
</member>
|
|
3863
|
+
<member name="P:FileHelpers.ProgressEventArgs.ProgressCurrent">
|
|
3864
|
+
<summary>The current progress position. Check also the ProgressMode property.</summary>
|
|
3865
|
+
</member>
|
|
3866
|
+
<member name="P:FileHelpers.ProgressEventArgs.ProgressTotal">
|
|
3867
|
+
<summary>The total when the progress finish. (<b>-1 means undefined</b>)</summary>
|
|
3868
|
+
</member>
|
|
3869
|
+
<member name="P:FileHelpers.ProgressEventArgs.ProgressMode">
|
|
3870
|
+
<summary>The ProgressMode used.</summary>
|
|
3871
|
+
</member>
|
|
3872
|
+
<member name="T:FileHelpers.ProgressChangeHandler">
|
|
3873
|
+
<summary>Delegate used to notify progress to the user.</summary>
|
|
3874
|
+
<param name="e">The Event args with information about the progress.</param>
|
|
3875
|
+
</member>
|
|
3876
|
+
<member name="T:FileHelpers.RunTime.ClassBuilder">
|
|
3877
|
+
<summary>The MAIN class to work with runtime defined records.</summary>
|
|
3878
|
+
</member>
|
|
3879
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromString(System.String)">
|
|
3880
|
+
<summary>Compiles the source code passed and returns the FIRST Type of the assembly. (Code in C#)</summary>
|
|
3881
|
+
<param name="classStr">The Source Code of the class in C#</param>
|
|
3882
|
+
<returns>The Type generated by runtime compilation of the class source.</returns>
|
|
3883
|
+
</member>
|
|
3884
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromString(System.String,FileHelpers.NetLanguage)">
|
|
3885
|
+
<summary>Compiles the source code passed and returns the FIRST Type of the assembly.</summary>
|
|
3886
|
+
<param name="classStr">The Source Code of the class in the specified language</param>
|
|
3887
|
+
<returns>The Type generated by runtime compilation of the class source.</returns>
|
|
3888
|
+
<param name="lang">One of the .NET Languages</param>
|
|
3889
|
+
</member>
|
|
3890
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromString(System.String,System.String)">
|
|
3891
|
+
<summary>Compiles the source code passed and returns the Type with the name className. (Code in C#)</summary>
|
|
3892
|
+
<param name="classStr">The Source Code of the class in C#</param>
|
|
3893
|
+
<param name="className">The Name of the Type that must be returned</param>
|
|
3894
|
+
<returns>The Type generated by runtime compilation of the class source.</returns>
|
|
3895
|
+
</member>
|
|
3896
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromString(System.String,System.String,FileHelpers.NetLanguage)">
|
|
3897
|
+
<summary>Compiles the source code passed and returns the Type with the name className.</summary>
|
|
3898
|
+
<param name="classStr">The Source Code of the class in the specified language</param>
|
|
3899
|
+
<param name="className">The Name of the Type that must be returned</param>
|
|
3900
|
+
<returns>The Type generated by runtime compilation of the class source.</returns>
|
|
3901
|
+
<param name="lang">One of the .NET Languages</param>
|
|
3902
|
+
</member>
|
|
3903
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromSourceFile(System.String)">
|
|
3904
|
+
<summary>
|
|
3905
|
+
Create a class from a source file.
|
|
3906
|
+
</summary>
|
|
3907
|
+
<param name="filename">The filename with the source of the class.</param>
|
|
3908
|
+
<returns>The compiled class.</returns>
|
|
3909
|
+
</member>
|
|
3910
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromSourceFile(System.String,FileHelpers.NetLanguage)">
|
|
3911
|
+
<summary>
|
|
3912
|
+
Create a class from a source file.
|
|
3913
|
+
</summary>
|
|
3914
|
+
<param name="filename">The filename with the source of the class.</param>
|
|
3915
|
+
<param name="lang">The languaje used to compile the class.</param>
|
|
3916
|
+
<returns>The compiled class.</returns>
|
|
3917
|
+
</member>
|
|
3918
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromSourceFile(System.String,System.String)">
|
|
3919
|
+
<summary>
|
|
3920
|
+
Create a class from a source file.
|
|
3921
|
+
</summary>
|
|
3922
|
+
<param name="filename">The filename with the source of the class.</param>
|
|
3923
|
+
<param name="className">The name of the class to return.</param>
|
|
3924
|
+
<returns>The compiled class.</returns>
|
|
3925
|
+
</member>
|
|
3926
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromSourceFile(System.String,System.String,FileHelpers.NetLanguage)">
|
|
3927
|
+
<summary>
|
|
3928
|
+
Create a class from a source file.
|
|
3929
|
+
</summary>
|
|
3930
|
+
<param name="filename">The filename with the source of the class.</param>
|
|
3931
|
+
<param name="className">The name of the class to return.</param>
|
|
3932
|
+
<param name="lang">The languaje used to compile the class.</param>
|
|
3933
|
+
<returns>The compiled class.</returns>
|
|
3934
|
+
</member>
|
|
3935
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromBinaryFile(System.String)">
|
|
3936
|
+
<summary>
|
|
3937
|
+
Create a class from a encripted source file.
|
|
3938
|
+
</summary>
|
|
3939
|
+
<param name="filename">The filename with the source of the class.</param>
|
|
3940
|
+
<returns>The compiled class.</returns>
|
|
3941
|
+
</member>
|
|
3942
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromBinaryFile(System.String,FileHelpers.NetLanguage)">
|
|
3943
|
+
<summary>
|
|
3944
|
+
Create a class from a encripted source file.
|
|
3945
|
+
</summary>
|
|
3946
|
+
<param name="filename">The filename with the source of the class.</param>
|
|
3947
|
+
<param name="lang">The languaje used to compile the class.</param>
|
|
3948
|
+
<returns>The compiled class.</returns>
|
|
3949
|
+
</member>
|
|
3950
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromBinaryFile(System.String,System.String,FileHelpers.NetLanguage)">
|
|
3951
|
+
<summary>
|
|
3952
|
+
Create a class from a encripted source file.
|
|
3953
|
+
</summary>
|
|
3954
|
+
<param name="filename">The filename with the source of the class.</param>
|
|
3955
|
+
<param name="lang">The languaje used to compile the class.</param>
|
|
3956
|
+
<param name="className">The name of the class to return.</param>
|
|
3957
|
+
<returns>The compiled class.</returns>
|
|
3958
|
+
</member>
|
|
3959
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassFromXmlFile(System.String)">
|
|
3960
|
+
<summary>
|
|
3961
|
+
Create a class from a Xml file generated with the Wizard or saved using the SaveToXml Method.
|
|
3962
|
+
</summary>
|
|
3963
|
+
<param name="filename">The filename with the Xml definition.</param>
|
|
3964
|
+
<returns>The compiled class.</returns>
|
|
3965
|
+
</member>
|
|
3966
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClassToBinaryFile(System.String,System.String)">
|
|
3967
|
+
<summary>
|
|
3968
|
+
Encript the class source code and write it to a file.
|
|
3969
|
+
</summary>
|
|
3970
|
+
<param name="filename">The file name to write to.</param>
|
|
3971
|
+
<param name="classSource">The source code for the class.</param>
|
|
3972
|
+
</member>
|
|
3973
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.SaveToSourceFile(System.String)">
|
|
3974
|
+
<summary>Write the source code of the current class to a file. (In C#)</summary>
|
|
3975
|
+
<param name="filename">The file to write to.</param>
|
|
3976
|
+
</member>
|
|
3977
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.SaveToSourceFile(System.String,FileHelpers.NetLanguage)">
|
|
3978
|
+
<summary>Write the source code of the current class to a file. (In the especified language)</summary>
|
|
3979
|
+
<param name="filename">The file to write to.</param>
|
|
3980
|
+
<param name="lang">The .NET Language used to write the source code.</param>
|
|
3981
|
+
</member>
|
|
3982
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.SaveToBinaryFile(System.String)">
|
|
3983
|
+
<summary>Write the ENCRIPTED source code of the current class to a file. (In C#)</summary>
|
|
3984
|
+
<param name="filename">The file to write to.</param>
|
|
3985
|
+
</member>
|
|
3986
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.SaveToBinaryFile(System.String,FileHelpers.NetLanguage)">
|
|
3987
|
+
<summary>Write the ENCRIPTED source code of the current class to a file. (In C#)</summary>
|
|
3988
|
+
<param name="filename">The file to write to.</param>
|
|
3989
|
+
<param name="lang">The .NET Language used to write the source code.</param>
|
|
3990
|
+
</member>
|
|
3991
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.CreateRecordClass">
|
|
3992
|
+
<summary>Generate the runtime record class to be used by the engines.</summary>
|
|
3993
|
+
<returns>The generated record class</returns>
|
|
3994
|
+
</member>
|
|
3995
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.ClearFields">
|
|
3996
|
+
<summary>Removes all the Fields of the current class.</summary>
|
|
3997
|
+
</member>
|
|
3998
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.FieldByIndex(System.Int32)">
|
|
3999
|
+
<summary>Return the field at the specified index.</summary>
|
|
4000
|
+
<param name="index">The index of the field.</param>
|
|
4001
|
+
<returns>The field at the specified index.</returns>
|
|
4002
|
+
</member>
|
|
4003
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.GetClassBinaryCode(FileHelpers.NetLanguage)">
|
|
4004
|
+
<summary>
|
|
4005
|
+
Returns the ENCRIPTED code for the current class in the specified language.
|
|
4006
|
+
</summary>
|
|
4007
|
+
<param name="lang">The language for the return code.</param>
|
|
4008
|
+
<returns>The ENCRIPTED code for the class that are currently building.</returns>
|
|
4009
|
+
</member>
|
|
4010
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.GetClassSourceCode(FileHelpers.NetLanguage)">
|
|
4011
|
+
<summary>
|
|
4012
|
+
Returns the source code for the current class in the specified language.
|
|
4013
|
+
</summary>
|
|
4014
|
+
<param name="lang">The language for the return code.</param>
|
|
4015
|
+
<returns>The Source Code for the class that are currently building.</returns>
|
|
4016
|
+
</member>
|
|
4017
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.LoadFromXml(System.String)">
|
|
4018
|
+
<summary>
|
|
4019
|
+
Loads and return a ClassBuilder inheritor that has been saved with the SaveToXml method
|
|
4020
|
+
</summary>
|
|
4021
|
+
<param name="filename">A file name with the ClassBuilder difinition.</param>
|
|
4022
|
+
<returns>A new instance of a ClassBuilder inheritor.</returns>
|
|
4023
|
+
</member>
|
|
4024
|
+
<member name="M:FileHelpers.RunTime.ClassBuilder.SaveToXml(System.String)">
|
|
4025
|
+
<summary>
|
|
4026
|
+
Creates a custom serialization of the current ClassBuilder
|
|
4027
|
+
</summary>
|
|
4028
|
+
<param name="filename">A file name to write to.</param>
|
|
4029
|
+
</member>
|
|
4030
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.Fields">
|
|
4031
|
+
<summary>Returns the current fields of the class.</summary>
|
|
4032
|
+
</member>
|
|
4033
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.FieldCount">
|
|
4034
|
+
<summary>Returns the current number of fields.</summary>
|
|
4035
|
+
</member>
|
|
4036
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.ClassName">
|
|
4037
|
+
<summary>The name of the Class.</summary>
|
|
4038
|
+
</member>
|
|
4039
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.IgnoreFirstLines">
|
|
4040
|
+
<summary>Indicates the number of FIRST LINES to be ignored by the engines.</summary>
|
|
4041
|
+
</member>
|
|
4042
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.IgnoreLastLines">
|
|
4043
|
+
<summary>Indicates the number of LAST LINES to be ignored by the engines.</summary>
|
|
4044
|
+
</member>
|
|
4045
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.IgnoreEmptyLines">
|
|
4046
|
+
<summary>Indicates that the engines must ignore the empty lines in the files.</summary>
|
|
4047
|
+
</member>
|
|
4048
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.GenerateProperties">
|
|
4049
|
+
<summary>Indicates if this ClassBuilder generates also the property accessors (Perfect for DataBinding)</summary>
|
|
4050
|
+
</member>
|
|
4051
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.Visibility">
|
|
4052
|
+
<summary>The Visibility for the class.</summary>
|
|
4053
|
+
</member>
|
|
4054
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.SealedClass">
|
|
4055
|
+
<summary>Indicates if the generated class must be sealed.</summary>
|
|
4056
|
+
</member>
|
|
4057
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.Namespace">
|
|
4058
|
+
<summary>The namespace used when creating the class.</summary>
|
|
4059
|
+
</member>
|
|
4060
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.RecordCondition">
|
|
4061
|
+
<summary>Allow to tell the engine what records must be included or excluded while reading.</summary>
|
|
4062
|
+
</member>
|
|
4063
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.IgnoreCommentedLines">
|
|
4064
|
+
<summary>Indicates that the engine must ignore the lines with this comment marker.</summary>
|
|
4065
|
+
</member>
|
|
4066
|
+
<member name="T:FileHelpers.RunTime.ClassBuilder.RecordConditionInfo">
|
|
4067
|
+
<summary>Allow to tell the engine what records must be included or excluded while reading.</summary>
|
|
4068
|
+
</member>
|
|
4069
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.RecordConditionInfo.Condition">
|
|
4070
|
+
<summary>Allow to tell the engine what records must be included or excluded while reading.</summary>
|
|
4071
|
+
</member>
|
|
4072
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.RecordConditionInfo.Selector">
|
|
4073
|
+
<summary>The selector used by the <see cref="P:FileHelpers.RunTime.ClassBuilder.RecordCondition"/>.</summary>
|
|
4074
|
+
</member>
|
|
4075
|
+
<member name="T:FileHelpers.RunTime.ClassBuilder.IgnoreCommentInfo">
|
|
4076
|
+
<summary>Indicates that the engine must ignore the lines with this comment marker.</summary>
|
|
4077
|
+
</member>
|
|
4078
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.IgnoreCommentInfo.CommentMarker">
|
|
4079
|
+
<summary>
|
|
4080
|
+
<para>Indicates that the engine must ignore the lines with this comment marker.</para>
|
|
4081
|
+
<para>An emty string or null indicates that the engine dont look for comments</para>
|
|
4082
|
+
</summary>
|
|
4083
|
+
</member>
|
|
4084
|
+
<member name="P:FileHelpers.RunTime.ClassBuilder.IgnoreCommentInfo.InAnyPlace">
|
|
4085
|
+
<summary>Indicates if the comment can have spaces or tabs at left (true by default)</summary>
|
|
4086
|
+
</member>
|
|
4087
|
+
<member name="T:FileHelpers.RunTime.ConverterBuilder">
|
|
4088
|
+
<summary>Used to build the ConverterAttribute for the run time classes.</summary>
|
|
4089
|
+
</member>
|
|
4090
|
+
<member name="P:FileHelpers.RunTime.ConverterBuilder.Kind">
|
|
4091
|
+
<summary>The ConverterKind to be used , like the one in the FieldConverterAttribute.</summary>
|
|
4092
|
+
</member>
|
|
4093
|
+
<member name="P:FileHelpers.RunTime.ConverterBuilder.TypeName">
|
|
4094
|
+
<summary>The type name of your custom converter.</summary>
|
|
4095
|
+
</member>
|
|
4096
|
+
<member name="P:FileHelpers.RunTime.ConverterBuilder.Arg1">
|
|
4097
|
+
<summary>The first argument pased to the converter.</summary>
|
|
4098
|
+
</member>
|
|
4099
|
+
<member name="P:FileHelpers.RunTime.ConverterBuilder.Arg2">
|
|
4100
|
+
<summary>The first argument pased to the converter.</summary>
|
|
4101
|
+
</member>
|
|
4102
|
+
<member name="P:FileHelpers.RunTime.ConverterBuilder.Arg3">
|
|
4103
|
+
<summary>The first argument pased to the converter.</summary>
|
|
4104
|
+
</member>
|
|
4105
|
+
<member name="T:FileHelpers.RunTime.CsvClassBuilder">
|
|
4106
|
+
<summary>Used to create classes that maps to CSV records (can be quoted, multiplelined quoted, etc).</summary>
|
|
4107
|
+
</member>
|
|
4108
|
+
<member name="T:FileHelpers.RunTime.DelimitedClassBuilder">
|
|
4109
|
+
<summary>Used to create classes that maps to Delimited records.</summary>
|
|
4110
|
+
</member>
|
|
4111
|
+
<member name="M:FileHelpers.RunTime.DelimitedClassBuilder.FieldByIndex(System.Int32)">
|
|
4112
|
+
<summary>Return the field at the specified index.</summary>
|
|
4113
|
+
<param name="index">The index of the field.</param>
|
|
4114
|
+
<returns>The field at the specified index.</returns>
|
|
4115
|
+
</member>
|
|
4116
|
+
<member name="M:FileHelpers.RunTime.DelimitedClassBuilder.#ctor(System.String,System.String)">
|
|
4117
|
+
<summary>Creates a new DelimitedClassBuilder.</summary>
|
|
4118
|
+
<param name="className">The valid class name.</param>
|
|
4119
|
+
<param name="delimiter">The delimiter for that class.</param>
|
|
4120
|
+
</member>
|
|
4121
|
+
<member name="M:FileHelpers.RunTime.DelimitedClassBuilder.#ctor(System.String)">
|
|
4122
|
+
<summary>Creates a new DelimitedClassBuilder.</summary>
|
|
4123
|
+
<param name="className">The valid class name.</param>
|
|
4124
|
+
</member>
|
|
4125
|
+
<member name="M:FileHelpers.RunTime.DelimitedClassBuilder.#ctor(System.String,System.String,System.Data.DataTable)">
|
|
4126
|
+
<summary>Creates a new DelimitedClassBuilder with the same structure than a DataTable.</summary>
|
|
4127
|
+
<param name="className">The valid class name.</param>
|
|
4128
|
+
<param name="delimiter">The delimiter for that class.</param>
|
|
4129
|
+
<param name="dt">The DataTable from where to get the field names and types</param>
|
|
4130
|
+
</member>
|
|
4131
|
+
<member name="M:FileHelpers.RunTime.DelimitedClassBuilder.AddField(System.String,System.String)">
|
|
4132
|
+
<summary>Add a new Delimited field to the current class.</summary>
|
|
4133
|
+
<param name="fieldName">The Name of the field.</param>
|
|
4134
|
+
<param name="fieldType">The Type of the field.</param>
|
|
4135
|
+
<returns>The just created field.</returns>
|
|
4136
|
+
</member>
|
|
4137
|
+
<member name="M:FileHelpers.RunTime.DelimitedClassBuilder.AddField(System.String,System.Type)">
|
|
4138
|
+
<summary>Add a new Delimited field to the current class.</summary>
|
|
4139
|
+
<param name="fieldName">The Name of the field.</param>
|
|
4140
|
+
<param name="fieldType">The Type of the field.</param>
|
|
4141
|
+
<returns>The just created field.</returns>
|
|
4142
|
+
</member>
|
|
4143
|
+
<member name="M:FileHelpers.RunTime.DelimitedClassBuilder.AddField(System.String)">
|
|
4144
|
+
<summary>Add a new Delimited string field to the current class.</summary>
|
|
4145
|
+
<param name="fieldName">The Name of the string field.</param>
|
|
4146
|
+
<returns>The just created field.</returns>
|
|
4147
|
+
</member>
|
|
4148
|
+
<member name="M:FileHelpers.RunTime.DelimitedClassBuilder.AddField(FileHelpers.RunTime.DelimitedFieldBuilder)">
|
|
4149
|
+
<summary>Add a new Delimited field to the current class.</summary>
|
|
4150
|
+
<param name="field">The field definition.</param>
|
|
4151
|
+
<returns>The just added field.</returns>
|
|
4152
|
+
</member>
|
|
4153
|
+
<member name="P:FileHelpers.RunTime.DelimitedClassBuilder.Delimiter">
|
|
4154
|
+
<summary>The Delimiter that marks the end of each field.</summary>
|
|
4155
|
+
</member>
|
|
4156
|
+
<member name="P:FileHelpers.RunTime.DelimitedClassBuilder.Fields">
|
|
4157
|
+
<summary>Returns the current fields of the class.</summary>
|
|
4158
|
+
</member>
|
|
4159
|
+
<member name="P:FileHelpers.RunTime.DelimitedClassBuilder.LastField">
|
|
4160
|
+
<summary>Return the last added field. (use it reduce casts and code)</summary>
|
|
4161
|
+
</member>
|
|
4162
|
+
<member name="M:FileHelpers.RunTime.CsvClassBuilder.#ctor(System.String,System.Char,System.String)">
|
|
4163
|
+
<summary>Creates a new DelimitedClassBuilder.</summary>
|
|
4164
|
+
<param name="className">The valid class name.</param>
|
|
4165
|
+
<param name="delimiter">The delimiter for that class.</param>
|
|
4166
|
+
<param name="sampleFile">A sample file from where to read the field names and number</param>
|
|
4167
|
+
</member>
|
|
4168
|
+
<member name="M:FileHelpers.RunTime.CsvClassBuilder.#ctor(System.String,System.Char,System.Int32)">
|
|
4169
|
+
<summary>Creates a new DelimitedClassBuilder.</summary>
|
|
4170
|
+
<param name="className">The valid class name.</param>
|
|
4171
|
+
<param name="delimiter">The delimiter for that class.</param>
|
|
4172
|
+
<param name="numberOfFields">The number of fields in each record.</param>
|
|
4173
|
+
</member>
|
|
4174
|
+
<member name="M:FileHelpers.RunTime.CsvClassBuilder.#ctor(FileHelpers.CsvOptions)">
|
|
4175
|
+
<summary>Creates a new DelimitedClassBuilder.</summary>
|
|
4176
|
+
<param name="options">The specifications for the Csv file.</param>
|
|
4177
|
+
</member>
|
|
4178
|
+
<member name="M:FileHelpers.RunTime.CsvClassBuilder.AddField(System.String,System.String)">
|
|
4179
|
+
<summary>Add a new Delimited field to the current class.</summary>
|
|
4180
|
+
<param name="fieldName">The Name of the field.</param>
|
|
4181
|
+
<param name="fieldType">The Type of the field.</param>
|
|
4182
|
+
<returns>The just created field.</returns>
|
|
4183
|
+
</member>
|
|
4184
|
+
<member name="M:FileHelpers.RunTime.CsvClassBuilder.AddFields(System.Int32)">
|
|
4185
|
+
<summary>
|
|
4186
|
+
Adds to the class the specified number of fileds.
|
|
4187
|
+
</summary>
|
|
4188
|
+
<param name="number">The number of fileds to add.</param>
|
|
4189
|
+
</member>
|
|
4190
|
+
<member name="M:FileHelpers.RunTime.CsvClassBuilder.AddFields(System.Int32,System.String)">
|
|
4191
|
+
<summary>
|
|
4192
|
+
Adds to the class the specified number of fileds.
|
|
4193
|
+
</summary>
|
|
4194
|
+
<param name="prefix">The prefix used for the fields.</param>
|
|
4195
|
+
<param name="number">The number of fileds to add.</param>
|
|
4196
|
+
</member>
|
|
4197
|
+
<member name="T:FileHelpers.RunTime.DelimitedFieldBuilder">
|
|
4198
|
+
<summary>Used to create fields that are part of a dilimited record class.</summary>
|
|
4199
|
+
</member>
|
|
4200
|
+
<member name="T:FileHelpers.RunTime.FieldBuilder">
|
|
4201
|
+
<summary>Base class for the field converters</summary>
|
|
4202
|
+
</member>
|
|
4203
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.TrimMode">
|
|
4204
|
+
<summary>Indicates the TrimMode for the field.</summary>
|
|
4205
|
+
</member>
|
|
4206
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.TrimChars">
|
|
4207
|
+
<summary>Indicates the trim chars used if TrimMode is set.</summary>
|
|
4208
|
+
</member>
|
|
4209
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.FieldIndex">
|
|
4210
|
+
<summary>The position index inside the class.</summary>
|
|
4211
|
+
</member>
|
|
4212
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.FieldInNewLine">
|
|
4213
|
+
<summary>Indicates that this field is at the begging of a new line.</summary>
|
|
4214
|
+
</member>
|
|
4215
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.FieldIgnored">
|
|
4216
|
+
<summary>Indicates that this field must be ignored by the engine.</summary>
|
|
4217
|
+
</member>
|
|
4218
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.FieldOptional">
|
|
4219
|
+
<summary>Indicates that this field is optional.</summary>
|
|
4220
|
+
</member>
|
|
4221
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.Converter">
|
|
4222
|
+
<summary>Uset to create the converter for the current field.</summary>
|
|
4223
|
+
</member>
|
|
4224
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.FieldName">
|
|
4225
|
+
<summary>The name of the field.</summary>
|
|
4226
|
+
</member>
|
|
4227
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.FieldType">
|
|
4228
|
+
<summary>The Type of the field</summary>
|
|
4229
|
+
</member>
|
|
4230
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.FieldNullValue">
|
|
4231
|
+
<summary>The null value of the field when their value not is in the file.</summary>
|
|
4232
|
+
</member>
|
|
4233
|
+
<member name="P:FileHelpers.RunTime.FieldBuilder.Visibility">
|
|
4234
|
+
<summary>
|
|
4235
|
+
Gets or sets the visibility of the field.
|
|
4236
|
+
</summary>
|
|
4237
|
+
</member>
|
|
4238
|
+
<member name="P:FileHelpers.RunTime.DelimitedFieldBuilder.FieldQuoted">
|
|
4239
|
+
<summary>Indicates if the field is quoted with some char. (works with QuoteMode and QuoteChar)</summary>
|
|
4240
|
+
</member>
|
|
4241
|
+
<member name="P:FileHelpers.RunTime.DelimitedFieldBuilder.QuoteChar">
|
|
4242
|
+
<summary>Indicates the char used to quote this field. (only used when FieldQuoted is true)</summary>
|
|
4243
|
+
</member>
|
|
4244
|
+
<member name="P:FileHelpers.RunTime.DelimitedFieldBuilder.QuoteMode">
|
|
4245
|
+
<summary>Indicates the QuoteMode for this field. (only used when FieldQuoted is true)</summary>
|
|
4246
|
+
</member>
|
|
4247
|
+
<member name="P:FileHelpers.RunTime.DelimitedFieldBuilder.QuoteMultiline">
|
|
4248
|
+
<summary>Indicates if this quoted field can span multiple lines. (only used when FieldQuoted is true)</summary>
|
|
4249
|
+
</member>
|
|
4250
|
+
<member name="T:FileHelpers.RunTime.FixedFieldBuilder">
|
|
4251
|
+
<summary>Used to create Fixed Length fields and set their properties.</summary>
|
|
4252
|
+
</member>
|
|
4253
|
+
<member name="P:FileHelpers.RunTime.FixedFieldBuilder.FieldLength">
|
|
4254
|
+
<summary>The fixed length of the field.</summary>
|
|
4255
|
+
</member>
|
|
4256
|
+
<member name="P:FileHelpers.RunTime.FixedFieldBuilder.AlignMode">
|
|
4257
|
+
<summary>The align of the field used for write operations.</summary>
|
|
4258
|
+
</member>
|
|
4259
|
+
<member name="P:FileHelpers.RunTime.FixedFieldBuilder.AlignChar">
|
|
4260
|
+
<summary>The align char of the field used for write operations.</summary>
|
|
4261
|
+
</member>
|
|
4262
|
+
<member name="T:FileHelpers.RunTime.FixedLengthClassBuilder">
|
|
4263
|
+
<summary>Used to create classes that maps to Fixed Length records.</summary>
|
|
4264
|
+
</member>
|
|
4265
|
+
<member name="M:FileHelpers.RunTime.FixedLengthClassBuilder.FieldByIndex(System.Int32)">
|
|
4266
|
+
<summary>Return the field at the specified index.</summary>
|
|
4267
|
+
<param name="index">The index of the field.</param>
|
|
4268
|
+
<returns>The field at the specified index.</returns>
|
|
4269
|
+
</member>
|
|
4270
|
+
<member name="M:FileHelpers.RunTime.FixedLengthClassBuilder.#ctor(System.String)">
|
|
4271
|
+
<summary>Used to create classes that maps to Fixed Length records.</summary>
|
|
4272
|
+
<param name="className">A valid class name.</param>
|
|
4273
|
+
</member>
|
|
4274
|
+
<member name="M:FileHelpers.RunTime.FixedLengthClassBuilder.#ctor(System.String,System.Int32[])">
|
|
4275
|
+
<summary>Used to create classes that maps to Fixed Length records and automatic instanciate many string fields as values are passed in the lengths arg. </summary>
|
|
4276
|
+
<param name="className">A valid class name.</param>
|
|
4277
|
+
<param name="lengths">The lengths of the fields (one string field will be create for each length)</param>
|
|
4278
|
+
</member>
|
|
4279
|
+
<member name="M:FileHelpers.RunTime.FixedLengthClassBuilder.#ctor(System.String,System.Data.DataTable,System.Int32)">
|
|
4280
|
+
<summary>Used to create classes that maps to Fixed Length records with the same structure than a DataTable.</summary>
|
|
4281
|
+
<param name="className">A valid class name.</param>
|
|
4282
|
+
<param name="dt">The DataTable from where to get the field names and types</param>
|
|
4283
|
+
<param name="defaultLength">The initial length of all fields</param>
|
|
4284
|
+
</member>
|
|
4285
|
+
<member name="M:FileHelpers.RunTime.FixedLengthClassBuilder.#ctor(System.String,FileHelpers.FixedMode)">
|
|
4286
|
+
<summary>Used to create classes that maps to Fixed Length records.</summary>
|
|
4287
|
+
<param name="className">A valid class name.</param>
|
|
4288
|
+
<param name="mode">Indicates the behavior when variable length records are found.</param>
|
|
4289
|
+
</member>
|
|
4290
|
+
<member name="M:FileHelpers.RunTime.FixedLengthClassBuilder.AddField(System.String,System.Int32,System.String)">
|
|
4291
|
+
<summary>Adds a new Fixed Length field.</summary>
|
|
4292
|
+
<param name="fieldName">The name of the field.</param>
|
|
4293
|
+
<param name="length">The length of the field.</param>
|
|
4294
|
+
<param name="fieldType">The Type of the field.</param>
|
|
4295
|
+
<returns>The just created field.</returns>
|
|
4296
|
+
</member>
|
|
4297
|
+
<member name="M:FileHelpers.RunTime.FixedLengthClassBuilder.AddField(System.String,System.Int32,System.Type)">
|
|
4298
|
+
<summary>Adds a new Fixed Length field.</summary>
|
|
4299
|
+
<param name="fieldName">The name of the field.</param>
|
|
4300
|
+
<param name="length">The length of the field.</param>
|
|
4301
|
+
<param name="fieldType">The Type of the field.</param>
|
|
4302
|
+
<returns>The just created field.</returns>
|
|
4303
|
+
</member>
|
|
4304
|
+
<member name="M:FileHelpers.RunTime.FixedLengthClassBuilder.AddField(FileHelpers.RunTime.FixedFieldBuilder)">
|
|
4305
|
+
<summary>Adds a new Fixed Length field.</summary>
|
|
4306
|
+
<param name="field">The field definition.</param>
|
|
4307
|
+
<returns>The just added field.</returns>
|
|
4308
|
+
</member>
|
|
4309
|
+
<member name="M:FileHelpers.RunTime.FixedLengthClassBuilder.SetFieldsLength(System.Int32[])">
|
|
4310
|
+
<summary>
|
|
4311
|
+
Set the length of each field at once.
|
|
4312
|
+
</summary>
|
|
4313
|
+
<param name="lengths">The length of each field, must be the same that the number of fields.</param>
|
|
4314
|
+
</member>
|
|
4315
|
+
<member name="P:FileHelpers.RunTime.FixedLengthClassBuilder.Fields">
|
|
4316
|
+
<summary>Returns the current fields of the class.</summary>
|
|
4317
|
+
</member>
|
|
4318
|
+
<member name="P:FileHelpers.RunTime.FixedLengthClassBuilder.LastField">
|
|
4319
|
+
<summary>Return the last added field. (use it reduce casts and code)</summary>
|
|
4320
|
+
</member>
|
|
4321
|
+
<member name="P:FileHelpers.RunTime.FixedLengthClassBuilder.FixedMode">
|
|
4322
|
+
<summary>Indicates the behavior when variable length records are found </summary>
|
|
4323
|
+
</member>
|
|
4324
|
+
</members>
|
|
4325
|
+
</doc>
|