Class SongCollection

Namespace

Microsoft.Xna.Framework.Media

Assembly

MonoGame.Framework.dll

public class SongCollection : ICollection<Song>, IEnumerable<Song>, IEnumerable, IDisposable

Inheritance

object

SongCollection

Implements

ICollection<Song>

IEnumerable<Song>

IEnumerable

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Count

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

public 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 bool IsReadOnly { get; }

Property Value

bool

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

this[int]

public Song this[int index] { get; }

Parameters

index int

Property Value

Song

Methods

Add(Song)

Adds an item to the ICollection<T>.

public void Add(Song item)

Parameters

item Song

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Clone()

public SongCollection Clone()

Returns

SongCollection

Contains(Song)

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

public bool Contains(Song item)

Parameters

item Song

The object to locate in the ICollection<T>.

Returns

bool

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

CopyTo(Song[], int)

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

public void CopyTo(Song[] array, int arrayIndex)

Parameters

array Song[]

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.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<Song> GetEnumerator()

Returns

IEnumerator<Song>

An enumerator that can be used to iterate through the collection.

IndexOf(Song)

public int IndexOf(Song item)

Parameters

item Song

Returns

int

Remove(Song)

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

public bool Remove(Song item)

Parameters

item Song

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.