DataSourceSelectArguments Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Fornece um mecanismo que os controlos encadernados por dados utilizam para solicitar operações relacionadas com dados aos controlos fonte de dados quando os dados são recuperados. Esta classe não pode ser herdada.
public ref class DataSourceSelectArguments sealedpublic sealed class DataSourceSelectArgumentstype DataSourceSelectArguments = classPublic NotInheritable Class DataSourceSelectArguments- Herança
-
DataSourceSelectArguments
Observações
Os controlos de dados limitados utilizam a DataSourceSelectArguments classe para solicitar que um controlo de fonte de dados realize operações adicionais relacionadas com dados num conjunto de resultados, como ordenar os dados ou devolver um subconjunto específico de dados. Estas operações relacionadas com dados são enumeradas pela DataSourceCapabilities enumeração. A tabela seguinte indica como a DataSourceSelectArguments classe suporta estas operações relacionadas com dados.
| Capability | Propriedades relacionadas DataSourceSelectArguments |
|---|---|
| DataSourceCapabilities.Sort | SortExpression |
| DataSourceCapabilities.Page | StartRowIndex, MaximumRows |
| DataSourceCapabilities.RetrieveTotalRowCount | RetrieveTotalRowCount, TotalRowCount |
Os controlos data-bound chamam explicitamente o PerformSelect método para ligar dados, que chama o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método do controlo de fonte de dados ao qual estão associados. Desta forma, o controlo data-bound recupera dados do controlo de fonte de dados a pedido. Como o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método aceita um DataSourceSelectArguments parâmetro, o controlo data-bound é responsável por criar e gerir um DataSourceSelectArguments objeto e passá-lo ao Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método quando este recupera dados do controlo fonte de dados.
Em alguns casos, os controlos vinculados a dados podem não necessitar de capacidades adicionais relacionadas com dados. Neste caso, os controlos ligados a dados passam um Empty objeto argumento para o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método.
Para conjuntos de resultados ordenados, os controlos data-bound verificam a propriedade da CanSort vista da fonte de dados em tempo de execução e adicionam uma DataSourceCapabilities.Sort capacidade usando o AddSupportedCapabilities(DataSourceCapabilities) método. Como operação separada, o controlo data-bound pode solicitar um conjunto de resultados ordenados a um controlo 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 controlos data-bound verificam a propriedade da CanPage vista da fonte de dados em tempo de execução e adicionam uma DataSourceCapabilities.Page capacidade usando o AddSupportedCapabilities(DataSourceCapabilities) método. Como operação separada, o controlo de dados limitado pode solicitar um subconjunto de dados a um controlo 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 obter a contagem total de linhas para cenários de paginação, os controlos de dados encadernados verificam a propriedade da CanRetrieveTotalRowCount vista da fonte de dados em tempo de execução e adicionam uma DataSourceCapabilities.RetrieveTotalRowCount capacidade usando o AddSupportedCapabilities(DataSourceCapabilities) método. Como operação separada, o controlo data-bound pode solicitar uma contagem total de linhas a um controlador de fonte de dados para paginação, definindo a RetrieveTotalRowCount propriedade no DataSourceSelectArguments objeto passado ao Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método. Quando o Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método retorna, a contagem total de linhas é contida pela TotalRowCount propriedade.
Importante
Se alguma das DataSourceSelectArguments propriedades estiver definida, mas o controlo de fonte de dados atualmente atribuído não suportar a capacidade solicitada, é lançada uma InvalidOperationException exceção quando o DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) método é chamado.
Construtores
| Name | Description |
|---|---|
| DataSourceSelectArguments() |
Inicializa uma nova instância padrão da DataSourceSelectArguments classe. |
| DataSourceSelectArguments(Int32, Int32) |
Inicializa uma nova instância da DataSourceSelectArguments classe com a posição inicial especificada e o número de linhas a devolver para cenários de paginação. |
| DataSourceSelectArguments(String, Int32, Int32) |
Inicializa uma nova instância da DataSourceSelectArguments classe com a expressão de ordenação especificada, posição inicial e número de linhas a devolver para cenários de paginação. |
| DataSourceSelectArguments(String) |
Inicializa uma nova instância da DataSourceSelectArguments classe com a expressão de ordenação especificada. |
Propriedades
| Name | Description |
|---|---|
| Empty |
Obtém um DataSourceSelectArguments objeto com a expressão de ordenação definida como Empty. |
| MaximumRows |
Obtém ou define um valor que representa o número máximo de linhas de dados que um controlo de fonte de dados devolve para uma operação de recuperação de dados. |
| RetrieveTotalRowCount |
Recebe ou define um valor que indica se um controlo de fonte de dados deve recuperar a 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 vista da fonte de dados usa para ordenar os dados recuperados pelo Select(DataSourceSelectArguments, DataSourceViewSelectCallback) método. |
| StartRowIndex |
Obtém ou define um valor que representa a posição inicial que o controlo 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
| Name | Description |
|---|---|
| AddSupportedCapabilities(DataSourceCapabilities) |
Adiciona uma capacidade à DataSourceSelectArguments instância, que é usada para comparar capacidades suportadas e solicitadas. |
| Equals(Object) |
Determina se a instância especificada DataSourceSelectArguments é igual à instância atual. |
| GetHashCode() |
Devolve o código hash do DataSourceSelectArguments tipo. |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| MemberwiseClone() |
Cria uma cópia superficial do atual Object. (Herdado de Object) |
| RaiseUnsupportedCapabilitiesError(DataSourceView) |
Compara as capacidades solicitadas para uma ExecuteSelect(DataSourceSelectArguments) operação com aquelas suportadas pela vista de fonte de dados especificada. |
| ToString() |
Devolve uma cadeia que representa o objeto atual. (Herdado de Object) |