LabelWithCheckbox

Description
Class for checkboxes that are associated with a static label. Offers same interactions as Checkbox.
LabelWithCheckbox Class
Namespace:  Progile.TRIO.BaseModel
Assembly:  Progile.TRIO.BaseModel (in Progile.TRIO.BaseModel.dll)
Inheritance Hierarchy:
​Object
  Progile.TRIO.BaseModel.OnScreenElement
    Progile.TRIO.BaseModel.LabelWithElementBase
      Progile.TRIO.BaseModel.LabelWithCheckbox
Constructors
Initializes a new instance of the LabelWithCheckbox class.
LabelWithCheckbox(ITester, string, RelativePosition, ImageReference, ImageReference, ImageReference, int, int, IImageFilter[ ])
Syntax:
public LabelWithCheckbox(
	ITester tester,
	string displayName,
	RelativePosition checkboxPosition,
	ImageReference imageReferenceForLabel,
	ImageReference checkedImageReference,
	ImageReference uncheckedImageReference,
	int gridWidth = 0,
	int checkboxLineHeight = 0,
	params IImageFilter[] filters
)
Parameters:
Parameter
Description
tester
Type: ITester​
The tester interface.
displayName
Type: String
The name of the checkbox that will be used for logging and reporting of exceptions (customer facing).
checkboxPosition
Type: Progile.TRIO.BaseModel.RelativePosition
The position of the checkbox relative to the label.
imageReferenceForLabel
Type: ImageReference
The image reference that will be used to locate the label on the screen.
checkedImageReference
Type: ImageReference​
The image reference for the checked representation. This or the uncheckedImgRef will be used to locate the checkbox.
uncheckedImageReference
Type: ImageReference​
The image reference for the unchecked representation. This or the checkedImgRef will be used to locate the checkbox.
[gridWidth]
Type: Int32
The minimum width that contains both the label and the checkbox, typically the width of the UI grid column.
(Note: ensure the width fits with all window sizes that need to be supported)
The gridWith needs to be set for checkboxPosition Left or Right
[checkboxLineHeight]
Type: Int32​
The minimum Height of the line with the checkbox.
The lineHeight needs to be set for checkboxPosition Above or Under
[filters]
Type: IImageFilter[]
The filters to find the label.
Exceptions:
Exception
Condition
ArgumentException
checkboxLineHeight needs to be set if checkboxPosition is Above or Under;
gridWidth needs to be set if checkboxPosition is Left or Right
LabelWithCheckbox(ITester, string, RelativePosition, string, ImageReference, ImageReference, int, int, IImageFilter[ ])
Syntax:
public LabelWithCheckbox(
	ITester tester,
	string displayName,
	RelativePosition checkboxPosition,
	string searchTextForLabel,
	ImageReference checkedImageReference,
	ImageReference uncheckedImageReference,
	int gridWidth = 0,
	int checkboxLineHeight = 0,
	params IImageFilter[] filters
)
Parameters:
Parameter
Description
tester
Type: ITester​
The tester interface.
displayName
Type: String
The name of the checkbox that will be used for logging and reporting of exceptions (customer facing).
checkboxPosition
Type: Progile.TRIO.BaseModel.RelativePosition
The position of the checkbox relative to the label.
searchTextForLabel
Type: String
The search text that will be used to locate the label on the screen. 
checkedImageReference
Type: ImageReference​
The image reference for the checked representation. This or the uncheckedImgRef will be used to locate the checkbox.
uncheckedImageReference
Type: ImageReference​
The image reference for the unchecked representation. This or the checkedImgRef will be used to locate the checkbox.
[gridWidth]
Type: Int32
The minimum width that contains both the label and the checkbox, typically the width of the UI grid column.
(Note: ensure the width fits with all window sizes that need to be supported)
The gridWith needs to be set for checkboxPosition Left or Right
[checkboxLineHeight]
Type: Int32​
The minimum Height of the line with the checkbox.
The lineHeight needs to be set for checkboxPosition Above or Under
[filters]
Type: IImageFilter[]
The filters to find the label.
Exceptions:
Exception
Condition
ArgumentException
checkboxLineHeight needs to be set if checkboxPosition is Above or Under;
gridWidth needs to be set if checkboxPosition is Left or Right
Methods 
Name
Description
​Check​
Checks the checkbox if it is not already in the correct state. Else it logs that nothing was done.
​IsChecked​
Returns true if the image checked can be found, false if unchecked can be found and throws an exception if neither one or the other can be found.
​Uncheck​
Unchecks the checkbox if it is not already in the correct state. Else it logs that nothing was done.
Properties
Name
Description
​Checkbox​
Gets the Checkbox object of the LabelWithCheckbox.

LabelWithButton Properties

LabelWithCheckbox Properties

Last modified 2yr ago

Parameter	Description
tester	Type: ITester The tester interface.
displayName	Type: String The name of the checkbox that will be used for logging and reporting of exceptions (customer facing).
checkboxPosition	Type: Progile.TRIO.BaseModel.RelativePosition The position of the checkbox relative to the label.
imageReferenceForLabel	Type: ImageReference The image reference that will be used to locate the label on the screen.
checkedImageReference	Type: ImageReference The image reference for the checked representation. This or the uncheckedImgRef will be used to locate the checkbox.
uncheckedImageReference	Type: ImageReference The image reference for the unchecked representation. This or the checkedImgRef will be used to locate the checkbox.
[gridWidth]	Type: Int32 The minimum width that contains both the label and the checkbox, typically the width of the UI grid column. (Note: ensure the width fits with all window sizes that need to be supported) The gridWith needs to be set for checkboxPosition `Left` or `Right`
[checkboxLineHeight]	Type: Int32 The minimum Height of the line with the checkbox. The lineHeight needs to be set for checkboxPosition `Above` or `Under`
[filters]	Type: IImageFilter[] The filters to find the label.

Parameter	Description
tester	Type: ITester The tester interface.
displayName	Type: String The name of the checkbox that will be used for logging and reporting of exceptions (customer facing).
checkboxPosition	Type: Progile.TRIO.BaseModel.RelativePosition The position of the checkbox relative to the label.
searchTextForLabel	Type: String The search text that will be used to locate the label on the screen.
checkedImageReference	Type: ImageReference The image reference for the checked representation. This or the uncheckedImgRef will be used to locate the checkbox.
uncheckedImageReference	Type: ImageReference The image reference for the unchecked representation. This or the checkedImgRef will be used to locate the checkbox.
[gridWidth]	Type: Int32 The minimum width that contains both the label and the checkbox, typically the width of the UI grid column. (Note: ensure the width fits with all window sizes that need to be supported) The gridWith needs to be set for checkboxPosition `Left` or `Right`
[checkboxLineHeight]	Type: Int32 The minimum Height of the line with the checkbox. The lineHeight needs to be set for checkboxPosition `Above` or `Under`
[filters]	Type: IImageFilter[] The filters to find the label.

Exception	Condition
ArgumentException	checkboxLineHeight needs to be set if checkboxPosition is Above or Under; gridWidth needs to be set if checkboxPosition is Left or Right

Name	Description
Check	Checks the checkbox if it is not already in the correct state. Else it logs that nothing was done.
IsChecked	Returns true if the image checked can be found, false if unchecked can be found and throws an exception if neither one or the other can be found.
Uncheck	Unchecks the checkbox if it is not already in the correct state. Else it logs that nothing was done.

Name	Description
Checkbox	Gets the Checkbox object of the LabelWithCheckbox.