CsvRecordWriter()
Added in v34.0.0
protected CsvRecordWriter()Creates a record writer whose columns have their own names.
Class in CsvHelper
CsvRecordWriter<T>
Added in v34.0.0
Writes records of type T as fields of a CsvWriter, in the columns that a CsvRecordMapper<T> reads. The CsvHelper source generator writes one for each CsvRecordAttribute type; CsvWriter.WriteRecords<T>(IEnumerable<T>) and the other record methods of the writer use it.
public abstract class CsvRecordWriter<T>- Namespace
CsvHelper- Assembly
CsvHelper.dll- Builds
- net10.0 netstandard2.1 netstandard2.0 net47
- Source
- CsvRecordWriter.cs
Remarks
A record writer does not depend on the CsvWriter it writes to and does not change after it is created, so it can be used with any writer, on any thread.
To write one by hand, write the column names in WriteHeader (with WriteColumnName, which puts ColumnPrefix in front) and the fields of a record in Write, as many as FieldCount says, with the writer's WriteField methods. Neither ends the record. Register it with CsvRecordWriter.Register.
Constructors
CsvRecordWriter(string)
Added in v34.0.0
protected CsvRecordWriter(string columnPrefix)Creates a record writer that puts columnPrefix in front of the names of its columns.
Parameters
columnPrefixstring- The text in front of each column name, such as
"Ship ", for a record written as a member of another record (CsvColumnAttribute.Prefix);""for none.
Exceptions
- ArgumentNullException
columnPrefixisnull.
Properties
ColumnPrefix
Added in v34.0.0
protected string ColumnPrefix { get; }The text that WriteColumnName puts in front of each column name; "" for none.
Property value
string
FieldCount
Added in v34.0.0abstract
public abstract int FieldCount { get; }The number of fields that Write and WriteHeader write.
Property value
int
Methods
NestedWriter<TNested>(string)
Added in v34.0.0
protected CsvRecordWriter<TNested> NestedWriter<TNested>(string prefix)Creates the record writer of a member whose type is itself a record type, which writes its columns in the same records, with ColumnPrefix and then prefix in front of their names.
Type parameters
TNested- The type of the member.
Parameters
prefixstring- The text in front of the nested record's column names (CsvColumnAttribute.Prefix);
""for none.
Returns
CsvRecordWriter<TNested>
The record writer of
TNested.Exceptions
- ArgumentNullException
prefixisnull.- InvalidOperationException
TNestedhas no record writer, or its records cannot be written, or the nested record writers lead back to their own type without end.
Write(CsvWriter, T)
Added in v34.0.0abstract
public abstract void Write(CsvWriter writer, T record)Writes the values of a record as fields of the current record, without ending it.
Parameters
writerCsvWriter- The writer.
recordT- The record; not
null.
WriteColumnName(CsvWriter, string)
Added in v34.0.0
protected void WriteColumnName(CsvWriter writer, string name)Writes ColumnPrefix followed by name as a field: a column name of the header.
Parameters
writerCsvWriter- The writer.
namestring- The name of the column.
Exceptions
- ArgumentNullException
writerornameisnull.
WriteEmpty(CsvWriter)
Added in v34.0.0
public virtual void WriteEmpty(CsvWriter writer)Writes FieldCount empty fields, for a nested record that is null, without ending the record.
Parameters
writerCsvWriter- The writer.
Exceptions
- ArgumentNullException
writerisnull.
WriteHeader(CsvWriter)
Added in v34.0.0abstract
public abstract void WriteHeader(CsvWriter writer)Writes the names of the columns as fields of the current record, without ending it.
Parameters
writerCsvWriter- The writer.