DataSourceSelectArguments Класс

Определение

Предоставляет механизм, используемый элементом управления, связанным с данными, для запроса операций над данными из элемента управления источника данных после извлечения данных.Provides a mechanism that data-bound controls use to request data-related operations from data source controls when data is retrieved. Этот класс не наследуется.This class cannot be inherited.

public ref class DataSourceSelectArguments sealed
public sealed class DataSourceSelectArguments
type DataSourceSelectArguments = class
Public NotInheritable Class DataSourceSelectArguments
Наследование
DataSourceSelectArguments

Комментарии

Элементы управления с привязкой к DataSourceSelectArguments данным используют класс для запроса того, что элемент управления источником данных выполняет дополнительные операции с данными в результирующем наборе, например сортирует данные или возвращает определенное подмножество данных.Data-bound controls use the DataSourceSelectArguments class to request that a data source control performs additional data-related operations on a result set, such as sorting the data or returning a specific subset of data. Эти операции, связанные с данными, перечисляются по DataSourceCapabilities перечислению.These data-related operations are enumerated by the DataSourceCapabilities enumeration. В следующей таблице показано, как DataSourceSelectArguments класс поддерживает эти операции, связанные с данными.The following table indicates how the DataSourceSelectArguments class supports these data-related operations.

ВозможностьCapability Связанные свойства ДатасаурцеселектаргументсRelated DataSourceSelectArguments properties
DataSourceCapabilities.Sort SortExpression
DataSourceCapabilities.Page StartRowIndex, MaximumRowsStartRowIndex, MaximumRows
DataSourceCapabilities.RetrieveTotalRowCount RetrieveTotalRowCount, TotalRowCountRetrieveTotalRowCount, TotalRowCount

Привязанные к данным элементы управления явно PerformSelect вызывают метод для привязки данных, который Select(DataSourceSelectArguments, DataSourceViewSelectCallback) вызывает метод элемента управления источника данных, с которым они связаны.Data-bound controls explicitly call the PerformSelect method to bind data, which calls the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method of the data source control they are associated with. Таким образом, элемент управления с привязкой к данным извлекает данные из элемента управления источника данных по запросу.In this way, the data-bound control retrieves data from the data source control on demand. Поскольку метод принимает параметр, элемент управления с привязкой к данным отвечает за создание и управление DataSourceSelectArguments объектом и передает его Select(DataSourceSelectArguments, DataSourceViewSelectCallback) методу при извлечении данных из элемента управления источника данных. DataSourceSelectArguments Select(DataSourceSelectArguments, DataSourceViewSelectCallback)Because the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method accepts a DataSourceSelectArguments parameter, the data-bound control is responsible for creating and managing a DataSourceSelectArguments object and passing it to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method when it retrieves data from the data source control.

В некоторых случаях элементы управления с привязкой к данным могут не нуждаться в дополнительных возможностях, связанных с данными.In some cases, data-bound controls might not need any additional data-related capabilities. В этом случае элементы управления с привязкой к данным Empty передают в Select(DataSourceSelectArguments, DataSourceViewSelectCallback) метод объект arguments.In this case, data-bound controls pass an Empty arguments object to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

Для отсортированных результирующих наборов элементы управления с привязкой к данным проверяют CanSort свойство представления источника данных во время выполнения и DataSourceCapabilities.Sort добавляют возможность AddSupportedCapabilities(DataSourceCapabilities) с помощью метода.For sorted result sets, data-bound controls check a data source view's CanSort property at run time, and add a DataSourceCapabilities.Sort capability using the AddSupportedCapabilities(DataSourceCapabilities) method. В качестве отдельной операции элемент управления с привязкой к данным может запрашивать отсортированный результирующий набор из элемента управления источниками SortExpression данных путем задания DataSourceSelectArguments свойства объекта, передаваемого Select(DataSourceSelectArguments, DataSourceViewSelectCallback) в метод.As a separate operation, the data-bound control can request a sorted result set from a data source control by setting the SortExpression property on the DataSourceSelectArguments object passed to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

Для сценариев разбиения по страницам элементы управления с привязкой к данным CanPage проверяют свойство представления источника данных во время DataSourceCapabilities.Page выполнения и добавляют возможность с помощью AddSupportedCapabilities(DataSourceCapabilities) метода.For paging scenarios, data-bound controls check a data source view's CanPage property at run time, and add a DataSourceCapabilities.Page capability using the AddSupportedCapabilities(DataSourceCapabilities) method. В качестве отдельной операции элемент управления с привязкой к данным может запрашивать подмножество данных из элемента управления источниками данных для разбиения StartRowIndex на MaximumRows страницы, устанавливая свойства и для Select(DataSourceSelectArguments, DataSourceViewSelectCallback) DataSourceSelectArguments объекта, передаваемого в метод.As a separate operation, the data-bound control can request a subset of data from a data source control for paging by setting the StartRowIndex and MaximumRows properties on the DataSourceSelectArguments object passed to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

Чтобы получить общее число строк для сценариев разбиения на страницы, элементы управления с привязкой к данным проверяют CanRetrieveTotalRowCount свойство представления источника данных во время выполнения и DataSourceCapabilities.RetrieveTotalRowCount добавляют AddSupportedCapabilities(DataSourceCapabilities) возможность с помощью метода.To retrieve a total row count for paging scenarios, data-bound controls check a data source view's CanRetrieveTotalRowCount property at run time, and add a DataSourceCapabilities.RetrieveTotalRowCount capability using the AddSupportedCapabilities(DataSourceCapabilities) method. В качестве отдельной операции элемент управления с привязкой к данным может запрашивать общее количество строк из элемента управления источниками данных для разбиения RetrieveTotalRowCount на страницы путем DataSourceSelectArguments задания свойства объекта, Select(DataSourceSelectArguments, DataSourceViewSelectCallback) передаваемого в метод.As a separate operation, the data-bound control can request a total row count from a data source control for paging by setting the RetrieveTotalRowCount property on the DataSourceSelectArguments object passed to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method. Когда метод возвращает значение, общее число строк содержится TotalRowCount в свойстве. Select(DataSourceSelectArguments, DataSourceViewSelectCallback)When the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method returns, the total row count is contained by the TotalRowCount property.

Важно!

Если задано какое DataSourceSelectArguments -либо из свойств, но текущий привязанный элемент управления источника данных не поддерживает запрошенную возможность InvalidOperationException , при вызове DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) метода создается исключение.If any of the DataSourceSelectArguments properties are set, but the currently bound data source control does not support the requested capability, an InvalidOperationException exception is thrown when the DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) method is called.

Конструкторы

DataSourceSelectArguments()

Инициализирует новый экземпляр по умолчанию класса DataSourceSelectArguments.Initializes a new default instance of the DataSourceSelectArguments class.

DataSourceSelectArguments(Int32, Int32)

Инициализирует новый экземпляр класса DataSourceSelectArguments с указанной стартовой позицией и числом строк, которые возвращаются для скриптов разбиения по страницам.Initializes a new instance of the DataSourceSelectArguments class with the specified starting position and number of rows to return for paging scenarios.

DataSourceSelectArguments(String)

Инициализирует новый экземпляр класса DataSourceSelectArguments с заданным условием сортировки.Initializes a new instance of the DataSourceSelectArguments class with the specified sort expression.

DataSourceSelectArguments(String, Int32, Int32)

Инициализирует новый экземпляр класса DataSourceSelectArguments с указанным выражением сортировки, стартовой позицией и числом строк, которые возвращаются для скриптов разбиения по страницам.Initializes a new instance of the DataSourceSelectArguments class with the specified sort expression, starting position, and number of rows to return for paging scenarios.

Свойства

Empty

Возвращает объект DataSourceSelectArguments с выражением сортировки, заданным в Empty.Gets a DataSourceSelectArguments object with the sort expression set to Empty.

MaximumRows

Возвращает или задает значение, представляющее максимальное число строк данных, которые возвращаются элементом управления источником данных для операции по извлечению данных.Gets or sets a value that represents the maximum number of data rows that a data source control returns for a data retrieval operation.

RetrieveTotalRowCount

Возвращает или задает значение, указывающее, извлекает ли элемент управления источником данных общее число строк в процессе операции по извлечению данных.Gets or sets a value indicating whether a data source control should retrieve a count of all the data rows during a data retrieval operation.

SortExpression

Возвращает или задает выражение, которое представление источника данных использует для сортировки данных, извлеченных методом Select(DataSourceSelectArguments, DataSourceViewSelectCallback).Gets or sets an expression that the data source view uses to sort the data retrieved by the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

StartRowIndex

Возвращает или задает значение, представляющее начальную позицию, которую использует элемент управления источника данных при извлечении строк в процессе операции по извлечению данных.Gets or sets a value that represents the starting position the data source control should use when retrieving data rows during a data retrieval operation.

TotalRowCount

Возвращает или задает число строк, которые извлекаются в процессе операции по извлечению данных.Gets or sets the number of rows retrieved during a data retrieval operation.

Методы

AddSupportedCapabilities(DataSourceCapabilities)

Добавляет одну возможность экземпляру DataSourceSelectArguments, используемому для сравнения поддерживаемых и запрошенных возможностей.Adds one capability to the DataSourceSelectArguments instance, which is used to compare supported capabilities and requested capabilities.

Equals(Object)

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

GetHashCode()

Возвращает хэш-код для типа DataSourceSelectArguments.Returns the hash code for the DataSourceSelectArguments type.

GetType()

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

(Унаследовано от Object)
MemberwiseClone()

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

(Унаследовано от Object)
RaiseUnsupportedCapabilitiesError(DataSourceView)

Сравнивает возможности, запрошенные для операции ExecuteSelect(DataSourceSelectArguments), с возможностями, поддерживаемыми указанным представлением источника данных.Compares the capabilities requested for an ExecuteSelect(DataSourceSelectArguments) operation against those that the specified data source view supports.

ToString()

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

(Унаследовано от Object)

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

Дополнительно