New-UDProgress

Progress dialogs can show both determinate and indeterminate progress. They can also be circular or linear.

Synopsis

Progress dialogs can show both determinate and indeterminate progress. They can also be circular or linear.

Syntax

New-UDProgress [[-Id] <String>] [[-PercentComplete] <Int32>] [[-BackgroundColor] <DashboardColor>] [[-ProgressColor] <DashboardColor>] [-Circular] [[-Size] <String>] [[-Label] <String>] [<CommonParameters>]

Description

Creates a progress dialog. Progress dialogs can show both determinate and indeterminate progress. They can also be circular or linear.

Parameters

-Id

The ID of the component. It defaults to a random GUID.

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

-PercentComplete

The percent complete for the progress.

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

-BackgroundColor

The background color.

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

-ProgressColor

The progress bar color.

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

    -Circular [<SwitchParameter>]
        Whether the progress is circular.

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

-Size

The size of the progress. Valid values are: "small", "medium", "large"

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

-Label

Adds a label to a circle progress.

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

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

Outputs

-------------------------- EXAMPLE 1 --------------------------

PS >New-UDProgress -PercentComplete 75 -Id 'progress1'

Determinate|A determinate progress bar.




-------------------------- EXAMPLE 2 --------------------------

PS >New-UDProgress -Circular -Size large -Id 'progress2'

Circular|A circular progress bar.




-------------------------- EXAMPLE 3 --------------------------

PS >New-UDProgress -BackgroundColor 'red' -ProgressColor 'blue' -Id 'progress3'

Color|Define the background and progress colors.




-------------------------- EXAMPLE 4 --------------------------

PS >New-UDProgress -Circular -Size large -Id 'progress4' -PercentComplete 75 -Label '75%'

Circular with Label|Create a circle progress with a label




-------------------------- EXAMPLE 5 --------------------------

PS >New-UDProgress -Circular -Size large -Id 'progress4'