Show-ADTInstallationPrompt

PackageDeployment Module Help	Package Deployment Module
Show-ADTInstallationPrompt Cmdlet	Version 4.0.0.5

Show-ADTInstallationPrompt

Synopsis

Displays a custom installation prompt with the toolkit branding and optional buttons.

Syntax

Show-ADTInstallationPrompt [[-Title] <String>] [[-Message] <String>] [[-MessageAlignment] <String>] [[-ButtonRightText] <String>] [[-ButtonLeftText] <String>] [[-ButtonMiddleText] <String>] [[-Icon] <String>] [-NoWait] [-PersistPrompt] [[-MinimizeWindows] <Boolean>] [[-Timeout] <Int32>] [[-ExitOnTimeout] <Boolean>] [[-TopMost] <Boolean>] [[-ResultVariable] <String>] [[-Context] <String>] [<CommonParameters>]

Description

Any combination of Left, Middle or Right buttons can be displayed. The return value of the button clicked by the user is the button text specified.

Parameters

-Title <String>

Title of the prompt. Default: the application installation name.

Required	False
Position	1
Accepts pipeline input	False

-Message <String>

Message text to be included in the prompt.

Required	False
Position	2
Accepts pipeline input	False

-MessageAlignment <String>

Alignment of the message text. Options: Left, Center, Right. Default: Center.

Required	False
Position	3
Accepts pipeline input	False

-ButtonRightText <String>

Show a button on the right of the prompt with the specified text.

Required	False
Position	4
Accepts pipeline input	False

-ButtonLeftText <String>

Show a button on the left of the prompt with the specified text.

Required	False
Position	5
Accepts pipeline input	False

-ButtonMiddleText <String>

Show a button in the middle of the prompt with the specified text.

Required	False
Position	6
Accepts pipeline input	False

-Icon <String>

Show a system icon in the prompt. Options: Application, Asterisk, Error, Exclamation, Hand, Information, None, Question, Shield, Warning, WinLogo. Default: None

Required	False
Position	7
Accepts pipeline input	False

-NoWait <SwitchParameter>

Specifies whether to show the prompt asynchronously (i.e. allow the script to continue without waiting for a response). Default: $false.

Required	False
Position	Named
Accepts pipeline input	False

-PersistPrompt <SwitchParameter>

Specify whether to make the prompt persist in the center of the screen every couple of seconds, specified in the AppDeployToolkitConfig.xml. The user will have no option but to respond to the prompt - resistance is futile!

Required	False
Position	Named
Accepts pipeline input	False

-MinimizeWindows <Boolean>

Specifies whether to minimize other windows when displaying prompt. Default: $false.

Required	False
Position	8
Accepts pipeline input	False

-Timeout <Int32>

Specifies the time period in seconds after which the prompt should timeout. Default: UI timeout value set in the config XML file.

Required	False
Position	9
Accepts pipeline input	False

-ExitOnTimeout <Boolean>

Specifies whether to exit the script if the UI times out. Default: $true.

Required	False
Position	10
Accepts pipeline input	False

-Topmost <Boolean>

Specifies whether the progress window should be topmost. Default: $true.

Required	False
Position	11
Accepts pipeline input	False

-ResultVariable <String>

Name of the variable in which the result is saved.

Required	False
Position	12
Accepts pipeline input	False

-Context <String>

User: Execution under user account; logging in HKEY_CURRENT_USER, i.e. for the user.
UserPerService: User-related command, execution in Service context.
Computer: Execution under user account; logging in HKEY_CURRENT_MACHINE, i.e. for the computer.
ComputerPerService: Execution in service context; logging in HKEY_LOCAL_MACHINE, i.e. for the computer.

Required	False
Position	6
Accepts pipeline input	False

For more information about common parameters, type "Get-Help about_CommonParameters".