API Reference
CsvDocument
Represents a CSV document with a fluent, document-centric API. Thread-safe for independent read enumeration; not thread-safe for concurrent mutations on the same instance.
Inheritance
- Object
- CsvDocument
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method CsvDocument.AddColumn
- Method CsvDocument.AddRow
- Method CsvDocument.AddRow
- Method CsvDocument.EnsureInferredSchema
- Method CsvDocument.EnsureSchema
- Method CsvDocument.Filter
- Method CsvDocument.FromObjects
- Method CsvDocument.Load
- Method CsvDocument.Load
- Method CsvDocument.LoadAsync
- Method CsvDocument.LoadAsync
- Method CsvDocument.Parse
- Method CsvDocument.RemoveColumn
- Method CsvDocument.SortBy
- Method CsvDocument.SortBy``1
- Method CsvDocument.Transform
- Method CsvDocument.Validate
- Method CsvDocument.ValidateOrThrow
- Method CsvDocument.WithCulture
- Method CsvDocument.WithDateTimeFormats
- Method CsvDocument.WithDelimiter
- Method CsvDocument.WithEncoding
- Method CsvDocument.WithHeader
- Method CsvDocument.WithMappingErrorValuePolicy
Accepted by parameters
- Extension method CsvDocument.RowsAsParallel``1
- Extension method CsvDocument.RowsAsParallel``1
- Extension method CsvDocument.RowsAsParallel``1
- Extension method CsvDocument.RowsAs``1
- Extension method CsvDocument.RowsAs``1
- Extension method CsvDocument.RowsAs``1
- Method CsvDocument.Transform
- Method CsvMappingExtensions.RowsAsParallel``1
- Method CsvMappingExtensions.RowsAsParallel``1
- Method CsvMappingExtensions.RowsAsParallel``1
- Method CsvMappingExtensions.RowsAs``1
- Method CsvMappingExtensions.RowsAs``1
- Method CsvMappingExtensions.RowsAs``1
Constructors
public CsvDocument() #Initializes a new in-memory CSV document with default settings.
Methods
public CsvDocument AddColumn(String name, Func<CsvRow, Object> valueFactory) #CsvDocumentAdds a computed column to the document.
Parameters
- name System.String
- valueFactory System.Func{OfficeIMO.CSV.CsvRow,System.Object}
public IEnumerable<CsvRow> AsEnumerable() #IEnumerable<CsvRow>Returns rows as an enumerable sequence. In streaming mode this is lazy.
public DbDataReader CreateDataReader(CsvDataReaderOptions options = null) #DbDataReaderCreates a forward-only data reader over the document rows.
Parameters
- options OfficeIMO.CSV.CsvDataReaderOptions = null
- Reader projection options. When omitted, all columns are emitted as strings.
Returns
A data reader suitable for DataTable loading and provider bulk-copy APIs.
public CsvDocument EnsureInferredSchema(Int32 sampleSize = 1000) #CsvDocumentInfers and attaches a schema to the document so subsequent validation uses the sampled structure.
Parameters
- sampleSize System.Int32 = 1000
- Maximum number of rows to inspect. Defaults to 1000.
Returns
The current document.
public CsvDocument EnsureSchema(Action<CsvSchemaBuilder> buildAction) #CsvDocumentAttaches a schema to the document.
Parameters
- buildAction System.Action{OfficeIMO.CSV.CsvSchemaBuilder}
public CsvDocument Filter(Func<CsvRow, Boolean> predicate) #CsvDocumentFilters rows using the provided predicate.
Parameters
- predicate System.Func{OfficeIMO.CSV.CsvRow,System.Boolean}
public static CsvDocument FromObjects(IEnumerable<Object> items, Char delimiter = ',', CultureInfo culture = null, Encoding encoding = null) #CsvDocumentCreates a CSV document from a sequence of objects by projecting their properties or dictionary keys into columns.
Parameters
- items System.Collections.Generic.IEnumerable{System.Object}
- Sequence of objects to convert into CSV rows.
- delimiter System.Char = ','
- Delimiter to use for the CSV document.
- culture System.Globalization.CultureInfo = null
- Optional culture for value formatting.
- encoding System.Text.Encoding = null
- Optional encoding for file operations.
Returns
A populated CsvDocument.
public CsvSchema InferSchema(Int32 sampleSize = 1000) #CsvSchemaInfers a schema from the document header and sampled row values.
Parameters
- sampleSize System.Int32 = 1000
- Maximum number of rows to inspect. Defaults to 1000.
Returns
A schema containing one inferred column for each header field.
public static CsvDocument Load(String path, CsvLoadOptions options = null) #CsvDocumentLoads a CSV document from disk.
Parameters
- path System.String
- options OfficeIMO.CSV.CsvLoadOptions = null
public static CsvDocument Load(Stream stream, CsvLoadOptions options = null) #CsvDocumentLoads a CSV document from a stream.
Parameters
- stream System.IO.Stream
- Source stream.
- options OfficeIMO.CSV.CsvLoadOptions = null
- Load options.
public static async Task<CsvDocument> LoadAsync(String path, CsvLoadOptions options = null, CancellationToken cancellationToken = null) #Task<CsvDocument>Asynchronously loads a CSV document from disk.
Parameters
- path System.String
- options OfficeIMO.CSV.CsvLoadOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static async Task<CsvDocument> LoadAsync(Stream stream, CsvLoadOptions options = null, CancellationToken cancellationToken = null) #Task<CsvDocument>Asynchronously loads a CSV document from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.CSV.CsvLoadOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static DbDataReader OpenDataReader(String path, CsvLoadOptions loadOptions = null, CsvDataReaderOptions readerOptions = null) #DbDataReaderCreates a forward-only data reader over a CSV file.
Parameters
- path System.String
- Source CSV path.
- loadOptions OfficeIMO.CSV.CsvLoadOptions = null
- CSV load options.
- readerOptions OfficeIMO.CSV.CsvDataReaderOptions = null
- Reader projection options. When omitted, all columns are emitted as strings.
Returns
A data reader suitable for DataTable loading and provider bulk-copy APIs.
public static DbDataReader OpenDataReader(Stream stream, CsvLoadOptions loadOptions = null, CsvDataReaderOptions readerOptions = null) #DbDataReaderOpens a forward-only data reader over a CSV stream.
Parameters
- stream System.IO.Stream
- Readable CSV stream. The stream remains open after the reader is disposed.
- loadOptions OfficeIMO.CSV.CsvLoadOptions = null
- CSV load options.
- readerOptions OfficeIMO.CSV.CsvDataReaderOptions = null
- Reader projection options. When omitted, all columns are emitted as strings.
Returns
A data reader suitable for DataTable loading and provider bulk-copy APIs.
public static DbDataReader OpenTextDataReader(String text, CsvLoadOptions loadOptions = null, CsvDataReaderOptions readerOptions = null) #DbDataReaderCreates a forward-only data reader over already-decoded CSV text.
Parameters
- text System.String
- Decoded CSV text.
- loadOptions OfficeIMO.CSV.CsvLoadOptions = null
- CSV load options. MaxInputBytes is measured using UTF-8, matching the prior text-import stream contract.
- readerOptions OfficeIMO.CSV.CsvDataReaderOptions = null
- Reader projection options. When omitted, all columns are emitted as strings.
Returns
A data reader suitable for DataTable loading and provider bulk-copy APIs.
public static CsvDocument Parse(String text, CsvLoadOptions options = null) #CsvDocumentParses a CSV document from text.
Parameters
- text System.String
- options OfficeIMO.CSV.CsvLoadOptions = null
public static IEnumerable<T> ReadTextRowsAsParallel<T>(String text, CsvRecordFactoryBuilder<T> factoryBuilder, CsvLoadOptions loadOptions = null, CsvDataReaderOptions readerOptions = null, ParallelRowMappingOptions parallelOptions = null, CancellationToken cancellationToken = null) #IEnumerable<T>Reads decoded CSV text and projects records through bounded workers while preserving source order.
Type Parameters
- T
- Result row type.
Parameters
- text System.String
- Decoded CSV text.
- factoryBuilder OfficeIMO.CSV.CsvRecordFactoryBuilder{``0}
- Builds the concurrent record factory from resolved headers.
- loadOptions OfficeIMO.CSV.CsvLoadOptions = null
- Optional CSV parsing settings.
- readerOptions OfficeIMO.CSV.CsvDataReaderOptions = null
- Optional reader projection settings.
- parallelOptions OfficeIMO.Data.ParallelRowMappingOptions = null
- Optional worker and batch settings.
- cancellationToken System.Threading.CancellationToken = null
- Cancels parsing and pending projection work.
public CsvDocument RemoveColumn(String name) #CsvDocumentRemoves a column by name.
Parameters
- name System.String
public Void Save(String path, CsvSaveOptions options = null) #VoidSaves the document to the specified path.
Parameters
- path System.String
- options OfficeIMO.CSV.CsvSaveOptions = null
public Void Save(Stream destination, CsvSaveOptions options = null) #VoidSaves the document to a caller-owned writable stream.
Parameters
- destination System.IO.Stream
- options OfficeIMO.CSV.CsvSaveOptions = null
public async Task SaveAsync(String path, CsvSaveOptions options = null, CancellationToken cancellationToken = null) #TaskAsynchronously saves the document to a path.
Parameters
- path System.String
- options OfficeIMO.CSV.CsvSaveOptions = null
- cancellationToken System.Threading.CancellationToken = null
public Task SaveAsync(Stream destination, CsvSaveOptions options = null, CancellationToken cancellationToken = null) #TaskAsynchronously saves the document to a caller-owned writable stream.
Parameters
- destination System.IO.Stream
- options OfficeIMO.CSV.CsvSaveOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static Void SaveObjects(String path, IEnumerable<Object> items, CsvSaveOptions options = null) #VoidSaves a sequence of objects directly as CSV without materializing a CsvDocument.
Parameters
- path System.String
- Destination CSV path.
- items System.Collections.Generic.IEnumerable{System.Object}
- Sequence of objects to convert into CSV rows.
- options OfficeIMO.CSV.CsvSaveOptions = null
- Optional save settings.
public CsvDocument SortBy(String columnName, Boolean descending = false, IComparer<Object> comparer = null) #CsvDocumentSorts rows by a column name.
Parameters
- columnName System.String
- descending System.Boolean = false
- comparer System.Collections.Generic.IComparer{System.Object} = null
public CsvDocument SortBy<TKey>(Func<CsvRow, TKey> keySelector, Boolean descending = false, IComparer<TKey> comparer = null) #CsvDocumentSorts rows using a typed key selector.
Type Parameters
- TKey
Parameters
- keySelector System.Func{OfficeIMO.CSV.CsvRow,``0}
- descending System.Boolean = false
- comparer System.Collections.Generic.IComparer{``0} = null
public Byte[] ToBytes(CsvSaveOptions options = null) #Byte[]Encodes the document using the selected CSV encoding and compression.
Parameters
- options OfficeIMO.CSV.CsvSaveOptions = null
public DataTable ToDataTable(CsvDataTableOptions options = null) #DataTableProjects the CSV document into a DataTable.
Parameters
- options OfficeIMO.CSV.CsvDataTableOptions = null
- DataTable projection options. When omitted, all columns are emitted as strings.
Returns
A DataTable containing all document rows.
public MemoryStream ToStream(CsvSaveOptions options = null) #MemoryStreamEncodes the document in a new writable memory stream positioned at the beginning.
Parameters
- options OfficeIMO.CSV.CsvSaveOptions = null
public String ToString(CsvSaveOptions options) #StringSerializes the document to a string using the provided save options.
Parameters
- options OfficeIMO.CSV.CsvSaveOptions
public CsvDocument Transform(Func<CsvDocument, CsvDocument> transformer) #CsvDocumentExecutes a custom transformation.
Parameters
- transformer System.Func{OfficeIMO.CSV.CsvDocument,OfficeIMO.CSV.CsvDocument}
public CsvDocument Validate(out IReadOnlyList<CsvValidationError> errors) #CsvDocumentValidates the document against the configured schema.
Parameters
- errors System.Collections.Generic.IReadOnlyList{OfficeIMO.CSV.CsvValidationError}@
public CsvDocument ValidateOrThrow() #CsvDocumentValidates and throws when validation fails.
public CsvDocument WithCulture(CultureInfo culture) #CsvDocumentSets the culture for type conversions.
Parameters
- culture System.Globalization.CultureInfo
public CsvDocument WithDateTimeFormats(params String[] formats) #CsvDocumentSets additional date/time formats used by typed row conversion and schema validation.
Parameters
- formats System.String[]
public CsvDocument WithDelimiter(Char delimiter) #CsvDocumentSets the delimiter used for reading and writing.
Parameters
- delimiter System.Char
public CsvDocument WithEncoding(Encoding encoding) #CsvDocumentSets the encoding used for file operations.
Parameters
- encoding System.Text.Encoding
public CsvDocument WithHeader(params String[] headers) #CsvDocumentReplaces the header row.
Parameters
- headers System.String[]
public CsvDocument WithMappingErrorValuePolicy(DataMappingErrorValuePolicy policy) #CsvDocumentSets whether schema and row-mapping failures may include source values.
Parameters
- policy OfficeIMO.Data.DataMappingErrorValuePolicy
public static Void WriteDataReader(TextWriter writer, IDataReader reader, CsvSaveOptions options = null) #VoidWrites an IDataReader directly as CSV without materializing a CsvDocument.
Parameters
- writer System.IO.TextWriter
- Destination text writer.
- reader System.Data.IDataReader
- Source data reader positioned before the first row.
- options OfficeIMO.CSV.CsvSaveOptions = null
- Optional save settings.
public static Void WriteDataReader(TextWriter writer, IDataReader reader, CsvSaveOptions options, CancellationToken cancellationToken) #VoidWrites an IDataReader directly as CSV without materializing a CsvDocument.
Parameters
- writer System.IO.TextWriter
- Destination text writer.
- reader System.Data.IDataReader
- Source data reader positioned before the first row.
- options OfficeIMO.CSV.CsvSaveOptions
- Optional save settings.
- cancellationToken System.Threading.CancellationToken
- Token observed while projecting and writing rows.
public static Void WriteDataReader(String path, IDataReader reader, CsvSaveOptions options = null) #VoidWrites an open data reader to a CSV file.
Parameters
- path System.String
- Destination CSV path.
- reader System.Data.IDataReader
- Open data reader positioned before the first row.
- options OfficeIMO.CSV.CsvSaveOptions = null
- CSV serialization options.
public static Void WriteDataReader(String path, IDataReader reader, CsvSaveOptions options, CancellationToken cancellationToken) #VoidWrites an open data reader to a CSV file.
Parameters
- path System.String
- Destination CSV path.
- reader System.Data.IDataReader
- Open data reader positioned before the first row.
- options OfficeIMO.CSV.CsvSaveOptions
- CSV serialization options.
- cancellationToken System.Threading.CancellationToken
- Token observed while projecting and writing rows.
public static Void WriteDataReader(Stream destination, IDataReader reader, CsvSaveOptions options = null, Boolean leaveOpen = true) #VoidWrites an open data reader to a CSV stream.
Parameters
- destination System.IO.Stream
- Writable destination stream.
- reader System.Data.IDataReader
- Open data reader positioned before the first row.
- options OfficeIMO.CSV.CsvSaveOptions = null
- CSV serialization options.
- leaveOpen System.Boolean = true
- Whether the destination stream remains open after writing.
public static Void WriteDataReader(Stream destination, IDataReader reader, CsvSaveOptions options, Boolean leaveOpen, CancellationToken cancellationToken) #VoidWrites an open data reader to a CSV stream.
Parameters
- destination System.IO.Stream
- Writable destination stream.
- reader System.Data.IDataReader
- Open data reader positioned before the first row.
- options OfficeIMO.CSV.CsvSaveOptions
- CSV serialization options.
- leaveOpen System.Boolean
- Whether the destination stream remains open after writing.
- cancellationToken System.Threading.CancellationToken
- Token observed while projecting and writing rows.
public static Void WriteDataReaderParallel(TextWriter writer, IDataReader reader, CsvSaveOptions options = null, CsvWriteParallelOptions parallelOptions = null, CancellationToken cancellationToken = null) #VoidWrites an open data reader to CSV with bounded, ordered parallel row formatting.
Parameters
- writer System.IO.TextWriter
- Destination text writer.
- reader System.Data.IDataReader
- Source data reader positioned before the first row.
- options OfficeIMO.CSV.CsvSaveOptions = null
- Optional CSV serialization settings.
- parallelOptions OfficeIMO.CSV.CsvWriteParallelOptions = null
- Optional worker and batch limits.
- cancellationToken System.Threading.CancellationToken = null
- Token observed while reading, formatting, and writing rows.
public static Void WriteDataReaderParallel(String path, IDataReader reader, CsvSaveOptions options = null, CsvWriteParallelOptions parallelOptions = null, CancellationToken cancellationToken = null) #VoidWrites an open data reader to a CSV file with bounded, ordered parallel row formatting.
Parameters
- path System.String
- Destination CSV path.
- reader System.Data.IDataReader
- Source data reader positioned before the first row.
- options OfficeIMO.CSV.CsvSaveOptions = null
- Optional CSV serialization settings.
- parallelOptions OfficeIMO.CSV.CsvWriteParallelOptions = null
- Optional worker and batch limits.
- cancellationToken System.Threading.CancellationToken = null
- Token observed while reading, formatting, and writing rows.
public static Void WriteDataReaderParallel(Stream destination, IDataReader reader, CsvSaveOptions options = null, CsvWriteParallelOptions parallelOptions = null, Boolean leaveOpen = true, CancellationToken cancellationToken = null) #VoidWrites an open data reader to a CSV stream with bounded, ordered parallel row formatting.
Parameters
- destination System.IO.Stream
- Writable destination stream.
- reader System.Data.IDataReader
- Source data reader positioned before the first row.
- options OfficeIMO.CSV.CsvSaveOptions = null
- Optional CSV serialization settings.
- parallelOptions OfficeIMO.CSV.CsvWriteParallelOptions = null
- Optional worker and batch limits.
- leaveOpen System.Boolean = true
- Whether the destination stream remains open after writing.
- cancellationToken System.Threading.CancellationToken = null
- Token observed while reading, formatting, and writing rows.
public static Void WriteObjects(TextWriter writer, IEnumerable<Object> items, CsvSaveOptions options = null) #VoidWrites a sequence of objects directly as CSV without materializing a CsvDocument.
Parameters
- writer System.IO.TextWriter
- Destination text writer.
- items System.Collections.Generic.IEnumerable{System.Object}
- Sequence of objects to convert into CSV rows.
- options OfficeIMO.CSV.CsvSaveOptions = null
- Optional save settings.
Inherited Methods
Properties
public IReadOnlyList<String> Header { get; } #Gets the document header columns.
public Char Delimiter { get; } #Gets the delimiter used by the document.
public CultureInfo Culture { get; } #Gets the culture used for type conversions.
public Encoding Encoding { get; } #Gets the encoding used when reading or writing files.
public IReadOnlyList<String> DateTimeFormats { get; } #Gets the configured date/time formats used by typed conversions.
public DataMappingErrorValuePolicy MappingErrorValuePolicy { get; } #Gets how source values are represented in schema and row-mapping failures.
Extension Methods
public static IEnumerable<T> RowsAsParallel<T>(CsvDocument document, ParallelRowMappingOptions options = null, CancellationToken cancellationToken = null) #IEnumerable<T>Projects rows in bounded parallel batches by matching CSV headers to writable public properties. Results retain source order.
Type Parameters
- T
Parameters
- document OfficeIMO.CSV.CsvDocument
- options OfficeIMO.Data.ParallelRowMappingOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static IEnumerable<T> RowsAsParallel<T>(CsvDocument document, Action<RowMapper<T>> configure, ParallelRowMappingOptions options = null, CancellationToken cancellationToken = null) #IEnumerable<T>Projects rows in bounded parallel batches using explicit, AOT-friendly column assignments. Results retain source order.
Type Parameters
- T
Parameters
- arg1 OfficeIMO.CSV.CsvDocument
- arg2 System.Action{OfficeIMO.Data.RowMapper{``0}}
- arg3 OfficeIMO.Data.ParallelRowMappingOptions = null
- arg4 System.Threading.CancellationToken = null
public static IEnumerable<T> RowsAsParallel<T>(CsvDocument document, Func<IDataRecord, T> factory, ParallelRowMappingOptions options = null, CancellationToken cancellationToken = null) #IEnumerable<T>Projects rows in bounded parallel batches with a caller-supplied factory. Results retain source order.
Type Parameters
- T
Parameters
- arg1 OfficeIMO.CSV.CsvDocument
- arg2 System.Func{System.Data.IDataRecord,``0}
- arg3 OfficeIMO.Data.ParallelRowMappingOptions = null
- arg4 System.Threading.CancellationToken = null
public static IEnumerable<T> RowsAs<T>(CsvDocument document) #IEnumerable<T>Projects rows by matching CSV headers to writable public properties. Matching is case-insensitive and also ignores spaces and punctuation.
Type Parameters
- T
Parameters
- document OfficeIMO.CSV.CsvDocument
public static IEnumerable<T> RowsAs<T>(CsvDocument document, Action<RowMapper<T>> configure) #IEnumerable<T>Projects rows using explicit, AOT-friendly column assignments.
Type Parameters
- T
Parameters
- arg1 OfficeIMO.CSV.CsvDocument
- arg2 System.Action{OfficeIMO.Data.RowMapper{``0}}
public static IEnumerable<T> RowsAs<T>(CsvDocument document, Func<IDataRecord, T> factory) #IEnumerable<T>Projects rows with a caller-supplied factory. This overload supports constructor-bound and other models without a public parameterless constructor.
Type Parameters
- T
Parameters
- document OfficeIMO.CSV.CsvDocument
- Document whose rows are projected.
- factory System.Func{System.Data.IDataRecord,``0}
- Creates one model instance from the current row.