QueryableExtensions.Include メソッド (IQueryable, String)
[このページは、Entity Framework 6 に関するページです。最新バージョンは、'Entity Framework' NuGet パッケージとして入手できます。Entity Framework の詳細については、msdn.com/data/ef を参照してください。]
クエリ結果に含める関連オブジェクトを指定します。
名前空間: System.Data.Entity
アセンブリ: EntityFramework (EntityFramework.dll 内)
構文
'宣言
<ExtensionAttribute> _
Public Shared Function Include ( _
source As IQueryable, _
path As String _
) As IQueryable
'使用
Dim source As IQueryable
Dim path As String
Dim returnValue As IQueryable
returnValue = source.Include(path)
public static IQueryable Include(
this IQueryable source,
string path
)
[ExtensionAttribute]
public:
static IQueryable^ Include(
IQueryable^ source,
String^ path
)
static member Include :
source:IQueryable *
path:string -> IQueryable
public static function Include(
source : IQueryable,
path : String
) : IQueryable
パラメーター
- source
型 : System.Linq.IQueryable
Include を呼び出す対象のソース IQueryable。
- path
型 : System.String
クエリ結果で返す関連オブジェクトをドットで区切った一覧。
戻り値
型 : System.Linq.IQueryable
定義されたクエリ パスを使用する新しい IQueryable。
使用上の注意
Visual Basic および Visual C# では、このメソッドを、IQueryable 型のオブジェクトのインスタンス メソッドとして呼び出すことができます。インスタンス メソッド構文を使用してこのメソッドを呼び出す場合は、最初のパラメーターを省略します。詳細については、「https://msdn.microsoft.com/ja-jp/library/bb384936(v=vs.113)」または「https://msdn.microsoft.com/ja-jp/library/bb383977(v=vs.113)」を参照してください。
解説
この拡張メソッドはソース IQueryable オブジェクトの Include(String) メソッドを呼び出します (存在する場合)。 ソース IQueryable に一致するメソッドが存在しない場合、このメソッドは何も行いません。 ObjectQuery、ObjectSet<TEntity>、DbQuery、および DbSet 型のすべてで、適切な Include メソッドを呼び出す必要があります。 パスは包括的です。 たとえば、インクルード呼び出しで Include("Orders.OrderLines") が指定されている場合は、OrderLines だけではなく Orders も含まれます。 Include メソッドを呼び出した場合、クエリ パスは IQueryable の返されたインスタンスでのみ有効です。 IQueryable の他のインスタンスとオブジェクト コンテキスト自体は影響を受けません。 Include メソッドはクエリ オブジェクトを返すので、このメソッドを IQueryable で複数回呼び出すことで、クエリに複数のパスを指定できます。