Properties
Description
Type
Arguments
Use the Arguments property to enter command-line arguments for an executable file shortcut. For example, you could enter a file name here so when a program launched via a shortcut starts, it opens that file. Also use this property when working with Java applications to specify the Java class name.
String
BrowserBitness
Default is Only32bit. Can be set for 64-bit.
String
CloseTimeout
This property is used when the Stop method is called on the adapter and is related to the StopMethod property ForceClose, ForceCloseThenTerminate, and SimulateCloseThenTerminate options. It specifies the amount of time, in milliseconds, OpenSpan waits for the process to exit after the Stop method has been called. The TerminateTimout value applies when the CloseTimeout expires. After the CloseTimeout expires, OpenSpan attempts to terminate the process. The TerminateTimout value sets the amount of time OpenSpan waits for the process to terminate. If this TerminateTimout value is exceeded, the process is most likely hung and OpenSpan leaves the process running. The CloseTimeout and TerminateTimout properties apply to each process monitored by the adapter.
Milliseconds
Context
Design that indicates the context in which the Windows Adapter is loaded. Contexts generally apply to solutions running in a Citrix environment. Click here for more information on Contexts.
String
DesignTime
Gets a value indicating if the control is a design time control.
Boolean
ExcludedProcesses
Use this property to identify processes that are not required by your project. See the Excluding Processes for Use in Projects topic for more information.
ProcessList
Extender
Use this property to specify an extender class implemented in a separate DLL for the project. Adapter extender classes implement IAdapterExtender and are able to contribute properties, methods and events to an adapter.
String
FullName
Gets the fully qualified name of the Adapter item.
String
This property determines whether the adapter application window displays while the project and corresponding application is running. Set this property to True to hide the application during project runtime. If you set this to True on the Properties Grid at design-time, you can use the adapter's Show method in an automation to display the application while the project is running. You can also hide the application by calling the adapter's Hide method.
Notes:
Matching: Hiding an application effects the matching of interrogated controls within the application. See the UnMatchOnHidden property to understand how hiding an application changes control matching.
Reparented Application: This property is not applicable when the application is selected to display in the TabbedReparentContainer control. If the application is selected in the DesignComponentConfiguration property for the TabbedReparentContainer, the application will display even if the HideApplicationAtRuntime property is set to True. Also, you cannot hide the reparented application by calling the Hide method on the adapter.
Boolean
HookChildProcesses
Use this property to specify how OpenSpan interacts with any processes spawned by the adapter application. Set this property to True to OpenSpan to inject into spawned processes thereby enabling interrogation spawned application targets. See the Using HookChildProcesses topic for more information.
Boolean
IdleTimeout
Sets the amount of time before the application becomes idle.
Milliseconds
InDesign
Gets a value indicating if the control is in design mode.
Boolean
InvokeRequired
This property applies when the project and adapter are referenced in code by a non-OpenSpan project and is not used in OpenSpan stand-alone projects. See the OpenSpan Knowledge Base for more information on referencing OpenSpan Projects.
Boolean
IsRunning
Gets a value indicating whether the application is running.
Boolean
IsStartStoppable
This property controls how the OpenSpan project reacts when the adapter application has been stopped and then restarted. (For example, the user closed the application and then restarted it.) The options are:
True - If the application is stopped and then restarted while the project is running, OpenSpan will hook the application again so that automations or event monitoring can continue.
False - If the application is stopped and then restarted while the project is running, OpenSpan will not attempt to hook the application. The controls within the application will no longer be matched and therefore the project's automations/event monitoring which use the application's controls will fail. The adapter's Start method will not restart the application. You must stop and start the project in order for OpenSpan to hook the application again.
Boolean
IsSuspended
Gets a value indicating whether the adapter application execution suspended.
Boolean
IsStopping
Indicates whether the application is in the process of Stopping. The IsStopping property returns a True value from the time the Stop method is called until the application is finished stopping.
Boolean
MonitoredEvents
Use this property to specify the target types and corresponding events for which event notifications are generated. Browse this property to open the Configure Monitored Events dialog for selection of the target types and events associated with each selected target type for which notifications are generated. See the Events topic for more information.
SelectedEvents
MonitorEventsMode
Use this property to specify the types of application controls for which event notifications are generated. The options are:
-
None. No event notifications are generated for the adapter.
-
Interrogated Controls. Event notifications are generated only for controls which have been interrogated at design time. For this mode, you must interrogate the application's controls for which you want to generate event notifications and then use the MonitoredEvents property to select the controls (target types) and corresponding events for which event notifications will be generated.
-
All Controls. Event notifications are generated for any application control matching the selected target types and corresponding events. For this mode, you do not need to interrogate individual controls in the application. It is only necessary to interrogate the main application window to allow OpenSpan to integrate the application, and complete the MonitoredEvents property to select the controls (target types) and corresponding events for which event notifications will be generated.
See the Events topic for more information.
String
Name
Gets or sets the name assigned to the Adapter.
String
OpenExternalLinksInNewProcess
This property applies when the project contains at least one web application and the version of Internet Explorer used by the project is either version 6 or 7.
The OpenExternalLinksInNewProcess property controls how web applications or pages, unrelated to the active OpenSpan project, are opened. You can have external web applications open in the same Internet Explorer instance used by the project or force the unrelated application to open in a separate Internet Explorer instance. The settings for this property are defined below:
True - Any web applications/pages unrelated to the active project are opened in separate instances of Internet Explorer. For example, suppose the OpenSpan project is automating the training application: http://training.openspan.com/index.htm on a system using Internet Explorer 7.0. If the user opens a web page unrelated to the project, the page will open in a new instance of Internet Explorer. Any pages opened external to the project will remain open after the OpenSpan project is stopped.
False - Any web applications/pages unrelated to the active project are opened in the same Internet Explorer process which is used by the project. For example, suppose the OpenSpan project is automating the training application: http://training.openspan.com/index.htm on a system using Internet Explorer 7.0. If the user opens a web page unrelated to the project, the page will open in a new tab within the current Internet Explorer process and focus will shift to the new tab. In this case, when the OpenSpan project is stopped, Internet Explorer is closed along with any pages opened external to the project.
The OpenExternalLinksInNewProcess property applies regardless of whether the adapter is reparented (displayed in the TabbedReparentContainer control). Therefore if the property is False and a page external to the project is opened, the page will display in the TabbedReparentContainer control.
Boolean
Use this property to set the path to the first application launched through the adapter. Enter the full path to the executable, for example: For example:C:\Program Files\OpenSpan\CRM Setup\CRM.exe.
If the application is in a folder that is already set in the system path, you can enter the application file name without the full path. For example, Calc.exe.
Use the Folder sub-property when the executable is in a different folder on OpenSpan Runtime workstations which will be running the deployed solution than on the OpenSpan Studio workstation. The Folder property enables you to select a system folder for the executable which OpenSpan Runtime uses to open the application in the runtime project. You select these folders from a drop down menu with options such as Deployment, Temporary, Personal etc
.
If the solution is using an application which launches other applications which will be interrogated, use the Path property to set the path for the launching program and use the TargetPath property to set the path for the application to be interrogated. Set the HookChildProcesses property to True if multiple applications are launched and these applications are interrogated. See the Using TargetPath Property topic for more information.
ResolvePath
This property is used in conjunction with the Path property at design time to help the developer resolve the full qualified path of the application automatically. Set the ResolvePath to True if the application path is part of the system environmental path and you want the designer to auto-complete the Path property . Set the ResolvePath to False if you want to manually select the location of the executable or you are using the MonitorAll StartMethod on the adapter. When using MonitorAll, the executable name is the only required value in the Path property.
Boolean
SendMessageTimeOut
Sets the amount of time OpenSpan waits for an acknowledgment message before sending the timeout message.
Milliseconds
Use this property to define whether the OpenSpan project launches the adapter application, or whether OpenSpan will wait for an external actor to launch it. See the StartMethod Property and StartOnProjectStart topic for more information.
StartMethod string
StartOnProjectStart
Sets whether or not the selected adapter should start when the project runs. See the StartMethod Property and StartOnProjectStart topic for more information.
Boolean
StartTimeout
Sets the number of milliseconds the adapter waits for the application to start before OpenSpan issues a timeout message.
Milliseconds
StopMethod
Sets how OpenSpan stops the application when the Stop method is called on the adapter. The options are:
None - Stops the adapter, but leaves the process running.
ForceClose - For each process monitored by the adapter, OpenSpan 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, OpenSpan leaves the process running.
SimulateClose - For each process monitored by the adapter, OpenSpan 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, OpenSpan leaves the process running.
ForceCloseThenTerminate - Same as ForceClose, however, OpenSpan waits up to the CloseTimeout value for the process to exit. When the CloseTimeout period expires, OpenSpan attempts to terminate the process and waits up to the TerminateTimeout value for the process to exit. If the process does not terminate within the TerminateTimeout it is likely hung, and OpenSpan leaves the process running.
SimulateCloseThenTerminate -Same as SimulateClose, however, OpenSpan waits up to the CloseTimeout value for the process to exit. When the CloseTimeout period expires, OpenSpan attempts to terminate the process and waits up to the TerminateTimeout value for the process to exit. If the process does not terminate within the TerminateTimeout it is likely hung, and OpenSpan leaves the process running.
Terminate - This setting does not attempt to gracefully close the process. For each process monitored by the adapter, OpenSpan attempts to terminate the process immediately and waits up to the TerminateTimeout value for the process to exit. If the process does not terminate within the TerminateTimeout it is likely hung, and OpenSpan leaves the process running.
String
SuppressForegroundWindows
Set to True to prevent an application from creating top most windows or bringing windows into the foreground when it is not the active application. The default is False. For example, when automating a windows application in the background, the application may create top most windows that show over the top of foreground windows disrupting user activity.
Setting this property to True will prevent the application from creating new topmost windows, converting existing windows to topmost, and bringing windows into the foreground.
Boolean
TargetPath
Sets the reference path to the application or document. See the Using Target Path Property topic for more information.
String
TerminateTimeout
This property is used when the Stop method is called on the adapter and is related to the StopMethod property ForceCloseThenTerminate, SimulateCloseThenTerminate, and Terminate options. The TerminateTimout value applies when the CloseTimeout expires. After the CloseTimeout expires, OpenSpan attempts to terminate the process. The TerminateTimout value sets the amount of time OpenSpan waits for the process to terminate. If the TerminateTimout value is exceeded, the process is most likely hung and OpenSpan leaves the process running. The TerminateTimeout property applies to each process monitored by the adapter.
Milliseconds
This
A reference to the Adapter object.
String
UniqueId
Indicates the unique identifier of the Adapter object.
String
WorkingDirectory
This is the working directory of the application interrogated by OpenSpan. OpenSpan Studio determines the location of the Working Directory based on the Path property.
String
