DataSourceSelectArguments Classe

  • Referência

Definição

Namespace:
System.Web.UI
Assembly:
System.Web.dll

Fornece um mecanismo que os controles associados a dados usam para solicitar operações relacionadas a dados de controles da fonte de dados quando os dados são recuperados. Essa classe não pode ser herdada.

public ref class DataSourceSelectArguments sealed
public sealed class DataSourceSelectArguments
type DataSourceSelectArguments = class
Public NotInheritable Class DataSourceSelectArguments
Herança
Object
DataSourceSelectArguments

Comentários

Os controles associados a dados usam a DataSourceSelectArguments classe para solicitar que um controle de fonte de dados execute operações adicionais relacionadas a dados em um conjunto de resultados, como classificar os dados ou retornar um subconjunto específico de dados. Essas operações relacionadas a dados são enumeradas pela DataSourceCapabilities enumeração . A tabela a seguir indica como a classe dá suporte a DataSourceSelectArguments essas operações relacionadas a dados.

Funcionalidade Propriedades de DataSourceSelectArguments relacionadas
DataSourceCapabilities.Sort SortExpression
DataSourceCapabilities.Page StartRowIndex, MaximumRows
DataSourceCapabilities.RetrieveTotalRowCount RetrieveTotalRowCount, TotalRowCount

Os controles associados a dados chamam explicitamente o PerformSelect método para associar dados, que chama o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método do controle da fonte de dados ao qual estão associados. Dessa forma, o controle associado a dados recupera dados do controle da fonte de dados sob demanda. Como o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método aceita um DataSourceSelectArguments parâmetro, o controle associado a dados é responsável por criar e gerenciar um DataSourceSelectArguments objeto e passá-lo para o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método quando recupera dados do controle da fonte de dados.

Em alguns casos, os controles associados a dados podem não precisar de recursos adicionais relacionados a dados. Nesse caso, os controles associados a dados passam um Empty objeto arguments para o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método .

Para conjuntos de resultados classificados, os controles associados a dados marcar a propriedade de uma exibição de fonte de CanSort dados em tempo de execução e adicionam uma DataSourceCapabilities.Sort funcionalidade usando o AddSupportedCapabilities(DataSourceCapabilities) método . Como uma operação separada, o controle associado a dados pode solicitar um conjunto de resultados classificado de um controle de fonte de dados definindo a SortExpression propriedade no DataSourceSelectArguments objeto passado para o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método .

Para cenários de paginação, os controles associados a dados marcar a propriedade de uma exibição de fonte de CanPage dados em tempo de execução e adicionam uma DataSourceCapabilities.Page funcionalidade usando o AddSupportedCapabilities(DataSourceCapabilities) método . Como uma operação separada, o controle associado a dados pode solicitar um subconjunto de dados de um controle de fonte de dados para paginação definindo as StartRowIndex propriedades e MaximumRows no DataSourceSelectArguments objeto passado para o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método .

Para recuperar uma contagem total de linhas para cenários de paginação, os controles associados a dados marcar a propriedade de uma exibição de fonte de CanRetrieveTotalRowCount dados em tempo de execução e adicionar uma DataSourceCapabilities.RetrieveTotalRowCount funcionalidade usando o AddSupportedCapabilities(DataSourceCapabilities) método . Como uma operação separada, o controle associado a dados pode solicitar uma contagem total de linhas de um controle de fonte de dados para paginação definindo a RetrieveTotalRowCount propriedade no DataSourceSelectArguments objeto passado para o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método . Quando o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método retorna, a contagem total de linhas é contida pela TotalRowCount propriedade .

Importante

Se qualquer uma das DataSourceSelectArguments propriedades estiver definida, mas o controle de fonte de dados associado no momento não oferecer suporte à funcionalidade solicitada, uma exceção InvalidOperationException será gerada quando o DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) método for chamado.

Construtores

DataSourceSelectArguments()

Inicializa uma nova instância padrão da classe DataSourceSelectArguments.
DataSourceSelectArguments(Int32, Int32)

Inicializa uma nova instância da classe DataSourceSelectArguments com a posição inicial e o número de linhas a serem retornadas especificados para cenários de paginação.
DataSourceSelectArguments(String)

Inicializa uma nova instância da classe DataSourceSelectArguments com a expressão de classificação especificada.
DataSourceSelectArguments(String, Int32, Int32)

Inicializa uma nova instância da classe DataSourceSelectArguments com a expressão de classificação, a posição inicial e o número de linhas a serem retornadas especificados para cenários de paginação.

Propriedades

Empty

Obtém um objeto DataSourceSelectArguments com a expressão de classificação definida como Empty.
MaximumRows

Obtém ou define um valor que representa o número máximo de linhas de dados que um controle de fonte de dados retorna para uma operação de recuperação de dados.
RetrieveTotalRowCount

Obtém ou define um valor que indica se um controle de fonte de dados deve recuperar uma contagem de todas as linhas de dados durante uma operação de recuperação de dados.
SortExpression

Obtém ou define uma expressão que a exibição de fonte de dados usa para classificar os dados recuperados pelo método Select(DataSourceSelectArguments, DataSourceViewSelectCallback).
StartRowIndex

Obtém ou define um valor que representa a posição inicial que o controle de fonte de dados deve usar ao recuperar linhas de dados durante uma operação de recuperação de dados.
TotalRowCount

Obtém ou define o número de linhas recuperadas durante uma operação de recuperação de dados.

Métodos

AddSupportedCapabilities(DataSourceCapabilities)

Adiciona uma funcionalidade à instância DataSourceSelectArguments, que é usada para comparar as funcionalidades solicitadas e as funcionalidades com suporte.
Equals(Object)

Determina se a instância DataSourceSelectArguments especificada é igual à instância atual.
GetHashCode()

Retorna o código hash para o tipo DataSourceSelectArguments.
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do Object atual.

(Herdado de Object)
RaiseUnsupportedCapabilitiesError(DataSourceView)

Compara as funcionalidades solicitadas para uma operação ExecuteSelect(DataSourceSelectArguments) em relação às que a exibição da fonte de dados especificada dá suporte.
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Aplica-se a

Confira também