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