Skip to main content

​
SYNOPSIS

Displays a small splash window with an indeterminate progress bar.

​
SYNTAX

Show-Splash [[-InitialMessage] <String>] [[-Title] <String>] [[-Subtitle] <String>] [[-Version] <String>]
 [[-LogoPath] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

​
DESCRIPTION

The splash runs in its own STA runspace so its UI keeps animating while the caller’s thread is busy building the main window or loading data. Returns an object exposing: .Update($message) - update the status line (thread-safe) .Close() - dismiss the splash and dispose the runspace

​
EXAMPLES

​
PARAMETERS

​
-InitialMessage

{{ Fill InitialMessage Description }} 
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: Loading...
Accept pipeline input: False
Accept wildcard characters: False

​
-Title

{{ Fill Title Description }} 
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: PS365.Clidsys
Accept pipeline input: False
Accept wildcard characters: False

​
-Subtitle

{{ Fill Subtitle Description }} 
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

​
-Version

{{ Fill Version Description }} 
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

​
-LogoPath

{{ Fill LogoPath Description }} 
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

​
CommonParameters

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

​
INPUTS

​
OUTPUTS

​
NOTES