Class MemberMapCollection

Namespace

CsvHelper.Configuration

Assembly

CsvHelper.dll

A collection that holds MemberMap's.

public class MemberMapCollection : IList<MemberMap>, ICollection<MemberMap>, IEnumerable<MemberMap>, IEnumerable

Inheritance

object

MemberMapCollection

Implements

IList<MemberMap>

ICollection<MemberMap>

IEnumerable<MemberMap>

IEnumerable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MemberMapCollection()

Initializes a new instance of the MemberMapCollection class.

public MemberMapCollection()

MemberMapCollection(IComparer<MemberMap>)

Initializes a new instance of the MemberMapCollection class.

public MemberMapCollection(IComparer<MemberMap> comparer)

Parameters

comparer IComparer<MemberMap>

The comparer to use when sorting the member maps.

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public virtual int Count { get; }

Property Value

int

The number of elements contained in the ICollection<T>.

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

public virtual bool IsReadOnly { get; }

Property Value

bool

true if the ICollection<T> is read-only; otherwise, false.

this[int]

Gets or sets the element at the specified index.

public virtual MemberMap this[int index] { get; set; }

Parameters

index int

The zero-based index of the element to get or set.

Property Value

MemberMap

The element at the specified index.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The member is set and the IList<T> is read-only.

Methods

Add(MemberMap)

Adds an item to the ICollection<T>.

public virtual void Add(MemberMap item)

Parameters

item MemberMap

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

AddMembers(ClassMap)

Adds the members from the mapping. This will recursively traverse the mapping tree and add all members for reference maps.

public virtual void AddMembers(ClassMap mapping)

Parameters

mapping ClassMap

The mapping where the members are added from.

AddRange(ICollection<MemberMap>)

Adds a range of items to the ICollection<T>.

public virtual void AddRange(ICollection<MemberMap> collection)

Parameters

collection ICollection<MemberMap>

The collection to add.

Clear()

Removes all items from the ICollection<T>.

public virtual void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Contains(MemberMap)

Determines whether the ICollection<T> contains a specific value.

public virtual bool Contains(MemberMap item)

Parameters

item MemberMap

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(MemberMap[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public virtual void CopyTo(MemberMap[] array, int arrayIndex)

Parameters

array MemberMap[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

Find(MemberInfo)

Finds the MemberMap using the given member.

public virtual MemberMap? Find(MemberInfo member)

Parameters

member MemberInfo

The member.

Returns

MemberMap

The MemberMap for the given expression, or null if not found.

Find<T>(Expression<Func<T, object?>>)

Finds the MemberMap using the given member expression.

public virtual MemberMap? Find<T>(Expression<Func<T, object?>> expression)

Parameters

expression Expression<Func<T, object>>

The member expression.

Returns

MemberMap

The MemberMap for the given expression, or null if not found.

Type Parameters

T

The Type the member is on.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public virtual IEnumerator<MemberMap> GetEnumerator()

Returns

IEnumerator<MemberMap>

A IEnumerator<T> that can be used to iterate through the collection.

IndexOf(MemberMap)

Determines the index of a specific item in the IList<T>.

public virtual int IndexOf(MemberMap item)

Parameters

item MemberMap

The object to locate in the IList<T>.

Returns

int

The index of item if found in the list; otherwise, -1.

Insert(int, MemberMap)

Inserts an item to the IList<T> at the specified index.

public virtual void Insert(int index, MemberMap item)

Parameters

index int

The zero-based index at which item should be inserted.

item MemberMap

The object to insert into the IList<T>.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

Remove(MemberMap)

Removes the first occurrence of a specific object from the ICollection<T>.

public virtual bool Remove(MemberMap item)

Parameters

item MemberMap

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

RemoveAt(int)

Removes the IList<T> item at the specified index.

public virtual void RemoveAt(int index)

Parameters

index int

The zero-based index of the item to remove.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.