New-UDTable
Résumé
Crée un tableau.
Syntaxe
New-UDTable [-Id <String>] [-Title <String>] [-Data <Object[]>] [-Columns <Hashtable[]>] [-OnRowSelection <Endpoint>] [-ShowSort] [-ShowFilter] [-ShowSearch] [-Dense] [-ShowExport] [-StickyHeader] [-PageSize <Int32>] [-PageSizeOptions <Int32[]>] [-PaginationLocation <String>] [-ShowSelection] [-ShowPagination] [-Padding <String>] [-Size <String>] [-TextOption <Hashtable>] [-ExportOption <String[]>] [-OnExport <Endpoint>] [-DisablePageSizeAll] [-DefaultSortDirection <String>] [-HideToggleAllRowsSelected] [-DisableMultiSelect] [-DisableSortRemove] [-Icon <Hashtable>] [-ClassName <String>] [-ShowRefresh] [-ToolbarContent <ScriptBlock>] [-OnRowExpand <ScriptBlock>] [-MaxHeight <Int32>] [-Language <String>] [-RemoveCard] [-OnRowStyle <ScriptBlock>] [-HeaderStyle <Hashtable>] [-InitialState <Hashtable>] [<CommonParameters>]
New-UDTable [-Id <String>] [-Title <String>] -LoadRows <Endpoint> [-Columns <Hashtable[]>] [-OnRowSelection <Endpoint>] [-ShowSort] [-ShowFilter] [-ShowSearch] [-Dense] [-ShowExport] [-StickyHeader] [-PageSize <Int32>] [-PageSizeOptions <Int32[]>] [-PaginationLocation <String>] [-ShowSelection] [-ShowPagination] [-Padding <String>] [-Size <String>] [-TextOption <Hashtable>] [-ExportOption <String[]>] [-OnExport <Endpoint>] [-DisablePageSizeAll] [-DefaultSortDirection <String>] [-HideToggleAllRowsSelected] [-DisableMultiSelect] [-DisableSortRemove] [-Icon <Hashtable>] [-ClassName <String>] [-ShowRefresh] [-ToolbarContent <ScriptBlock>] [-OnRowExpand <ScriptBlock>] [-MaxHeight <Int32>] [-AutoRefresh] [-AutoRefreshInterval <Int32>] [-Language <String>] [-RemoveCard] [-OnRowStyle <ScriptBlock>] [-HeaderStyle <Hashtable>] [-InitialState <Hashtable>] [<CommonParameters>]Description
Crée un tableau. Les tableaux servent à afficher des données statiques et dynamiques. Vous pouvez définir les colonnes et les données à afficher dans le tableau. Les colonnes peuvent servir à rendre des composants personnalisés en fonction des données de la ligne. Vous pouvez aussi activer la pagination, le filtrage, le tri et même le traitement côté serveur.
Paramètres
-Id
L'ID du composant. Il s'agit par défaut d'un GUID aléatoire.
Required? false
Position? named
Default value [Guid]::NewGuid().ToString()
Accept pipeline input? false
Aliases
Accept wildcard characters? false-Title
Le titre à afficher dans le haut de la carte du tableau.
-Data <Object[]>
Les données à insérer dans le tableau.
-LoadRows
Lorsque des tableaux dynamiques sont utilisés, ce bloc de script est appelé. Le paramètre $Body contiendra une table de hachage avec les options suivantes :
filters: @() orderBy: string orderDirection: string page: int pageSize: int properties: @() search: string totalCount: int
Vous pouvez utiliser ces valeurs pour effectuer un traitement côté serveur, comme des requêtes SQL, afin d'améliorer la performance des grandes grilles.
Après avoir traité les données avec ces valeurs, produisez les données au moyen de Out-UDTableData.
-Columns <Hashtable[]>
Définit les colonnes à afficher dans le tableau. Utilisez New-UDTableColumn pour définir ces colonnes. Si ce paramètre n'est pas spécifié, les propriétés des données que vous transmettez deviendront les colonnes.
-OnRowSelection
Un bloc de script à appeler lorsqu'une ligne est sélectionnée. $EventData contiendra les lignes sélectionnées.
-ShowSort
Indique s'il faut afficher les contrôles de tri sur les colonnes
-ShowFilter
Indique s'il faut afficher les contrôles de filtre sur les colonnes
-ShowSearch
Indique s'il faut afficher la recherche sur tout le tableau
-Dense
Réduit l'espace blanc utilisé dans le tableau.
-ShowExport
Indique s'il faut afficher le bouton d'exportation.
-StickyHeader
Rend l'en-tête fixe.
-PageSize
La taille de page par défaut.
-PageSizeOptions <Int32[]>
Un tableau des options de taille de page disponibles.
-PaginationLocation
Où afficher les contrôles de pagination. Les valeurs valides sont top, bottom ou both. La valeur par défaut est bottom.
-ShowSelection
Indique s'il faut autoriser la sélection dans le tableau.
-ShowPagination
Indique s'il faut afficher les contrôles de pagination.
-Padding
-Size
La taille du tableau. La valeur par défaut est medium. Les valeurs valides sont medium et small.
-TextOption
Personnalisations du texte standard dans le tableau. Utilisez New-UDTextOption pour créer les options de texte.
-ExportOption <String[]>
Un tableau d'options d'exportation.
-OnExport
Un bloc de script utilisé pour personnaliser la façon dont l'exportation est effectuée.
-DisablePageSizeAll
Supprime l'option All des options de taille de page.
-DefaultSortDirection
La direction de tri par défaut.
-HideToggleAllRowsSelected
Masque le bouton permettant de basculer la sélection de toutes les lignes.
-DisableMultiSelect
Désactive la sélection multiple.
-DisableSortRemove
Supprime l'option de tri pour les colonnes non triées. Les colonnes seront toujours en ordre croissant ou décroissant.
-Icon
Définit une icône à côté du titre. Utilisez New-UDIcon pour créer l'icône.
-ClassName
Une classe CSS à appliquer au tableau.
-ShowRefresh
Indique s'il faut afficher le bouton d'actualisation.
-ToolbarContent
Contenu personnalisé à afficher dans la barre d'outils.
-OnRowExpand
Un bloc de script à appeler lorsqu'une ligne est développée. La variable $EventData contiendra les données de la ligne.
-MaxHeight
-AutoRefresh
Recharge le tableau à intervalle régulier lorsque -LoadRows est utilisé.
-AutoRefreshInterval
L'intervalle de rechargement des données lorsque AutoRefresh est spécifié.
-Language
La langue. Utilisée principalement pour les filtres de date et d'heure.
-RemoveCard
-OnRowStyle
Un bloc de script à appeler pour styliser les lignes. La variable $EventData contiendra les données de la ligne.
-HeaderStyle
Une table de hachage de styles à appliquer à l'en-tête.
-InitialState
Paramètres communs
Cette applet de commande prend en charge les paramètres communs : Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable et OutVariable. Pour plus d'informations, consultez about_CommonParameters.
Sorties
Exemples
Exemple 1 : Tableau de base
Crée un tableau statique dont les colonnes sont les propriétés des données spécifiées.
Exemple 2 : Colonnes
Crée un tableau pour lequel des colonnes personnalisées sont définies.
Exemple 3 : Rendu
Crée un tableau dont les colonnes sont rendues avec du contenu personnalisé.
Exemple 4 : Largeur de colonne
Définir une largeur de colonne personnalisée
Exemple 5 : Filtre de colonne
Filtres de colonnes pour un tableau
Exemple 6 : Recherche de colonne
Les colonnes peuvent être incluses dans la recherche
Exemple 7
Exemple 8 : Pagination
La pagination peut être activée en réglant le paramètre -Paging à $true. La taille de page par défaut est 10.
Exemple 9 : Développement de ligne
Le développement de ligne peut être activé en réglant le paramètre -OnRowExpand à un bloc de script. Les données de la ligne seront transmises au bloc de script sous forme de table de hachage dans la variable $EventData.
Exemple 10 : Exportation
Exportez les données du tableau avec le paramètre -Export. Vous pouvez configurer les colonnes incluses dans l'exportation en réglant le paramètre -IncludeInExport sur la colonne. Utilisez -Hidden pour masquer une colonne dans le tableau tout en l'incluant dans l'exportation.
Exemple 11 : Options de texte
Les options de texte peuvent servir à personnaliser le texte dans le tableau.
Exemple 12 : Stylisation des lignes
Vous pouvez styliser les lignes à l'aide du paramètre -OnRowStyle. Les données de la ligne seront transmises au bloc de script sous forme de table de hachage dans la variable $EventData. Le bloc de script doit retourner une table de hachage de styles CSS à appliquer à la ligne.
Exemple 13 : Tri par défaut
Définir la direction de tri et la colonne par défaut.
Exemple 14 : État initial
Définir l'état initial du tableau. Cela peut servir à définir l'index de page, la taille de page, les filtres et la colonne de tri.
Exemple 15 : Coloration des lignes
Utilisez OnRowStyle pour styliser les lignes en fonction des données de la ligne.
Mis à jour
Ce contenu vous a-t-il été utile ?