OnScreenElement Properties

DefaultDisappearWaitTime

Default value for DisappearWaitTimeInSeconds of new OnScreenElements. Default is 20 seconds.

Syntax: public static int DefaultDisappearWaitTime = 20;

DefaultWaitTime

Default value for WaitTimeInSeconds of new OnScreenElements. Default is 20 seconds.

Syntax: public static int DefaultWaitTime = 20;

DisappearWaitTimeInSeconds

How long to wait for the element to disappear from the screen. Defaults to DefaultDisappearWaitTime.

Syntax: public int DisappearWaitTimeInSeconds { get; set; }

Filters

The image filters that will be used to find the element on screen (e.g. Select filter to limit the search to a specific rectangle). Should be used in all methods on derived elements for finding the element.

Syntax: public virtual IImageFilter[] Filters { get; set; }

ImageParameters

Parameters for the image search to find the element on screen. Should be used in all methods on derived elements for finding the element.

Syntax: public ImageDetectionParameters ImageParameters { get; set; }

ParentElement

The screen or other element which contains this element. This is used to wait for the parent element before finding this element. Typically this property is directly set to the screen (this) from which the element is instantiated. ParentElement can also refer to parent elements of other types than BaseScreen, such as Tables, LabelWithElement or other elements that contain child elements.

Syntax: public OnScreenElement ParentElement { get; set; }

Position

The search result of WaitFor. Gives the IEngineResult with the position of the image or text that locates the element on the screen. Is only set if WaitFor succeeded, thus it should always be Position.HasSucceeded() = true;

Syntax: public IEngineResult Position { get; set; }

RetryCount

Determines how many times an interaction shall be attempted, 1 meaning 1 attempt, so no retries. Default = 3.

Syntax: public int RetryCount { get; set; }

TextParameters

Parameters for the text search to find the element on screen. Should be used in all methods on derived elements for finding the element.

Syntax: public OcrEngineParameters TextParameters { get; set; }

UseCachedPosition

If this is true, we don't search the element again, if it was found before (e.g. before an interaction such as Click or Enter). Instead the cached Position is used. Note: This will lead to unexpected behavior, if the element was moved in the mean time! Only set to true, if element cannot move on the UI.

Default = false

Syntax: public bool UseCachedPosition { get; set; }

WaitTimeInSeconds

How long to wait for the element to appear on screen. Defaults to DefaultWaitTime.

Syntax: public int WaitTimeInSeconds { get; set; }