QuickGrid<TGridItem> Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Um componente que exibe uma grade.
[Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")]
public class QuickGrid<TGridItem> : Microsoft.AspNetCore.Components.ComponentBase, IAsyncDisposable
[Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")]
[Microsoft.AspNetCore.Components.CacheBehavior(Microsoft.AspNetCore.Components.CacheBehavior.Throw)]
[Microsoft.AspNetCore.Components.CacheCondition(Microsoft.AspNetCore.Components.CacheVaryBy.Query)]
public class QuickGrid<TGridItem> : Microsoft.AspNetCore.Components.ComponentBase, IAsyncDisposable
[<Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")>]
type QuickGrid<'GridItem> = class
inherit ComponentBase
interface IAsyncDisposable
[<Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")>]
[<Microsoft.AspNetCore.Components.CacheBehavior(Microsoft.AspNetCore.Components.CacheBehavior.Throw)>]
[<Microsoft.AspNetCore.Components.CacheCondition(Microsoft.AspNetCore.Components.CacheVaryBy.Query)>]
type QuickGrid<'GridItem> = class
inherit ComponentBase
interface IAsyncDisposable
Public Class QuickGrid(Of TGridItem)
Inherits ComponentBase
Implements IAsyncDisposable
Parâmetros de tipo
- TGridItem
O tipo de dados representado por cada linha na grade.
- Herança
- Atributos
- Implementações
Construtores
| Nome | Description |
|---|---|
| QuickGrid<TGridItem>() |
Constrói uma instância de QuickGrid<TGridItem>. |
Propriedades
| Nome | Description |
|---|---|
| AdditionalAttributes |
Obtém ou define uma coleção de atributos adicionais que serão aplicados ao elemento criado. |
| AnchorMode |
Obtém ou define o modo de âncora que controla como o visor se comporta nas bordas da lista quando novos itens chegam durante a virtualização. O padrão é Start. Isso só tem um efeito quando Virtualize é |
| Assets |
Obtém o ResourceAssetCollection para o aplicativo. (Herdado de ComponentBase) |
| AssignedRenderMode |
Obtém o IComponentRenderMode atribuído a esse componente. (Herdado de ComponentBase) |
| ChildContent |
Define os componentes filho dessa instância. Por exemplo, você pode definir colunas adicionando componentes derivados da ColumnBase<TGridItem> classe base. |
| Class |
Um nome de classe CSS opcional. Se for dado, isso será incluído no atributo de classe da tabela renderizada. |
| InitialItemIndex |
Isso é aplicável somente ao usar Virtualize. Obtém ou define o índice baseado em zero da linha para rolar na primeira renderização interativa. Aplicado uma vez quando a grade conhece pela primeira vez sua contagem de itens e é ignorada nas renderizações subsequentes; para rolar programaticamente em qualquer ponto posterior, chame ScrollToItemAsync(Int32, CancellationToken). Valores fora do intervalo são limitados. O valor padrão significa |
| ItemComparer |
Obtém ou define um comparador usado durante a virtualização para detectar se os itens foram anexados ou acrescentados entre cargas de dados. Quando as janelas do provedor se sobrepõem, o comparador determina se um item renderizado anteriormente foi alterado no mesmo índice global, o que indica que os itens foram inseridos acima do visor atual, para que a grade possa manter o visor ancorado. Forneça um comparador que compara itens por um identificador exclusivo estável (por exemplo, uma chave primária). Usa Default como padrão. Para registros e tipos implementados IEquatable<T>, o padrão funciona automaticamente (igualdade de valor). Para tipos de referência sem semântica de igualdade de valor, o padrão volta à igualdade de referência, que produz detecção de predefinição false-positivo quando a fonte de dados retorna novas instâncias entre cargas. Isso só tem um efeito quando Virtualize é |
| ItemKey |
Opcionalmente, define um valor para @key cada linha renderizada. Normalmente, isso deve ser usado para especificar um identificador exclusivo, como um valor de chave primária, para cada item de dados. Isso permite que a grade preserve a associação entre elementos de linha e itens de dados com base em seus identificadores exclusivos, mesmo quando as instâncias do TGridItem são substituídas por novas cópias (por exemplo, após uma nova consulta no armazenamento de dados subjacente). Se não for definido, será a @key própria instância do TGridItem. |
| Items |
Uma fonte de dados que pode ser consultada para a grade. Isso pode ser dados na memória convertidos em consultáveis usando o AsQueryable(IEnumerable) método de extensão ou um EntityFramework DataSet ou um IQueryable derivado dele. Você deve fornecer ou ItemsItemsProvider, mas não ambos. |
| ItemSize |
Isso é aplicável somente ao usar Virtualize. Ele define uma altura esperada em pixels para cada linha, permitindo que o mecanismo de virtualização busque o número correto de itens para corresponder ao tamanho de exibição e garantir uma rolagem precisa. |
| ItemsProvider |
Um retorno de chamada que fornece dados para a grade. Você deve fornecer ou ItemsItemsProvider, mas não ambos. |
| OnRowClick |
Opcional. Um retorno de chamada que é invocado quando uma linha é clicada. |
| OverscanCount |
Isso é aplicável somente ao usar Virtualize. Ele define quantos itens adicionais serão renderizados antes e depois da região visível para reduzir a frequência de renderização durante a rolagem. Embora valores mais altos possam melhorar a suavidade da rolagem renderizando mais itens fora da tela, eles também podem aumentar os tempos de carga iniciais. É recomendável encontrar um equilíbrio com base no tamanho do conjunto de dados e nos requisitos de experiência do usuário. O valor padrão é 3. |
| Pagination |
Opcionalmente, vincula essa QuickGrid<TGridItem> instância a um PaginationState modelo, fazendo com que a grade busque e renderize apenas a página atual de dados. Normalmente, é usado em conjunto com um componente Paginator ou alguma outra lógica de interface do usuário que exiba e atualize a instância PaginationState fornecida. |
| QueryParameterNameOptions |
Especifica o QueryParameterNameOptions usado para persistir a página, classificar a coluna e a direção de classificação na URL. Usa como padrão uma instância cujos parâmetros de consulta são chamados "page", "sort" e "direction". |
| RendererInfo |
Obtém o RendererInfo componente em execução. (Herdado de ComponentBase) |
| RowClass |
Opcional. Um retorno de chamada a ser invocado para cada linha renderizada para especificar uma classe CSS. |
| Theme |
Um nome de tema, com o valor padrão "padrão". Isso afeta quais regras de estilo correspondem à tabela. |
| Virtualize |
Se for true, a grade será renderizada com virtualização. Normalmente, isso é usado em conjunto com a rolagem e faz com que a grade busque e renderize apenas os dados ao redor do visor de rolagem atual. Isso pode melhorar muito o desempenho ao rolar por grandes conjuntos de dados. Se você usar Virtualize, deverá fornecer um valor ItemSize e deve garantir que cada linha seja renderizada com a mesma altura constante. Geralmente, é preferível não usar Virtualize se a quantidade de dados sendo renderizados for pequena ou se você estiver usando paginação. |
Métodos
| Nome | Description |
|---|---|
| BuildRenderTree(RenderTreeBuilder) |
Um componente que exibe uma grade. |
| DispatchExceptionAsync(Exception) |
Trata o fornecido Isso é útil se uma exceção ocorrer fora dos métodos de ciclo de vida do componente, mas você deseja tratá-la da mesma forma que uma exceção de um método de ciclo de vida de componente. (Herdado de ComponentBase) |
| DisposeAsync() |
Um componente que exibe uma grade. |
| HideColumnOptionsAsync() |
Fecha a interface do ColumnOptions usuário exibida anteriormente. |
| InvokeAsync(Action) |
Executa o item de trabalho fornecido no contexto de sincronização do renderizador associado. (Herdado de ComponentBase) |
| InvokeAsync(Func<Task>) |
Executa o item de trabalho fornecido no contexto de sincronização do renderizador associado. (Herdado de ComponentBase) |
| OnAfterRender(Boolean) |
Método invocado após cada vez que o componente é renderizado interativamente e a interface do usuário termina de atualizar (por exemplo, depois que os elementos são adicionados ao DOM do navegador). Todos os ElementReference campos serão preenchidos quando isso for executado. Esse método não é invocado durante a pré-geração ou a renderização do lado do servidor, pois esses processos não são anexados a nenhum DOM do navegador dinâmico e já estão concluídos antes que o DOM seja atualizado. (Herdado de ComponentBase) |
| OnAfterRenderAsync(Boolean) |
Método invocado após cada vez que o componente tiver sido renderizado interativamente e a interface do usuário tiver terminado de atualizar (por exemplo, depois que os elementos tiverem sido adicionados ao DOM do navegador). Todos os ElementReference campos serão preenchidos quando isso for executado. Esse método não é invocado durante a pré-geração ou a renderização do lado do servidor, pois esses processos não são anexados a nenhum DOM do navegador dinâmico e já estão concluídos antes que o DOM seja atualizado. Observe que o componente não é renderizado automaticamente após a conclusão de qualquer retorno Task, porque isso causaria um loop de renderização infinito. |
| OnInitialized() |
Método invocado quando o componente está pronto para iniciar, tendo recebido seus parâmetros iniciais de seu pai na árvore de renderização. |
| OnInitialized() |
Método invocado quando o componente está pronto para iniciar, tendo recebido seus parâmetros iniciais de seu pai na árvore de renderização. (Herdado de ComponentBase) |
| OnInitializedAsync() |
Método invocado quando o componente está pronto para iniciar, tendo recebido seus parâmetros iniciais de seu pai na árvore de renderização. Substitua esse método se você executar uma operação assíncrona e quiser que o componente seja atualizado quando essa operação for concluída. (Herdado de ComponentBase) |
| OnParametersSet() |
Método invocado quando o componente recebeu parâmetros de seu pai na árvore de renderização e os valores de entrada foram atribuídos às propriedades. (Herdado de ComponentBase) |
| OnParametersSetAsync() |
Método invocado quando o componente recebeu parâmetros de seu pai na árvore de renderização e os valores de entrada foram atribuídos às propriedades. |
| RefreshDataAsync() |
Instrui a grade a buscar novamente e renderizar os dados atuais da fonte de dados fornecida (ou ItemsItemsProvider). |
| ScrollToItemAsync(Int32, CancellationToken) |
Rola a grade virtualizada para que a linha |
| SetParametersAsync(ParameterView) |
Define parâmetros fornecidos pelo pai do componente na árvore de renderização. (Herdado de ComponentBase) |
| ShouldRender() |
Retorna um sinalizador para indicar se o componente deve ser renderizado. (Herdado de ComponentBase) |
| ShowColumnOptionsAsync(ColumnBase<TGridItem>) |
Exibe a interface do ColumnOptions usuário da coluna especificada, fechando qualquer outra interface do usuário de opções de coluna exibida anteriormente. |
| SortByColumnAsync(ColumnBase<TGridItem>, SortDirection) |
Define a coluna de classificação atual da grade como a especificada |
| StateHasChanged() |
Notifica o componente de que seu estado foi alterado. Quando aplicável, isso fará com que o componente seja renderizado novamente. (Herdado de ComponentBase) |
Implantações explícitas de interface
| Nome | Description |
|---|---|
| IComponent.Attach(RenderHandle) |
Um componente que exibe uma grade. (Herdado de ComponentBase) |
| IHandleAfterRender.OnAfterRenderAsync() |
Um componente que exibe uma grade. (Herdado de ComponentBase) |
| IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object) |
Um componente que exibe uma grade. (Herdado de ComponentBase) |