Methods, Properties, and Events to Use with Cloned Controls

The following properties, methods, and events are useful when designing solutions that contain cloned controls.

Property

Description

ActiveFormKey

Gets or sets the key for the currently active form. The form is considered active if it is the top-most form.

IsCreated

Returns True if the control is matched and False if it is unmatched.

On controls that can match multiple native targets, returns True if any target is matched and False if no targets are matched.

Key

Gets or sets the unique key value for the control. Type: String.

NextKey

Gets the control assigned to the nextkey value. Type: ICloneableControl.

WaitTimeout

The amount of time, measured in seconds, to wait for a control to be created or destroyed before timing out. The default is 30 seconds.

Methods

Description

Activate

1 string parameter

If a control exists that has the specified key, activates that control and returns True. Otherwise, returns False.

Activate or Set Next Key

1 string parameter

If a form exists that has the specified key, activates that form. Otherwise, calls SetNextKeyAndReset().

Form Exists

1 string parameter

Returns True if a form exists with the specified key. Otherwise, returns False.

SetNextKey

1 string parameter

Sets a key that will be applied to the next control that is created. If WaitForCreate times out with no control being created the next key is cleared.

SetNextKeyAndReset

1 string parameter

Calls SetNextKey and then WaitForCreateReset.

WaitForCreate

Waits for a control to be matched. Returns True if the Control is matched before the WaitTimeout period elapses. Otherwise, returns False.

WaitForCreate (int seconds)

Waits for a control to be matched. Returns True if the Control is matched before the specified number of seconds elapses. Otherwise, returns False.

Events

Description

Created

Fires when a control is matched.

Destroyed

Fires when a control is unmatched.

FormActivated

Fires when a form is activated. The argument for this EventAn occurrence that is significant to a program and which may call for a response from a program. For example, when a button is clicked., Key Property, gets the key of the form that was activated.

FormCreated

Fires when a form is created. The argument for this Event, Key Property, gets or sets the key of the form that was created.

FormDestroyed

Fires when a form is destroyed. The argument for this Event, Key Property, gets the key for the form that was destroyed.


Privacy | Trademarks | Terms of Use | Feedback

Updated: 18 June 2020

© 2016 - 2020 Pegasystems Inc.  Cambridge, MA All rights reserved.

 

OpenSpan data classification label