ItemList Methods

GetRow

Overload List

Name

Description

Searches a specific row based on an image search in the list (includes scrolling). By default, method throws an exception if it cannot find the expected row. If returnNullInsteadOfFail is true, it returns null instead of throwing the exception.

Searches a specific row based on a text search in the list (includes scrolling). By default, method throws an exception if it cannot find the expected row. If returnNullInsteadOfFail is true, it returns null instead of throwing the exception.

GetRow(ImageReference, bool, ImageDetectionParameters)

Searches a specific row based on an image search in the list (includes scrolling). By default, method throws an exception if it cannot find the expected row. If returnNullInsteadOfFail is true, it returns null instead of throwing the exception.

Syntax:

public virtual TRow GetRow(
	ImageReference imageReference,
	bool returnNullInsteadOfFail = false,
	ImageDetectionParameters imageParameters = null
)

Parameters:

Parameter

Description

imageReference

Type: ImageReference The image reference that will be used to find the row in the list.

[returnNullInsteadOfFail]

Type: Boolean

Whether null or an exception shall be returned when the row cannot be found. Default false, so exception will be thrown.

[imageParameters]

Type: ImageDetectionParameters

The parameters that shall be used for the imagesearch.

Return Value:

Returns a Row of the same type TRow that was defined when the list was created.

Exceptions:

Exception

Condition

When the row could not be found in the list and returnNullInsteadOfFail is false.

GetRow(string, bool, OcrEngineParameters)

Searches a specific row based on a text search in the list (includes scrolling). By default, method throws an exception if it cannot find the expected row. If returnNullInsteadOfFail is true, it returns null instead of throwing the exception.

Syntax:

public virtual TRow GetRow(
	string searchText,
	bool returnNullInsteadOfFail = false,
	OcrEngineParameters ocrEngineParameters = null
)

Parameters:

Parameter

Description

searchText

Type: String The search text that will be used to find the row in the list.

[returnNullInsteadOfFail]

Type: Boolean

Whether null or an exception shall be returned when the row cannot be found. Default false, so exception will be thrown.

[ocrEngineParameters]

Type: OcrEngineParameters

The parameters that shall be used for the textsearch.

Return Value:

Returns a Row of the same type TRow that was defined when the list was created.

Exceptions:

Exception

Condition

When the row could not be found in the list and returnNullInsteadOfFail is false.

VerifyItemInList Method

Overload List

Name

Description

Returns a bool whether an item is in the list. The foundRow is returned as an out parameter so it can be used for following interactions. Row will be null, if the item is not in the list.

Returns a bool whether an item is in the list.

VerifyItemInList (String, TRow, OcrEngineParameters)

Returns a bool whether an item is in the list. The foundRow is returned as an out parameter so it can be used for following interactions. Row will be null, if the item is not in the list.

Syntax:

public bool VerifyItemInList(
	string searchText,
	out TRow foundRow,
	OcrEngineParameters ocrEngineParameters = null
)

Parameters:

Parameter

Description

searchText

Type: String The text that shall be searched for to verify the row is in the list.

foundRow

Type: TRow

The row that was found as out parameter so it can be used for following interactions. Will be null, if the item is not in the list.

[ocrEngineParameters]

Type: OcrEngineParameters

The parameters that shall be used for the textsearch.

Return Value:

True if the searchText was found in the list, false otherwise.

VerifyItemInList (String, OcrEngineParameters)

Returns a bool whether an item is in the list.

Syntax:

public bool VerifyItemInList(
	string searchText,
	OcrEngineParameters ocrEngineParameters = null
)

Parameters:

Parameter

Description

searchText

Type: String The text that shall be searched for to verify the row is in the list.

[ocrEngineParameters]

Type: OcrEngineParameters

The parameters that shall be used for the textsearch.

Return Value:

True if the searchText was found in the list, false otherwise.

Last updated