New-UDAutocomplete

Übersicht

Die Autovervollständigung ist eine normale Texteingabe, die um ein Panel mit vorgeschlagenen Optionen erweitert ist.

Syntax

New-UDAutocomplete [-Id <String>] [-Label <String>] [-Value <Object>] [-OnChange <Endpoint>] [-Options <Object>] [-FullWidth] [-AutoSelect] [-Variant <String>] [-Multiple] [-ClassName <String>] [-Icon <Object>] [-OnEnter <Endpoint>] [-Disabled] [<CommonParameters>]

New-UDAutocomplete [-Id <String>] [-Label <String>] [-Value <Object>] [-OnChange <Endpoint>] -OnLoadOptions <Endpoint> [-FullWidth] [-AutoSelect] [-Variant <String>] [-Multiple] [-ClassName <String>] [-Icon <Object>] [-OnEnter <Endpoint>] [-Disabled] [<CommonParameters>]

Beschreibung

Textfelder mit Autovervollständigung können verwendet werden, um dem Benutzer die Auswahl aus einer großen Liste statischer oder dynamischer Elemente zu ermöglichen. Durch die Eingabe in das Textfeld wird die Liste gefiltert.

Parameter

-Id

Die ID der Komponente. Standardmäßig ist dies eine zufällige GUID.

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

-Label

Die Beschriftung, die für das Textfeld angezeigt werden soll.

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

-Value

Der Wert des Textfelds.

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

-OnChange

Ein Skriptblock, der aufgerufen wird, wenn sich die Auswahl ändert.

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

-OnLoadOptions

Ein Skriptblock, der aufgerufen wird, wenn der Benutzer beginnt, in das Textfeld zu tippen. Die Variable $Body enthält den eingegebenen Text. Sie sollten ein JSON-Array mit Werten zurückgeben, die sich aus der Eingabe des Benutzers ergeben.

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

-Options

Statische Optionen, die in der Auswahl-Dropdownliste angezeigt werden sollen. Wenn der Benutzer tippt, werden diese Optionen gefiltert.

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

-FullWidth

Ob die Komponente die volle Breite ihres übergeordneten Elements einnehmen soll.

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

-AutoSelect

Ob die Komponente automatisch ausgewählt werden soll, wenn im Options-Array insgesamt nur eine Option vorhanden war.

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

-Variant

Die Variante des Textfelds. Gültige Werte sind: "filled", "outlined", "standard"

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

-Multiple

Ob mehrere Elemente ausgewählt werden können.

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

-ClassName

Eine CSS-Klasse, die auf die Komponente angewendet werden soll.

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

-Icon

Das Symbol, das vor dem Textfeld angezeigt werden soll. Verwenden Sie New-UDIcon, um den Wert für diesen Parameter zu erstellen.

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

-OnEnter

Ein Skriptblock, der aufgerufen wird, wenn der Benutzer innerhalb des Autovervollständigungs-Textfelds die Eingabetaste drückt.

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

-Disabled

Ob diese Autovervollständigung deaktiviert ist.

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

Allgemeine Parameter

Dieses Cmdlet unterstützt die allgemeinen Parameter: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable und OutVariable. Weitere Informationen finden Sie unter about_CommonParameters.

Ausgaben

Beispiele

Beispiel 1: Einfache Autovervollständigung

New-UDAutocomplete -Options @('Test', 'Test2', 'Test3', 'Test4') -Id 'autocomplete1' -FullWidth

Der Wert muss aus einem vordefinierten Satz zulässiger Werte gewählt werden.

Beispiel 2

New-UDAutocomplete -Options @("Test", "No", "Yes") -Multiple  -Id 'autocomplete2' -FullWidth

Multi-Select|Allow the user to select multiple values.

Beispiel 3: Varianten

New-UDStack -Content {
   New-UDAutocomplete -Options @("Test", "No", "Yes") -Variant 'filled'  -Id 'autocomplete3' -FullWidth
   New-UDAutocomplete -Options @("Test", "No", "Yes") -Variant 'outlined'  -Id 'autocomplete4' -FullWidth
   New-UDAutocomplete -Options @("Test", "No", "Yes") -Variant 'standard'  -Id 'autocomplete5' -FullWidth
} -Direction 'column' -FullWidth

Ändern Sie den Stil des Autovervollständigungs-Textfelds.

Beispiel 4: Umgang mit Änderungen

New-UDAutocomplete -Options @("Test", "No", "Yes") -OnChange {
   Show-UDToast $EventData
}  -Id 'autocomplete6' -FullWidth

Führen Sie PowerShell aus, wenn sich die Autovervollständigung ändert.

Beispiel 5: OnEnter

New-UDAutocomplete -Options @("Test", "No", "Yes") -OnEnter {
   Show-UDToast $EventData
} -Id 'autocomplete7' -FullWidth

Führen Sie PowerShell aus, wenn der Benutzer die Eingabetaste drückt.

Beispiel 6: Asynchrone Optionen

New-UDAutocomplete -OnLoadOptions {
  @('Test', 'Test2', 'Test3', 'Test4') | Where-Object { $_ -match $Body } | ConvertTo-Json
} -Id 'autocomplete8' -FullWidth

Erstellt eine Autovervollständigung mit einem dynamisch gefilterten Satz von Optionen

Beispiel 7

New-UDAutocomplete -Options @(
   New-UDAutocompleteOption -Name 'Test' -Value 'test' -Group 'Group1'
   New-UDAutocompleteOption -Name 'Test2' -Value 'test2' -Group 'Group1'
   New-UDAutocompleteOption -Name 'Test3' -Value 'test3' -Group 'Group2'
   New-UDAutocompleteOption -Name 'Test4' -Value 'test4' -Group 'Group2'
) -Id 'autocomplete9' -FullWidth