Table of Contents

Class MemberMap<TClass, TMember>

Namespace
CsvHelper.Configuration
Assembly
CsvHelper.dll

Mapping info for a member to a CSV field.

public class MemberMap<TClass, TMember> : MemberMap

Type Parameters

TClass
TMember
Inheritance
MemberMap<TClass, TMember>
Inherited Members

Constructors

MemberMap(MemberInfo?)

Creates a new MemberMap instance using the specified member.

public MemberMap(MemberInfo? member)

Parameters

member MemberInfo

Properties

TypeConverterOption 

public override MemberMapTypeConverterOption TypeConverterOption { get; }

Property Value

MemberMapTypeConverterOption

Methods

Constant(TMember?)

The constant value that will be used for every record when reading and writing. This value will always be used no matter what other mapping configurations are specified.

public virtual MemberMap<TClass, TMember> Constant(TMember? constantValue)

Parameters

constantValue TMember

The constant value.

Returns

MemberMap<TClass, TMember>

Convert(ConvertFromString<TMember>)

Specifies an expression to be used to convert data in the row to the member.

public virtual MemberMap<TClass, TMember> Convert(ConvertFromString<TMember> convertFromStringFunction)

Parameters

convertFromStringFunction ConvertFromString<TMember>

The convert expression.

Returns

MemberMap<TClass, TMember>

Convert(ConvertToString<TClass>)

Specifies an expression to be used to convert the object to a field.

public virtual MemberMap<TClass, TMember> Convert(ConvertToString<TClass> convertToStringFunction)

Parameters

convertToStringFunction ConvertToString<TClass>

The convert expression.

Returns

MemberMap<TClass, TMember>

Default(string?, bool)

The default value that will be used when reading when the CSV field is empty. This value is not type checked and will use a ITypeConverter to convert the field. This could potentially have runtime errors.

public virtual MemberMap<TClass, TMember> Default(string? defaultValue, bool useOnConversionFailure = false)

Parameters

defaultValue string

The default value.

useOnConversionFailure bool

Use default on conversion failure.

Returns

MemberMap<TClass, TMember>

Default(TMember, bool)

The default value that will be used when reading when the CSV field is empty.

public virtual MemberMap<TClass, TMember> Default(TMember defaultValue, bool useOnConversionFailure = false)

Parameters

defaultValue TMember

The default value.

useOnConversionFailure bool

Use default on conversion failure.

Returns

MemberMap<TClass, TMember>

Ignore()

Ignore the member when reading and writing. If this member has already been mapped as a reference member, either by a class map, or by automapping, calling this method will not ignore all the child members down the tree that have already been mapped.

public virtual MemberMap<TClass, TMember> Ignore()

Returns

MemberMap<TClass, TMember>

Ignore(bool)

Ignore the member when reading and writing. If this member has already been mapped as a reference member, either by a class map, or by automapping, calling this method will not ignore all the child members down the tree that have already been mapped.

public virtual MemberMap<TClass, TMember> Ignore(bool ignore)

Parameters

ignore bool

True to ignore, otherwise false.

Returns

MemberMap<TClass, TMember>

Index(int, int)

When reading, is used to get the field at the given index. When writing, the fields will be written in the order of the field indexes.

public virtual MemberMap<TClass, TMember> Index(int index, int indexEnd = -1)

Parameters

index int

The index of the CSV field.

indexEnd int

The end index used when mapping to an IEnumerable member.

Returns

MemberMap<TClass, TMember>

Name(params string[])

When reading, is used to get the field at the index of the name if there was a header specified. It will look for the first name match in the order listed. When writing, sets the name of the field in the header record. The first name will be used.

public virtual MemberMap<TClass, TMember> Name(params string[] names)

Parameters

names string[]

The possible names of the CSV field.

Returns

MemberMap<TClass, TMember>

NameIndex(int)

When reading, is used to get the index of the name used when there are multiple names that are the same.

public virtual MemberMap<TClass, TMember> NameIndex(int index)

Parameters

index int

The index of the name.

Returns

MemberMap<TClass, TMember>

Optional()

Ignore the member when reading if no matching field name can be found.

public virtual MemberMap<TClass, TMember> Optional()

Returns

MemberMap<TClass, TMember>

TypeConverter(ITypeConverter)

Specifies the TypeConverter(ITypeConverter) to use when converting the member to and from a CSV field.

public virtual MemberMap<TClass, TMember> TypeConverter(ITypeConverter typeConverter)

Parameters

typeConverter ITypeConverter

The TypeConverter to use.

Returns

MemberMap<TClass, TMember>

TypeConverter<TConverter>()

Specifies the TypeConverter(ITypeConverter) to use when converting the member to and from a CSV field.

public virtual MemberMap<TClass, TMember> TypeConverter<TConverter>() where TConverter : ITypeConverter

Returns

MemberMap<TClass, TMember>

Type Parameters

TConverter

The Type of the TypeConverter(ITypeConverter) to use.

Validate(Validate)

Specifies an expression to be used to validate a field when reading.

public virtual MemberMap<TClass, TMember> Validate(Validate validateExpression)

Parameters

validateExpression Validate

Returns

MemberMap<TClass, TMember>

Validate(Validate, ValidateMessage)

Specifies an expression to be used to validate a field when reading along with specified exception message.

public virtual MemberMap<TClass, TMember> Validate(Validate validateExpression, ValidateMessage validateMessageExpression)

Parameters

validateExpression Validate
validateMessageExpression ValidateMessage

Returns

MemberMap<TClass, TMember>