TableBase Methods

GetCell

Returns a Select filter of the particular cell in the provided column and row.

Syntax:

public Select GetCell(
	TColumn targetColumn,
	TRow targetRow
)

Parameters:

Parameter	Description
targetColumn	Type: TColumn The column containing the cell that we are looking for.
targetRow	Type: TRow The row containing the cell that we are looking for.

Return Value:

A Select filter of the particular cell in the provided column and row.

GetRow

Overload List

Name	Description
GetRow(TColumn, ImageReference, bool, ImageDetectionParameters)	Searches a specific row based on an image search in the provided searchColum (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(TColumn, string, bool, OcrEngineParameters)	Searches a specific row based on a text search in the provided searchColumn (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(TColumn, ImageReference, bool, ImageDetectionParameters)

Searches a specific row based on an image search in the provided searchColumn (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 TRow GetRow(
	TColumn searchColumn,
	ImageReference imageReference,
	bool returnNullInsteadOfFail = false,
	ImageDetectionParameters imageParameters = null
)

Parameters:

Parameter	Description
searchColumn	Type: TColumn The column containing the cell that we are looking for.
imageReference	Type: ImageReference The image reference that will be used to find the row in the table.
[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 table was created.

Exceptions:

Exception	Condition
TestStepAbortedException	When the row could not be found in the table and returnNullInsteadOfFail is false.

GetRow(TColumn, string, bool, ImageDetectionParameters)

Searches a specific row based on a text search in the provided searchColumn (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 TRow GetRow(
	TColumn searchColumn,
	string searchText,
	bool returnNullInsteadOfFail = false,
	OcrEngineParameters ocrEngineParameters = null,
)

Parameters:

Parameter	Description
searchColumn	Type: TColumn The column containing the cell that we are looking for.
searchText	Type: String The search text that will be used to find the row in the table.
[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 table was created.

Exceptions:

Exception	Condition
TestStepAbortedException	When the row could not be found in the table and returnNullInsteadOfFail is false.

GetRowWithDuplicates

Similar to GetRow, but checks that additional values are as expected in additional columns. Useful when main search column contains multiple rows with same value, that can be distinguished by values in other columns.

Syntax:

public TRow GetRowWithDuplicates(
	TColumn[] searchColumns,
	string[] searchTexts,
	bool returnNullInsteadOfFail = false,
	OcrEngineParameters ocrEngineParameters = null
)

Parameters:

Parameter	Description
searchColumns	Type: TColumn[ ] Array of Columns in which shall be searched. First entry is used for search, other columns are used to check if all values match the searchTexts.
searchTexts	Type: String[] Array of searchTexts. First entry is used to search in first entry of searchColumns, remaining entries are checked in the corresponding entry of searchColumns Array.
[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 table was created.

Exceptions:

Exception	Condition
TestStepAbortedException	When the row could not be found in the table and returnNullInsteadOfFail is false.

VerifyCellContent Method

Verifies the text in a particular cell, defined by the provided column and row, matches the contentToVerify

Syntax:

public bool VerifyCellContent(
	TColumn targetColumn,
	TRow targetRow,
	string contentToVerify,
	OcrEngineParameters ocrEngineParameters = null
)

Parameters:

Parameter	Description
targetColumn	Type: TColumn The column containing the cell that we are looking for.
targetRow	Type: TRow The row containing the cell that we are looking for.
contentToVerify	Type: String The text that shall be verified in the cell.
[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:

True if the cell content matches the contentToVerify, false otherwise.