Dropdown

Description
The Dropdown class represents UI elements that are consisting of a text field (which can be editable or not) and a dropdown list that can be expanded by clicking in the text field or on an optional dropdown button. The dropdown list can include a scroller to scroll through the possible selections.
The dropdown is identified on the screen by the Hotspot of the image given in the constructor, which should be placed within the text field. If there is no closed border around the text field, this implementation will not support this dropdown type.
The Dropdown object uses a TextBox object, a Button object and an ItemList with an optional Scroller.
Dropdown Class
Namespace:  Progile.TRIO.BaseModel
Assembly:  Progile.TRIO.BaseModel (in Progile.TRIO.BaseModel.dll)
Inheritance Hierarchy:
​Object
  Progile.TRIO.BaseModel.OnScreenElement
    Progile.TRIO.BaseModel.Dropdown
Constructors
Dropdown(IAppBasics, string, string, IImageFilter[ ])
Creates a new Dropdown instance, that can be found with a text search for dropdownLabelText within the provided filters.
Syntax:
public Dropdown(
	IAppBasics appBasics, 
	string displayName, 
	string dropdownLabelText, 
	params IImageFilter[] filters
)
Parameter
Description
appBasics
Type: Progile.TRIO.BaseModel.IAppBasics​
The interface for the AppBasics, that is available on every BaseScreen. Allows access to the testerinterface and the application window.
displayName
Type: String
The name of the element that will be used for logging and reporting of exceptions (customer facing).
dropdownLabelText
Type: String
The string that will be used to locate the Dropdown on the screen.
[filters]
Type: IImageFilter[ ]
Typically a Select filter indicating the area of interest for the text search.
Dropdown(IAppBasics, string, ImageReference, bool, IImageFilter[ ])
Creates a new Dropdown instance. Dropdown Textbox will be defined by the visible closed border around the Hotspot of the provided image. If an image for the Dropdown button is provided, it will be used to open the dropdown list, otherwise the dropdown is opened simply by clicking in the textbox.
Syntax:
public Dropdown(
	IAppBasics appBasics, 
	string displayName, 
	ImageReference imageReference, 
	bool useVisualSense, 
	params IImageFilter[] filters
)
Parameter
Description
appBasics
Type: Progile.TRIO.BaseModel.IAppBasics​
The interface for the AppBasics, that is available on every BaseScreen. Allows access to the testerinterface and the application window.
displayName
Type: String
The name of the element that will be used for logging and reporting of exceptions (customer facing).
imageReference
Type: ImageReference
The image that will be used to locate the Dropdown on the screen. The Hotspot of the image must be set within the dropdown textbox.
useVisualSense
Type: Boolean
True if VisualSense should be used to find the element
[filters]
Type: IImageFilter[ ]
Typically a Select filter indicating the area of interest for the image search.
Dropdown(IAppBasics, string, ImageReference, ImageReference, bool, IImageFilter[ ])
Creates a new Dropdown instance. Dropdown Textbox will be defined by the visible closed border around the Hotspot of the provided image. If an image for the Dropdown button is provided, it will be used to open the dropdown list, otherwise the dropdown is opened simply by clicking in the textbox.
Syntax:
public Dropdown(
	IAppBasics appBasics,
	string displayName,
	ImageReference imageReference,
	ImageReference buttonImage, 
	bool useVisualSense,
	params IImageFilter[] filters
)
Parameter
Description
appBasics
Type: Progile.TRIO.BaseModel.IAppBasics​
The interface for the AppBasics, that is available on every BaseScreen. Allows access to the testerinterface and the application window.
displayName
Type: String
The name of the element that will be used for logging and reporting of exceptions (customer facing).
imageReference
Type: ImageReference
The image that will be used to locate the Dropdown on the screen. The Hotspot of the image must be set within the dropdown textbox.
buttonImage
Type: ImageReference
The image that defines the dropdown button to expand the dropdown. For many dropdown simply clicking in the textbox expands the dropdown list, in this case the buttonImage can be left null.
useVisualSense
Type: Boolean
True if VisualSense should be used to find the element
[filters]
Type: IImageFilter[ ]
Typically a Select filter indicating the area of interest for the image search.
Methods 
Name
Description
​OpenDropdownList​
Opens the dropdown list and returns a rectangle for the list (based on rectangle with changes after expanding dropdown list)
​SelectImage​
Opens the dropdown list, searches the imageReference in the list (incl. scrolling) and selects it. If the image cannot be found, throws a TestStepAbortedException.
​SelectOnScreenElement​
Opens the dropdown list, searches for the element in the list (incl. scrolling) and selects it. If the image cannot be found, throws a TestStepAbortedException. 
​SelectValue​
Opens the dropdown list, searches the text value in the list (incl. scrolling) and selects it. If the text cannot be found, throws a TestStepAbortedException.
​VerifySelectedValue​
Verifies if the value that is currently set in the TextBox matches the expected value. If it doesn't, the value read from the TextBox is returned as the actualValue out parameter.
​VerifyValueInList​
Opens the dropdown list and verifies if the provided value is present in the dropdown list (includes scrolling). Closes the dropdown list again.
Properties
Name
Description
​BlurKernelForDetectChanges​
The size of the kernel that is used to blur the images when detecting the changes to define the list rectangle. Size 0 means no blur, a common value for moderate blurring is 8 (approx. the size of a character). 
Default: 0
​DropdownListImageParas​
The image detection parameters that are used to find an image entry in the dropdown list.
​DropdownListOcrParas​
The OCR parameters that are used to find a text entry in the dropdown list. By default also this paras are used to verify a selected element, but TextBox.TextBoxOcrParas can be set separately.
​ListBorder​
Width of the border of the list that will be cut away on all sides to remove a border from the image that is passed to the OCR algorithm.
Default: 3
​MoveMouseListAfterOpen​
Determines whether the mouse should be moved in the middle of the dropdown list in order to focus the scroller of the list. Can cause problems with list entries that have tooltips. 
Default: false
​SearchRectangleForList​
The search rectangle in which changes are detected to define the list rectangle. 
Default: AppBasic.Window​
​TextBox​
Textbox of the dropdown. Is also used to define the dropdown list. Rectangle of TextBox is defined when first used by visible closed border around the Hotspot of the provided image.
​ToleranceForDetectChanges​
The tolerance value for changes that shall be ignored when detecting the changes to define the list rectangle. 
Default 0.04
Protected properties
Name
Description
​DropdownButton​
The dropdown button used to open the dropdownList. Either coming from provided buttonImage in Dropdown ctor or just the Textbox itself (works in most dropdowns).

ContextMenu Properties

Dropdown Methods

Last modified 3mo ago

Parameter	Description
appBasics	Type: Progile.TRIO.BaseModel.IAppBasics The interface for the AppBasics, that is available on every BaseScreen. Allows access to the testerinterface and the application window.
displayName	Type: String The name of the element that will be used for logging and reporting of exceptions (customer facing).
dropdownLabelText	Type: String The string that will be used to locate the Dropdown on the screen.
[filters]	Type: IImageFilter[ ] Typically a Select filter indicating the area of interest for the text search.

Parameter	Description
appBasics	Type: Progile.TRIO.BaseModel.IAppBasics The interface for the AppBasics, that is available on every BaseScreen. Allows access to the testerinterface and the application window.
displayName	Type: String The name of the element that will be used for logging and reporting of exceptions (customer facing).
imageReference	Type: ImageReference The image that will be used to locate the Dropdown on the screen. The Hotspot of the image must be set within the dropdown textbox.
useVisualSense	Type: Boolean True if VisualSense should be used to find the element
[filters]	Type: IImageFilter[ ] Typically a Select filter indicating the area of interest for the image search.

Parameter	Description
appBasics	Type: Progile.TRIO.BaseModel.IAppBasics The interface for the AppBasics, that is available on every BaseScreen. Allows access to the testerinterface and the application window.
displayName	Type: String The name of the element that will be used for logging and reporting of exceptions (customer facing).
imageReference	Type: ImageReference The image that will be used to locate the Dropdown on the screen. The Hotspot of the image must be set within the dropdown textbox.
buttonImage	Type: ImageReference The image that defines the dropdown button to expand the dropdown. For many dropdown simply clicking in the textbox expands the dropdown list, in this case the buttonImage can be left null.
useVisualSense	Type: Boolean True if VisualSense should be used to find the element
[filters]	Type: IImageFilter[ ] Typically a Select filter indicating the area of interest for the image search.

Name	Description
OpenDropdownList	Opens the dropdown list and returns a rectangle for the list (based on rectangle with changes after expanding dropdown list)
SelectImage	Opens the dropdown list, searches the imageReference in the list (incl. scrolling) and selects it. If the image cannot be found, throws a TestStepAbortedException.
SelectOnScreenElement	Opens the dropdown list, searches for the element in the list (incl. scrolling) and selects it. If the image cannot be found, throws a TestStepAbortedException.
SelectValue	Opens the dropdown list, searches the text value in the list (incl. scrolling) and selects it. If the text cannot be found, throws a TestStepAbortedException.
VerifySelectedValue	Verifies if the value that is currently set in the TextBox matches the expected value. If it doesn't, the value read from the TextBox is returned as the actualValue out parameter.
VerifyValueInList	Opens the dropdown list and verifies if the provided value is present in the dropdown list (includes scrolling). Closes the dropdown list again.

Name	Description
BlurKernelForDetectChanges	The size of the kernel that is used to blur the images when detecting the changes to define the list rectangle. Size 0 means no blur, a common value for moderate blurring is 8 (approx. the size of a character). Default: 0
DropdownListImageParas	The image detection parameters that are used to find an image entry in the dropdown list.
DropdownListOcrParas	The OCR parameters that are used to find a text entry in the dropdown list. By default also this paras are used to verify a selected element, but `TextBox.TextBoxOcrParas` can be set separately.
ListBorder	Width of the border of the list that will be cut away on all sides to remove a border from the image that is passed to the OCR algorithm. Default: 3
MoveMouseListAfterOpen	Determines whether the mouse should be moved in the middle of the dropdown list in order to focus the scroller of the list. Can cause problems with list entries that have tooltips. Default: false
SearchRectangleForList	The search rectangle in which changes are detected to define the list rectangle. Default: AppBasic.Window
TextBox	Textbox of the dropdown. Is also used to define the dropdown list. Rectangle of TextBox is defined when first used by visible closed border around the Hotspot of the provided image.
ToleranceForDetectChanges	The tolerance value for changes that shall be ignored when detecting the changes to define the list rectangle. Default 0.04

Name	Description
DropdownButton	The dropdown button used to open the dropdownList. Either coming from provided buttonImage in Dropdown ctor or just the Textbox itself (works in most dropdowns).