< Back
Set-AMWindowCondition
Post
NAME Set-AMWindowCondition
SYNOPSIS
Sets properties of an AutoMate Enterprise window condition.
SYNTAX
Set-AMWindowCondition [-InputObject] <Object> [[-Action] {Open | Close | Focus | Background}] [-TriggerOnce]
[-HoldFocus] [[-Title] <String>] [[-Class] <String>] [[-Handle] <String>] [-ChildWindow] [[-Delay] <Int32>]
[-Wait] [[-Timeout] <Int32>] [[-TimeoutUnit] {Seconds | Minutes | Hours | Days | Milliseconds}] [[-TriggerAfter]
<Int32>] [[-Notes] <String>] [[-CompletionState] {InDevelopment | Testing | Production | Archive}] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Set-AMWindowCondition modifies an existing window condition.
PARAMETERS
-InputObject <Object>
The condition to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Action
Specifies the window state to monitor.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TriggerOnce [<SwitchParameter>]
If enabled, specifies that the action to be performed on the window being monitored will occur only once when
that window first opens and ignore other instances.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-HoldFocus [<SwitchParameter>]
If specified, holds the window in focus.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Title <String>
Specifies the title of the window to monitor. The value is not case sensitive.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Class <String>
Specifies the class of the window to monitor.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Handle <String>
Specifies the handle of the window to monitor. A window handle is code that uniquely identifies an open window
(disabled by default).
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ChildWindow [<SwitchParameter>]
If enabled, specifies that the window to monitor is a child window. A child window is normally a secondary
window on screen that is displayed within the main overall window of the application. This option is available
only when the Action parameter is set to Wait for window to be focused or Wait for window to not be focused.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Delay <Int32>
Use a delay (in milliseconds) to prevent this condition from checking a window's condition immediately.
Required? false
Position? 6
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Wait [<SwitchParameter>]
Wait for the condition, or evaluate immediately.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
If wait is specified, the amount of time before the condition times out.
Required? false
Position? 7
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutUnit
The unit for Timeout (Seconds by default).
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TriggerAfter <Int32>
The number of times the condition should occur before the trigger fires.
Required? false
Position? 9
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Notes <String>
The new notes to set on the object.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CompletionState
The completion state (staging level) to set on the object.
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
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).
INPUTS
OUTPUTS
RELATED LINKS
https://github.com/AutomatePS/AutomatePS
SYNOPSIS
Sets properties of an AutoMate Enterprise window condition.
SYNTAX
Set-AMWindowCondition [-InputObject] <Object> [[-Action] {Open | Close | Focus | Background}] [-TriggerOnce]
[-HoldFocus] [[-Title] <String>] [[-Class] <String>] [[-Handle] <String>] [-ChildWindow] [[-Delay] <Int32>]
[-Wait] [[-Timeout] <Int32>] [[-TimeoutUnit] {Seconds | Minutes | Hours | Days | Milliseconds}] [[-TriggerAfter]
<Int32>] [[-Notes] <String>] [[-CompletionState] {InDevelopment | Testing | Production | Archive}] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Set-AMWindowCondition modifies an existing window condition.
PARAMETERS
-InputObject <Object>
The condition to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Action
Specifies the window state to monitor.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TriggerOnce [<SwitchParameter>]
If enabled, specifies that the action to be performed on the window being monitored will occur only once when
that window first opens and ignore other instances.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-HoldFocus [<SwitchParameter>]
If specified, holds the window in focus.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Title <String>
Specifies the title of the window to monitor. The value is not case sensitive.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Class <String>
Specifies the class of the window to monitor.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Handle <String>
Specifies the handle of the window to monitor. A window handle is code that uniquely identifies an open window
(disabled by default).
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ChildWindow [<SwitchParameter>]
If enabled, specifies that the window to monitor is a child window. A child window is normally a secondary
window on screen that is displayed within the main overall window of the application. This option is available
only when the Action parameter is set to Wait for window to be focused or Wait for window to not be focused.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Delay <Int32>
Use a delay (in milliseconds) to prevent this condition from checking a window's condition immediately.
Required? false
Position? 6
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Wait [<SwitchParameter>]
Wait for the condition, or evaluate immediately.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
If wait is specified, the amount of time before the condition times out.
Required? false
Position? 7
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutUnit
The unit for Timeout (Seconds by default).
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TriggerAfter <Int32>
The number of times the condition should occur before the trigger fires.
Required? false
Position? 9
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Notes <String>
The new notes to set on the object.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CompletionState
The completion state (staging level) to set on the object.
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
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).
INPUTS
OUTPUTS
RELATED LINKS
https://github.com/AutomatePS/AutomatePS