Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Enumerable.ElementAtOrDefault(Of 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
Assembly:  System.Core (in System.Core.dll)
'Declaration
<ExtensionAttribute> _
Public Shared Function ElementAtOrDefault(Of TSource) ( _
	source As IEnumerable(Of TSource), _
	index As Integer _
) As TSource

Type Parameters

TSource

The type of the elements of source.

Parameters

source
Type: System.Collections.Generic.IEnumerable(Of TSource)
An IEnumerable(Of 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(Of TSource). When you use instance method syntax to call this method, omit the first parameter.
ExceptionCondition
ArgumentNullException

source is Nothing.

If the type of source implements IList(Of 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 Nothing.

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


      ' Create an array of strings.
      Dim names() As String = _
          {"Hartono, Tommy", "Adams, Terry", "Andersen, Henriette Thaulow", "Hedlund, Magnus", "Ito, Shu"}

      Dim index As Integer = 20

      ' Get a string at an index that is out of range in the array.
      Dim name As String = names.ElementAtOrDefault(index)

      Dim text As String = IIf(String.IsNullOrEmpty(name), "[THERE IS NO NAME AT THIS INDEX]", name)

      ' Display the output.
      outputBlock.Text &= "The name chosen at index " & index & " is " & text & vbCrLf

      ' This code produces the following output:
      '
      ' The name chosen at index 20 is [THERE IS NO NAME AT THIS INDEX]



Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.