Export (0) Print
Expand All

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

Bypasses elements in a sequence as long as a specified condition is true and then returns the remaining elements. The element's index is used in the logic of the predicate function.

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

'Declaration
<ExtensionAttribute> _
Public Shared Function SkipWhile(Of TSource) ( _
	source As IQueryable(Of TSource), _
	predicate As Expression(Of Func(Of TSource, Integer, Boolean)) _
) As IQueryable(Of TSource)

Type Parameters

TSource

The type of the elements of source.

Parameters

source
Type: System.Linq.IQueryable(Of TSource)
An IQueryable(Of T) to return elements from.
predicate
Type: System.Linq.Expressions.Expression(Of Func(Of TSource, Int32, Boolean))
A function to test each element for a condition; the second parameter of this function represents the index of the source element.

Return Value

Type: System.Linq.IQueryable(Of TSource)
An IQueryable(Of T) that contains elements from source starting at the first element in the linear series that does not pass the test specified by predicate.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable(Of 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 or predicate is Nothing.

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 SkipWhile(Of TSource)(IQueryable(Of TSource), Expression(Of Func(Of TSource, Int32, Boolean))) method generates a MethodCallExpression that represents calling SkipWhile(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 SkipWhile(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. That element and all the remaining elements are returned. The index of each source element is provided as the second argument to predicate.

The following code example demonstrates how to use SkipWhile(Of TSource)(IQueryable(Of TSource), Expression(Of Func(Of TSource, Int32, Boolean))) to skip elements of an array as long as a condition that depends on the element's index is true.


        Dim amounts() As Integer = {5000, 2500, 9000, 8000, _
                            6500, 4000, 1500, 5500}

        ' Skip over amounts in the array until the first amount
        ' that is less than or equal to the product of its
        ' index in the array and 1000. Take the remaining items.
        Dim query = amounts.AsQueryable() _
            .SkipWhile(Function(amount, index) amount > index * 1000)

        Dim output As New System.Text.StringBuilder
        For Each amount As Integer In query
            output.AppendLine(amount)
        Next

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

        ' This code produces the following output:

        ' 4000
        ' 1500
        ' 5500



.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft