Windows process object properties, methods, and events
The application process object is not created as a control in Object Explorer, but you can add the process using the Create Control function from the Windows, web, or Java tabs. For more information, see Create Control.
These tables list the properties, methods, and events for the Process object.
Properties
Properties |
Description |
Return Type |
Extender |
Lets users specify an extender class they have implemented in a separate DLL file. Adapter extender classes implement IAdapterExtender and are able to contribute properties, methods, and events to a process. |
String |
FullName |
Design Property. Gets the fully-qualified name of the Process object. |
|
IsCreated |
Indicates whether the process has been created (matched). |
Boolean |
IsDisposed |
Returns True if the instance of the Process object is disposed. Otherwise it returns False. |
Boolean |
Key |
Gets or sets the unique Key value for this process. |
String |
Name |
Gets or sets the name assigned to the Process control. |
String |
NextKey |
Sets the key value that will be assigned to the next clone created. |
ICloneableControl |
Process |
Internal property that should not be used in an automation |
WindowsProcess |
This |
A reference to the Process object. |
Application |
Timeout |
Specifies the timeout interval for the Created event. |
Int32 Milliseconds |
UniqueID |
A design property that indicates the system generated unique identifier of the Process object. |
|
UseKeys |
Specifies whether (True) or not (False) multiple instances of the process exist at runtime. For more information, see Windows Applications - MDI Child Windows. |
Boolean |
WaitHandle |
A control's WaitHandle is a signal that is turned on when a control is created and off when the control is destroyed. The WaitHandle allows callers to wait for the component's creation signal when using the WaitAny or WaitAll components. |
WaitHandle |
Events
Event |
Description |
Created |
Occurs when the process is matched. |
Destroyed |
Occurs when the process is unmatched. |
Disposed |
Occurs when the process is disposed by a call to the Dispose method. |
Methods
Method |
Description |
Parameters |
Return Type |
Disconnect |
Disconnects Studio from the associated process (and all child processes) without stopping it. |
None |
Void |
Dispose |
Disposes of the resources, other than memory, that are used by the process. |
None |
Void |
GetClones |
Returns a collection of cloned objects. Use the GetClones method in combination with a ListLoop component to iterate over the list of cloned objects to extract individual list items. |
None |
CloneCollection |
GetEvent (1 param) |
Initiates downstream logic pending the occurrence of a particular event . Click the Name parameter in the GetEvent design block to view a list of events applicable for the component . Select the event and then create a proxy from the GetEvent result. For more information, see Get Event for Windows Controls and Forms. |
EventName name |
Event |
Hide |
Hides the application from user's desktop. Note: We do not recommend using this method when automating applications because some applications and controls must be on an active desktop and visible. |
None |
Void |
IsKeyAssigned (1 param) |
Verifies that a key is assigned. Supply the Key as a string parameter. For more information, see Windows Applications - MDI Child Windows. |
String |
Boolean |
LaunchProgram (3 params) |
A convenience method used to launch a program. The resulting process is not directly injected by Studio, but if the driver or branding is being used, the process could be injected by those techniques. This is mainly used when the StartMethod is MonitorAll and an automation needs to be able to launch a program. Arguments: Path – The program to start including as much of the path as is required to locate it. Arguments – Arguments to pass to the program at startup. WorkingDirectory – The working directory to associate with the program. For more information, see Start Method and StartOnProjectStart. |
String path, String arguments, String workingDirectory |
Void |
Rematch |
Refreshes matching on the Process control. If the control is currently matched, Studio detaches (unmatches) the control and children before attempting to rematch. If the control is currently unmatched, you can only call Rematch if the parent is matched. |
None |
Void |
RematchChildren |
Refreshes matching on all objects under the control. Set the detach property to True to unmatch all targets before attempting to rematch. |
Boolean detach |
Void |
ResetState |
Reserved for .NET requirements. |
None |
Void |
SetNextKey (1 param) |
Set the Next Key control using unique key.For more information, see Windows Applications - MDI Child Windows. |
String |
Void |
Show |
Makes a hidden application visible. Use this method with either the process's Hide method or the HideApplicationAtRuntime property of the process. |
None |
Void |
Stop |
Stops the associated process (and all child processes). Studio waits up to 10 seconds for the process to stop before terminating it. Returns True if the process and all child processes stopped within the time allowed. Returns False if one or more processes did not stop. |
None |
Boolean |
Stop (5 params) |
Internal method that should not be called from an automation. |
WindowsProcessStopMethod method, Int32 closeTimeout, Int32 terminateTimeout, Boolean stopChildren, Boolean detach |
Boolean |
Terminate |
Stops the associated process (and all child processes) immediately. No attempt is made to close open windows or to otherwise notify the process that it is about to be stopped. Returns True if the process and all child processes stopped within the time allowed. Returns False if one or more processes did not stop. |
None |
Boolean |
WaitForCreate |
Waits for the process to be created (matched). Returns True if the process is created before the WaitTimeout period elapses. Otherwise, it returns False. For more information, see Wait For Create. |
None |
Boolean |
WaitForCreate (1 param) |
Waits for the process to be created (matched). Returns True if the process is created before the specified number of milliseconds has elapsed. Otherwise, it returns False.For more information, see Wait For Create. |
Milliseconds |
Boolean |
Privacy | Trademarks | Terms of Use | Feedback
Updated: 01 July 2024
© 2016 - 2024 Pegasystems Inc. Cambridge, MA All rights reserved.