Queryable.TakeWhile(Of TSource) Method (IQueryable(Of TSource), Expression(Of Func(Of TSource, Int32, Boolean)))


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns elements from a sequence as long as a specified condition is true. The element's index is used in the logic of the predicate function.

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

Public Shared Function TakeWhile(Of TSource) (
	source As IQueryable(Of TSource),
	predicate As Expression(Of Func(Of TSource, Integer, Boolean))
) As IQueryable(Of TSource)


Type: System.Linq.IQueryable(Of TSource)

The sequence to return elements from.

Type: System.Linq.Expressions.Expression(Of Func(Of TSource, Int32, Boolean))

A function to test each element for a condition; the second parameter of the function represents the index of the element in the source sequence.

Return Value

Type: System.Linq.IQueryable(Of TSource)

An IQueryable(Of T) that contains elements from the input sequence occurring before the element at which the test specified by predicate no longer passes.

Type Parameters


The type of the elements of source.

Exception Condition

source or predicate is null.

This method has at least one parameter of type Expression(Of TDelegate) whose type argument is one of the Func(Of T, TResult) types. For these parameters, you can pass in a lambda expression and it will be compiled to an Expression(Of TDelegate).

The TakeWhile(Of TSource)(IQueryable(Of TSource), Expression(Of Func(Of TSource, Int32, Boolean))) method generates a MethodCallExpression that represents calling TakeWhile(Of TSource)(IQueryable(Of TSource), Expression(Of Func(Of TSource, Int32, Boolean))) itself as a constructed generic method. It then passes the MethodCallExpression to the CreateQuery(Expression) method of the IQueryProvider represented by the Provider property of the source parameter.

The query behavior that occurs as a result of executing an expression tree that represents calling TakeWhile(Of TSource)(IQueryable(Of TSource), Expression(Of Func(Of TSource, Int32, Boolean))) depends on the implementation of the type of the source parameter. The expected behavior is that it applies predicate to each element in source until it finds an element for which predicate returns false. It returns all the elements up until that point. The index of each source element is provided as the second argument to predicate.

The following code example demonstrates how to use TakeWhile(Of TSource)(IQueryable(Of TSource), Expression(Of Func(Of TSource, Int32, Boolean))) to return elements from the start of a sequence as long as a condition that uses the index of the element is true.

Dim fruits() As String = _
    {"apple", "passionfruit", "banana", "mango", _
     "orange", "blueberry", "grape", "strawberry"}

' Take strings from the array until a string whose length
' is less than its index in the array is found.
Dim query = fruits.AsQueryable() _
    .TakeWhile(Function(fruit, index) fruit.Length >= index)

' Display the results.
Dim output As New System.Text.StringBuilder
For Each fruit As String In query

' This code produces the following output:

' apple
' passionfruit
' banana
' mango
' orange
' blueberry

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.1
Windows Phone
Available since 8.1
Return to top