Queryable.GroupJoin<TOuter, TInner, TKey, TResult> Method (IQueryable<TOuter>, IEnumerable<TInner>, Expression<Func<TOuter, TKey>>, Expression<Func<TInner, TKey>>, Expression<Func<TOuter, IEnumerable<TInner>, TResult>>)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Correlates the elements of two sequences based on key equality and groups the results. The default equality comparer is used to compare keys.
Namespace: System.Linq
Assembly: System.Core (in System.Core.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function GroupJoin(Of TOuter, TInner, TKey, TResult) ( _
outer As IQueryable(Of TOuter), _
inner As IEnumerable(Of TInner), _
outerKeySelector As Expression(Of Func(Of TOuter, TKey)), _
innerKeySelector As Expression(Of Func(Of TInner, TKey)), _
resultSelector As Expression(Of Func(Of TOuter, IEnumerable(Of TInner), TResult)) _
) As IQueryable(Of TResult)
public static IQueryable<TResult> GroupJoin<TOuter, TInner, TKey, TResult>(
this IQueryable<TOuter> outer,
IEnumerable<TInner> inner,
Expression<Func<TOuter, TKey>> outerKeySelector,
Expression<Func<TInner, TKey>> innerKeySelector,
Expression<Func<TOuter, IEnumerable<TInner>, TResult>> resultSelector
)
Type Parameters
- TOuter
The type of the elements of the first sequence.
- TInner
The type of the elements of the second sequence.
- TKey
The type of the keys returned by the key selector functions.
- TResult
The type of the result elements.
Parameters
- outer
Type: System.Linq.IQueryable<TOuter>
The first sequence to join.
- inner
Type: System.Collections.Generic.IEnumerable<TInner>
The sequence to join to the first sequence.
- outerKeySelector
Type: System.Linq.Expressions.Expression<Func<TOuter, TKey>>
A function to extract the join key from each element of the first sequence.
- innerKeySelector
Type: System.Linq.Expressions.Expression<Func<TInner, TKey>>
A function to extract the join key from each element of the second sequence.
- resultSelector
Type: System.Linq.Expressions.Expression<Func<TOuter, IEnumerable<TInner>, TResult>>
A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence.
Return Value
Type: System.Linq.IQueryable<TResult>
An IQueryable<T> that contains elements of type TResult obtained by performing a grouped join on two sequences.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable<TOuter>. When you use instance method syntax to call this method, omit the first parameter.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | outer or inner or outerKeySelector or innerKeySelector or resultSelector is nulla null reference (Nothing in Visual Basic). |
Remarks
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 GroupJoin<TOuter, TInner, TKey, TResult>(IQueryable<TOuter>, IEnumerable<TInner>, Expression<Func<TOuter, TKey>>, Expression<Func<TInner, TKey>>, Expression<Func<TOuter, IEnumerable<TInner>, TResult>>) method generates a MethodCallExpression that represents calling GroupJoin<TOuter, TInner, TKey, TResult>(IQueryable<TOuter>, IEnumerable<TInner>, Expression<Func<TOuter, TKey>>, Expression<Func<TInner, TKey>>, Expression<Func<TOuter, IEnumerable<TInner>, TResult>>) itself as a constructed generic method. It then passes the MethodCallExpression to the CreateQuery<TElement>(Expression) method of the IQueryProvider represented by the Provider property of the outer parameter.
The query behavior that occurs as a result of executing an expression tree that represents calling GroupJoin<TOuter, TInner, TKey, TResult>(IQueryable<TOuter>, IEnumerable<TInner>, Expression<Func<TOuter, TKey>>, Expression<Func<TInner, TKey>>, Expression<Func<TOuter, IEnumerable<TInner>, TResult>>) depends on the implementation of the type of the outer parameter. The expected behavior is that the outerKeySelector and innerKeySelector functions are used to extract keys from outer and inner, respectively. These keys are compared for equality to match each element in outer with zero or more elements from inner. Then the resultSelector function is invoked to project a result object from each group of correlated elements.
Examples
The following code example demonstrates how to use GroupJoin<TOuter, TInner, TKey, TResult>(IQueryable<TOuter>, IEnumerable<TInner>, Expression<Func<TOuter, TKey>>, Expression<Func<TInner, TKey>>, Expression<Func<TOuter, IEnumerable<TInner>, TResult>>) to perform a grouped join on two sequences.
Structure Person
Public Name As String
End Structure
Structure Pet
Public Name As String
Public Owner As Person
End Structure
Shared Sub GroupJoinEx1()
Dim magnus As New Person With {.Name = "Hedlund, Magnus"}
Dim terry As New Person With {.Name = "Adams, Terry"}
Dim charlotte As New Person With {.Name = "Weiss, Charlotte"}
Dim barley As New Pet With {.Name = "Barley", .Owner = terry}
Dim boots As New Pet With {.Name = "Boots", .Owner = terry}
Dim whiskers As New Pet With {.Name = "Whiskers", .Owner = charlotte}
Dim daisy As New Pet With {.Name = "Daisy", .Owner = magnus}
Dim people As New List(Of Person)(New Person() {magnus, terry, charlotte})
Dim pets As New List(Of Pet)(New Pet() {barley, boots, whiskers, daisy})
' Create a list where each element is an anonymous
' type that contains a person's name and a collection
' of the names of the pets that are owned by them.
Dim query = _
people.AsQueryable().GroupJoin(pets, _
Function(person) person, _
Function(pet) pet.Owner, _
Function(person, petCollection) _
New With {.OwnerName = person.Name, _
.Pets = petCollection.Select( _
Function(pet) pet.Name)})
Dim output As New System.Text.StringBuilder
For Each obj In query
' Output the owner's name.
output.AppendLine(String.Format("{0}:", obj.OwnerName))
' Output each of the owner's pet's names.
For Each pet As String In obj.Pets
output.AppendLine(String.Format(" {0}", pet))
Next
Next
' Display the output.
outputBlock.Text &= output.ToString() & vbCrLf
End Sub
' This code produces the following output:
' Hedlund, Magnus:
' Daisy
' Adams, Terry:
' Barley
' Boots
' Weiss, Charlotte:
' Whiskers
class Person
{
public string Name { get; set; }
}
class Pet
{
public string Name { get; set; }
public Person Owner { get; set; }
}
public static void GroupJoinEx1()
{
Person magnus = new Person { Name = "Hedlund, Magnus" };
Person terry = new Person { Name = "Adams, Terry" };
Person charlotte = new Person { Name = "Weiss, Charlotte" };
Pet barley = new Pet { Name = "Barley", Owner = terry };
Pet boots = new Pet { Name = "Boots", Owner = terry };
Pet whiskers = new Pet { Name = "Whiskers", Owner = charlotte };
Pet daisy = new Pet { Name = "Daisy", Owner = magnus };
List<Person> people = new List<Person> { magnus, terry, charlotte };
List<Pet> pets = new List<Pet> { barley, boots, whiskers, daisy };
// Create a list where each element is an anonymous
// type that contains a person's name and a collection
// of names of the pets that are owned by them.
var query =
people.AsQueryable().GroupJoin(pets,
person => person,
pet => pet.Owner,
(person, petCollection) =>
new
{
OwnerName = person.Name,
Pets = petCollection.Select(pet => pet.Name)
});
foreach (var obj in query)
{
// Output the owner's name.
outputBlock.Text += String.Format("{0}:", obj.OwnerName) + "\n";
// Output each of the owner's pet's names.
foreach (string pet in obj.Pets)
outputBlock.Text += String.Format(" {0}", pet) + "\n";
}
}
/*
This code produces the following output:
Hedlund, Magnus:
Daisy
Adams, Terry:
Barley
Boots
Weiss, Charlotte:
Whiskers
*/
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.