Queryable::TakeWhile<TSource> Method (IQueryable<TSource>^, Expression<Func<TSource, Boolean>^>^)

.NET Framework (current version)

Returns elements from a sequence as long as a specified condition is true.

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

Syntax

public:
generic<typename TSource>
[ExtensionAttribute]
static IQueryable<TSource>^ TakeWhile(
	IQueryable<TSource>^ source,
	Expression<Func<TSource, bool>^>^ predicate
)

Parameters

source: Type: System.Linq::IQueryable<TSource>^
The sequence to return elements from.

predicate: Type: System.Linq.Expressions::Expression<Func<TSource, Boolean>^>^
A function to test each element for a condition.

Return Value

Type: System.Linq::IQueryable<TSource>^

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

Type Parameters

TSource: The type of the elements of source.

Exceptions

Exception	Condition
ArgumentNullException	source or predicate is null.

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

The TakeWhile<TSource>(IQueryable<TSource>^, Expression<Func<TSource, Boolean>^>^) method generates a MethodCallExpression that represents calling TakeWhile<TSource>(IQueryable<TSource>^, Expression<Func<TSource, 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<TSource>(IQueryable<TSource>^, Expression<Func<TSource, 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.

Examples

The following code example demonstrates how to use TakeWhile<TSource>(IQueryable<TSource>^, Expression<Func<TSource, Boolean>^>^) to return elements from the start of a sequence as long as a condition is true.

C++

No code example is currently available or this language may not be supported.

Version Information

Universal Windows Platform
Available since 8
.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.1
Windows Phone
Available since 8.1