Export (0) Print
Expand All

Queryable.DefaultIfEmpty(Of TSource) Method (IQueryable(Of TSource), TSource)

Returns the elements of the specified sequence or the specified value in a singleton collection if the sequence is empty.

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

'Declaration
<ExtensionAttribute> _
Public Shared Function DefaultIfEmpty(Of TSource) ( _
	source As IQueryable(Of TSource), _
	defaultValue As TSource _
) As IQueryable(Of TSource)

Type Parameters

TSource

The type of the elements of source.

Parameters

source
Type: System.Linq.IQueryable(Of TSource)

The IQueryable(Of T) to return the specified value for if empty.

defaultValue
Type: TSource

The value to return if the sequence is empty.

Return Value

Type: System.Linq.IQueryable(Of TSource)
An IQueryable(Of T) that contains defaultValue if source is empty; otherwise, source.

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 is Nothing.

The DefaultIfEmpty(Of TSource)(IQueryable(Of TSource), TSource) method generates a MethodCallExpression that represents calling DefaultIfEmpty(Of TSource)(IQueryable(Of TSource), TSource) itself as a constructed generic method. It then passes the MethodCallExpression to the CreateQuery(Of TElement)(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 DefaultIfEmpty(Of TSource)(IQueryable(Of TSource), TSource) depends on the implementation of the type of the source parameter. The expected behavior is that it returns source if it is not empty. Otherwise, it returns an IQueryable(Of T) that contains defaultValue.

The following code example shows a situation in which it is useful to call DefaultIfEmpty(Of TSource)(IQueryable(Of TSource), TSource) in a LINQ query. A default value is passed to DefaultIfEmpty(Of TSource)(IQueryable(Of TSource), TSource) in this example.

        ' Create a list of Pet objects. 
        Dim pets As New List(Of Pet)(New Pet() { _
                           New Pet With {.Name = "Barley", .Age = 8}, _
                           New Pet With {.Name = "Boots", .Age = 4}, _
                           New Pet With {.Name = "Whiskers", .Age = 1}})

        ' This query returns pets that are 10 or older. In case there are no pets  
        ' that meet that criteria, call DefaultIfEmpty(). This code passes an (optional)  
        ' default value to DefaultIfEmpty(). 
        Dim oldPets() As String = pets.AsQueryable() _
            .Where(Function(Pet) Pet.Age >= 10) _
            .Select(Function(Pet) Pet.Name) _
            .DefaultIfEmpty("[EMPTY]") _
            .ToArray()
        Try
            MsgBox("First query: " + oldPets(0))
        Catch ex As Exception
            Console.WriteLine("First query: An exception was thrown: " + ex.Message)
        End Try 

        ' This query selects only those pets that are 10 or older. 
        ' This code does not call DefaultIfEmpty(). 
        Dim oldPets2() As String = _
            pets.AsQueryable() _
            .Where(Function(Pet) Pet.Age >= 10) _
            .Select(Function(Pet) Pet.Name) _
            .ToArray()

        ' There may be no elements in the array, so directly 
        ' accessing element 0 may throw an exception. 
        Try
            MsgBox("Second query: " + oldPets2(0))
        Catch ex As Exception
            MsgBox("Second query: An exception was thrown: " + ex.Message)
        End Try 

        ' This code produces the following output: 
        
        ' First(query) : [EMPTY] 
        ' Second query: An exception was thrown: Index was outside the bounds of the array.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft