DataSourceSelectArguments Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Fournit un mécanisme que les contrôles liés aux données utilisent pour demander des opérations liées aux données à partir de contrôles de source de données lorsque les données sont récupérées. Cette classe ne peut pas être héritée.
public ref class DataSourceSelectArguments sealed
public sealed class DataSourceSelectArguments
type DataSourceSelectArguments = class
Public NotInheritable Class DataSourceSelectArguments
- Héritage
-
DataSourceSelectArguments
Remarques
Les contrôles liés aux données utilisent la classe pour demander qu’un contrôle de source de données effectue des opérations supplémentaires liées aux données sur un jeu de résultats, telles que le DataSourceSelectArguments tri des données ou le renvoi d’un sous-ensemble spécifique de données. Ces opérations liées aux données sont énumérées par l’énumération DataSourceCapabilities . Le tableau suivant indique comment la DataSourceSelectArguments classe prend en charge ces opérations liées aux données.
| Capacité | Propriétés DataSourceSelectArguments associées |
|---|---|
| DataSourceCapabilities.Sort | SortExpression |
| DataSourceCapabilities.Page | StartRowIndex, MaximumRows |
| DataSourceCapabilities.RetrieveTotalRowCount | RetrieveTotalRowCount, TotalRowCount |
Les contrôles liés aux données appellent explicitement la PerformSelect méthode pour lier des données, ce qui appelle la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode du contrôle de source de données auquel elles sont associées. De cette façon, le contrôle lié aux données récupère les données du contrôle de source de données à la demande. Étant donné que la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode accepte un DataSourceSelectArguments paramètre, le contrôle lié aux données est responsable de la création et de la gestion d’un DataSourceSelectArguments objet et de son passage à la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode lorsqu’elle récupère des données à partir du contrôle de source de données.
Dans certains cas, les contrôles liés aux données n’ont peut-être pas besoin de fonctionnalités supplémentaires liées aux données. Dans ce cas, les contrôles liés aux données passent un Empty objet arguments à la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode.
Pour les jeux de résultats triés, les contrôles liés aux données vérifient la propriété d’une vue de source de données au moment de l’exécution CanSort et ajoutent une DataSourceCapabilities.Sort fonctionnalité à l’aide de la AddSupportedCapabilities(DataSourceCapabilities) méthode. En tant qu’opération distincte, le contrôle lié aux données peut demander un jeu de résultats trié à partir d’un contrôle de source de données en définissant la SortExpression propriété sur l’objet DataSourceSelectArguments passé à la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode.
Pour les scénarios de pagination, les contrôles liés aux données vérifient la propriété d’une vue de source de données au moment de l’exécution CanPage et ajoutent une DataSourceCapabilities.Page fonctionnalité à l’aide de la AddSupportedCapabilities(DataSourceCapabilities) méthode. En tant qu’opération distincte, le contrôle lié aux données peut demander un sous-ensemble de données à partir d’un contrôle de source de données pour la pagination en définissant les propriétés et MaximumRows les StartRowIndex propriétés sur l’objet DataSourceSelectArguments transmis à la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode.
Pour récupérer un nombre total de lignes pour les scénarios de pagination, les contrôles liés aux données vérifient la propriété d’une vue de source de données au moment de l’exécution CanRetrieveTotalRowCount et ajoutent une DataSourceCapabilities.RetrieveTotalRowCount fonctionnalité à l’aide de la AddSupportedCapabilities(DataSourceCapabilities) méthode. En tant qu’opération distincte, le contrôle lié aux données peut demander un nombre total de lignes à partir d’un contrôle de source de données pour la pagination en définissant la RetrieveTotalRowCount propriété sur l’objet DataSourceSelectArguments passé à la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode. Lorsque la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode retourne, le nombre total de lignes est contenu par la TotalRowCount propriété.
Important
Si l’une DataSourceSelectArguments des propriétés est définie, mais que le contrôle de source de données actuellement lié ne prend pas en charge la fonctionnalité demandée, une InvalidOperationException exception est levée lorsque la DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) méthode est appelée.
Constructeurs
| Nom | Description |
|---|---|
| DataSourceSelectArguments() |
Initialise une nouvelle instance par défaut de la DataSourceSelectArguments classe. |
| DataSourceSelectArguments(Int32, Int32) |
Initialise une nouvelle instance de la DataSourceSelectArguments classe avec la position de départ spécifiée et le nombre de lignes à retourner pour les scénarios de pagination. |
| DataSourceSelectArguments(String, Int32, Int32) |
Initialise une nouvelle instance de la DataSourceSelectArguments classe avec l’expression de tri spécifiée, la position de départ et le nombre de lignes à retourner pour les scénarios de pagination. |
| DataSourceSelectArguments(String) |
Initialise une nouvelle instance de la DataSourceSelectArguments classe avec l’expression de tri spécifiée. |
Propriétés
| Nom | Description |
|---|---|
| Empty |
Obtient un DataSourceSelectArguments objet avec l’expression de tri définie sur Empty. |
| MaximumRows |
Obtient ou définit une valeur qui représente le nombre maximal de lignes de données retournées par un contrôle de source de données pour une opération de récupération de données. |
| RetrieveTotalRowCount |
Obtient ou définit une valeur indiquant si un contrôle de source de données doit récupérer le nombre de toutes les lignes de données pendant une opération de récupération de données. |
| SortExpression |
Obtient ou définit une expression utilisée par la vue de source de données pour trier les données récupérées par la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode. |
| StartRowIndex |
Obtient ou définit une valeur qui représente la position de départ que le contrôle de source de données doit utiliser lors de la récupération de lignes de données pendant une opération de récupération de données. |
| TotalRowCount |
Obtient ou définit le nombre de lignes récupérées pendant une opération de récupération de données. |
Méthodes
| Nom | Description |
|---|---|
| AddSupportedCapabilities(DataSourceCapabilities) |
Ajoute une fonctionnalité à l’instance DataSourceSelectArguments , utilisée pour comparer les fonctionnalités prises en charge et les fonctionnalités demandées. |
| Equals(Object) |
Détermine si l’instance spécifiée DataSourceSelectArguments est égale à l’instance actuelle. |
| GetHashCode() |
Retourne le code de hachage pour le DataSourceSelectArguments type. |
| GetType() |
Obtient la Type de l’instance actuelle. (Hérité de Object) |
| MemberwiseClone() |
Crée une copie superficielle du Objectactuel. (Hérité de Object) |
| RaiseUnsupportedCapabilitiesError(DataSourceView) |
Compare les fonctionnalités demandées pour une ExecuteSelect(DataSourceSelectArguments) opération par rapport à celles prises en charge par la vue de source de données spécifiée. |
| ToString() |
Retourne une chaîne qui représente l’objet actuel. (Hérité de Object) |