ObjectParameterCollection Class

Определение

Представляет параметры запроса в виде объектов ObjectParameter, определенных в ObjectQuery<T>. Represents the query parameters as ObjectParameter objects that are defined in an ObjectQuery<T>.

public sealed class ObjectParameterCollection : System.Collections.Generic.ICollection<System.Data.Objects.ObjectParameter>, System.Collections.Generic.IEnumerable<System.Data.Objects.ObjectParameter>
Наследование
ObjectParameterCollection
Реализации

Примеры

Пример в этом разделе основан на модели AdventureWorks Sales.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. Коллекция не может содержать два параметра с одинаковыми именами.There cannot be two parameters in the collection with the same name.

Если используется методы с композицией, такие как Union, UnionAll, Intersect и Except, выполняется слияние параметров.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

Возвращает число параметров, находящихся в коллекции в данный момент. Gets the number of parameters currently in the collection.

Item[String]

Представляет индексатор, который позволяет вызывающим методам получать параметры по имени. Provides an indexer that allows callers to retrieve parameters by name.

Методы

Add(ObjectParameter)

Добавляет указанный параметр ObjectParameter в коллекцию. Adds the specified ObjectParameter to the collection.

Clear()

Удаляет все экземпляры ObjectParameter из коллекции. Deletes all ObjectParameter instances from the collection.

Contains(ObjectParameter)

Проверяет наличие указанного параметра ObjectParameter в коллекции по ссылке. Checks for the existence of a specified ObjectParameter in the collection by reference.

Contains(String)

Определяет, присутствует ли в коллекции объект ObjectParameter с указанным именем. Determines whether an ObjectParameter with the specified name is in the collection.

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)

Определяет, равен ли заданный объект текущему объекту. Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Служит хэш-функцией по умолчанию. Serves as the default hash function.

(Inherited from Object)
GetType()

Возвращает объект Type для текущего экземпляра. Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object. Creates a shallow copy of the current Object.

(Inherited from Object)
Remove(ObjectParameter)

Удаляет экземпляр ObjectParameter из коллекции по ссылке, если он существует в этой коллекции. Removes an instance of an ObjectParameter from the collection by reference if it exists in the collection.

ToString()

Возвращает строку, представляющую текущий объект. Returns a string that represents the current object.

(Inherited from Object)

Явные реализации интерфейса

ICollection<ObjectParameter>.IsReadOnly

Возвращает значение, которое определяет, является ли коллекция доступной только для чтения. Gets a value that indicates whether the collection is read-only or can be modified.

IEnumerable.GetEnumerator()

Возвращает нетипизированный перечислитель по коллекции. Returns an untyped enumerator over the collection.

IEnumerable<ObjectParameter>.GetEnumerator()

Возвращает типизированный перечислитель по коллекции. Returns a typed enumerator over the collection.

Применяется к