ObjectQuery<T>::Include Method (String^)

 

Specifies the related objects to include in the query results.

Namespace:   System.Data.Objects
Assembly:  System.Data.Entity (in System.Data.Entity.dll)

public:
ObjectQuery<T>^ Include(
	String^ path
)

Parameters

path
Type: System::String^

Dot-separated list of related objects to return in the query results.

Return Value

Type: System.Data.Objects::ObjectQuery<T>^

A new ObjectQuery<T> with the defined query path.

Exception Condition
ArgumentNullException

path is null.

ArgumentException

path is empty.

Query paths can be used with Entity SQL and LINQ queries.

Paths are all-inclusive. For example, if an include call indicates Include("Orders.OrderLines"), not only will OrderLines be included, but also Orders. For more information, see Loading Related Objects.

When you call the Include method, the query path is only valid on the returned instance of the ObjectQuery<T>. Other instances of ObjectQuery<T> and the object context itself are not affected.

Because the Include method returns the query object, you can call this method multiple times on an ObjectQuery<T> to specify multiple paths for the query, as in the following example:

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.5
Return to top
Show: