ItemList

Description
Class for Lists, basically a table with only a single column. Can be instantiated directly, however the ListRect Property should be set. Can be used with provided Row or inherited implementation of Row.
ItemList(TRow) Class 
Namespace:  Progile.TRIO.BaseModel
Assembly:  Progile.TRIO.BaseModel (in Progile.TRIO.BaseModel.dll)
Type Parameters:
Type Parameter
Description
TRow
Type: Row​
The type of row that shall be used for the list.
Inheritance Hierarchy:
​Object
  Progile.TRIO.BaseModel.OnScreenElement
    Progile.TRIO.BaseModel.ItemList<TRow>
Constructors
ItemList(ITester, string, ImageReference, IImageFilter[ ])
Syntax:
public ItemList(
	ITester tester,
	string displayName,
	ImageReference imageReference,
	params IImageFilter[] filters
)
Parameter
Description
tester
Type: ITester​
The tester interface.
displayName
Type: String
The name of the list that will be used for logging and reporting of exceptions (customer facing).
imageReference
Type: ImageReference
The image reference that will be used to locate the list on the screen.
filters
Type: IImageFilter[ ]
Typically a Select filter indicating the area of interest for the image search.
ItemList(ITester, string, string, IImageFilter[ ])
Syntax:
public ItemList(
	ITester tester,
	string displayName,
	string searchText,
	params IImageFilter[] filters
)
Parameter
Description
tester
Type: ITester​
The tester interface.
displayName
Type: String
The name of the list that will be used for logging and reporting of exceptions (customer facing).
searchText
Type: String
The search text that will be used to locate the list on the screen.
filters
Type: IImageFilter[ ]
Typically a Select filter indicating the area of interest for the image search.
Methods
Name
Description
​GetRow​
Searches a specific row based on a text or 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.
​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.
​VerifyItemInList(String, OcrEngineParameters)​
Returns a bool whether an item is in the list.
Properties
Name
Description
​ListRect​
Rectangle that contains the whole list.
​ListSelect​
Gets the Select filter for the list.
​Scroller​
Gets or sets the scroller for the list.

Column Properties

ItemList Methods

Last modified 2yr ago

Type Parameter	Description
TRow	Type: Row The type of row that shall be used for the list.

Parameter	Description
tester	Type: ITester The tester interface.
displayName	Type: String The name of the list that will be used for logging and reporting of exceptions (customer facing).
imageReference	Type: ImageReference The image reference that will be used to locate the list on the screen.
filters	Type: IImageFilter[ ] Typically a Select filter indicating the area of interest for the image search.

Parameter	Description
tester	Type: ITester The tester interface.
displayName	Type: String The name of the list that will be used for logging and reporting of exceptions (customer facing).
searchText	Type: String The search text that will be used to locate the list on the screen.
filters	Type: IImageFilter[ ] Typically a Select filter indicating the area of interest for the image search.

Name	Description
GetRow	Searches a specific row based on a text or 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.
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.
VerifyItemInList(String, OcrEngineParameters)	Returns a bool whether an item is in the list.

Name	Description
ListRect	Rectangle that contains the whole list.
ListSelect	Gets the Select filter for the list.
Scroller	Gets or sets the scroller for the list.