Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

New-UDProgress

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.

-BackgroundColor

The background color.

-ProgressColor

The progress bar color.

-Circular

Whether the progress is circular.

-Size

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

-Label

Adds a label to a circle progress.

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: Determinate

A determinate progress bar.

Example 2: Circular

A circular progress bar.

Example 3: Color

Define the background and progress colors.

Example 4: Circular with Label

Create a circle progress with a label

Example 5

Last updated

Was this helpful?