Table of Contents

Namespace CsvHelper

Classes

ArrayHelper

Methods to help with arrays.

BadDataException

Represents errors that occur due to bad data.

CsvContext

Share state for CsvHelper.

CsvDataReader

Provides a means of reading a CSV file forward-only by using CsvReader.

CsvHelperException

Represents errors that occur in CsvHelper.

CsvParser

Parses a CSV file.

CsvReader

Reads data that was parsed from IParser.

CsvWriter

Used to write CSV files.

Factory

Creates CsvHelper classes.

FieldValidationException

Represents a user supplied field validation failure.

HeaderValidationException

Represents a header validation failure.

InvalidHeader

Invalid header information.

MaxFieldSizeException

Represents an error due to a field that is too large.

MissingFieldException

Represents an error caused because a field is missing in the header while reading a CSV file.

ObjectCreator

Efficiently creates instances of object types.

ObjectResolver

Creates objects from a given type.

ParserException

Represents errors that occur while parsing a CSV file.

ReaderException

Represents errors that occur while reading a CSV file.

ReflectionExtensions

Extensions to help with reflection.

ValidationException

Represents a user supplied validation failure.

WriterException

Represents errors that occur while writing a CSV file.

Structs

BadDataFoundArgs

Information about the field that caused BadDataFound to be called.

ConvertFromStringArgs

ConvertFromString<TMember> args.

ConvertToStringArgs<TClass>

ConvertToString<TClass> args.

CsvParser.ProcessedField

Processes a raw field based on configuration. This will remove quotes, remove escapes, and trim if configured to.

GetConstructorArgs

GetConstructor args.

GetDynamicPropertyNameArgs

GetDynamicPropertyName args.

HeaderValidatedArgs

HeaderValidated args.

MissingFieldFoundArgs

MissingFieldFound args.

PrepareHeaderForMatchArgs

PrepareHeaderForMatch args.

ReadingExceptionOccurredArgs

ReadingExceptionOccurred args.

RecordTypeInfo

Type information for a record.

ReferenceHeaderPrefixArgs

ReferenceHeaderPrefix args.

ShouldQuoteArgs

ShouldQuote args.

ShouldSkipRecordArgs

ShouldSkipRecord args.

ShouldUseConstructorParametersArgs

ShouldUseConstructorParameters args.

ValidateArgs

Validate args.

Interfaces

IFactory

Defines methods used to create CsvHelper classes.

IObjectResolver

Defines the functionality of a class that creates objects from a given type.

IParser

Defines methods used the parse a CSV file.

IReader

Defines methods used to read parsed data from a CSV file.

IReaderRow

Defines methods used to read parsed data from a CSV file row.

IWriter

Defines methods used to write to a CSV file.

IWriterRow

Defines methods used to write a CSV row.

Enums

CsvMode

Mode to use when parsing and writing.

Delegates

BadDataFound

Function that gets called when bad data is found.

ConvertFromString<TMember>

Function that converts a string into an object.

ConvertToString<TClass>

Function that converts an object into a string.

GetConstructor

Function that chooses the constructor to use for constructor mapping.

GetDynamicPropertyName

Function that gets the name to use for the property of the dynamic object.

HeaderValidated

Function that is called when a header validation check is ran. The default function will throw a ValidationException if there is no header for a given member mapping. You can supply your own function to do other things like logging the issue instead of throwing an exception.

MissingFieldFound

Function that is called when a missing field is found. The default function will throw a MissingFieldException. You can supply your own function to do other things like logging the issue instead of throwing an exception.

PrepareHeaderForMatch

Function that prepares the header field for matching against a member name. The header field and the member name are both ran through this function. You should do things like trimming, removing whitespace, removing underscores, and making casing changes to ignore case.

ReadingExceptionOccurred

Function that is called when a reading exception occurs. The default function will re-throw the given exception. If you want to ignore reading exceptions, you can supply your own function to do other things like logging the issue.

ReferenceHeaderPrefix

Function that will return the prefix for a reference header.

ShouldQuote

Function that is used to determine if a field should get quoted when writing.

ShouldSkipRecord

Function that determines whether to skip the given record or not.

ShouldUseConstructorParameters

Function that determines if constructor parameters should be used to create the class instead of the default constructor and members.

Validate

Function that validates a field.

ValidateMessage

Function that gets the exception message when validation fails.