Export (0) Print
Expand All

Enumerable.ElementAtOrDefault<TSource> Method

Returns the element at a specified index in a sequence or a default value if the index is out of range.

Namespace:  System.Linq
Assemblies:   System.Linq (in System.Linq.dll)
  System.Core (in System.Core.dll)

public static TSource ElementAtOrDefault<TSource>(
	this IEnumerable<TSource> source,
	int index
)

Type Parameters

TSource

The type of the elements of source.

Parameters

source
Type: System.Collections.Generic.IEnumerable<TSource>

An IEnumerable<T> to return an element from.

index
Type: System.Int32

The zero-based index of the element to retrieve.

Return Value

Type: TSource
default(TSource) if the index is outside the bounds of the source sequence; otherwise, the element at the specified position in the source sequence.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable<TSource>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

ExceptionCondition
ArgumentNullException

source is null.

If the type of source implements IList<T>, that implementation is used to obtain the element at the specified index. Otherwise, this method obtains the specified element.

The default value for reference and nullable types is null.

The following code example demonstrates how to use ElementAtOrDefault<TSource>. This example uses an index that is outside the bounds of the array.

            string[] names =
                { "Hartono, Tommy", "Adams, Terry", "Andersen, Henriette Thaulow",
                    "Hedlund, Magnus", "Ito, Shu" };

            int index = 20;

            string name = names.ElementAtOrDefault(index);

            Console.WriteLine(
                "The name chosen at index {0} is '{1}'.",
                index,
                String.IsNullOrEmpty(name) ? "<no name at this index>" : name);

            /*
             This code produces the following output:

             The name chosen at index 20 is '<no name at this index>'.
            */

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft