QuickGrid<TGridItem> Classe

Définition

Composant qui affiche une grille.

[Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")]
public class QuickGrid<TGridItem> : Microsoft.AspNetCore.Components.ComponentBase, IAsyncDisposable
[<Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")>]
type QuickGrid<'GridItem> = class
    inherit ComponentBase
    interface IAsyncDisposable
Public Class QuickGrid(Of TGridItem)
Inherits ComponentBase
Implements IAsyncDisposable

Paramètres de type

TGridItem

Type de données représentées par chaque ligne de la grille.

Héritage
QuickGrid<TGridItem>
Attributs
Implémente

Constructeurs

Nom Description
QuickGrid<TGridItem>()

Construit une instance de QuickGrid<TGridItem>.

Propriétés

Nom Description
AdditionalAttributes

Obtient ou définit une collection d’attributs supplémentaires qui seront appliqués à l’élément créé.

Assets

Obtient l’application ResourceAssetCollection .

(Hérité de ComponentBase)
AssignedRenderMode

Obtient l’affectation IComponentRenderMode à ce composant.

(Hérité de ComponentBase)
ChildContent

Définit les composants enfants de cette instance. Par exemple, vous pouvez définir des colonnes en ajoutant des composants dérivés de la ColumnBase<TGridItem> classe de base.

Class

Nom de classe CSS facultatif. Si elle est donnée, elle sera incluse dans l’attribut de classe de la table rendue.

ItemKey

Définit éventuellement une valeur pour @key chaque ligne rendue. En règle générale, cela doit être utilisé pour spécifier un identificateur unique, tel qu’une valeur de clé primaire, pour chaque élément de données.

Cela permet à la grille de conserver l’association entre les éléments de ligne et les éléments de données en fonction de leurs identificateurs uniques, même lorsque les instances TGridItem sont remplacées par de nouvelles copies (par exemple, après une nouvelle requête sur le magasin de données sous-jacent).

S’il n’est pas défini, il @key s’agit de l’instance TGridItem elle-même.

Items

Source interrogeable de données pour la grille.

Il peut s’agir de données en mémoire converties en requêtes à l’aide de la AsQueryable(IEnumerable) méthode d’extension, d’un Jeu de données EntityFramework ou d’un IQueryable jeu de données dérivé de celui-ci.

Vous devez fournir l’un ou l’autre Items , ItemsProvidermais pas les deux.

ItemSize

Cela s’applique uniquement lors de l’utilisation Virtualize. Il définit une hauteur attendue en pixels pour chaque ligne, ce qui permet au mécanisme de virtualisation d’extraire le nombre correct d’éléments correspondant à la taille d’affichage et de garantir un défilement précis.

ItemsProvider

Rappel qui fournit des données pour la grille.

Vous devez fournir l’un ou l’autre Items , ItemsProvidermais pas les deux.

OnRowClick

Optionnel. Rappel appelé lorsqu’une ligne est cliquée.

OverscanCount

Cela s’applique uniquement lors de l’utilisation Virtualize. Il définit le nombre d’éléments supplémentaires qui seront rendus avant et après la région visible pour réduire la fréquence de rendu pendant le défilement. Bien que les valeurs supérieures puissent améliorer la douceur du défilement en affichant davantage d’éléments hors écran, elles peuvent également augmenter les temps de chargement initiaux. La recherche d’un équilibre en fonction de la taille de votre jeu de données et des exigences d’expérience utilisateur est recommandée. La valeur par défaut est 3.

Pagination

Vous pouvez éventuellement lier cette QuickGrid<TGridItem> instance à un PaginationState modèle, ce qui entraîne l’extraction et le rendu de la grille uniquement sur la page active des données.

Cela est habituellement utilisé conjointement avec un composant Paginator ou une autre logique d'interface utilisateur qui affiche et met à jour l'instance PaginationState fournie.

RendererInfo

Obtient le RendererInfo composant en cours d’exécution.

(Hérité de ComponentBase)
RowClass

Optionnel. Rappel à appeler pour chaque ligne rendue pour spécifier une classe CSS.

Theme

Nom du thème, avec la valeur par défaut « default ». Cela affecte les règles de style qui correspondent à la table.

Virtualize

Si la valeur est true, la grille est rendue avec la virtualisation. Cela est normalement utilisé conjointement avec le défilement et provoque l’extraction et le rendu de la grille uniquement les données autour de la fenêtre d’affichage de défilement actuelle. Cela peut considérablement améliorer les performances lors du défilement de jeux de données volumineux.

Si vous utilisez Virtualize, vous devez fournir une valeur pour ItemSize et vous assurer que chaque ligne s’affiche avec la même hauteur constante.

En règle générale, il est préférable de ne pas utiliser Virtualize si la quantité de données rendues est petite ou si vous utilisez la pagination.

Méthodes

Nom Description
BuildRenderTree(RenderTreeBuilder)

Composant qui affiche une grille.

DispatchExceptionAsync(Exception)

Traite l’élément fourni exception comme étant levée par ce composant. Cela entraîne la transition de la limite d’erreur englobante en état d’échec. S’il n’existe aucune limite d’erreur englobante, elle est considérée comme une exception du renderer englobant.

Cela est utile si une exception se produit en dehors des méthodes de cycle de vie des composants, mais que vous souhaitez la traiter comme une exception d’une méthode de cycle de vie de composant.

(Hérité de ComponentBase)
DisposeAsync()

Composant qui affiche une grille.

HideColumnOptionsAsync()

Ferme l’interface ColumnOptions utilisateur qui a été affichée précédemment.

InvokeAsync(Action)

Exécute l’élément de travail fourni dans le contexte de synchronisation du renderer associé.

(Hérité de ComponentBase)
InvokeAsync(Func<Task>)

Exécute l’élément de travail fourni dans le contexte de synchronisation du renderer associé.

(Hérité de ComponentBase)
OnAfterRender(Boolean)

Méthode appelée après chaque rendu interactif du composant et de la mise à jour de l’interface utilisateur (par exemple, après l’ajout d’éléments au DOM du navigateur). Tous les ElementReference champs seront renseignés au moment de l’exécution.

Cette méthode n’est pas appelée pendant le rendu côté serveur ou avant l’affichage côté serveur, car ces processus ne sont pas attachés à un DOM de navigateur en direct et sont déjà terminés avant la mise à jour du DOM.

(Hérité de ComponentBase)
OnAfterRenderAsync(Boolean)

Méthode appelée après chaque rendu interactif du composant et de la mise à jour de l’interface utilisateur (par exemple, après l’ajout d’éléments au DOM du navigateur). Tous les ElementReference champs seront renseignés au moment de l’exécution.

Cette méthode n’est pas appelée pendant le rendu côté serveur ou avant l’affichage côté serveur, car ces processus ne sont pas attachés à un DOM de navigateur en direct et sont déjà terminés avant la mise à jour du DOM.

Notez que le composant ne réexécure pas automatiquement après l’achèvement d’un élément retourné Task, car cela provoquerait une boucle de rendu infinie.

OnInitialized()

Méthode appelée lorsque le composant est prêt à démarrer, ayant reçu ses paramètres initiaux de son parent dans l’arborescence de rendu.

(Hérité de ComponentBase)
OnInitializedAsync()

Méthode appelée lorsque le composant est prêt à démarrer, ayant reçu ses paramètres initiaux de son parent dans l’arborescence de rendu.

Remplacez cette méthode si vous effectuez une opération asynchrone et souhaitez que le composant s’actualise une fois cette opération terminée.

(Hérité de ComponentBase)
OnParametersSet()

Méthode appelée lorsque le composant a reçu des paramètres de son parent dans l’arborescence de rendu et que les valeurs entrantes ont été affectées aux propriétés.

(Hérité de ComponentBase)
OnParametersSetAsync()

Méthode appelée lorsque le composant a reçu des paramètres de son parent dans l’arborescence de rendu et que les valeurs entrantes ont été affectées aux propriétés.

RefreshDataAsync()

Indique à la grille de récupérer et de restituer les données actuelles à partir de la source de données fournie (ou ItemsItemsProvider).

SetParametersAsync(ParameterView)

Définit les paramètres fournis par le parent du composant dans l’arborescence de rendu.

(Hérité de ComponentBase)
ShouldRender()

Retourne un indicateur pour indiquer si le composant doit être rendu.

(Hérité de ComponentBase)
ShowColumnOptionsAsync(ColumnBase<TGridItem>)

Affiche l’interface ColumnOptions utilisateur de la colonne spécifiée, fermant toute autre interface utilisateur d’options de colonne qui a été affichée précédemment.

SortByColumnAsync(ColumnBase<TGridItem>, SortDirection)

Définit la colonne de tri actuelle de la grille sur la colonne de tri spécifiée column.

StateHasChanged()

Avertit le composant que son état a changé. Le cas échéant, le composant sera recréé.

(Hérité de ComponentBase)

Implémentations d’interfaces explicites

Nom Description
IComponent.Attach(RenderHandle)

Composant qui affiche une grille.

(Hérité de ComponentBase)
IHandleAfterRender.OnAfterRenderAsync()

Composant qui affiche une grille.

(Hérité de ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)

Composant qui affiche une grille.

(Hérité de ComponentBase)

S’applique à