PsUi

1.0.0

public/list/Clear-UiList.ps1

                                function Clear-UiList {

    <#

    .SYNOPSIS

        Clears all items from a UiList control.

    .PARAMETER Variable

        The variable name of the list control.

    .EXAMPLE

        Clear-UiList 'myList'

    #>

    [CmdletBinding()]

    param(

        [Parameter(Mandatory, Position = 0)]

        [string]$Variable

    )

    $session = Get-UiSession

    Write-Debug "Clearing list '$Variable'"

    $collection = $session.GetListCollection($Variable)

    if ($null -eq $collection) {

        Write-Error "List '$Variable' not found."

        return

    }

    Write-Debug "Removing $($collection.Count) items"

    $collection.Clear()

}