OfType(TResult) Method

Enumerable.OfType(Of TResult) Method (IEnumerable)

 

Filters the elements of an IEnumerable based on a specified type.

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

<ExtensionAttribute>
Public Shared Function OfType(Of TResult) (
	source As IEnumerable
) As IEnumerable(Of TResult)

Parameters

source
Type: System.Collections.IEnumerable

The IEnumerable whose elements to filter.

Return Value

Type: System.Collections.Generic.IEnumerable(Of TResult)

An IEnumerable(Of T) that contains elements from the input sequence of type TResult.

Type Parameters

TResult

The type to filter the elements of the sequence on.

Exception Condition
ArgumentNullException

source is null.

This method is implemented by using deferred execution. The immediate return value is an object that stores all the information that is required to perform the action. The query represented by this method is not executed until the object is enumerated either by calling its GetEnumerator method directly or by using foreach in Visual C# or For Each in Visual Basic.

The OfType(Of TResult)(IEnumerable) method returns only those elements in source that can be cast to type TResult. To instead receive an exception if an element cannot be cast to type TResult, use Cast(Of TResult)(IEnumerable).

This method is one of the few standard query operator methods that can be applied to a collection that has a non-parameterized type, such as an ArrayList. This is because OfType(Of TResult) extends the type IEnumerable. OfType(Of TResult) cannot only be applied to collections that are based on the parameterized IEnumerable(Of T) type, but collections that are based on the non-parameterized IEnumerable type also.

By applying OfType(Of TResult) to a collection that implements IEnumerable, you gain the ability to query the collection by using the standard query operators. For example, specifying a type argument of Object to OfType(Of TResult) would return an object of type IEnumerable<Object> in C# or IEnumerable(Of Object) in Visual Basic, to which the standard query operators can be applied.

The following code example demonstrates how to use OfType(Of TResult) to filter the elements of an IEnumerable.

' Create an ArrayList and add items to it.
Dim fruits As New System.Collections.ArrayList(4)
fruits.Add("Mango")
fruits.Add("Orange")
fruits.Add("Apple")
fruits.Add(3.0)
fruits.Add("Banana")

' Apply OfType(Of String)() to the ArrayList
' to filter out non-string items.
Dim query1 As IEnumerable(Of String) = fruits.OfType(Of String)()

' Print the results.
Dim output As New System.Text.StringBuilder("Elements of type 'string' are:" _
                                            & vbCrLf)
For Each fruit As String In query1
    output.AppendLine(fruit)
Next

' The following query shows that the standard query operators such as 
' Where() can be applied to the ArrayList type after calling OfType().
Dim query2 As IEnumerable(Of String) = _
    fruits.OfType(Of String)().Where(Function(fruit) _
                                         fruit.ToLower().Contains("n"))

output.AppendLine(vbCrLf & "The following strings contain 'n':")
For Each fruit As String In query2
    output.AppendLine(fruit)
Next

' Display the output.
MsgBox(output.ToString())

' This code produces the following output:
'
' Elements of type 'string' are:
' Mango
' Orange
' Apple
' Banana
'
' The following strings contain 'n':
' Mango
' Orange
' Banana

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft