DataSourceSelectArguments Klasa

Definicja

Zapewnia mechanizm używany przez kontrolki powiązane z danymi w celu żądania operacji związanych z danymi z kontrolek źródła danych podczas pobierania danych. Klasa ta nie może być dziedziczona.

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

Uwagi

Kontrolki powiązane z danymi używają DataSourceSelectArguments klasy do żądania, aby kontrolka źródła danych wykonywała dodatkowe operacje związane z danymi w zestawie wyników, takie jak sortowanie danych lub zwracanie określonego podzestawu danych. Te operacje związane z danymi są wyliczane przez DataSourceCapabilities wyliczenie. Poniższa tabela wskazuje, jak DataSourceSelectArguments klasa obsługuje te operacje związane z danymi.

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

Kontrolki powiązane z danymi jawnie wywołają metodę PerformSelect , aby powiązać dane, co wywołuje Select(DataSourceSelectArguments, DataSourceViewSelectCallback) metodę kontroli źródła danych, z którą są skojarzone. W ten sposób kontrolka powiązana z danymi pobiera dane z kontroli źródła danych na żądanie. Select(DataSourceSelectArguments, DataSourceViewSelectCallback) Ponieważ metoda akceptuje DataSourceSelectArguments parametr, kontrolka powiązana z danymi jest odpowiedzialna za tworzenie obiektu i zarządzanie DataSourceSelectArguments nim oraz przekazywanie go do Select(DataSourceSelectArguments, DataSourceViewSelectCallback) metody podczas pobierania danych z kontroli źródła danych.

W niektórych przypadkach kontrolki powiązane z danymi mogą nie potrzebować żadnych dodatkowych funkcji związanych z danymi. W tym przypadku kontrolki powiązane z danymi przekazują Empty obiekt argumentów do Select(DataSourceSelectArguments, DataSourceViewSelectCallback) metody .

W przypadku posortowanych zestawów wyników kontrolki powiązane z danymi sprawdzają właściwość widoku CanSort źródła danych w czasie wykonywania i dodają DataSourceCapabilities.Sort możliwość przy użyciu AddSupportedCapabilities(DataSourceCapabilities) metody . W ramach oddzielnej operacji kontrolka powiązana z danymi może zażądać posortowanego zestawu wyników z kontrolki źródła danych, ustawiając SortExpression właściwość na DataSourceSelectArguments obiekcie przekazanym Select(DataSourceSelectArguments, DataSourceViewSelectCallback) do metody .

W przypadku scenariuszy stronicowania kontrolki powiązane z danymi sprawdzają właściwość widoku CanPage źródła danych w czasie wykonywania i dodają DataSourceCapabilities.Page możliwość przy użyciu AddSupportedCapabilities(DataSourceCapabilities) metody . W ramach oddzielnej operacji kontrolka powiązana z danymi może zażądać podzestawu danych z kontrolki źródła danych na potrzeby stronicowania, ustawiając StartRowIndex właściwości i MaximumRows na DataSourceSelectArguments obiekcie przekazanym Select(DataSourceSelectArguments, DataSourceViewSelectCallback) do metody .

Aby pobrać łączną liczbę wierszy dla scenariuszy stronicowania, kontrolki powiązane z danymi sprawdzają właściwość widoku CanRetrieveTotalRowCount źródła danych w czasie wykonywania i dodają DataSourceCapabilities.RetrieveTotalRowCount możliwość przy użyciu AddSupportedCapabilities(DataSourceCapabilities) metody . W ramach oddzielnej operacji kontrolka powiązana z danymi może zażądać łącznej liczby wierszy z kontrolki źródła danych na potrzeby stronicowania, ustawiając RetrieveTotalRowCount właściwość obiektu DataSourceSelectArguments przekazanego Select(DataSourceSelectArguments, DataSourceViewSelectCallback) do metody . Select(DataSourceSelectArguments, DataSourceViewSelectCallback) Gdy metoda zwraca wartość , łączna liczba wierszy jest zawarta TotalRowCount przez właściwość .

Ważne

Jeśli którakolwiek z DataSourceSelectArguments właściwości jest ustawiona, ale obecnie powiązana kontrola źródła danych nie obsługuje żądanej możliwości, InvalidOperationException zgłaszany jest wyjątek po wywołaniu DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) metody.

Konstruktory

DataSourceSelectArguments()

Inicjuje DataSourceSelectArguments nowe domyślne wystąpienie klasy.

DataSourceSelectArguments(Int32, Int32)

Inicjuje DataSourceSelectArguments nowe wystąpienie klasy z określoną pozycją początkową i liczbą wierszy do zwrócenia w scenariuszach stronicowania.

DataSourceSelectArguments(String)

Inicjuje DataSourceSelectArguments nowe wystąpienie klasy za pomocą określonego wyrażenia sortowania.

DataSourceSelectArguments(String, Int32, Int32)

Inicjuje DataSourceSelectArguments nowe wystąpienie klasy z określonym wyrażeniem sortowania, pozycją początkową i liczbą wierszy, które mają być zwracane w scenariuszach stronicowania.

Właściwości

Empty

Pobiera obiekt z wyrażeniem DataSourceSelectArguments sortowania ustawionym na Empty.

MaximumRows

Pobiera lub ustawia wartość reprezentującą maksymalną liczbę wierszy danych zwracanych przez kontrolkę źródła danych dla operacji pobierania danych.

RetrieveTotalRowCount

Pobiera lub ustawia wartość wskazującą, czy kontrolka źródła danych powinna pobrać liczbę wszystkich wierszy danych podczas operacji pobierania danych.

SortExpression

Pobiera lub ustawia wyrażenie używane przez widok źródła danych do sortowania danych pobranych przez metodę Select(DataSourceSelectArguments, DataSourceViewSelectCallback) .

StartRowIndex

Pobiera lub ustawia wartość reprezentującą pozycję początkową kontrolki źródła danych, która powinna być używana podczas pobierania wierszy danych podczas operacji pobierania danych.

TotalRowCount

Pobiera lub ustawia liczbę wierszy pobranych podczas operacji pobierania danych.

Metody

AddSupportedCapabilities(DataSourceCapabilities)

Dodaje jedną możliwość do DataSourceSelectArguments wystąpienia, która służy do porównywania obsługiwanych możliwości i żądanych możliwości.

Equals(Object)

Określa, czy określone DataSourceSelectArguments wystąpienie jest równe bieżącemu wystąpieniu.

GetHashCode()

Zwraca kod skrótu DataSourceSelectArguments dla typu.

GetType()

Type Pobiera wartość bieżącego wystąpienia.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
RaiseUnsupportedCapabilitiesError(DataSourceView)

Porównuje możliwości żądane dla ExecuteSelect(DataSourceSelectArguments) operacji z tymi, które obsługuje określony widok źródła danych.

ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)

Dotyczy

Zobacz też