DataSourceSelectArguments Class

Definition

Fournit un mécanisme utilisé par les contrôles liés aux données pour demander aux contrôles de source de données d'exécuter des opérations liées aux données, lors de la récupération de données.Provides a mechanism that data-bound controls use to request data-related operations from data source controls when data is retrieved. Cette classe ne peut pas être héritée.This class cannot be inherited.

public ref class DataSourceSelectArguments sealed
public sealed class DataSourceSelectArguments
type DataSourceSelectArguments = class
Public NotInheritable Class DataSourceSelectArguments
Inheritance
DataSourceSelectArguments

Remarks

Les contrôles liés aux données utilisent DataSourceSelectArguments la classe pour demander à ce 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 tri des données ou le retour d’un sous-ensemble spécifique de données.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. Ces opérations liées aux données sont énumérées par l' DataSourceCapabilities énumération.These data-related operations are enumerated by the DataSourceCapabilities enumeration. Le tableau suivant indique comment la DataSourceSelectArguments classe prend en charge ces opérations liées aux données.The following table indicates how the DataSourceSelectArguments class supports these data-related operations.

FonctionnalitéCapability Propriétés DataSourceSelectArguments associéesRelated DataSourceSelectArguments properties
DataSourceCapabilities.Sort SortExpression
DataSourceCapabilities.Page StartRowIndex, MaximumRowsStartRowIndex, MaximumRows
DataSourceCapabilities.RetrieveTotalRowCount RetrieveTotalRowCount, TotalRowCountRetrieveTotalRowCount, TotalRowCount

Les contrôles liés aux données appellent explicitement PerformSelect la méthode pour lier des données, qui Select(DataSourceSelectArguments, DataSourceViewSelectCallback) appelle la méthode du contrôle de source de données auquel elles sont associées.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. 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.In this way, the data-bound control retrieves data from the data source control on demand. Étant donné Select(DataSourceSelectArguments, DataSourceViewSelectCallback) que la méthode DataSourceSelectArguments accepte un paramètre, le contrôle lié aux données est chargé de créer et DataSourceSelectArguments de gérer un objet et de Select(DataSourceSelectArguments, DataSourceViewSelectCallback) le passer à la méthode lorsqu’il récupère des données du contrôle de source de données.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.

Dans certains cas, les contrôles liés aux données peuvent ne pas avoir besoin de fonctionnalités supplémentaires liées aux données.In some cases, data-bound controls might not need any additional data-related capabilities. Dans ce cas, les contrôles liés aux données passent Empty un objet d’arguments Select(DataSourceSelectArguments, DataSourceViewSelectCallback) à la méthode.In this case, data-bound controls pass an Empty arguments object to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

Pour les jeux de résultats triés, les contrôles liés aux données vérifient CanSort la propriété d’une vue de source de DataSourceCapabilities.Sort données au moment AddSupportedCapabilities(DataSourceCapabilities) de l’exécution et ajoutent une fonctionnalité à l’aide de la méthode.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. Dans le cadre d’une opération distincte, le contrôle lié aux données peut demander un jeu de résultats trié à partir d’un SortExpression contrôle de source DataSourceSelectArguments de données en définissant la propriété sur l’objet passé à la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode.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.

Pour les scénarios de pagination, les contrôles liés aux données vérifient la CanPage propriété d’une vue de source de données DataSourceCapabilities.Page au moment de AddSupportedCapabilities(DataSourceCapabilities) l’exécution et ajoutent une fonctionnalité à l’aide de la méthode.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. Dans le cadre d’une opération distincte, le contrôle lié aux données peut demander un sous-ensemble de données à partir d’un contrôle StartRowIndex de source de données DataSourceSelectArguments pour la pagination en Select(DataSourceSelectArguments, DataSourceViewSelectCallback) définissant les propriétés et MaximumRows sur l’objet passé à la méthode.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.

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 CanRetrieveTotalRowCount la propriété d’une vue de source de DataSourceCapabilities.RetrieveTotalRowCount données au moment AddSupportedCapabilities(DataSourceCapabilities) de l’exécution et ajoutent une fonctionnalité à l’aide de la méthode.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. Dans le cadre d’une opération distincte, le contrôle lié aux données peut demander un nombre total de lignes à partir d’un contrôle de RetrieveTotalRowCount source de données DataSourceSelectArguments pour la pagination en Select(DataSourceSelectArguments, DataSourceViewSelectCallback) définissant la propriété sur l’objet passé à la méthode.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. Lorsque la Select(DataSourceSelectArguments, DataSourceViewSelectCallback) méthode retourne, le nombre total de lignes est contenu par TotalRowCount la propriété.When the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method returns, the total row count is contained by the TotalRowCount property.

Important

Si l’une des DataSourceSelectArguments propriétés est définie, mais que le contrôle de source de données actuellement lié ne prend pas en charge InvalidOperationException la fonctionnalité demandée, une DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) exception est levée lorsque la méthode est appelée.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.

Constructors

DataSourceSelectArguments()

Initialise une nouvelle instance par défaut de la classe DataSourceSelectArguments.Initializes a new default instance of the DataSourceSelectArguments class.

DataSourceSelectArguments(Int32, Int32)

Initialise une nouvelle instance de la classe DataSourceSelectArguments avec la position de départ spécifiée et le nombre de lignes à retourner pour les scénarios de pagination.Initializes a new instance of the DataSourceSelectArguments class with the specified starting position and number of rows to return for paging scenarios.

DataSourceSelectArguments(String)

Initialise une nouvelle instance de la classe DataSourceSelectArguments avec l'expression de tri spécifiée.Initializes a new instance of the DataSourceSelectArguments class with the specified sort expression.

DataSourceSelectArguments(String, Int32, Int32)

Initialise une nouvelle instance de la classe DataSourceSelectArguments avec l'expression de tri spécifiée, la position de départ et le nombre de lignes à retourner pour des scénarios de pagination.Initializes a new instance of the DataSourceSelectArguments class with the specified sort expression, starting position, and number of rows to return for paging scenarios.

Properties

Empty

Obtient un objet DataSourceSelectArguments dont la valeur de l'expression de tri est Empty.Gets a DataSourceSelectArguments object with the sort expression set to Empty.

MaximumRows

Obtient ou définit une valeur qui représente le nombre maximal de lignes de données qu'un contrôle de source de données retourne lors d'une opération de récupération de données.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

Obtient ou définit une valeur qui indique si un contrôle de source de données doit récupérer toutes les lignes de données lors d'une opération de récupération de données.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

Obtient ou définit une expression utilisée par l'affichage de source de données pour trier les données récupérées par la méthode 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

Obtient ou définit une valeur qui représente la position de départ devant être utilisée par le contrôle de source de données pour récupérer des lignes de données lors d'une opération de récupération de données.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

Obtient ou définit le nombre de lignes récupérées lors d'une opération de récupération de données.Gets or sets the number of rows retrieved during a data retrieval operation.

Methods

AddSupportedCapabilities(DataSourceCapabilities)

Ajoute une fonction à l'instance de DataSourceSelectArguments qui est utilisée pour comparer des fonctions prises en charge et des fonctions demandées.Adds one capability to the DataSourceSelectArguments instance, which is used to compare supported capabilities and requested capabilities.

Equals(Object)

Détermine si l'instance spécifiée DataSourceSelectArguments équivaut à l'instance actuelle.Determines whether the specified DataSourceSelectArguments instance is equal to the current instance.

GetHashCode()

Retourne le code de hachage pour le type DataSourceSelectArguments.Returns the hash code for the DataSourceSelectArguments type.

GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
RaiseUnsupportedCapabilitiesError(DataSourceView)

Compare les fonctions demandées pour une opération ExecuteSelect(DataSourceSelectArguments) par rapport à celles prises en charge par l'affichage de source de données spécifié.Compares the capabilities requested for an ExecuteSelect(DataSourceSelectArguments) operation against those that the specified data source view supports.

ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also