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:

Return Value:

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

GetRow

Overload List

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:

Return Value:

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

Exceptions:

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:

Return Value:

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

Exceptions:

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:

Return Value:

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

Exceptions:

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:

Return Value:

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

Last updated