New-UDTransferList

Synopsis

Creates a transfer list component.

Syntax

New-UDTransferList [[-Id] <String>] [[-Item] <ScriptBlock>] [[-SelectedItem] <String[]>] [[-OnChange] <Endpoint>] [[-ClassName] <String>] [-Disabled] [[-Height] <String>] [[-Width] <String>] [-ShowSearch] [[-Alignment] <String>] [-Dense] [[-LeftTitle] <String>] [[-RightTitle] <String>] [[-LeftSubTitle] <String>] [[-RightSubTitle] <String>] [-Enhanced] [<CommonParameters>]

Description

A transfer list (or "shuttle") enables the user to move one or more list items between lists.

Parameters

-Id

The ID of this component.

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

-Item

A list of items that can be transferred between lists. Use New-UDTransferListItem to create an item.

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

-SelectedItem <String[]>

A list of selected items. Use the value of item to transfer items between lists.

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

-OnChange

A script block that is executed when the user changes the selected items.

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

-ClassName

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

-Disabled

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

-Height

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

-Width

Required?                    false
Position?                    7
Default value                100%
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ShowSearch

Shows search box for left hand items

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

-Alignment

Alignment of the transfer list. Valid values are left, right, and center.

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

-Dense

Makes the transfer list dense.

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

-LeftTitle

Title for the left hand list.

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

-RightTitle

Title for the right hand list.

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

-LeftSubTitle

Subtitle for the left hand list.

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

-RightSubTitle

Subtitle for the right hand list.

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

-Enhanced

Show enhanced selection.

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

Common parameters

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.

Outputs

Examples

Example 1: Basic Transfer List

New-UDTransferList -Item {
    New-UDTransferListItem -Name 'test1' -Value 1
    New-UDTransferListItem -Name 'test2' -Value 2
    New-UDTransferListItem -Name 'test3' -Value 3
    New-UDTransferListItem -Name 'test4' -Value 4
    New-UDTransferListItem -Name 'test5' -Value 5
} -Id 'transferlist1'

Creates a basic transfer list.

Example 2: OnChange

New-UDTransferList -Item {
    New-UDTransferListItem -Name 'test1' -Value 1
    New-UDTransferListItem -Name 'test2' -Value 2
    New-UDTransferListItem -Name 'test3' -Value 3
    New-UDTransferListItem -Name 'test4' -Value 4
    New-UDTransferListItem -Name 'test5' -Value 5
} -OnChange {
    if ($EventData) {
       Show-UDToast ($EventData | ConvertTo-Json)
    } else {
       Show-UDToast "No items selected"
    }
} -Id 'transferlist2'

Creates a transfer list with an OnChange script block.

Example 3: Selected Items

New-UDTransferList -Item {
    New-UDTransferListItem -Name 'test1' -Value 1
    New-UDTransferListItem -Name 'test2' -Value 2
    New-UDTransferListItem -Name 'test3' -Value 3
    New-UDTransferListItem -Name 'test4' -Value 4
    New-UDTransferListItem -Name 'test5' -Value 5
} -SelectedItem @(1, 2) -Id 'transferlist3'

Creates a transfer list with selected items.

Example 4: Disabled

New-UDTransferList -Item {
    New-UDTransferListItem -Name 'test1' -Value 1
    New-UDTransferListItem -Name 'test2' -Value 2
    New-UDTransferListItem -Name 'test3' -Value 3
    New-UDTransferListItem -Name 'test4' -Value 4
    New-UDTransferListItem -Name 'test5' -Value 5
} -Disabled -Id 'transferlist4'

Creates a disabled transfer list.

Example 5: Disabled Item

New-UDTransferList -Item {
    New-UDTransferListItem -Name 'test1' -Value 1
    New-UDTransferListItem -Name 'test2' -Value 2
    New-UDTransferListItem -Name 'test3' -Value 3
    New-UDTransferListItem -Name 'test4' -Value 4
    New-UDTransferListItem -Name 'test5' -Value 5 -Disabled
} -Id 'transferlist5'

Creates a transfer list with a disabled item.

Example 6: Width and Height

New-UDTransferList -Item {
    New-UDTransferListItem -Name 'test1' -Value 1
    New-UDTransferListItem -Name 'test2' -Value 2
    New-UDTransferListItem -Name 'test3' -Value 3
    New-UDTransferListItem -Name 'test4' -Value 4
    New-UDTransferListItem -Name 'test5' -Value 5
} -Id 'transferlist6' -Width "50%" -Height '200'

Creates a transfer list with a width and height.

Example 7: Dense

New-UDTransferList -Item {
    New-UDTransferListItem -Name 'test1' -Value 1
    New-UDTransferListItem -Name 'test2' -Value 2
    New-UDTransferListItem -Name 'test3' -Value 3
    New-UDTransferListItem -Name 'test4' -Value 4
    New-UDTransferListItem -Name 'test5' -Value 5
} -Id 'transferlist7' -Dense

Creates a transfer list with dense items.

Example 8: Show Search

New-UDTransferList -Item {
    New-UDTransferListItem -Name 'test1' -Value 1
    New-UDTransferListItem -Name 'test2' -Value 2
    New-UDTransferListItem -Name 'test3' -Value 3
    New-UDTransferListItem -Name 'test4' -Value 4
    New-UDTransferListItem -Name 'test5' -Value 5
} -Id 'transferlist8' -ShowSearch

Creates a transfer list with a search box.

Example 9: Titles

New-UDTransferList -Item {
    New-UDTransferListItem -Name 'test1' -Value 1
    New-UDTransferListItem -Name 'test2' -Value 2
    New-UDTransferListItem -Name 'test3' -Value 3
    New-UDTransferListItem -Name 'test4' -Value 4
    New-UDTransferListItem -Name 'test5' -Value 5
} -Id 'transferlist9' -LeftTitle 'Left Title' -RightTitle 'Right Title' -LeftSubTitle 'Left Subtitle' -RightSubTitle 'Right Subtitle'

Creates a transfer list with titles.

Example 10: Enhanced

New-UDTransferList -Item {
    New-UDTransferListItem -Name 'test1' -Value 1
    New-UDTransferListItem -Name 'test2' -Value 2
    New-UDTransferListItem -Name 'test3' -Value 3
    New-UDTransferListItem -Name 'test4' -Value 4
    New-UDTransferListItem -Name 'test5' -Value 5
} -Id 'transferlist10' -Enhanced

Creates a transfer list with enhanced selection.