filehelpers 2.0.0.0.20100812
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
|
|
Binary file
|
|
@@ -0,0 +1,1874 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<doc>
|
|
3
|
+
<assembly>
|
|
4
|
+
<name>FileHelpersPPC</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.ConverterBase">
|
|
328
|
+
<summary>
|
|
329
|
+
Base class to provide bidirectional
|
|
330
|
+
Field - String convertion.
|
|
331
|
+
</summary>
|
|
332
|
+
</member>
|
|
333
|
+
<member name="M:FileHelpers.ConverterBase.StringToField(System.String)">
|
|
334
|
+
<summary>
|
|
335
|
+
Convert a string in the file to a field value.
|
|
336
|
+
</summary>
|
|
337
|
+
<param name="from">The string to convert.</param>
|
|
338
|
+
<returns>The field value.</returns>
|
|
339
|
+
</member>
|
|
340
|
+
<member name="M:FileHelpers.ConverterBase.FieldToString(System.Object)">
|
|
341
|
+
<summary>
|
|
342
|
+
Convert a field value to an string to write this to the file.
|
|
343
|
+
</summary>
|
|
344
|
+
<remarks>The basic implementation performs a: from.ToString();</remarks>
|
|
345
|
+
<param name="from">The field values to convert.</param>
|
|
346
|
+
<returns>The string representing the field value.</returns>
|
|
347
|
+
</member>
|
|
348
|
+
<member name="M:FileHelpers.ConverterBase.ThrowConvertException(System.String,System.String)">
|
|
349
|
+
<summary>
|
|
350
|
+
Thorws a ConvertException with the passed values
|
|
351
|
+
</summary>
|
|
352
|
+
<param name="from">The source string.</param>
|
|
353
|
+
<param name="errorMsg">The custom error msg.</param>
|
|
354
|
+
</member>
|
|
355
|
+
<member name="P:FileHelpers.ConverterBase.DefaultDateTimeFormat">
|
|
356
|
+
<summary>
|
|
357
|
+
<para>Allow you to set the default Date Format used for the converter.</para>
|
|
358
|
+
<para>With the same format that the .NET framework.</para>
|
|
359
|
+
<para>By default: "ddMMyyyy"</para>
|
|
360
|
+
</summary>
|
|
361
|
+
</member>
|
|
362
|
+
<member name="P:FileHelpers.ConverterBase.CustomNullHandling">
|
|
363
|
+
<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>
|
|
364
|
+
</member>
|
|
365
|
+
<member name="T:FileHelpers.ConvertHelpers">
|
|
366
|
+
<summary>Class that provides static methods that returns a default <see cref="T:FileHelpers.ConverterBase">Converter</see> to the basic types.</summary>
|
|
367
|
+
<remarks>Used by the <see cref="T:FileHelpers.FieldConverterAttribute"/>.</remarks>
|
|
368
|
+
</member>
|
|
369
|
+
<member name="T:FileHelpers.RecordInfo">
|
|
370
|
+
<summary>An internal class used to store information about the Record Type.</summary>
|
|
371
|
+
<remarks>Is public to provide extensibility of DataSorage from outside the library.</remarks>
|
|
372
|
+
</member>
|
|
373
|
+
<member name="M:FileHelpers.RecordInfo.#ctor(System.Type)">
|
|
374
|
+
<summary>The unique constructor for this class. It needs the subyacent record class.</summary>
|
|
375
|
+
<param name="recordType">The Type of the record class.</param>
|
|
376
|
+
</member>
|
|
377
|
+
<member name="M:FileHelpers.RecordInfo.ValuesToRecord(System.Object[])">
|
|
378
|
+
<summary>Returns a record formed with the passed values.</summary>
|
|
379
|
+
<param name="values">The source Values.</param>
|
|
380
|
+
<returns>A record formed with the passed values.</returns>
|
|
381
|
+
</member>
|
|
382
|
+
<member name="M:FileHelpers.RecordInfo.RecordToValues(System.Object)">
|
|
383
|
+
<summary>Get an object[] of the values in the fields of the passed record.</summary>
|
|
384
|
+
<param name="record">The source record.</param>
|
|
385
|
+
<returns>An object[] of the values in the fields.</returns>
|
|
386
|
+
</member>
|
|
387
|
+
<member name="T:FileHelpers.DelimitedFileEngine">
|
|
388
|
+
<summary>
|
|
389
|
+
Is a version of the <see cref="T:FileHelpers.FileHelperEngine"/> exclusive for
|
|
390
|
+
delimited records that allow you to change the delimiter an other options at runtime
|
|
391
|
+
</summary>
|
|
392
|
+
<remarks>
|
|
393
|
+
Useful when you need to export or import the same info with 2 or more different delimiters or little different options.
|
|
394
|
+
</remarks>
|
|
395
|
+
</member>
|
|
396
|
+
<member name="T:FileHelpers.FileHelperEngine">
|
|
397
|
+
<summary>
|
|
398
|
+
<para><b>One of the main classes of the library.</b></para>
|
|
399
|
+
<para>This engine is responsable to Read/Write the records <b>at once</b> from/to files or streams.</para>
|
|
400
|
+
<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>
|
|
401
|
+
</summary><remarks>
|
|
402
|
+
<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>
|
|
403
|
+
<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>
|
|
404
|
+
<para>Or you can browse the <a href="examples.html">Examples Seccion</a> for more code.</para>
|
|
405
|
+
<para>Engines Diagram:</para>
|
|
406
|
+
<para><center><img src="diag_engines.gif"/></center></para>
|
|
407
|
+
</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>
|
|
408
|
+
<example>
|
|
409
|
+
This example show the basic use of the library with minimun code:
|
|
410
|
+
<code>
|
|
411
|
+
<textarea name="code" class="c#">
|
|
412
|
+
|
|
413
|
+
using FileHelpers;
|
|
414
|
+
|
|
415
|
+
// First declare the record class
|
|
416
|
+
|
|
417
|
+
[Delimitedrecord("|")]
|
|
418
|
+
public class SampleType
|
|
419
|
+
{
|
|
420
|
+
public string Field1;
|
|
421
|
+
public int Field2;
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
public void ReadExample()
|
|
426
|
+
{
|
|
427
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
428
|
+
|
|
429
|
+
SampleType[] records;
|
|
430
|
+
|
|
431
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
432
|
+
|
|
433
|
+
// Now "records" array contains all the records in the
|
|
434
|
+
// sourcefile and can be acceded like this:
|
|
435
|
+
|
|
436
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
public void WriteExample()
|
|
441
|
+
{
|
|
442
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
443
|
+
|
|
444
|
+
SampleType[] records = new SampleType[1];
|
|
445
|
+
|
|
446
|
+
records[0] = new SampleType();
|
|
447
|
+
|
|
448
|
+
records[0].Field1 = "Hello World";
|
|
449
|
+
records[0].Field2 = 12;
|
|
450
|
+
|
|
451
|
+
engine.WriteFile("destination.txt", records);
|
|
452
|
+
|
|
453
|
+
// Now the file contains the created record in this format:
|
|
454
|
+
//
|
|
455
|
+
// Hello World,12
|
|
456
|
+
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
</textarea>
|
|
460
|
+
</code> </example>
|
|
461
|
+
</member>
|
|
462
|
+
<member name="T:FileHelpers.EngineBase">
|
|
463
|
+
<summary>Base class for the two engines of the library: <see cref="T:FileHelpers.FileHelperEngine"/> and <see cref="T:FileHelpers.FileHelperAsyncEngine"/></summary>
|
|
464
|
+
</member>
|
|
465
|
+
<member name="F:FileHelpers.EngineBase.mErrorManager">
|
|
466
|
+
<summary>This is a common class that manage the errors of the library.</summary>
|
|
467
|
+
</member>
|
|
468
|
+
<member name="P:FileHelpers.EngineBase.LineNumber">
|
|
469
|
+
<summary>The current line number.</summary>
|
|
470
|
+
</member>
|
|
471
|
+
<member name="P:FileHelpers.EngineBase.TotalRecords">
|
|
472
|
+
<summary>The total numbers of records in the last read/written file (only works with whole read/write).</summary>
|
|
473
|
+
</member>
|
|
474
|
+
<member name="P:FileHelpers.EngineBase.RecordType">
|
|
475
|
+
<summary>Returns the type of records handled by this engine.</summary>
|
|
476
|
+
</member>
|
|
477
|
+
<member name="P:FileHelpers.EngineBase.HeaderText">
|
|
478
|
+
<summary>The read header in the last read operation. If any.</summary>
|
|
479
|
+
</member>
|
|
480
|
+
<member name="P:FileHelpers.EngineBase.FooterText">
|
|
481
|
+
<summary>The read footer in the last read operation. If any.</summary>
|
|
482
|
+
</member>
|
|
483
|
+
<member name="P:FileHelpers.EngineBase.Encoding">
|
|
484
|
+
<summary>The encoding to Read and Write the streams.</summary>
|
|
485
|
+
<remarks>Default is the system's current ANSI code page.</remarks>
|
|
486
|
+
<value>Default is the system's current ANSI code page.</value>
|
|
487
|
+
</member>
|
|
488
|
+
<member name="P:FileHelpers.EngineBase.ErrorManager">
|
|
489
|
+
<summary>This is a common class that manage the errors of the library.</summary>
|
|
490
|
+
<remarks>You can, for example, get the errors, their number, Save them to a file, etc.</remarks>
|
|
491
|
+
</member>
|
|
492
|
+
<member name="M:FileHelpers.FileHelperEngine.#ctor(System.Type)">
|
|
493
|
+
<summary>
|
|
494
|
+
Initializes a new instance of the FileHelperEngine class with the specified type of records.
|
|
495
|
+
</summary><param name="recordType">The record mapping class.</param>
|
|
496
|
+
</member>
|
|
497
|
+
<member name="M:FileHelpers.FileHelperEngine.#ctor(System.Type,System.Text.Encoding)">
|
|
498
|
+
<summary>
|
|
499
|
+
Initializes a new instance of the FileHelperEngine class with the specified type of records.
|
|
500
|
+
</summary><param name="recordType">The record mapping class.</param>
|
|
501
|
+
<param name="encoding">The Encoding used by the engine.</param>
|
|
502
|
+
</member>
|
|
503
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadFile(System.String)">
|
|
504
|
+
<summary>
|
|
505
|
+
Read a file and return an array of the contained records.
|
|
506
|
+
</summary><remarks>
|
|
507
|
+
This method open, read and close the file (don't open or close the file before or after to call this method)
|
|
508
|
+
</remarks><example>
|
|
509
|
+
This example show the basic use of the library with minimun code:
|
|
510
|
+
<code>
|
|
511
|
+
<textarea name="code" class="c#">
|
|
512
|
+
|
|
513
|
+
using FileHelpers;
|
|
514
|
+
|
|
515
|
+
// First declare the record class
|
|
516
|
+
|
|
517
|
+
[Delimitedrecord("|")]
|
|
518
|
+
public class SampleType
|
|
519
|
+
{
|
|
520
|
+
public string Field1;
|
|
521
|
+
public int Field2;
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
public void ReadExample()
|
|
526
|
+
{
|
|
527
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
528
|
+
|
|
529
|
+
SampleType[] records;
|
|
530
|
+
|
|
531
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
532
|
+
|
|
533
|
+
// Now "records" array contains all the records in the
|
|
534
|
+
// sourcefile and can be acceded like this:
|
|
535
|
+
|
|
536
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
</textarea>
|
|
540
|
+
</code>
|
|
541
|
+
</example><param name="fileName">The file path to be read.</param><returns>An array of the records in the file</returns>
|
|
542
|
+
</member>
|
|
543
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadFile(System.String,System.Int32)">
|
|
544
|
+
<summary>
|
|
545
|
+
Read a file and return an array of the contained records.
|
|
546
|
+
</summary><remarks>
|
|
547
|
+
This method open, read and close the file (don't open or close the file before or after to call this method)
|
|
548
|
+
</remarks><example>
|
|
549
|
+
This example show the basic use of the library with minimun code:
|
|
550
|
+
<code>
|
|
551
|
+
<textarea name="code" class="c#">
|
|
552
|
+
|
|
553
|
+
using FileHelpers;
|
|
554
|
+
|
|
555
|
+
// First declare the record class
|
|
556
|
+
|
|
557
|
+
[Delimitedrecord("|")]
|
|
558
|
+
public class SampleType
|
|
559
|
+
{
|
|
560
|
+
public string Field1;
|
|
561
|
+
public int Field2;
|
|
562
|
+
}
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
public void ReadExample()
|
|
566
|
+
{
|
|
567
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
568
|
+
|
|
569
|
+
SampleType[] records;
|
|
570
|
+
|
|
571
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
572
|
+
|
|
573
|
+
// Now "records" array contains all the records in the
|
|
574
|
+
// sourcefile and can be acceded like this:
|
|
575
|
+
|
|
576
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
</textarea>
|
|
580
|
+
</code>
|
|
581
|
+
</example><param name="fileName">The file path to be read.</param><returns>An array of the records in the file</returns>
|
|
582
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
583
|
+
</member>
|
|
584
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadStream(System.IO.TextReader)">
|
|
585
|
+
<summary>
|
|
586
|
+
Read a Stream and return an array of the contained records.
|
|
587
|
+
</summary><remarks>
|
|
588
|
+
This method only uses the stream and dont close them after use it, you must do it.
|
|
589
|
+
</remarks><example>
|
|
590
|
+
This example show the basic use of the library with minimun code:
|
|
591
|
+
<code>
|
|
592
|
+
<textarea name="code" class="c#">
|
|
593
|
+
|
|
594
|
+
using FileHelpers;
|
|
595
|
+
|
|
596
|
+
// First declare the record class
|
|
597
|
+
|
|
598
|
+
[Delimitedrecord("|")]
|
|
599
|
+
public class SampleType
|
|
600
|
+
{
|
|
601
|
+
public string Field1;
|
|
602
|
+
public int Field2;
|
|
603
|
+
}
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
public void ReadExample()
|
|
607
|
+
{
|
|
608
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
609
|
+
|
|
610
|
+
SampleType[] records;
|
|
611
|
+
|
|
612
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
613
|
+
|
|
614
|
+
// Now "records" array contains all the records in the
|
|
615
|
+
// sourcefile and can be acceded like this:
|
|
616
|
+
|
|
617
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
618
|
+
}
|
|
619
|
+
|
|
620
|
+
</textarea>
|
|
621
|
+
</code>
|
|
622
|
+
</example><param name="reader">The reader of the source stream.</param><returns>An array of the records in the Stream</returns>
|
|
623
|
+
</member>
|
|
624
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadStream(System.IO.TextReader,System.Int32)">
|
|
625
|
+
<summary>
|
|
626
|
+
Read a Stream and return an array of the contained records.
|
|
627
|
+
</summary><remarks>
|
|
628
|
+
This method only uses the stream and dont close them after use it, you must do it.
|
|
629
|
+
</remarks><example>
|
|
630
|
+
This example show the basic use of the library with minimun code:
|
|
631
|
+
<code>
|
|
632
|
+
<textarea name="code" class="c#">
|
|
633
|
+
|
|
634
|
+
using FileHelpers;
|
|
635
|
+
|
|
636
|
+
// First declare the record class
|
|
637
|
+
|
|
638
|
+
[Delimitedrecord("|")]
|
|
639
|
+
public class SampleType
|
|
640
|
+
{
|
|
641
|
+
public string Field1;
|
|
642
|
+
public int Field2;
|
|
643
|
+
}
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
public void ReadExample()
|
|
647
|
+
{
|
|
648
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
649
|
+
|
|
650
|
+
SampleType[] records;
|
|
651
|
+
|
|
652
|
+
records = (SampleType[]) engine.ReadFile("source.txt");
|
|
653
|
+
|
|
654
|
+
// Now "records" array contains all the records in the
|
|
655
|
+
// sourcefile and can be acceded like this:
|
|
656
|
+
|
|
657
|
+
int sum = records[0].Field2 + records[1].Field2;
|
|
658
|
+
}
|
|
659
|
+
|
|
660
|
+
</textarea>
|
|
661
|
+
</code>
|
|
662
|
+
</example><param name="reader">The reader of the source stream.</param><returns>An array of the records in the Stream</returns>
|
|
663
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
664
|
+
</member>
|
|
665
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadString(System.String)">
|
|
666
|
+
<summary>
|
|
667
|
+
Read a String and return an array of the contained records.
|
|
668
|
+
</summary><param name="source">The string that contains the records.</param><returns>An array of the records in the String.</returns>
|
|
669
|
+
</member>
|
|
670
|
+
<member name="M:FileHelpers.FileHelperEngine.ReadString(System.String,System.Int32)">
|
|
671
|
+
<summary>
|
|
672
|
+
Read a String and return an array of the contained records.
|
|
673
|
+
</summary><param name="source">The string that contains the records.</param><returns>An array of the records in the String.</returns>
|
|
674
|
+
<param name="maxRecords">The max number of records to read. Int32.MaxValue or -1 to read all records.</param>
|
|
675
|
+
</member>
|
|
676
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteFile(System.String,System.Collections.IEnumerable)">
|
|
677
|
+
<summary>
|
|
678
|
+
Write an array of records to the specified file.
|
|
679
|
+
</summary><remarks>
|
|
680
|
+
<para>This method open, write and close the file (don't open or close the file before or after to call this method)</para>
|
|
681
|
+
<para>This method overrides existing files.</para>
|
|
682
|
+
</remarks><example>
|
|
683
|
+
This example show the basic use of the library with minimun code:
|
|
684
|
+
<code>
|
|
685
|
+
<textarea name="code" class="c#">
|
|
686
|
+
|
|
687
|
+
using FileHelpers;
|
|
688
|
+
|
|
689
|
+
// First declare the record class
|
|
690
|
+
|
|
691
|
+
[Delimitedrecord("|")]
|
|
692
|
+
public class SampleType
|
|
693
|
+
{
|
|
694
|
+
public string Field1;
|
|
695
|
+
public int Field2;
|
|
696
|
+
}
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
public void WriteExample()
|
|
700
|
+
{
|
|
701
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
702
|
+
|
|
703
|
+
SampleType[] records = new SampleType[1];
|
|
704
|
+
|
|
705
|
+
records[0] = new SampleType();
|
|
706
|
+
|
|
707
|
+
records[0].Field1 = "Hello World";
|
|
708
|
+
records[0].Field2 = 12;
|
|
709
|
+
|
|
710
|
+
engine.WriteFile("destination.txt", records);
|
|
711
|
+
|
|
712
|
+
// Now the file contains the created record in this format:
|
|
713
|
+
//
|
|
714
|
+
// Hello World,12
|
|
715
|
+
|
|
716
|
+
}
|
|
717
|
+
|
|
718
|
+
</textarea>
|
|
719
|
+
</code>
|
|
720
|
+
</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>
|
|
721
|
+
</member>
|
|
722
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteFile(System.String,System.Collections.IEnumerable,System.Int32)">
|
|
723
|
+
<summary>
|
|
724
|
+
Write the specified number of records from the array to a file.
|
|
725
|
+
</summary><remarks>
|
|
726
|
+
<para>This method open, write and close the file (don't open or close the file before or after to call this method)</para>
|
|
727
|
+
<para>This method overrides existing files.</para>
|
|
728
|
+
</remarks><example>
|
|
729
|
+
This example show the basic use of the library with minimun code:
|
|
730
|
+
<code>
|
|
731
|
+
<textarea name="code" class="c#">
|
|
732
|
+
|
|
733
|
+
using FileHelpers;
|
|
734
|
+
|
|
735
|
+
// First declare the record class
|
|
736
|
+
|
|
737
|
+
[Delimitedrecord("|")]
|
|
738
|
+
public class SampleType
|
|
739
|
+
{
|
|
740
|
+
public string Field1;
|
|
741
|
+
public int Field2;
|
|
742
|
+
}
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
public void WriteExample()
|
|
746
|
+
{
|
|
747
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
748
|
+
|
|
749
|
+
SampleType[] records = new SampleType[1];
|
|
750
|
+
|
|
751
|
+
records[0] = new SampleType();
|
|
752
|
+
|
|
753
|
+
records[0].Field1 = "Hello World";
|
|
754
|
+
records[0].Field2 = 12;
|
|
755
|
+
|
|
756
|
+
engine.WriteFile("destination.txt", records);
|
|
757
|
+
|
|
758
|
+
// Now the file contains the created record in this format:
|
|
759
|
+
//
|
|
760
|
+
// Hello World,12
|
|
761
|
+
|
|
762
|
+
}
|
|
763
|
+
|
|
764
|
+
</textarea>
|
|
765
|
+
</code>
|
|
766
|
+
</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>
|
|
767
|
+
</member>
|
|
768
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteStream(System.IO.TextWriter,System.Collections.IEnumerable)">
|
|
769
|
+
<summary>
|
|
770
|
+
Write an array of records to the specified Stream.
|
|
771
|
+
</summary><remarks>
|
|
772
|
+
This method only uses the stream and don't close them after use it, you must do it.
|
|
773
|
+
</remarks><example>
|
|
774
|
+
This example show the basic use of the library with minimun code:
|
|
775
|
+
<code>
|
|
776
|
+
<textarea name="code" class="c#">
|
|
777
|
+
|
|
778
|
+
using FileHelpers;
|
|
779
|
+
|
|
780
|
+
// First declare the record class
|
|
781
|
+
|
|
782
|
+
[Delimitedrecord("|")]
|
|
783
|
+
public class SampleType
|
|
784
|
+
{
|
|
785
|
+
public string Field1;
|
|
786
|
+
public int Field2;
|
|
787
|
+
}
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
public void WriteExample()
|
|
791
|
+
{
|
|
792
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
793
|
+
|
|
794
|
+
SampleType[] records = new SampleType[1];
|
|
795
|
+
|
|
796
|
+
records[0] = new SampleType();
|
|
797
|
+
|
|
798
|
+
records[0].Field1 = "Hello World";
|
|
799
|
+
records[0].Field2 = 12;
|
|
800
|
+
|
|
801
|
+
engine.WriteFile("destination.txt", records);
|
|
802
|
+
|
|
803
|
+
// Now the file contains the created record in this format:
|
|
804
|
+
//
|
|
805
|
+
// Hello World,12
|
|
806
|
+
|
|
807
|
+
}
|
|
808
|
+
|
|
809
|
+
</textarea>
|
|
810
|
+
</code>
|
|
811
|
+
</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>
|
|
812
|
+
</member>
|
|
813
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteStream(System.IO.TextWriter,System.Collections.IEnumerable,System.Int32)">
|
|
814
|
+
<summary>
|
|
815
|
+
Write the specified number of records in the array to the Stream.
|
|
816
|
+
</summary><remarks>
|
|
817
|
+
This method only uses the stream and don't close them after use it, you must do it.
|
|
818
|
+
</remarks><example>
|
|
819
|
+
This example show the basic use of the library with minimun code:
|
|
820
|
+
<code>
|
|
821
|
+
<textarea name="code" class="c#">
|
|
822
|
+
|
|
823
|
+
using FileHelpers;
|
|
824
|
+
|
|
825
|
+
// First declare the record class
|
|
826
|
+
|
|
827
|
+
[Delimitedrecord("|")]
|
|
828
|
+
public class SampleType
|
|
829
|
+
{
|
|
830
|
+
public string Field1;
|
|
831
|
+
public int Field2;
|
|
832
|
+
}
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
public void WriteExample()
|
|
836
|
+
{
|
|
837
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
838
|
+
|
|
839
|
+
SampleType[] records = new SampleType[1];
|
|
840
|
+
|
|
841
|
+
records[0] = new SampleType();
|
|
842
|
+
|
|
843
|
+
records[0].Field1 = "Hello World";
|
|
844
|
+
records[0].Field2 = 12;
|
|
845
|
+
|
|
846
|
+
engine.WriteFile("destination.txt", records);
|
|
847
|
+
|
|
848
|
+
// Now the file contains the created record in this format:
|
|
849
|
+
//
|
|
850
|
+
// Hello World,12
|
|
851
|
+
|
|
852
|
+
}
|
|
853
|
+
|
|
854
|
+
</textarea>
|
|
855
|
+
</code>
|
|
856
|
+
</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>
|
|
857
|
+
</member>
|
|
858
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteString(System.Collections.IEnumerable)">
|
|
859
|
+
<summary>
|
|
860
|
+
Write an array of records to an String and return it.
|
|
861
|
+
</summary><param name="records">The records to write (Can be an array, ArrayList, etc)</param><returns>The resulting string after write the records.</returns>
|
|
862
|
+
</member>
|
|
863
|
+
<member name="M:FileHelpers.FileHelperEngine.WriteString(System.Collections.IEnumerable,System.Int32)">
|
|
864
|
+
<summary>
|
|
865
|
+
Write an array of records to an String and return it.
|
|
866
|
+
</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>
|
|
867
|
+
</member>
|
|
868
|
+
<member name="M:FileHelpers.FileHelperEngine.AppendToFile(System.String,System.Object)">
|
|
869
|
+
<summary>
|
|
870
|
+
Append a record to the specified file.
|
|
871
|
+
</summary><remarks>
|
|
872
|
+
This method open, seek ends, write and close the file (don't open or close the file before or after to call this method)
|
|
873
|
+
</remarks><example>
|
|
874
|
+
This example show the basic use of the library with minimun code:
|
|
875
|
+
<code>
|
|
876
|
+
<textarea name="code" class="c#">
|
|
877
|
+
|
|
878
|
+
using FileHelpers;
|
|
879
|
+
|
|
880
|
+
// First declare the record class
|
|
881
|
+
|
|
882
|
+
[Delimitedrecord("|")]
|
|
883
|
+
public class SampleType
|
|
884
|
+
{
|
|
885
|
+
public string Field1;
|
|
886
|
+
public int Field2;
|
|
887
|
+
}
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
public void AppendExample()
|
|
891
|
+
{
|
|
892
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
893
|
+
|
|
894
|
+
SampleType[] records = new SampleType[1];
|
|
895
|
+
|
|
896
|
+
records[0] = new SampleType();
|
|
897
|
+
|
|
898
|
+
records[0].Field1 = "Hello World";
|
|
899
|
+
records[0].Field2 = 12;
|
|
900
|
+
|
|
901
|
+
engine.AppendToFile("destination.txt", records);
|
|
902
|
+
|
|
903
|
+
// Now the file contains have one more record at the end:
|
|
904
|
+
//
|
|
905
|
+
// Hello World,12
|
|
906
|
+
|
|
907
|
+
}
|
|
908
|
+
|
|
909
|
+
</textarea>
|
|
910
|
+
</code>
|
|
911
|
+
</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>
|
|
912
|
+
</member>
|
|
913
|
+
<member name="M:FileHelpers.FileHelperEngine.AppendToFile(System.String,System.Collections.IEnumerable)">
|
|
914
|
+
<summary>
|
|
915
|
+
Append an array of records to the specified file.
|
|
916
|
+
</summary><remarks>
|
|
917
|
+
This method open, seek ends, write and close the file (don't open or close the file before or after to call this method)
|
|
918
|
+
</remarks><example>
|
|
919
|
+
This example show the basic use of the library with minimun code:
|
|
920
|
+
<code>
|
|
921
|
+
<textarea name="code" class="c#">
|
|
922
|
+
|
|
923
|
+
using FileHelpers;
|
|
924
|
+
|
|
925
|
+
// First declare the record class
|
|
926
|
+
|
|
927
|
+
[Delimitedrecord("|")]
|
|
928
|
+
public class SampleType
|
|
929
|
+
{
|
|
930
|
+
public string Field1;
|
|
931
|
+
public int Field2;
|
|
932
|
+
}
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
public void AppendExample()
|
|
936
|
+
{
|
|
937
|
+
FileHelperEngine engine = new FileHelperEngine(typeof(SampleType));
|
|
938
|
+
|
|
939
|
+
SampleType[] records = new SampleType[1];
|
|
940
|
+
|
|
941
|
+
records[0] = new SampleType();
|
|
942
|
+
|
|
943
|
+
records[0].Field1 = "Hello World";
|
|
944
|
+
records[0].Field2 = 12;
|
|
945
|
+
|
|
946
|
+
engine.AppendToFile("destination.txt", records);
|
|
947
|
+
|
|
948
|
+
// Now the file contains have one more record at the end:
|
|
949
|
+
//
|
|
950
|
+
// Hello World,12
|
|
951
|
+
|
|
952
|
+
}
|
|
953
|
+
|
|
954
|
+
</textarea>
|
|
955
|
+
</code>
|
|
956
|
+
</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>
|
|
957
|
+
</member>
|
|
958
|
+
<member name="P:FileHelpers.FileHelperEngine.Options">
|
|
959
|
+
<summary>
|
|
960
|
+
Allows to change some record layout options at runtime
|
|
961
|
+
</summary>
|
|
962
|
+
</member>
|
|
963
|
+
<member name="M:FileHelpers.DelimitedFileEngine.#ctor(System.Type)">
|
|
964
|
+
<summary>
|
|
965
|
+
Create a version of the <see cref="T:FileHelpers.FileHelperEngine"/> exclusive for
|
|
966
|
+
delimited records that allow you to change the delimiter an other options at runtime
|
|
967
|
+
</summary>
|
|
968
|
+
<remarks>
|
|
969
|
+
Useful when you need to export or import the same info with 2 or more different delimiters.
|
|
970
|
+
</remarks>
|
|
971
|
+
<param name="recordType">The record mapping class.</param>
|
|
972
|
+
</member>
|
|
973
|
+
<member name="P:FileHelpers.DelimitedFileEngine.Options">
|
|
974
|
+
<summary>Allow changes in the record layout like delimiters and others common settings.</summary>
|
|
975
|
+
</member>
|
|
976
|
+
<member name="T:FileHelpers.FileHelperAsyncEngine">
|
|
977
|
+
<summary>
|
|
978
|
+
<para><b>One of the main classes of the library.</b></para>
|
|
979
|
+
<para>This engine is responsable to Read/Write the records <b>One by One</b> from/to files or streams.</para>
|
|
980
|
+
</summary><remarks>
|
|
981
|
+
<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>
|
|
982
|
+
<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>
|
|
983
|
+
<para>Or you can browse the <a href="examples.html">Examples Seccion</a> for more code.</para>
|
|
984
|
+
</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>
|
|
985
|
+
<example>
|
|
986
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
987
|
+
<code>
|
|
988
|
+
<textarea name="code" class="c#">
|
|
989
|
+
|
|
990
|
+
using FileHelpers;
|
|
991
|
+
|
|
992
|
+
// First declare the record class
|
|
993
|
+
|
|
994
|
+
[Delimitedrecord("|")]
|
|
995
|
+
public class SampleType
|
|
996
|
+
{
|
|
997
|
+
public string Field1;
|
|
998
|
+
public int Field2;
|
|
999
|
+
}
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
public void ReadExample()
|
|
1003
|
+
{
|
|
1004
|
+
SampleType record;
|
|
1005
|
+
|
|
1006
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1007
|
+
|
|
1008
|
+
engine.BeginReadFile("source.txt");
|
|
1009
|
+
|
|
1010
|
+
while( engine.ReadNext() != null )
|
|
1011
|
+
{
|
|
1012
|
+
record = (SampleType) engine.LastRecord;
|
|
1013
|
+
|
|
1014
|
+
// put your code here !!!!
|
|
1015
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
1016
|
+
|
|
1017
|
+
}
|
|
1018
|
+
|
|
1019
|
+
engine.Close();
|
|
1020
|
+
}
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
public void WriteExample()
|
|
1024
|
+
{
|
|
1025
|
+
SampleType record;
|
|
1026
|
+
|
|
1027
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1028
|
+
|
|
1029
|
+
engine.BeginWriteFile("source.txt");
|
|
1030
|
+
|
|
1031
|
+
record.Field1 = "Primer Registro";
|
|
1032
|
+
record.Field2 = 1;
|
|
1033
|
+
engine.WriteNext(record);
|
|
1034
|
+
|
|
1035
|
+
record.Field1 = "Segundo Registro";
|
|
1036
|
+
record.Field2 = 2;
|
|
1037
|
+
engine.WriteNext(record);
|
|
1038
|
+
|
|
1039
|
+
engine.Close();
|
|
1040
|
+
}
|
|
1041
|
+
|
|
1042
|
+
</textarea>
|
|
1043
|
+
</code>
|
|
1044
|
+
</example>
|
|
1045
|
+
</member>
|
|
1046
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.#ctor(System.Type)">
|
|
1047
|
+
<summary>
|
|
1048
|
+
Initializes a new instance of the FileHelperEngine class with the specified type of records.
|
|
1049
|
+
</summary><param name="recordType">The record mapping class.</param>
|
|
1050
|
+
</member>
|
|
1051
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.#ctor(System.Type,System.Text.Encoding)">
|
|
1052
|
+
<summary>
|
|
1053
|
+
Initializes a new instance of the FileHelperEngine class with the specified type of records.
|
|
1054
|
+
</summary><param name="recordType">The record mapping class.</param>
|
|
1055
|
+
<param name="encoding">The encoding used by the Engine.</param>
|
|
1056
|
+
</member>
|
|
1057
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginReadStream(System.IO.TextReader)">
|
|
1058
|
+
<summary>
|
|
1059
|
+
Open a specified stream and seek to the first record.
|
|
1060
|
+
</summary><remarks>
|
|
1061
|
+
<para>This method only seek to the first record.</para>
|
|
1062
|
+
<para>To read record by record use <b><see cref="M:FileHelpers.FileHelperAsyncEngine.ReadNext"/></b> method.</para>
|
|
1063
|
+
<para>When you stop to read the file you must call <b><see cref="M:FileHelpers.FileHelperAsyncEngine.Close"/></b> method.</para>
|
|
1064
|
+
</remarks><param name="reader">The TextReader of the stream.</param><example>
|
|
1065
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1066
|
+
<code>
|
|
1067
|
+
<textarea name="code" class="c#">
|
|
1068
|
+
|
|
1069
|
+
using FileHelpers;
|
|
1070
|
+
|
|
1071
|
+
// First declare the record class
|
|
1072
|
+
|
|
1073
|
+
[Delimitedrecord("|")]
|
|
1074
|
+
public class SampleType
|
|
1075
|
+
{
|
|
1076
|
+
public string Field1;
|
|
1077
|
+
public int Field2;
|
|
1078
|
+
}
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
public void ReadExample()
|
|
1082
|
+
{
|
|
1083
|
+
SampleType record;
|
|
1084
|
+
|
|
1085
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1086
|
+
|
|
1087
|
+
engine.BeginReadFile("source.txt");
|
|
1088
|
+
|
|
1089
|
+
while( engine.ReadNext() != null )
|
|
1090
|
+
{
|
|
1091
|
+
record = (SampleType) engine.LastRecord;
|
|
1092
|
+
|
|
1093
|
+
// put your code here !!!!
|
|
1094
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
1095
|
+
|
|
1096
|
+
}
|
|
1097
|
+
|
|
1098
|
+
engine.Close();
|
|
1099
|
+
}
|
|
1100
|
+
|
|
1101
|
+
</textarea>
|
|
1102
|
+
</code>
|
|
1103
|
+
</example>
|
|
1104
|
+
</member>
|
|
1105
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginReadFile(System.String)">
|
|
1106
|
+
<summary>
|
|
1107
|
+
Open a specified file and seek to the first record.
|
|
1108
|
+
</summary><remarks>
|
|
1109
|
+
<para>This method only open the file.</para>
|
|
1110
|
+
<para>To read record by record use <b><see cref="M:FileHelpers.FileHelperAsyncEngine.ReadNext"/></b> method.</para>
|
|
1111
|
+
<para>When you stop to read the file you must call <b><see cref="M:FileHelpers.FileHelperAsyncEngine.Close"/></b> method.</para>
|
|
1112
|
+
</remarks><param name="fileName">The file path to be read.</param><returns>True if the file is succefully opened. False otherway.</returns><example>
|
|
1113
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1114
|
+
<code>
|
|
1115
|
+
<textarea name="code" class="c#">
|
|
1116
|
+
|
|
1117
|
+
using FileHelpers;
|
|
1118
|
+
|
|
1119
|
+
// First declare the record class
|
|
1120
|
+
|
|
1121
|
+
[Delimitedrecord("|")]
|
|
1122
|
+
public class SampleType
|
|
1123
|
+
{
|
|
1124
|
+
public string Field1;
|
|
1125
|
+
public int Field2;
|
|
1126
|
+
}
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
public void ReadExample()
|
|
1130
|
+
{
|
|
1131
|
+
SampleType record;
|
|
1132
|
+
|
|
1133
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1134
|
+
|
|
1135
|
+
engine.BeginReadFile("source.txt");
|
|
1136
|
+
|
|
1137
|
+
while( engine.ReadNext() != null )
|
|
1138
|
+
{
|
|
1139
|
+
record = (SampleType) engine.LastRecord;
|
|
1140
|
+
|
|
1141
|
+
// put your code here !!!!
|
|
1142
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
1143
|
+
|
|
1144
|
+
}
|
|
1145
|
+
|
|
1146
|
+
engine.Close();
|
|
1147
|
+
}
|
|
1148
|
+
|
|
1149
|
+
</textarea>
|
|
1150
|
+
</code>
|
|
1151
|
+
</example>
|
|
1152
|
+
</member>
|
|
1153
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginReadString(System.String)">
|
|
1154
|
+
<!-- No matching elements were found for the following include tag --><include file="FileHelperAsyncEngine.docs.xml" path="doc/BeginReadString/*"/>
|
|
1155
|
+
</member>
|
|
1156
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.ReadNext">
|
|
1157
|
+
<summary>
|
|
1158
|
+
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.
|
|
1159
|
+
</summary><remarks>
|
|
1160
|
+
<para>This method not only returns the current record, also moves to the next.</para>
|
|
1161
|
+
<para>If the end of file is reached this method return <b>null</b>.</para>
|
|
1162
|
+
</remarks><returns>The current record of the opened file.</returns><example>
|
|
1163
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1164
|
+
<code>
|
|
1165
|
+
<textarea name="code" class="c#">
|
|
1166
|
+
|
|
1167
|
+
using FileHelpers;
|
|
1168
|
+
|
|
1169
|
+
// First declare the record class
|
|
1170
|
+
|
|
1171
|
+
[Delimitedrecord("|")]
|
|
1172
|
+
public class SampleType
|
|
1173
|
+
{
|
|
1174
|
+
public string Field1;
|
|
1175
|
+
public int Field2;
|
|
1176
|
+
}
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
public void ReadExample()
|
|
1180
|
+
{
|
|
1181
|
+
SampleType record;
|
|
1182
|
+
|
|
1183
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1184
|
+
|
|
1185
|
+
engine.BeginReadFile("source.txt");
|
|
1186
|
+
|
|
1187
|
+
while( engine.ReadNext() != null )
|
|
1188
|
+
{
|
|
1189
|
+
record = (SampleType) engine.LastRecord;
|
|
1190
|
+
|
|
1191
|
+
// put your code here !!!!
|
|
1192
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
1193
|
+
|
|
1194
|
+
}
|
|
1195
|
+
|
|
1196
|
+
engine.Close();
|
|
1197
|
+
}
|
|
1198
|
+
|
|
1199
|
+
</textarea>
|
|
1200
|
+
</code>
|
|
1201
|
+
</example>
|
|
1202
|
+
</member>
|
|
1203
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.ReadNexts(System.Int32)">
|
|
1204
|
+
<summary>
|
|
1205
|
+
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.
|
|
1206
|
+
</summary><remarks>
|
|
1207
|
+
If there are less records in the source, read to the end.
|
|
1208
|
+
</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>
|
|
1209
|
+
</member>
|
|
1210
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.Flush">
|
|
1211
|
+
<summary>
|
|
1212
|
+
Save all the buffered data for write to the disk.
|
|
1213
|
+
Useful to long opened async engines that wants to save pending values or for engines used for logging.
|
|
1214
|
+
</summary>
|
|
1215
|
+
</member>
|
|
1216
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.Close">
|
|
1217
|
+
<summary>
|
|
1218
|
+
Close all opened stream readers and writters (if any).
|
|
1219
|
+
</summary><remarks>
|
|
1220
|
+
<para>This method must be called when you finish to process a file to dispose the opened streams.</para>
|
|
1221
|
+
</remarks><example>
|
|
1222
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1223
|
+
<code>
|
|
1224
|
+
<textarea name="code" class="c#">
|
|
1225
|
+
|
|
1226
|
+
using FileHelpers;
|
|
1227
|
+
|
|
1228
|
+
// First declare the record class
|
|
1229
|
+
|
|
1230
|
+
[Delimitedrecord("|")]
|
|
1231
|
+
public class SampleType
|
|
1232
|
+
{
|
|
1233
|
+
public string Field1;
|
|
1234
|
+
public int Field2;
|
|
1235
|
+
}
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
public void ReadExample()
|
|
1239
|
+
{
|
|
1240
|
+
SampleType record;
|
|
1241
|
+
|
|
1242
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1243
|
+
|
|
1244
|
+
engine.BeginReadFile("source.txt");
|
|
1245
|
+
|
|
1246
|
+
while( engine.ReadNext() != null )
|
|
1247
|
+
{
|
|
1248
|
+
record = (SampleType) engine.LastRecord;
|
|
1249
|
+
|
|
1250
|
+
// put your code here !!!!
|
|
1251
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
1252
|
+
|
|
1253
|
+
}
|
|
1254
|
+
|
|
1255
|
+
engine.Close();
|
|
1256
|
+
}
|
|
1257
|
+
|
|
1258
|
+
</textarea>
|
|
1259
|
+
</code>
|
|
1260
|
+
</example>
|
|
1261
|
+
</member>
|
|
1262
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginWriteStream(System.IO.TextWriter)">
|
|
1263
|
+
<summary>
|
|
1264
|
+
Set the stream to be used in the <see cref="M:FileHelpers.FileHelperAsyncEngine.WriteNext(System.Object)"/> operation.
|
|
1265
|
+
</summary><remarks>
|
|
1266
|
+
<para>When you finish to write to the file you must call <b><see cref="M:FileHelpers.FileHelperAsyncEngine.Close"/></b> method.</para>
|
|
1267
|
+
</remarks><param name="writer">To stream to writes to.</param><example>
|
|
1268
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1269
|
+
<code>
|
|
1270
|
+
<textarea name="code" class="c#">
|
|
1271
|
+
|
|
1272
|
+
using FileHelpers;
|
|
1273
|
+
|
|
1274
|
+
// First declare the record class
|
|
1275
|
+
|
|
1276
|
+
[Delimitedrecord("|")]
|
|
1277
|
+
public class SampleType
|
|
1278
|
+
{
|
|
1279
|
+
public string Field1;
|
|
1280
|
+
public int Field2;
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
public void WriteExample()
|
|
1285
|
+
{
|
|
1286
|
+
SampleType record;
|
|
1287
|
+
|
|
1288
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1289
|
+
|
|
1290
|
+
engine.BeginWriteFile("source.txt");
|
|
1291
|
+
|
|
1292
|
+
record.Field1 = "Primer Registro";
|
|
1293
|
+
record.Field2 = 1;
|
|
1294
|
+
engine.WriteNext(record);
|
|
1295
|
+
|
|
1296
|
+
record.Field1 = "Segundo Registro";
|
|
1297
|
+
record.Field2 = 2;
|
|
1298
|
+
engine.WriteNext(record);
|
|
1299
|
+
|
|
1300
|
+
engine.Close();
|
|
1301
|
+
}
|
|
1302
|
+
|
|
1303
|
+
</textarea>
|
|
1304
|
+
</code>
|
|
1305
|
+
</example>
|
|
1306
|
+
</member>
|
|
1307
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginWriteFile(System.String)">
|
|
1308
|
+
<summary>
|
|
1309
|
+
Open a file to write it. If exist the engine override it
|
|
1310
|
+
</summary><remarks>
|
|
1311
|
+
<para>When you finish to write to the file you must call <b><see cref="M:FileHelpers.FileHelperAsyncEngine.Close"/></b> method.</para>
|
|
1312
|
+
</remarks><param name="fileName">The file path to be opened to write.</param><example>
|
|
1313
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1314
|
+
<code>
|
|
1315
|
+
<textarea name="code" class="c#">
|
|
1316
|
+
|
|
1317
|
+
using FileHelpers;
|
|
1318
|
+
|
|
1319
|
+
// First declare the record class
|
|
1320
|
+
|
|
1321
|
+
[Delimitedrecord("|")]
|
|
1322
|
+
public class SampleType
|
|
1323
|
+
{
|
|
1324
|
+
public string Field1;
|
|
1325
|
+
public int Field2;
|
|
1326
|
+
}
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
public void WriteExample()
|
|
1330
|
+
{
|
|
1331
|
+
SampleType record;
|
|
1332
|
+
|
|
1333
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1334
|
+
|
|
1335
|
+
engine.BeginWriteFile("source.txt");
|
|
1336
|
+
|
|
1337
|
+
record.Field1 = "Primer Registro";
|
|
1338
|
+
record.Field2 = 1;
|
|
1339
|
+
engine.WriteNext(record);
|
|
1340
|
+
|
|
1341
|
+
record.Field1 = "Segundo Registro";
|
|
1342
|
+
record.Field2 = 2;
|
|
1343
|
+
engine.WriteNext(record);
|
|
1344
|
+
|
|
1345
|
+
engine.Close();
|
|
1346
|
+
}
|
|
1347
|
+
|
|
1348
|
+
</textarea>
|
|
1349
|
+
</code>
|
|
1350
|
+
</example>
|
|
1351
|
+
</member>
|
|
1352
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.BeginAppendToFile(System.String)">
|
|
1353
|
+
<summary>
|
|
1354
|
+
Open a file to Append to the end.
|
|
1355
|
+
</summary><remarks>
|
|
1356
|
+
<para>This method open and seek ends the file.</para>
|
|
1357
|
+
<para>When you finish to append to the file you must call <b><see cref="M:FileHelpers.FileHelperAsyncEngine.Close"/></b> method.</para>
|
|
1358
|
+
</remarks><param name="fileName">The file path to be opened to write at the end.</param>
|
|
1359
|
+
</member>
|
|
1360
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.WriteNext(System.Object)">
|
|
1361
|
+
<summary>
|
|
1362
|
+
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.
|
|
1363
|
+
</summary><param name="record">The record to write.</param><example>
|
|
1364
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1365
|
+
<code>
|
|
1366
|
+
<textarea name="code" class="c#">
|
|
1367
|
+
|
|
1368
|
+
using FileHelpers;
|
|
1369
|
+
|
|
1370
|
+
// First declare the record class
|
|
1371
|
+
|
|
1372
|
+
[Delimitedrecord("|")]
|
|
1373
|
+
public class SampleType
|
|
1374
|
+
{
|
|
1375
|
+
public string Field1;
|
|
1376
|
+
public int Field2;
|
|
1377
|
+
}
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
public void WriteExample()
|
|
1381
|
+
{
|
|
1382
|
+
SampleType record;
|
|
1383
|
+
|
|
1384
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1385
|
+
|
|
1386
|
+
engine.BeginWriteFile("source.txt");
|
|
1387
|
+
|
|
1388
|
+
record.Field1 = "Primer Registro";
|
|
1389
|
+
record.Field2 = 1;
|
|
1390
|
+
engine.WriteNext(record);
|
|
1391
|
+
|
|
1392
|
+
record.Field1 = "Segundo Registro";
|
|
1393
|
+
record.Field2 = 2;
|
|
1394
|
+
engine.WriteNext(record);
|
|
1395
|
+
|
|
1396
|
+
engine.Close();
|
|
1397
|
+
}
|
|
1398
|
+
|
|
1399
|
+
</textarea>
|
|
1400
|
+
</code>
|
|
1401
|
+
</example>
|
|
1402
|
+
</member>
|
|
1403
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.WriteNexts(System.Collections.IEnumerable)">
|
|
1404
|
+
<summary>
|
|
1405
|
+
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.
|
|
1406
|
+
</summary><param name="records">The records to write (Can be an array, ArrayList, etc)</param>
|
|
1407
|
+
</member>
|
|
1408
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.System#Collections#IEnumerable#GetEnumerator">
|
|
1409
|
+
<summary>Allows to loop record by record in the engine</summary>
|
|
1410
|
+
<returns>The enumerator</returns>
|
|
1411
|
+
</member>
|
|
1412
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.System#IDisposable#Dispose">
|
|
1413
|
+
<summary>Release Resources</summary>
|
|
1414
|
+
</member>
|
|
1415
|
+
<member name="M:FileHelpers.FileHelperAsyncEngine.Finalize">
|
|
1416
|
+
<summary>Destructor</summary>
|
|
1417
|
+
</member>
|
|
1418
|
+
<member name="P:FileHelpers.FileHelperAsyncEngine.LastRecord">
|
|
1419
|
+
<summary>Contains the last Record read by the <see cref="M:FileHelpers.FileHelperAsyncEngine.ReadNext"/> method.</summary><example>
|
|
1420
|
+
This example show the basic use of the async methods in the FileHelperAsymcEngine:
|
|
1421
|
+
<code>
|
|
1422
|
+
<textarea name="code" class="c#">
|
|
1423
|
+
|
|
1424
|
+
using FileHelpers;
|
|
1425
|
+
|
|
1426
|
+
// First declare the record class
|
|
1427
|
+
|
|
1428
|
+
[Delimitedrecord("|")]
|
|
1429
|
+
public class SampleType
|
|
1430
|
+
{
|
|
1431
|
+
public string Field1;
|
|
1432
|
+
public int Field2;
|
|
1433
|
+
}
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
public void ReadExample()
|
|
1437
|
+
{
|
|
1438
|
+
SampleType record;
|
|
1439
|
+
|
|
1440
|
+
FileHelperAsyncEngine engine = new FileHelperAsyncEngine(typeof(SampleType));
|
|
1441
|
+
|
|
1442
|
+
engine.BeginReadFile("source.txt");
|
|
1443
|
+
|
|
1444
|
+
while( engine.ReadNext() != null )
|
|
1445
|
+
{
|
|
1446
|
+
record = (SampleType) engine.LastRecord;
|
|
1447
|
+
|
|
1448
|
+
// put your code here !!!!
|
|
1449
|
+
Console.WriteLine("Data " + record.Field1 + " , " + record.Field2.ToString());
|
|
1450
|
+
|
|
1451
|
+
}
|
|
1452
|
+
|
|
1453
|
+
engine.Close();
|
|
1454
|
+
}
|
|
1455
|
+
|
|
1456
|
+
</textarea>
|
|
1457
|
+
</code>
|
|
1458
|
+
</example>
|
|
1459
|
+
</member>
|
|
1460
|
+
<member name="T:FileHelpers.FixedFileEngine">
|
|
1461
|
+
<summary>
|
|
1462
|
+
Is a version of the <see cref="T:FileHelpers.FileHelperEngine"/> exclusive for
|
|
1463
|
+
fixed length records that allow you to change the delimiter an other options at runtime
|
|
1464
|
+
</summary>
|
|
1465
|
+
<remarks>
|
|
1466
|
+
Useful when you need to export or import the same info with little different options.
|
|
1467
|
+
</remarks>
|
|
1468
|
+
</member>
|
|
1469
|
+
<member name="M:FileHelpers.FixedFileEngine.#ctor(System.Type)">
|
|
1470
|
+
<summary>
|
|
1471
|
+
Creates a version of the <see cref="T:FileHelpers.FileHelperEngine"/> exclusive for
|
|
1472
|
+
fixed length records that allow you to change the delimiter an other options at runtime
|
|
1473
|
+
</summary>
|
|
1474
|
+
<remarks>
|
|
1475
|
+
Useful when you need to export or import the same info with little different options.
|
|
1476
|
+
</remarks>
|
|
1477
|
+
<param name="recordType">The record mapping class.</param>
|
|
1478
|
+
</member>
|
|
1479
|
+
<member name="P:FileHelpers.FixedFileEngine.Options">
|
|
1480
|
+
<summary>Allow changes some fixed length options and others common settings.</summary>
|
|
1481
|
+
</member>
|
|
1482
|
+
<member name="T:FileHelpers.AlignMode">
|
|
1483
|
+
<summary>Indicates the align of the field when the <see cref="T:FileHelpers.FileHelperEngine"/> <b>writes</b> the record.</summary>
|
|
1484
|
+
</member>
|
|
1485
|
+
<member name="F:FileHelpers.AlignMode.Left">
|
|
1486
|
+
<summary>Aligns the field to the left.</summary>
|
|
1487
|
+
</member>
|
|
1488
|
+
<member name="F:FileHelpers.AlignMode.Center">
|
|
1489
|
+
<summary>Aligns the field to the center.</summary>
|
|
1490
|
+
</member>
|
|
1491
|
+
<member name="F:FileHelpers.AlignMode.Right">
|
|
1492
|
+
<summary>Aligns the field to the right.</summary>
|
|
1493
|
+
</member>
|
|
1494
|
+
<member name="T:FileHelpers.ConverterKind">
|
|
1495
|
+
<summary>Indicates the convertion used in the <see cref="T:FileHelpers.FieldConverterAttribute"/>.</summary>
|
|
1496
|
+
</member>
|
|
1497
|
+
<member name="F:FileHelpers.ConverterKind.None">
|
|
1498
|
+
<summary>Null Converter.</summary>
|
|
1499
|
+
</member>
|
|
1500
|
+
<member name="F:FileHelpers.ConverterKind.Date">
|
|
1501
|
+
<summary>
|
|
1502
|
+
<para>Convert from/to <b>Date</b> values.</para>
|
|
1503
|
+
<para>Params: arg1 is the <b>string</b> with the date format.</para>
|
|
1504
|
+
</summary>
|
|
1505
|
+
</member>
|
|
1506
|
+
<member name="F:FileHelpers.ConverterKind.Boolean">
|
|
1507
|
+
<summary>Convert from/to <b>Boolean</b> values.</summary>
|
|
1508
|
+
</member>
|
|
1509
|
+
<member name="F:FileHelpers.ConverterKind.Byte">
|
|
1510
|
+
<summary>
|
|
1511
|
+
<para>Convert from/to <b>Byte</b> values.</para>
|
|
1512
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1513
|
+
</summary>
|
|
1514
|
+
</member>
|
|
1515
|
+
<member name="F:FileHelpers.ConverterKind.Int16">
|
|
1516
|
+
<summary>
|
|
1517
|
+
<para>Convert from/to <b>Int16 or short</b> values.</para>
|
|
1518
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1519
|
+
</summary>
|
|
1520
|
+
</member>
|
|
1521
|
+
<member name="F:FileHelpers.ConverterKind.Int32">
|
|
1522
|
+
<summary>
|
|
1523
|
+
<para>Convert from/to <b>Int32 or int</b> values.</para>
|
|
1524
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1525
|
+
</summary>
|
|
1526
|
+
</member>
|
|
1527
|
+
<member name="F:FileHelpers.ConverterKind.Int64">
|
|
1528
|
+
<summary>
|
|
1529
|
+
<para>Convert from/to <b>Int64 or long</b> values.</para>
|
|
1530
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1531
|
+
</summary>
|
|
1532
|
+
</member>
|
|
1533
|
+
<member name="F:FileHelpers.ConverterKind.Decimal">
|
|
1534
|
+
<summary>
|
|
1535
|
+
<para>Convert from/to <b>Decimal</b> values.</para>
|
|
1536
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1537
|
+
</summary>
|
|
1538
|
+
</member>
|
|
1539
|
+
<member name="F:FileHelpers.ConverterKind.Double">
|
|
1540
|
+
<summary>
|
|
1541
|
+
<para>Convert from/to <b>Double</b> values.</para>
|
|
1542
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1543
|
+
</summary>
|
|
1544
|
+
</member>
|
|
1545
|
+
<member name="F:FileHelpers.ConverterKind.Single">
|
|
1546
|
+
<summary>
|
|
1547
|
+
<para>Convert from/to <b>Single</b> values.</para>
|
|
1548
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1549
|
+
</summary>
|
|
1550
|
+
</member>
|
|
1551
|
+
<member name="F:FileHelpers.ConverterKind.SByte">
|
|
1552
|
+
<summary>
|
|
1553
|
+
<para>Convert from/to <b>Byte</b> values.</para>
|
|
1554
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1555
|
+
</summary>
|
|
1556
|
+
</member>
|
|
1557
|
+
<member name="F:FileHelpers.ConverterKind.UInt16">
|
|
1558
|
+
<summary>
|
|
1559
|
+
<para>Convert from/to <b>UInt16 or unsigned short</b> values.</para>
|
|
1560
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1561
|
+
</summary>
|
|
1562
|
+
</member>
|
|
1563
|
+
<member name="F:FileHelpers.ConverterKind.UInt32">
|
|
1564
|
+
<summary>
|
|
1565
|
+
<para>Convert from/to <b>UInt32 or unsigned int</b> values.</para>
|
|
1566
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1567
|
+
</summary>
|
|
1568
|
+
</member>
|
|
1569
|
+
<member name="F:FileHelpers.ConverterKind.UInt64">
|
|
1570
|
+
<summary>
|
|
1571
|
+
<para>Convert from/to <b>UInt64 or unsigned long</b> values.</para>
|
|
1572
|
+
<para>Params: arg1 is the <b>decimal separator</b>, by default '.'</para>
|
|
1573
|
+
</summary>
|
|
1574
|
+
</member>
|
|
1575
|
+
<member name="T:FileHelpers.ErrorMode">
|
|
1576
|
+
<summary>Indicates the behavior when the <see cref="T:FileHelpers.FileHelperEngine"/> class found an error.</summary>
|
|
1577
|
+
</member>
|
|
1578
|
+
<member name="F:FileHelpers.ErrorMode.ThrowException">
|
|
1579
|
+
<summary>Default value, this simple Rethrow the original exception.</summary>
|
|
1580
|
+
</member>
|
|
1581
|
+
<member name="F:FileHelpers.ErrorMode.SaveAndContinue">
|
|
1582
|
+
<summary>Add an <see cref="T:FileHelpers.ErrorInfo"/> to the array of <see cref="P:FileHelpers.ErrorManager.Errors"/>.</summary>
|
|
1583
|
+
</member>
|
|
1584
|
+
<member name="F:FileHelpers.ErrorMode.IgnoreAndContinue">
|
|
1585
|
+
<summary>Simply ignores the exception an continue.</summary>
|
|
1586
|
+
</member>
|
|
1587
|
+
<member name="T:FileHelpers.FixedMode">
|
|
1588
|
+
<summary>Indicates the behavior when variable length records are found in a [<see cref="T:FileHelpers.FixedLengthRecordAttribute"/>]. (Note: nothing in common with [FieldOptional])</summary>
|
|
1589
|
+
</member>
|
|
1590
|
+
<member name="F:FileHelpers.FixedMode.ExactLength">
|
|
1591
|
+
<summary>The records must have the length equals to the sum of each field length.</summary>
|
|
1592
|
+
</member>
|
|
1593
|
+
<member name="F:FileHelpers.FixedMode.AllowMoreChars">
|
|
1594
|
+
<summary>The records can contain less chars in the last field.</summary>
|
|
1595
|
+
</member>
|
|
1596
|
+
<member name="F:FileHelpers.FixedMode.AllowLessChars">
|
|
1597
|
+
<summary>The records can contain more chars in the last field.</summary>
|
|
1598
|
+
</member>
|
|
1599
|
+
<member name="F:FileHelpers.FixedMode.AllowVariableLength">
|
|
1600
|
+
<summary>The records can contain more or less chars in the last field.</summary>
|
|
1601
|
+
</member>
|
|
1602
|
+
<member name="T:FileHelpers.MultilineMode">
|
|
1603
|
+
<summary>Indicates the behavior of multiline fields.</summary>
|
|
1604
|
+
</member>
|
|
1605
|
+
<member name="F:FileHelpers.MultilineMode.AllowForBoth">
|
|
1606
|
+
<summary>The engine can handle multiline values for read or write.</summary>
|
|
1607
|
+
</member>
|
|
1608
|
+
<member name="F:FileHelpers.MultilineMode.AllowForRead">
|
|
1609
|
+
<summary>The engine can handle multiline values only for read.</summary>
|
|
1610
|
+
</member>
|
|
1611
|
+
<member name="F:FileHelpers.MultilineMode.AllowForWrite">
|
|
1612
|
+
<summary>The engine can handle multiline values only for write.</summary>
|
|
1613
|
+
</member>
|
|
1614
|
+
<member name="F:FileHelpers.MultilineMode.NotAllow">
|
|
1615
|
+
<summary>The engine don´t allow multiline values for this field.</summary>
|
|
1616
|
+
</member>
|
|
1617
|
+
<member name="T:FileHelpers.QuoteMode">
|
|
1618
|
+
<summary>Indicates the behavior of quoted fields.</summary>
|
|
1619
|
+
</member>
|
|
1620
|
+
<member name="F:FileHelpers.QuoteMode.AlwaysQuoted">
|
|
1621
|
+
<summary>The engine always expects a quote when read and always adds the quotes when write.</summary>
|
|
1622
|
+
</member>
|
|
1623
|
+
<member name="F:FileHelpers.QuoteMode.OptionalForRead">
|
|
1624
|
+
<summary>The engine expects or not a quote when read and always adds the quotes when write.</summary>
|
|
1625
|
+
</member>
|
|
1626
|
+
<member name="F:FileHelpers.QuoteMode.OptionalForWrite">
|
|
1627
|
+
<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>
|
|
1628
|
+
</member>
|
|
1629
|
+
<member name="F:FileHelpers.QuoteMode.OptionalForBoth">
|
|
1630
|
+
<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>
|
|
1631
|
+
</member>
|
|
1632
|
+
<member name="T:FileHelpers.RecordCondition">
|
|
1633
|
+
<summary>The condition used to include or exclude each record.</summary>
|
|
1634
|
+
</member>
|
|
1635
|
+
<member name="F:FileHelpers.RecordCondition.None">
|
|
1636
|
+
<summary>No Condition, Include it always.</summary>
|
|
1637
|
+
</member>
|
|
1638
|
+
<member name="F:FileHelpers.RecordCondition.IncludeIfContains">
|
|
1639
|
+
<summary>Include the record if it contains the selector string.</summary>
|
|
1640
|
+
</member>
|
|
1641
|
+
<member name="F:FileHelpers.RecordCondition.IncludeIfBegins">
|
|
1642
|
+
<summary>Include the record if it begins with selector string.</summary>
|
|
1643
|
+
</member>
|
|
1644
|
+
<member name="F:FileHelpers.RecordCondition.IncludeIfEnds">
|
|
1645
|
+
<summary>Include the record if it ends with selector string.</summary>
|
|
1646
|
+
</member>
|
|
1647
|
+
<member name="F:FileHelpers.RecordCondition.IncludeIfEnclosed">
|
|
1648
|
+
<summary>Include the record if it begins and ends with selector string.</summary>
|
|
1649
|
+
</member>
|
|
1650
|
+
<member name="F:FileHelpers.RecordCondition.ExcludeIfContains">
|
|
1651
|
+
<summary>Exclude the record if it contains the selector string.</summary>
|
|
1652
|
+
</member>
|
|
1653
|
+
<member name="F:FileHelpers.RecordCondition.ExcludeIfBegins">
|
|
1654
|
+
<summary>Exclude the record if it begins with selector string.</summary>
|
|
1655
|
+
</member>
|
|
1656
|
+
<member name="F:FileHelpers.RecordCondition.ExcludeIfEnds">
|
|
1657
|
+
<summary>Exclude the record if it ends with selector string.</summary>
|
|
1658
|
+
</member>
|
|
1659
|
+
<member name="F:FileHelpers.RecordCondition.ExcludeIfEnclosed">
|
|
1660
|
+
<summary>Exclude the record if it begins and ends with selector string.</summary>
|
|
1661
|
+
</member>
|
|
1662
|
+
<member name="T:FileHelpers.TrimMode">
|
|
1663
|
+
<summary>Indicates the triming behavior of the trailing characters.</summary>
|
|
1664
|
+
</member>
|
|
1665
|
+
<member name="F:FileHelpers.TrimMode.None">
|
|
1666
|
+
<summary>No triming is performed.</summary>
|
|
1667
|
+
</member>
|
|
1668
|
+
<member name="F:FileHelpers.TrimMode.Both">
|
|
1669
|
+
<summary>The field is trimed in both sides.</summary>
|
|
1670
|
+
</member>
|
|
1671
|
+
<member name="F:FileHelpers.TrimMode.Left">
|
|
1672
|
+
<summary>The field is trimed in the left.</summary>
|
|
1673
|
+
</member>
|
|
1674
|
+
<member name="F:FileHelpers.TrimMode.Right">
|
|
1675
|
+
<summary>The field is trimed in the right.</summary>
|
|
1676
|
+
</member>
|
|
1677
|
+
<member name="T:FileHelpers.BadUsageException">
|
|
1678
|
+
<summary>Indicates the wrong usage of the library.</summary>
|
|
1679
|
+
</member>
|
|
1680
|
+
<member name="T:FileHelpers.FileHelpersException">
|
|
1681
|
+
<summary>Base class for all the library Exceptions.</summary>
|
|
1682
|
+
</member>
|
|
1683
|
+
<member name="M:FileHelpers.FileHelpersException.#ctor(System.String)">
|
|
1684
|
+
<summary>Basic constructor of the exception.</summary>
|
|
1685
|
+
<param name="message">Message of the exception.</param>
|
|
1686
|
+
</member>
|
|
1687
|
+
<member name="M:FileHelpers.FileHelpersException.#ctor(System.String,System.Exception)">
|
|
1688
|
+
<summary>Basic constructor of the exception.</summary>
|
|
1689
|
+
<param name="message">Message of the exception.</param>
|
|
1690
|
+
<param name="innerEx">The inner Exception.</param>
|
|
1691
|
+
</member>
|
|
1692
|
+
<member name="M:FileHelpers.BadUsageException.#ctor(System.String)">
|
|
1693
|
+
<summary>Creates an instance of an BadUsageException.</summary>
|
|
1694
|
+
<param name="message">The exception Message</param>
|
|
1695
|
+
</member>
|
|
1696
|
+
<member name="T:FileHelpers.ConvertException">
|
|
1697
|
+
<summary>
|
|
1698
|
+
Indicates that a string value can't be converted to a dest type.
|
|
1699
|
+
</summary>
|
|
1700
|
+
</member>
|
|
1701
|
+
<member name="M:FileHelpers.ConvertException.#ctor(System.String,System.Type)">
|
|
1702
|
+
<summary>
|
|
1703
|
+
Create a new ConvertException object
|
|
1704
|
+
</summary>
|
|
1705
|
+
<param name="origValue">The value to convert.</param>
|
|
1706
|
+
<param name="destType">The destination Type.</param>
|
|
1707
|
+
</member>
|
|
1708
|
+
<member name="M:FileHelpers.ConvertException.#ctor(System.String,System.Type,System.String)">
|
|
1709
|
+
<summary>
|
|
1710
|
+
Create a new ConvertException object
|
|
1711
|
+
</summary>
|
|
1712
|
+
<param name="origValue">The value to convert.</param>
|
|
1713
|
+
<param name="destType">The destination Type.</param>
|
|
1714
|
+
<param name="extraInfo">Aditional info of the error.</param>
|
|
1715
|
+
</member>
|
|
1716
|
+
<member name="M:FileHelpers.ConvertException.#ctor(System.String,System.Type,System.String,System.Int32,System.Int32,System.String)">
|
|
1717
|
+
<summary>
|
|
1718
|
+
Create a new ConvertException object
|
|
1719
|
+
</summary>
|
|
1720
|
+
<param name="origValue">The value to convert.</param>
|
|
1721
|
+
<param name="destType">The destination Type.</param>
|
|
1722
|
+
<param name="extraInfo">Aditional info of the error.</param>
|
|
1723
|
+
<param name="columnNumber">The estimated column number.</param>
|
|
1724
|
+
<param name="lineNumber">The line where the error was found.</param>
|
|
1725
|
+
<param name="fieldName">The name of the field with the error</param>
|
|
1726
|
+
</member>
|
|
1727
|
+
<member name="P:FileHelpers.ConvertException.FieldType">
|
|
1728
|
+
<summary>The destination type.</summary>
|
|
1729
|
+
</member>
|
|
1730
|
+
<member name="P:FileHelpers.ConvertException.FieldStringValue">
|
|
1731
|
+
<summary>The value that cant be converterd. (null for unknown)</summary>
|
|
1732
|
+
</member>
|
|
1733
|
+
<member name="P:FileHelpers.ConvertException.MessageExtra">
|
|
1734
|
+
<summary>Extra info about the error.</summary>
|
|
1735
|
+
</member>
|
|
1736
|
+
<member name="P:FileHelpers.ConvertException.FieldName">
|
|
1737
|
+
<summary>The name of the field related to the exception. (null for unknown)</summary>
|
|
1738
|
+
</member>
|
|
1739
|
+
<member name="P:FileHelpers.ConvertException.LineNumber">
|
|
1740
|
+
<summary>The line where the error was found. (-1 is unknown)</summary>
|
|
1741
|
+
</member>
|
|
1742
|
+
<member name="P:FileHelpers.ConvertException.ColumnNumber">
|
|
1743
|
+
<summary>The estimate column where the error was found. (-1 is unknown)</summary>
|
|
1744
|
+
</member>
|
|
1745
|
+
<member name="T:FileHelpers.ErrorInfo">
|
|
1746
|
+
<summary>Contains error information of the <see cref="T:FileHelpers.FileHelperEngine"/> class.</summary>
|
|
1747
|
+
</member>
|
|
1748
|
+
<member name="P:FileHelpers.ErrorInfo.LineNumber">
|
|
1749
|
+
<summary>The line number of the error</summary>
|
|
1750
|
+
</member>
|
|
1751
|
+
<member name="P:FileHelpers.ErrorInfo.RecordString">
|
|
1752
|
+
<summary>The string of the record of the error.</summary>
|
|
1753
|
+
</member>
|
|
1754
|
+
<member name="P:FileHelpers.ErrorInfo.ExceptionInfo">
|
|
1755
|
+
<summary>The exception that indicates the error.</summary>
|
|
1756
|
+
</member>
|
|
1757
|
+
<member name="T:FileHelpers.ErrorManager">
|
|
1758
|
+
<summary>This is the class that handles the errors of the engines process.</summary>
|
|
1759
|
+
<remarks>All the engines and DataStorages contains a ErrorManager.</remarks>
|
|
1760
|
+
</member>
|
|
1761
|
+
<member name="M:FileHelpers.ErrorManager.#ctor">
|
|
1762
|
+
<summary>Initializes a new instance of the <see cref="T:FileHelpers.ErrorManager"/> class.</summary>
|
|
1763
|
+
</member>
|
|
1764
|
+
<member name="M:FileHelpers.ErrorManager.#ctor(FileHelpers.ErrorMode)">
|
|
1765
|
+
<summary>Initializes a new instance of the <see cref="T:FileHelpers.ErrorManager"/> class. with the specified <see cref="P:FileHelpers.ErrorManager.ErrorMode"/>.</summary>
|
|
1766
|
+
<param name="mode">Indicates the error behavior of the class.</param>
|
|
1767
|
+
</member>
|
|
1768
|
+
<member name="M:FileHelpers.ErrorManager.ClearErrors">
|
|
1769
|
+
<summary>Clears the error collection.</summary>
|
|
1770
|
+
</member>
|
|
1771
|
+
<member name="M:FileHelpers.ErrorManager.AddError(FileHelpers.ErrorInfo)">
|
|
1772
|
+
<summary>Add the specified ErrorInfo to the contained collection.</summary>
|
|
1773
|
+
<param name="error"></param>
|
|
1774
|
+
</member>
|
|
1775
|
+
<member name="M:FileHelpers.ErrorManager.AddErrors(FileHelpers.ErrorManager)">
|
|
1776
|
+
<summary>Add the specified ErrorInfo to the contained collection.</summary>
|
|
1777
|
+
</member>
|
|
1778
|
+
<member name="M:FileHelpers.ErrorManager.SaveErrors(System.String)">
|
|
1779
|
+
<summary>Saves the contained errors to the specified file.</summary>
|
|
1780
|
+
<param name="fileName">The file that contains the errors.</param>
|
|
1781
|
+
</member>
|
|
1782
|
+
<member name="M:FileHelpers.ErrorManager.SaveErrors(System.String,System.String)">
|
|
1783
|
+
<summary>Saves the contained errors to the specified file.</summary>
|
|
1784
|
+
<param name="fileName">The file that contains the errors.</param>
|
|
1785
|
+
<param name="header">The header line of the errors file.</param>
|
|
1786
|
+
</member>
|
|
1787
|
+
<member name="M:FileHelpers.ErrorManager.LoadErrors(System.String)">
|
|
1788
|
+
<summary>Load errors from a file.</summary>
|
|
1789
|
+
<param name="fileName">The file that contains the errors.</param>
|
|
1790
|
+
</member>
|
|
1791
|
+
<member name="P:FileHelpers.ErrorManager.Errors">
|
|
1792
|
+
<summary>Is an array of <see cref="T:FileHelpers.ErrorInfo"/> that contains the errors of the last operation in this class.</summary>
|
|
1793
|
+
</member>
|
|
1794
|
+
<member name="P:FileHelpers.ErrorManager.ErrorMode">
|
|
1795
|
+
<summary>Indicates the behavior of the <see cref="T:FileHelpers.FileHelperEngine"/> when it found an error.</summary>
|
|
1796
|
+
</member>
|
|
1797
|
+
<member name="P:FileHelpers.ErrorManager.ErrorCount">
|
|
1798
|
+
<summary>Number of contained errors.</summary>
|
|
1799
|
+
</member>
|
|
1800
|
+
<member name="P:FileHelpers.ErrorManager.HasErrors">
|
|
1801
|
+
<summary>Indicates if contains one or more errors.</summary>
|
|
1802
|
+
</member>
|
|
1803
|
+
<member name="T:FileHelpers.FieldBase">
|
|
1804
|
+
<summary>Base class for all Field Types. Implements all the basic functionality of a field in a typed file.</summary>
|
|
1805
|
+
</member>
|
|
1806
|
+
<member name="T:FileHelpers.DelimitedRecordOptions">
|
|
1807
|
+
<summary>
|
|
1808
|
+
This class allows you to set some options of the delimited records but at runtime.
|
|
1809
|
+
With this options the library is more flexible than never.
|
|
1810
|
+
</summary>
|
|
1811
|
+
</member>
|
|
1812
|
+
<member name="T:FileHelpers.RecordOptions">
|
|
1813
|
+
<summary>
|
|
1814
|
+
This class allows you to set some options of the records but at runtime.
|
|
1815
|
+
With this options the library is more flexible than never.
|
|
1816
|
+
</summary>
|
|
1817
|
+
</member>
|
|
1818
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreFirstLines">
|
|
1819
|
+
<summary>Indicates the number of first lines to be discarded.</summary>
|
|
1820
|
+
</member>
|
|
1821
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreLastLines">
|
|
1822
|
+
<summary>Indicates the number of lines at the end of file to be discarded.</summary>
|
|
1823
|
+
</member>
|
|
1824
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreEmptyLines">
|
|
1825
|
+
<summary>Indicates that the engine must ignore the empty lines while reading.</summary>
|
|
1826
|
+
</member>
|
|
1827
|
+
<member name="P:FileHelpers.RecordOptions.RecordCondition">
|
|
1828
|
+
<summary>Allow to tell the engine what records must be included or excluded while reading.</summary>
|
|
1829
|
+
</member>
|
|
1830
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreCommentedLines">
|
|
1831
|
+
<summary>Indicates that the engine must ignore the lines with this comment marker.</summary>
|
|
1832
|
+
</member>
|
|
1833
|
+
<member name="T:FileHelpers.RecordOptions.RecordConditionInfo">
|
|
1834
|
+
<summary>Allow to tell the engine what records must be included or excluded while reading.</summary>
|
|
1835
|
+
</member>
|
|
1836
|
+
<member name="P:FileHelpers.RecordOptions.RecordConditionInfo.Condition">
|
|
1837
|
+
<summary>The condition used to include or exclude records.</summary>
|
|
1838
|
+
</member>
|
|
1839
|
+
<member name="P:FileHelpers.RecordOptions.RecordConditionInfo.Selector">
|
|
1840
|
+
<summary>The selector used by the <see cref="P:FileHelpers.RecordOptions.RecordCondition"/>.</summary>
|
|
1841
|
+
</member>
|
|
1842
|
+
<member name="T:FileHelpers.RecordOptions.IgnoreCommentInfo">
|
|
1843
|
+
<summary>Indicates that the engine must ignore the lines with this comment marker.</summary>
|
|
1844
|
+
</member>
|
|
1845
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreCommentInfo.CommentMarker">
|
|
1846
|
+
<summary>
|
|
1847
|
+
<para>Indicates that the engine must ignore the lines with this comment marker.</para>
|
|
1848
|
+
<para>An emty string or null indicates that the engine dont look for comments</para>
|
|
1849
|
+
</summary>
|
|
1850
|
+
</member>
|
|
1851
|
+
<member name="P:FileHelpers.RecordOptions.IgnoreCommentInfo.InAnyPlace">
|
|
1852
|
+
<summary>Indicates if the comment can have spaces or tabs at left (true by default)</summary>
|
|
1853
|
+
</member>
|
|
1854
|
+
<member name="P:FileHelpers.DelimitedRecordOptions.Delimiter">
|
|
1855
|
+
<summary>
|
|
1856
|
+
The delimiter used to identify each field in the data.
|
|
1857
|
+
</summary>
|
|
1858
|
+
</member>
|
|
1859
|
+
<member name="T:FileHelpers.FixedRecordOptions">
|
|
1860
|
+
<summary>
|
|
1861
|
+
This class allows you to set some options of the fixed length records but at runtime.
|
|
1862
|
+
With this options the library is more flexible than never.
|
|
1863
|
+
</summary>
|
|
1864
|
+
</member>
|
|
1865
|
+
<member name="P:FileHelpers.FixedRecordOptions.FixedMode">
|
|
1866
|
+
<summary>Indicates the behavior when variable length records are found in a [<see cref="T:FileHelpers.FixedLengthRecordAttribute"/>]. (Note: nothing in common with [FieldOptional])</summary>
|
|
1867
|
+
</member>
|
|
1868
|
+
<member name="P:FileHelpers.FixedRecordOptions.RecordLength">
|
|
1869
|
+
<summary>
|
|
1870
|
+
The sum of the indivial field lengths.
|
|
1871
|
+
</summary>
|
|
1872
|
+
</member>
|
|
1873
|
+
</members>
|
|
1874
|
+
</doc>
|