Properties

Description

Return Type

Extender

Allows users to 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 an adapter.

String

FullName

Design Property. Gets the fully-qualified name of the Process object.

IsCreated

Indicates whether the process has been created (matched).

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

An 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

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.

Method

Description

Parameters

Return Type

CreateTarget

An internal method that should not be called from an automation.

Type targetType, ITarget defaultTarget

ITarget

Detach

Unmatches the process control.

None

Void

Disconnect

Disconnects Studio from the associated process (and all child processes) without stopping it.  

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

GetKeyInstance (2 params)

Gets the unique key instance for the process. For more information, see Windows Applications - MDI Child Windows.

String name, Object key

IComponent

GetTargetsFromFactories (1 param)

An internal method that should not be called from an automation.

IControl

ICollection

GetTargetsFromFactories (2 params)

An internal method that should not be called from an automation.

IControl, out GetTargetsWarning

ICollection

Hide

Hides the application from user's desktop.

None

Void

IsKeyAssigned (1 param)

Verifies that a key is assigned. Include 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 set to 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 (1 param)

Refreshes matching on the process. If the control is currently matched, Studio detaches (unmatches) the process before attempting to rematch. If the control is currently unmatched, you can only call the Rematch method if the parent is matched.

Boolean detach

Void

ResetState

Reserved for .NET requirements.

None

Void

SetNextKey (1 param)

Set the Next Key control using a 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

Sets how Studio stops the application when the Stop method is called on the process. Your options are:

None – Stops the process, but leaves the process running.

ForceClose – Sends the message WM_CLOSE to each top-level window in the process and waits up to the CloseTimeout value for the process to exit. If the CloseTimeout is exceeded, Studio terminates the process.

SimulateClose – Sends the message WM_SYSCOMMAND (with parameter SC_CLOSE) to each top-level window in the process and waits up to the CloseTimeout value for the process to exit. This simulates the user clicking the X on each form’s title bar. If the CloseTimeout is exceeded, Studio terminates the process.

ForceCloseThenTerminate – Same as ForceClose.  Additionally, if the process does not exit within the CloseTimeout period, Studio waits up to the TerminateTimeout value for the process to exit. When this timeout interval expires, Studio terminates the process.

SimulateCloseThenTerminate – Same as SimulateClose. Additionally, if the process does not exit within the CloseTimeout period, Studio waits up to the TerminateTimeout value for the process to exit. When this timeout interval expires, Studio terminates the process.

Terminate – This setting does not attempt to gracefully close the process. Studio waits up to TerminateTimeout value the process to exit. When this timeout interval expires, Studio terminates the process.

None

Boolean

Stop (5 params)

An 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) using StopMethod Terminate. With this StopMethod, the process is terminated 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.

For more information, see StopMethod Property Parameters.

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