DataSourceSelectArguments 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
提供一种机制,数据绑定控件可使用这种机制向数据源控件请求在检索数据之后执行与数据相关的操作。 此类不能被继承。
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)传递给 方法。
在某些情况下,数据绑定控件可能不需要任何其他与数据相关的功能。 在这种情况下,数据绑定控件将参数对象传递给 EmptySelect(DataSourceSelectArguments, DataSourceViewSelectCallback) 方法。
对于排序的结果集,数据绑定控件在运行时检查数据源视图的属性CanSort,并使用 AddSupportedCapabilities(DataSourceCapabilities) 方法添加DataSourceCapabilities.Sort功能。 作为一个单独的操作,数据绑定控件可以通过设置SortExpression传递给 Select(DataSourceSelectArguments, DataSourceViewSelectCallback) 方法的 DataSourceSelectArguments 对象的 属性,从数据源控件请求排序的结果集。
对于分页方案,数据绑定控件在运行时检查数据源视图的属性CanPage,并使用 AddSupportedCapabilities(DataSourceCapabilities) 方法添加DataSourceCapabilities.Page功能。 作为一个单独的操作,数据绑定控件可以通过设置StartRowIndex传递给 Select(DataSourceSelectArguments, DataSourceViewSelectCallback) 方法的 对象的 和 MaximumRows 属性DataSourceSelectArguments,从数据源控件请求一部分数据进行分页。
若要检索分页方案的总行计数,数据绑定控件在运行时检查数据源视图的属性CanRetrieveTotalRowCount,并使用 方法添加DataSourceCapabilities.RetrieveTotalRowCount功能AddSupportedCapabilities(DataSourceCapabilities)。 作为一个单独的操作,数据绑定控件可以通过设置RetrieveTotalRowCount传递给 Select(DataSourceSelectArguments, DataSourceViewSelectCallback) 方法的对象DataSourceSelectArguments上的 属性,从数据源控件请求总行计数进行分页。 Select(DataSourceSelectArguments, DataSourceViewSelectCallback)方法返回时,总行计数由 TotalRowCount 属性包含。
重要
如果设置了任何 DataSourceSelectArguments 属性,但当前绑定的数据源控件不支持请求的功能, InvalidOperationException 则在调用 方法时 DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) 将引发异常。
构造函数
DataSourceSelectArguments() |
初始化 DataSourceSelectArguments 类的新默认实例。 |
DataSourceSelectArguments(Int32, Int32) |
使用要为分页方案返回的起始位置和行数初始化 DataSourceSelectArguments 类的新实例。 |
DataSourceSelectArguments(String) |
使用指定的排序表达式初始化 DataSourceSelectArguments 类的新实例。 |
DataSourceSelectArguments(String, Int32, Int32) |
使用要为分页方案返回的指定排序表达式、起始位置和行数初始化 DataSourceSelectArguments 类的新实例。 |
属性
Empty |
获取一个排序表达式设置为 DataSourceSelectArguments 的 Empty 对象。 |
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) |