DataLoadOptions.LoadWith(Of T) Method (Expression(Of Func(Of T, Object)))

 

Specifies which sub-objects to retrieve when a query is submitted for an object of type T.

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

Public Sub LoadWith(Of T) (
	expression As Expression(Of Func(Of T, Object))
)

Parameters

expression
Type: System.Linq.Expressions.Expression(Of Func(Of T, Object))

Identifies the field or property to be retrieved.

If the expression does not identify a field or property that represents a one-to-one or one-to-many relationship, an exception is thrown.

Type Parameters

T

Type that is queried against.

If this type is unmapped, an exception is thrown.

You cannot specify the loading of two levels of relationships (for example, Orders.OrderDetails). In these scenarios you must specify two separate LoadWith methods.

To avoid cycling, see Remarks section in DataLoadOptions.

In the following example, all the Orders for all the Customers who are located in London are retrieved when the query is executed. As a result, successive access to the Orders property on a Customer object does not trigger a new database query.

Dim db As New Northwnd("c:\northwnd.mdf")

Dim dlo As DataLoadOptions = New DataLoadOptions()
dlo.LoadWith(Of Customer)(Function(c As Customer) c.Orders)
db.LoadOptions = dlo

Dim londonCustomers = _
    From cust In db.Customers _
    Where cust.City = "London" _
    Select cust

For Each custObj In londonCustomers
    Console.WriteLine(custObj.CustomerID)
Next

.NET Framework
Available since 3.5
Windows Phone Silverlight
Available since 7.1
Return to top
Show: