Class QueryParameterCollection
Коллекция параметров запроса.
Inheritance
Implements
Inherited Members
Namespace: Terrasoft.Core.DB
Assembly: Terrasoft.Core.dll
Syntax
public class QueryParameterCollection : Collection<QueryParameter>, IList<QueryParameter>, ICollection<QueryParameter>, IList, ICollection, IReadOnlyList<QueryParameter>, IReadOnlyCollection<QueryParameter>, IEnumerable<QueryParameter>, IEnumerable, ICloneable
Constructors
QueryParameterCollection()
Инициализирует новый экземпляр QueryParameterCollection.
Declaration
public QueryParameterCollection()
QueryParameterCollection(QueryParameterCollection)
Инициализирует новый экземпляр QueryParameterCollection, являющийся клоном заданной коллекции параметров запроса.
Declaration
public QueryParameterCollection(QueryParameterCollection source)
Parameters
Type | Name | Description |
---|---|---|
QueryParameterCollection | source | Коллекция параметров запроса, клон которой создается. |
Properties
ParentParametrizedQuery
Родительский запрос, которому принадлежит данная коллекция параметров запроса.
Declaration
public IParametrizedQuery ParentParametrizedQuery { get; set; }
Property Value
Type | Description |
---|---|
IParametrizedQuery |
Methods
Add(String, Object)
В текущую коллекцию параметров запроса добавляет параметр с заданными именем и значением.
Declaration
public QueryParameter Add(string name, object value)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя добавляемого параметра запроса. |
System.Object | value | Значение добавляемого параметра запроса. |
Returns
Type | Description |
---|---|
QueryParameter | Добавленный в текущую коллекцию параметров запроса
параметр QueryParameter с
именем |
Add(String, Object, String)
В текущую коллекцию параметров запроса добавляет параметр с заданным именем и заданным значением, которое имеет тип данных с указанным именем.
Declaration
public QueryParameter Add(string name, object value, string parameterTypeName)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя добавляемого параметра запроса. |
System.Object | value | Значение добавляемого параметра запроса. |
System.String | parameterTypeName | Имя типа данных значения параметра запроса. |
Returns
Type | Description |
---|---|
QueryParameter | Добавленный в текущую коллекцию параметров
запроса параметр QueryParameter с именем
|
Add(String, Object, DataValueType)
В текущую коллекцию параметров запроса добавляет параметр с заданным именем и заданным значением, который имеет определенный тип данных.
Declaration
public QueryParameter Add(string name, object value, DataValueType parameterType)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя добавляемого параметра запроса. |
System.Object | value | Значение добавляемого параметра запроса. |
DataValueType | parameterType | Тип данных значения добавляемого параметра запроса. |
Returns
Type | Description |
---|---|
QueryParameter | Добавленный в текущую коллекцию параметров запроса
параметр QueryParameter с именем
|
AddOut(String, String)
В текущую коллекцию параметров запроса добавляет исходящий параметр с заданными именем параметра и именем типа данных значения параметра.
Declaration
public QueryParameter AddOut(string name, string parameterTypeName)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя добавляемого параметра запроса. |
System.String | parameterTypeName | Имя типа данных значения параметра запроса. |
Returns
Type | Description |
---|---|
QueryParameter | Добавленный в текущую коллекцию параметров запроса
параметр QueryParameter с именем
|
AddOut(String, DataValueType)
В текущую коллекцию параметров запроса добавляет исходящий параметр с заданным именем и заданным типом данных значения параметра.
Declaration
public QueryParameter AddOut(string name, DataValueType parameterType)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя добавляемого параметра запроса. |
DataValueType | parameterType | Тип данных значения параметра запроса. |
Returns
Type | Description |
---|---|
QueryParameter | Добавленный в текущую коллекцию параметров
запроса исходящий параметр
QueryParameter, значение которого имеет тип данных
|
AddVar(String, Object, String)
В текущую коллекцию параметров запросов добавляет входящий/исходящий параметр с заданными именем, значением и именем типа данных значения параметра.
Declaration
public QueryParameter AddVar(string name, object value, string parameterTypeName)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя добавляемого параметра запроса. |
System.Object | value | Значение добавляемого параметра запроса. |
System.String | parameterTypeName | Имя типа данных значения добавляемого параметра запроса. |
Returns
Type | Description |
---|---|
QueryParameter | Добавленный в текущую коллекцию
параметров запроса параметр QueryParameter с именем
|
AddVar(String, Object, DataValueType)
В текущую коллекцию параметров запроса добавляет входящий/исходящий параметр с заданными именем, значением и типом значения.
Declaration
public QueryParameter AddVar(string name, object value, DataValueType parameterType)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя добавляемого параметра запроса. |
System.Object | value | Значение добавляемого параметра запроса. |
DataValueType | parameterType | Тип данных значения добавляемого параметра запроса. |
Returns
Type | Description |
---|---|
QueryParameter | Добавленный в текущую коллекцию
параметров запроса параметр QueryParameter с именем
|
ClearItems()
Declaration
protected override void ClearItems()
Overrides
Clone()
Создает клон текущего экземпляра QueryParameterCollection.
Declaration
public object Clone()
Returns
Type | Description |
---|---|
System.Object | Новый экземпляр QueryParameterCollection, представляющий копию текущего экземпляра. |
FindByName(String)
В текущей коллекции параметров запроса выполняет поиск параметра с заданным именем.
Declaration
public QueryParameter FindByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя искомого параметра запроса. |
Returns
Type | Description |
---|---|
QueryParameter | Экземпляр параметра запроса QueryParameter
с именем |
GenerateUniqueName(String)
По заданному префиксу генерирует уникальное имя параметра запроса.
Declaration
public string GenerateUniqueName(string parameterNamePrefix)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterNamePrefix | Префикс имени параметра запроса. |
Returns
Type | Description |
---|---|
System.String | Уникальное имя параметра запроса. |
GenerateUniqueNames()
Генерирует уникальные имена для всех элементов текущей коллекции параметров запроса.
Declaration
public void GenerateUniqueNames()
GetByName(String)
Из текущей коллекции параметров запроса возвращает параметр с заданным именем. Если параметр не найден в коллекции, генерируется исключение.
Declaration
public QueryParameter GetByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя возвращаемого параметра запроса. |
Returns
Type | Description |
---|---|
QueryParameter | Экземпляр параметра запроса QueryParameter
с именем |
InsertItem(Int32, QueryParameter)
Declaration
protected override void InsertItem(int index, QueryParameter item)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | |
QueryParameter | item |
Overrides
RemoveItem(Int32)
Declaration
protected override void RemoveItem(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Overrides
ResetParameters()
Очищает коллекцию параметров запроса, которые были добавлены автоматически.
Declaration
public void ResetParameters()
SetItem(Int32, QueryParameter)
Declaration
protected override void SetItem(int index, QueryParameter item)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | |
QueryParameter | item |