New-UDDynamic

Résumé

Définit une nouvelle région dynamique dans un tableau de bord.

Syntaxe

New-UDDynamic [-Id <String>] [-ArgumentList <Object[]>] [-Content] <Endpoint> [-AutoRefresh] [-AutoRefreshInterval <Int32>] [-LoadingComponent <ScriptBlock>] [<CommonParameters>]

Description

Définit une nouvelle région dynamique dans un tableau de bord. Les régions dynamiques servent à charger des données au chargement de la page ou à charger des données dynamiquement au moyen d'une interaction de l'utilisateur ou d'un rechargement automatique.

Paramètres

-Id

L'ID de ce composant.

Required?                    false
Position?                    named
Default value                [Guid]::NewGuid()
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ArgumentList <Object[]>

Arguments à transmettre à ce terminal dynamique.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Content

Le contenu de cette région dynamique.

Required?                    true
Position?                    1
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-AutoRefresh

Indique si cette région dynamique doit s'actualiser à un intervalle donné.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-AutoRefreshInterval

Le nombre de secondes entre les actualisations de cette région dynamique.

Required?                    false
Position?                    named
Default value                10
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-LoadingComponent

Un composant à afficher pendant le chargement de cette région dynamique.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

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'information, voir about_CommonParameters.

Sorties

Exemples

Exemple 1 : Région dynamique de base

New-UDDynamic -Content {
   New-UDTypography -Text (Get-Date) -Id 'text1'
} -Id 'dynamic1'

Une simple région dynamique qui s'exécute lorsque l'utilisateur charge la page.

Exemple 2 : Actualisation automatique

New-UDDynamic -Content {
   New-UDTypography -Text (Get-Date) -Id 'text2'
} -AutoRefresh -AutoRefreshInterval 3 -Id 'dynamic2'

Une région dynamique qui s'actualise toutes les 3 secondes

Exemple 3

New-UDDynamic -Content {
   New-UDTypography -Text (Get-Date) -Id 'text3'
} -Id 'dynamic3'
New-UDButton -Text 'Refresh' -OnClick {
   Sync-UDElement -Id 'dynamic3'
}

Sync-UDElement|A dynamic region that is updated when a button is clicked.

Exemple 4 : Composant de chargement

New-UDDynamic -Content {
   Start-Sleep 5
   New-UDTypography -Text (Get-Date) -Id 'text5'
} -Id 'dynamic4' -LoadingComponent {
   New-UDTypography -Text 'Loading...' -Id 'text4'
}
New-UDButton -Text 'Refresh' -OnClick {
   Sync-UDElement -Id 'dynamic4'
}

Une région dynamique qui affiche un composant de chargement pendant le chargement de la région dynamique.

[Component("Dynamic Region", "BoltLightning", "Creates a dynamic region.")]