.NET Framework Class Library
Queryable..::.DefaultIfEmpty<(Of <(TSource>)>) Method (IQueryable<(Of <(TSource>)>))

Returns the elements of the specified sequence or the type parameter's default value in a singleton collection if the sequence is empty.

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

Visual Basic (Declaration)
<ExtensionAttribute> _
Public Shared Function DefaultIfEmpty(Of TSource) ( _
    source As IQueryable(Of TSource) _
) As IQueryable(Of TSource)
Visual Basic (Usage)
Dim source As IQueryable(Of TSource)
Dim returnValue As IQueryable(Of TSource)

returnValue = source.DefaultIfEmpty()
C#
public static IQueryable<TSource> DefaultIfEmpty<TSource>(
    this IQueryable<TSource> source
)
Visual C++
[ExtensionAttribute]
public:
generic<typename TSource>
static IQueryable<TSource>^ DefaultIfEmpty(
    IQueryable<TSource>^ source
)
JScript
JScript does not support generic types or methods.

Type Parameters

TSource

The type of the elements of source.

Parameters

source
Type: System.Linq..::.IQueryable<(Of <(TSource>)>)
The IQueryable<(Of <(T>)>) to return a default value for if empty.

Return Value

Type: System.Linq..::.IQueryable<(Of <(TSource>)>)
An IQueryable<(Of <(T>)>) that contains default(TSource) 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).
Exceptions

ExceptionCondition
ArgumentNullException

source is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

The DefaultIfEmpty<(Of <(TSource>)>)(IQueryable<(Of <(TSource>)>)) method generates a MethodCallExpression that represents calling DefaultIfEmpty<(Of <(TSource>)>)(IQueryable<(Of <(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>)>)) 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 default(TSource).

Examples

The following code examples demonstrate how to use DefaultIfEmpty<(Of <(TSource>)>)(IQueryable<(Of <(TSource>)>)) to provide a default value in case the source sequence is empty.

Visual Basic
Structure Pet
    Public Name As String
    Public Age As Integer
End Structure

Shared Sub DefaultIfEmptyEx1()
    ' 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}})

    ' Call DefaultIfEmtpy() on the collection that Select()
    ' returns, so that if the initial list is empty, there
    ' will always be at least one item in the returned array.
    Dim names() As String = pets.AsQueryable() _
        .Select(Function(Pet) Pet.Name) _
        .DefaultIfEmpty() _
        .ToArray()

    Dim first As String = names(0)
    MsgBox(first)

    ' This code produces the following output:
    '
    ' Barley

End Sub
C#
class Pet
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public static void DefaultIfEmptyEx1()
{
    // Create a list of Pet objects.
    List<Pet> pets =
        new List<Pet>{ new Pet { Name="Barley", Age=8 },
                       new Pet { Name="Boots", Age=4 },
                       new Pet { Name="Whiskers", Age=1 } };

    // Call DefaultIfEmtpy() on the collection that Select()
    // returns, so that if the initial list is empty, there
    // will always be at least one item in the returned array.
    string[] names =
        pets.AsQueryable()
        .Select(pet => pet.Name)
        .DefaultIfEmpty()
        .ToArray();

    string first = names[0];
    Console.WriteLine(first);
}

/*
    This code produces the following output:

    Barley
*/
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5
See Also

Reference

Tags :


Page view tracker