ObjectParameterCollection ObjectParameterCollection ObjectParameterCollection ObjectParameterCollection Class

定義

クエリ パラメーターを、ObjectParameter で定義される ObjectQuery<T> オブジェクトとして表します。Represents the query parameters as ObjectParameter objects that are defined in an ObjectQuery<T>.

public ref class ObjectParameterCollection sealed : System::Collections::Generic::ICollection<System::Data::Objects::ObjectParameter ^>, System::Collections::Generic::IEnumerable<System::Data::Objects::ObjectParameter ^>
public sealed class ObjectParameterCollection : System.Collections.Generic.ICollection<System.Data.Objects.ObjectParameter>, System.Collections.Generic.IEnumerable<System.Data.Objects.ObjectParameter>
type ObjectParameterCollection = class
    interface ICollection<ObjectParameter>
    interface seq<ObjectParameter>
    interface IEnumerable
Public NotInheritable Class ObjectParameterCollection
Implements ICollection(Of ObjectParameter), IEnumerable(Of ObjectParameter)
継承
ObjectParameterCollectionObjectParameterCollectionObjectParameterCollectionObjectParameterCollection
実装

このトピックの例は、 AdventureWorks Sales Modelに基づいています。The example in this topic is based on the AdventureWorks Sales Model. この例では、新しいパラメーターをコレクションに追加し、コレクション内のパラメーターの数を取得します。The example adds new parameters to the collection and gets the count of the parameters in the collection. 次に、ObjectParameterCollection を反復処理し、コレクション内の各パラメーターの名前、型、および値を表示します。Then it iterates through the ObjectParameterCollection and displays the name, type, and value of each parameter in the collection.

using (AdventureWorksEntities context =
    new AdventureWorksEntities())
{
    string queryString =
        @"SELECT VALUE contact FROM AdventureWorksEntities.Contacts 
        AS contact WHERE contact.LastName = @ln AND contact.FirstName = @fn";

    ObjectQuery<Contact> contactQuery =
        new ObjectQuery<Contact>(queryString, context);

    // Add parameters to the collection.
    contactQuery.Parameters.Add(new ObjectParameter("ln", "Adams"));
    contactQuery.Parameters.Add(new ObjectParameter("fn", "Frances"));

    ObjectParameterCollection objectParameterCollection =
        contactQuery.Parameters;

    Console.WriteLine("Count is {0}.", objectParameterCollection.Count);

    // Iterate through the ObjectParameterCollection collection.
    foreach (ObjectParameter result in objectParameterCollection)
    {
        Console.WriteLine("{0} {1} {2}", result.Name,
            result.Value,
            result.ParameterType);
    }
}
Using context As New AdventureWorksEntities()
    Dim queryString As String = "SELECT VALUE contact FROM AdventureWorksEntities.Contacts " & _
            " AS contact WHERE contact.LastName = @ln AND contact.FirstName = @fn"

    Dim contactQuery As New ObjectQuery(Of Contact)(queryString, context)

    ' Add parameters to the collection. 
    contactQuery.Parameters.Add(New ObjectParameter("ln", "Adams"))
    contactQuery.Parameters.Add(New ObjectParameter("fn", "Frances"))

    Dim objectParameterCollection As ObjectParameterCollection = contactQuery.Parameters

    Console.WriteLine("Count is {0}.", objectParameterCollection.Count)

    ' Iterate through the ObjectParameterCollection collection. 
    For Each result As ObjectParameter In objectParameterCollection
        Console.WriteLine("{0} {1} {2}", result.Name, result.Value, result.ParameterType)
    Next
End Using

注釈

クエリ パラメーターを、ObjectParameter で定義される ObjectQuery<T> オブジェクトとして表します。Represents the query parameters as ObjectParameter objects defined in an ObjectQuery<T>.

このクラスは継承できません。This class cannot be inherited.

クエリ ビルダー メソッドに渡されるパラメーターは、シーケンス内の ObjectQuery<T> の後続のインスタンスによって集計されます。The parameters that are passed to query builder methods are aggregated by successive instances of an ObjectQuery<T> in the sequence. これらにアクセスするには、Parameters を返す ObjectParameterCollection プロパティを使用します。They can be accessed by using the Parameters property, which returns the ObjectParameterCollection. クエリがコンパイルまたは実行されていない限り、パラメーターを追加した後で、コレクションからパラメーターを削除することも、コレクションをクリアすることもできます。After parameters have been added, they can be removed from the collection and the collection can be cleared, as long as the query has not been compiled or executed. パラメーター名は変更できませんが、値はいつでも変更できます。Parameter names cannot be changed, but values can be changed at any time.

パラメーターは、ObjectParameterCollection 内で一意である必要があります。Parameters must be unique in the ObjectParameterCollection. コレクション内に同じ名前のパラメーターが 2 つ存在することはできません。There cannot be two parameters in the collection with the same name.

UnionUnionAllIntersectExcept などの結合メソッドを使用すると、パラメーターが結合されます。When using composition methods, such as Union, UnionAll, Intersect and Except, the parameters are merged. パラメーターのセットに互換性がない場合やパラメーターのセットが不完全である場合は、例外がスローされます。An exception is thrown when the sets of parameters are incompatible or incomplete. 詳細については、「クエリビルダーメソッド」を参照してください。For more information, see Query Builder Methods.

プロパティ

Count Count Count Count

コレクション内に現在存在するパラメーターの数を取得します。Gets the number of parameters currently in the collection.

Item[String] Item[String] Item[String] Item[String]

呼び出し元がパラメーターを名前によって取得できるようにするインデクサーを提供します。Provides an indexer that allows callers to retrieve parameters by name.

メソッド

Add(ObjectParameter) Add(ObjectParameter) Add(ObjectParameter) Add(ObjectParameter)

指定された ObjectParameter をコレクションに追加します。Adds the specified ObjectParameter to the collection.

Clear() Clear() Clear() Clear()

コレクションからすべての ObjectParameter インスタンスを削除します。Deletes all ObjectParameter instances from the collection.

Contains(ObjectParameter) Contains(ObjectParameter) Contains(ObjectParameter) Contains(ObjectParameter)

指定した ObjectParameter がコレクション内に存在するかどうかを参照によって確認します。Checks for the existence of a specified ObjectParameter in the collection by reference.

Contains(String) Contains(String) Contains(String) Contains(String)

指定した名前の ObjectParameter がコレクション内に存在するかどうかを調べます。Determines whether an ObjectParameter with the specified name is in the collection.

CopyTo(ObjectParameter[], Int32) CopyTo(ObjectParameter[], Int32) CopyTo(ObjectParameter[], Int32) CopyTo(ObjectParameter[], Int32)

指定された配列にコレクション内のパラメーターをコピーできます。その際、指定されたインデックス位置のオブジェクトからコピーを開始します。Allows the parameters in the collection to be copied into a supplied array, starting with the object at the specified index.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
Remove(ObjectParameter) Remove(ObjectParameter) Remove(ObjectParameter) Remove(ObjectParameter)

参照によって、ObjectParameter のインスタンスをコレクションから削除します (コレクション内に存在する場合)。Removes an instance of an ObjectParameter from the collection by reference if it exists in the collection.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

明示的なインターフェイスの実装

ICollection<ObjectParameter>.IsReadOnly ICollection<ObjectParameter>.IsReadOnly ICollection<ObjectParameter>.IsReadOnly ICollection<ObjectParameter>.IsReadOnly

コレクションが読み取り専用か変更可能かを示す値を取得します。Gets a value that indicates whether the collection is read-only or can be modified.

IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator()

コレクションに対する型指定されていない列挙子を返します。Returns an untyped enumerator over the collection.

IEnumerable<ObjectParameter>.GetEnumerator() IEnumerable<ObjectParameter>.GetEnumerator() IEnumerable<ObjectParameter>.GetEnumerator() IEnumerable<ObjectParameter>.GetEnumerator()

コレクションに対する型指定された列挙子を返します。Returns a typed enumerator over the collection.

拡張メソッド

CopyToDataTable<T>(IEnumerable<T>) CopyToDataTable<T>(IEnumerable<T>) CopyToDataTable<T>(IEnumerable<T>) CopyToDataTable<T>(IEnumerable<T>)

指定した入力 DataTable オブジェクトに応じて (ジェネリック パラメーター TDataRow)、IEnumerable<T> オブジェクトのコピーを格納する DataRow を返します。Returns a DataTable that contains copies of the DataRow objects, given an input IEnumerable<T> object where the generic parameter T is DataRow.

CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption) CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption) CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption) CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption)

指定した入力 DataRow オブジェクトに応じて (ジェネリック パラメーター TDataTable)、指定した IEnumerable<T>DataRow オブジェクトをコピーします。Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter T is DataRow.

CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption, FillErrorEventHandler) CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption, FillErrorEventHandler) CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption, FillErrorEventHandler) CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption, FillErrorEventHandler)

指定した入力 DataRow オブジェクトに応じて (ジェネリック パラメーター TDataTable)、指定した IEnumerable<T>DataRow オブジェクトをコピーします。Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter T is DataRow.

Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable)

IEnumerable の要素を、指定した型にキャストします。Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable)

指定された型に基づいて IEnumerable の要素をフィルター処理します。Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable)

クエリの並列化を有効にします。Enables parallelization of a query.

AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable)

IEnumerableIQueryable に変換します。Converts an IEnumerable to an IQueryable.

Ancestors<T>(IEnumerable<T>) Ancestors<T>(IEnumerable<T>) Ancestors<T>(IEnumerable<T>) Ancestors<T>(IEnumerable<T>)

ソース コレクション内のすべてのノードの先祖が格納された、要素のコレクションを返します。Returns a collection of elements that contains the ancestors of every node in the source collection.

Ancestors<T>(IEnumerable<T>, XName) Ancestors<T>(IEnumerable<T>, XName) Ancestors<T>(IEnumerable<T>, XName) Ancestors<T>(IEnumerable<T>, XName)

ソース コレクション内のすべてのノードの先祖が格納され、フィルター処理された要素のコレクションを返します。Returns a filtered collection of elements that contains the ancestors of every node in the source collection. 一致する XName を持つ要素のみがコレクションに含められます。Only elements that have a matching XName are included in the collection.

DescendantNodes<T>(IEnumerable<T>) DescendantNodes<T>(IEnumerable<T>) DescendantNodes<T>(IEnumerable<T>) DescendantNodes<T>(IEnumerable<T>)

ソース コレクション内のすべてのドキュメントおよび要素の子孫ノードのコレクションを返します。Returns a collection of the descendant nodes of every document and element in the source collection.

Descendants<T>(IEnumerable<T>) Descendants<T>(IEnumerable<T>) Descendants<T>(IEnumerable<T>) Descendants<T>(IEnumerable<T>)

ソース コレクション内のすべての要素とドキュメントの子孫要素が格納された要素のコレクションを返します。Returns a collection of elements that contains the descendant elements of every element and document in the source collection.

Descendants<T>(IEnumerable<T>, XName) Descendants<T>(IEnumerable<T>, XName) Descendants<T>(IEnumerable<T>, XName) Descendants<T>(IEnumerable<T>, XName)

ソース コレクション内のすべての要素とドキュメントの子孫要素が格納され、フィルター処理された要素のコレクションを返します。Returns a filtered collection of elements that contains the descendant elements of every element and document in the source collection. 一致する XName を持つ要素のみがコレクションに含められます。Only elements that have a matching XName are included in the collection.

Elements<T>(IEnumerable<T>) Elements<T>(IEnumerable<T>) Elements<T>(IEnumerable<T>) Elements<T>(IEnumerable<T>)

ソース コレクション内のすべての要素およびドキュメントの子要素のコレクションを返します。Returns a collection of the child elements of every element and document in the source collection.

Elements<T>(IEnumerable<T>, XName) Elements<T>(IEnumerable<T>, XName) Elements<T>(IEnumerable<T>, XName) Elements<T>(IEnumerable<T>, XName)

ソース コレクション内のすべての要素およびドキュメントの、フィルター処理された子要素のコレクションを返します。Returns a filtered collection of the child elements of every element and document in the source collection. 一致する XName を持つ要素のみがコレクションに含められます。Only elements that have a matching XName are included in the collection.

InDocumentOrder<T>(IEnumerable<T>) InDocumentOrder<T>(IEnumerable<T>) InDocumentOrder<T>(IEnumerable<T>) InDocumentOrder<T>(IEnumerable<T>)

ソース コレクション内のすべてのノードがドキュメント順に並べ替えて格納された、ノードのコレクションを返します。Returns a collection of nodes that contains all nodes in the source collection, sorted in document order.

Nodes<T>(IEnumerable<T>) Nodes<T>(IEnumerable<T>) Nodes<T>(IEnumerable<T>) Nodes<T>(IEnumerable<T>)

ソース コレクション内のすべてのドキュメントおよび要素の子ノードのコレクションを返します。Returns a collection of the child nodes of every document and element in the source collection.

Remove<T>(IEnumerable<T>) Remove<T>(IEnumerable<T>) Remove<T>(IEnumerable<T>) Remove<T>(IEnumerable<T>)

ソース コレクション内の親ノードからすべてのノードを削除します。Removes every node in the source collection from its parent node.

適用対象

こちらもご覧ください