DataSourceSelectArguments Klasa

Definicja

Zapewnia mechanizm, który kontroluje powiązane z danymi operacje związane z danymi z formantów źródła danych, gdy pobierane są dane.Provides a mechanism that data-bound controls use to request data-related operations from data source controls when data is retrieved. Klasa ta nie może być dziedziczona.This class cannot be inherited.

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

Uwagi

Formanty powiązane z danymi używają DataSourceSelectArguments klasy do żądania, aby kontrola źródła danych wykonywała dodatkowe operacje związane z danymi na zestawie wyników, takie jak sortowanie danych lub zwracanie określonego podzestawu danych.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. Te operacje związane z danymi są wyliczane przez DataSourceCapabilities Wyliczenie.These data-related operations are enumerated by the DataSourceCapabilities enumeration. Poniższa tabela wskazuje, jak DataSourceSelectArguments Klasa obsługuje te operacje związane z danymi.The following table indicates how the DataSourceSelectArguments class supports these data-related operations.

MożliwośćCapability Powiązane właściwości DataSourceSelectArgumentsRelated DataSourceSelectArguments properties
DataSourceCapabilities.Sort SortExpression
DataSourceCapabilities.Page StartRowIndex, MaximumRowsStartRowIndex, MaximumRows
DataSourceCapabilities.RetrieveTotalRowCount RetrieveTotalRowCount, TotalRowCountRetrieveTotalRowCount, TotalRowCount

Formanty powiązane z danymi jawnie wywołują PerformSelect metodę, aby powiązać dane, która wywołuje Select(DataSourceSelectArguments, DataSourceViewSelectCallback) metodę kontroli źródła danych, z którą są skojarzone.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. W ten sposób formant powiązany z danymi pobiera dane z kontroli źródła danych na żądanie.In this way, the data-bound control retrieves data from the data source control on demand. Ponieważ Select(DataSourceSelectArguments, DataSourceViewSelectCallback) Metoda akceptuje DataSourceSelectArguments parametr, formant powiązany z danymi jest odpowiedzialny za utworzenie obiektu i zarządzanie DataSourceSelectArguments nim i przekazanie go do metody, Select(DataSourceSelectArguments, DataSourceViewSelectCallback) gdy pobiera dane z kontroli źródła danych.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.

W niektórych przypadkach formanty powiązane z danymi mogą nie potrzebować dodatkowych możliwości związanych z danymi.In some cases, data-bound controls might not need any additional data-related capabilities. W takim przypadku formanty powiązane z danymi przekazują Empty obiekt arguments do Select(DataSourceSelectArguments, DataSourceViewSelectCallback) metody.In this case, data-bound controls pass an Empty arguments object to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

W przypadku posortowanych zestawów wyników formanty powiązane z danymi sprawdzają właściwość widoku źródła danych CanSort w czasie wykonywania i dodają DataSourceCapabilities.Sort funkcję przy użyciu AddSupportedCapabilities(DataSourceCapabilities) metody.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. W ramach osobnej operacji formant powiązany z danymi może zażądać posortowanego zestawu wyników z kontroli źródła danych przez ustawienie SortExpression właściwości DataSourceSelectArguments obiektu przekazaną do Select(DataSourceSelectArguments, DataSourceViewSelectCallback) metody.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.

W przypadku scenariuszy stronicowania formanty powiązane z danymi sprawdzają właściwość widoku źródła danych CanPage w czasie wykonywania i dodają DataSourceCapabilities.Page funkcję przy użyciu AddSupportedCapabilities(DataSourceCapabilities) metody.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. W ramach osobnej operacji formant powiązany z danymi może zażądać podzestawu danych z kontroli źródła danych na potrzeby stronicowania przez ustawienie StartRowIndex MaximumRows właściwości i DataSourceSelectArguments obiektu przekazaną na Select(DataSourceSelectArguments, DataSourceViewSelectCallback) metodę.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.

Aby pobrać całkowitą liczbę wierszy dla scenariuszy stronicowania, formanty powiązane z danymi sprawdzają właściwość widoku źródła danych CanRetrieveTotalRowCount w czasie wykonywania i dodają DataSourceCapabilities.RetrieveTotalRowCount możliwość przy użyciu AddSupportedCapabilities(DataSourceCapabilities) metody.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. W ramach osobnej operacji formant powiązany z danymi może zażądać całkowitej liczby wierszy od kontroli źródła danych na potrzeby stronicowania, ustawiając RetrieveTotalRowCount Właściwość DataSourceSelectArguments obiektu przekazaną na Select(DataSourceSelectArguments, DataSourceViewSelectCallback) metodę.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. Gdy Select(DataSourceSelectArguments, DataSourceViewSelectCallback) Metoda zwraca, Łączna liczba wierszy jest zawarta w TotalRowCount właściwości.When the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method returns, the total row count is contained by the TotalRowCount property.

Ważne

Jeśli dowolna z DataSourceSelectArguments właściwości jest ustawiona, ale aktualnie powiązane kontrolka źródła danych nie obsługuje żądanych możliwości, InvalidOperationException wyjątek jest zgłaszany, gdy DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) wywoływana jest metoda.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.

Konstruktory

DataSourceSelectArguments()

Inicjuje nowe wystąpienie domyślne DataSourceSelectArguments klasy.Initializes a new default instance of the DataSourceSelectArguments class.

DataSourceSelectArguments(Int32, Int32)

Inicjuje nowe wystąpienie DataSourceSelectArguments klasy z określoną pozycją początkową i liczbą wierszy do zwrócenia dla scenariuszy stronicowania.Initializes a new instance of the DataSourceSelectArguments class with the specified starting position and number of rows to return for paging scenarios.

DataSourceSelectArguments(String)

Inicjuje nowe wystąpienie DataSourceSelectArguments klasy z określonym wyrażeniem sortowania.Initializes a new instance of the DataSourceSelectArguments class with the specified sort expression.

DataSourceSelectArguments(String, Int32, Int32)

Inicjuje nowe wystąpienie DataSourceSelectArguments klasy z określonym wyrażeniem sortowania, początkową pozycją i liczbą wierszy do zwrócenia dla scenariuszy stronicowania.Initializes a new instance of the DataSourceSelectArguments class with the specified sort expression, starting position, and number of rows to return for paging scenarios.

Właściwości

Empty

Pobiera DataSourceSelectArguments obiekt z wyrażeniem sortowania ustawionym na wartość Empty .Gets a DataSourceSelectArguments object with the sort expression set to Empty.

MaximumRows

Pobiera lub ustawia wartość reprezentującą maksymalną liczbę wierszy danych zwracanych przez kontrolkę źródła danych dla operacji pobierania danych.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

Pobiera lub ustawia wartość wskazującą, czy kontrolka źródła danych ma pobierać liczbę wszystkich wierszy danych podczas operacji pobierania danych.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

Pobiera lub ustawia wyrażenie używane przez widok źródła danych do sortowania danych pobranych przez Select(DataSourceSelectArguments, DataSourceViewSelectCallback) metodę.Gets or sets an expression that the data source view uses to sort the data retrieved by the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) method.

StartRowIndex

Pobiera lub ustawia wartość reprezentującą pozycję początkową, która ma być używana przez formant źródła danych podczas pobierania wierszy danych podczas operacji pobierania danych.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

Pobiera lub ustawia liczbę wierszy pobranych podczas operacji pobierania danych.Gets or sets the number of rows retrieved during a data retrieval operation.

Metody

AddSupportedCapabilities(DataSourceCapabilities)

Dodaje jedną funkcję do DataSourceSelectArguments wystąpienia, która jest używana do porównywania obsługiwanych możliwości i żądanych możliwości.Adds one capability to the DataSourceSelectArguments instance, which is used to compare supported capabilities and requested capabilities.

Equals(Object)

Określa, czy określone DataSourceSelectArguments wystąpienie jest równe bieżącemu wystąpieniu.Determines whether the specified DataSourceSelectArguments instance is equal to the current instance.

GetHashCode()

Zwraca kod skrótu dla DataSourceSelectArguments typu.Returns the hash code for the DataSourceSelectArguments type.

GetType()

Pobiera Type bieżące wystąpienie.Gets the Type of the current instance.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy skróconą kopię bieżącego elementu Object .Creates a shallow copy of the current Object.

(Odziedziczone po Object)
RaiseUnsupportedCapabilitiesError(DataSourceView)

Porównuje możliwości wymagane dla ExecuteSelect(DataSourceSelectArguments) operacji względem tych, które obsługuje określony widok źródła danych.Compares the capabilities requested for an ExecuteSelect(DataSourceSelectArguments) operation against those that the specified data source view supports.

ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)

Dotyczy

Zobacz też