DataSourceSelectArguments Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет механизм, используемый элементами управления с привязкой к данным для запроса операций, связанных с данными, из элементов управления источниками данных при получении данных. Этот класс не может быть унаследован.
public ref class DataSourceSelectArguments sealed
public sealed class DataSourceSelectArguments
type DataSourceSelectArguments = class
Public NotInheritable Class DataSourceSelectArguments
- Наследование
-
DataSourceSelectArguments
Комментарии
Элементы управления, связанные с данными, используют DataSourceSelectArguments класс для запроса на выполнение дополнительных операций, связанных с данными, в результирующем наборе, таких как сортировка данных или возврат определенного подмножества данных. Эти операции, связанные с данными, перечисляются DataSourceCapabilities перечислением. В следующей таблице показано, как DataSourceSelectArguments класс поддерживает эти операции, связанные с данными.
| Функциональность | Связанные свойства DataSourceSelectArguments |
|---|---|
| DataSourceCapabilities.Sort | SortExpression |
| DataSourceCapabilities.Page | StartRowIndex, MaximumRows |
| DataSourceCapabilities.RetrieveTotalRowCount | RetrieveTotalRowCount, TotalRowCount |
Элементы управления, связанные с данными, явно вызывают PerformSelect метод привязки данных, который вызывает Select(DataSourceSelectArguments, DataSourceViewSelectCallback) метод элемента управления источниками данных, с которым они связаны. Таким образом, элемент управления с привязкой к данным извлекает данные из элемента управления источниками данных по запросу. Select(DataSourceSelectArguments, DataSourceViewSelectCallback) Так как метод принимает DataSourceSelectArguments параметр, элемент управления привязкой к данным отвечает за создание объекта и управление DataSourceSelectArguments им и передачу его Select(DataSourceSelectArguments, DataSourceViewSelectCallback) методу при получении данных из элемента управления источниками данных.
В некоторых случаях элементы управления с привязкой к данным могут не нуждаться в дополнительных возможностях, связанных с данными. В этом случае элементы управления с привязкой Empty к данным передают объект аргументов методу Select(DataSourceSelectArguments, DataSourceViewSelectCallback) .
Для отсортированных результирующих наборов элементы управления с привязкой к данным проверяют свойство представления CanSort источника данных во время выполнения и добавляют DataSourceCapabilities.Sort возможность с помощью AddSupportedCapabilities(DataSourceCapabilities) метода. В качестве отдельной операции элемент управления с привязкой к данным может запрашивать отсортированный результирующий набор из элемента управления источником данных, задав SortExpression свойство DataSourceSelectArguments объекта, переданного методу Select(DataSourceSelectArguments, DataSourceViewSelectCallback) .
В сценариях разбиения по страницам элементы управления с привязкой к данным проверяют свойство представления CanPage источника данных во время выполнения и добавляют DataSourceCapabilities.Page возможность с помощью AddSupportedCapabilities(DataSourceCapabilities) метода. В качестве отдельной операции элемент управления с привязкой к данным может запрашивать подмножество данных из элемента управления источником данных для разбиения по страницам, задав StartRowIndexMaximumRows свойства DataSourceSelectArguments объекта, переданного методу Select(DataSourceSelectArguments, DataSourceViewSelectCallback) .
Чтобы получить общее количество строк для сценариев разбиения на страницы, элементы управления с привязкой к данным проверяют свойство представления CanRetrieveTotalRowCount источника данных во время выполнения и добавляют DataSourceCapabilities.RetrieveTotalRowCount возможность с помощью AddSupportedCapabilities(DataSourceCapabilities) метода. В качестве отдельной операции элемент управления с привязкой к данным может запрашивать общее число строк из элемента управления источником данных для разбиения по страницам, задав RetrieveTotalRowCount свойство DataSourceSelectArguments объекта, переданного методу Select(DataSourceSelectArguments, DataSourceViewSelectCallback) . При возврате Select(DataSourceSelectArguments, DataSourceViewSelectCallback) метода общее число строк содержится свойством TotalRowCount .
Это важно
Если задано какое-либо из DataSourceSelectArguments свойств, но в настоящее время привязанный элемент управления источниками данных не поддерживает запрошенную возможность, InvalidOperationException при вызове метода возникает DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) исключение.
Конструкторы
| Имя | Описание |
|---|---|
| DataSourceSelectArguments() |
Инициализирует новый экземпляр DataSourceSelectArguments класса по умолчанию. |
| DataSourceSelectArguments(Int32, Int32) |
Инициализирует новый экземпляр DataSourceSelectArguments класса с указанным начальным положением и количеством строк, возвращаемых для сценариев разбиения по страницам. |
| DataSourceSelectArguments(String, Int32, Int32) |
Инициализирует новый экземпляр DataSourceSelectArguments класса с указанным выражением сортировки, начальной позицией и количеством строк, возвращаемых для сценариев разбиения по страницам. |
| DataSourceSelectArguments(String) |
Инициализирует новый экземпляр DataSourceSelectArguments класса с указанным выражением сортировки. |
Свойства
| Имя | Описание |
|---|---|
| Empty |
Возвращает объект с набором DataSourceSelectArgumentsEmptyвыражений сортировки. |
| MaximumRows |
Возвращает или задает значение, представляющее максимальное количество строк данных, возвращаемых элементом управления версиями данных для операции извлечения данных. |
| RetrieveTotalRowCount |
Возвращает или задает значение, указывающее, должен ли элемент управления источником данных получить количество всех строк данных во время операции извлечения данных. |
| SortExpression |
Возвращает или задает выражение, которое используется представлением источника данных для сортировки данных, полученных методом Select(DataSourceSelectArguments, DataSourceViewSelectCallback) . |
| StartRowIndex |
Возвращает или задает значение, представляющее начальную позицию элемента управления источником данных, следует использовать при получении строк данных во время операции извлечения данных. |
| TotalRowCount |
Возвращает или задает количество строк, полученных во время операции извлечения данных. |
Методы
| Имя | Описание |
|---|---|
| AddSupportedCapabilities(DataSourceCapabilities) |
Добавляет одну возможность в DataSourceSelectArguments экземпляр, который используется для сравнения поддерживаемых возможностей и запрошенных возможностей. |
| Equals(Object) |
Определяет, равен ли указанный DataSourceSelectArguments экземпляр текущему экземпляру. |
| GetHashCode() |
Возвращает хэш-код для DataSourceSelectArguments типа. |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| RaiseUnsupportedCapabilitiesError(DataSourceView) |
Сравнивает возможности, запрошенные для ExecuteSelect(DataSourceSelectArguments) операции, с теми, которые поддерживает указанное представление источника данных. |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |