ContextMenu Methods

SelectImage

Overload List

Name	Description
SelectImage(Point, ImageReference)	Opens the context menu, searches the image in the list (incl. scrolling) and selects it.
SelectImage(IEngineResult, ImageReference)	Opens the context menu, searches the image in the list (incl. scrolling) and selects it.

SelectImage(Point, ImageReference)

Opens the context menu, searches the image in the list (incl. scrolling) and selects it. If the image cannot be found, throws a TestStepAbortedException.

Syntax:

public virtual void SelectImage(
	Point point, 
	ImageReference imageReference
)

Parameters:

Parameter	Description
point	Type: Point The coordinates on the screen where the context shall be opened by right-clicking
imageReference	Type: ImageReference The image reference that shall be selected in the context menu.

Exceptions:

Exception	Condition
ElementNotFoundException	When the context menu could not be found on the screen.
InteractionFailedException	When the context menu could not be opened after the configured amount of retries.
TestStepAbortedException	When the image cannot be found in the context menu.

SelectImage(IEngineResult, ImageReference)

Opens the context menu, searches the image in the list (incl. scrolling) and selects it. If the image cannot be found, throws a TestStepAbortedException.

Syntax:

public virtual void SelectImage(
	IEngineResult position, 
	ImageReference imageReference
)

Parameters:

Parameter	Description
position	Type: IEngineResult The position of the element on which the context shall be opened by right-clicking
imageReference	Type: ImageReference The image reference that shall be selected in the context menu.

Exceptions:

Exception	Condition
ElementNotFoundException	When the context menu could not be found on the screen.
InteractionFailedException	When the context menu could not be opened after the configured amount of retries.
TestStepAbortedException	When the image cannot be found in the context menu.

SelectValue

Overload List

Name	Description
SelectValue(Point, String)	Opens the context menu, searches the text value in the list (incl. scrolling) and selects it.
SelectValue(IEngineResult, String)	Opens the context menu, searches the text value in the list (incl. scrolling) and selects it.

SelectValue(Point, String)

Opens the context menu, searches the text value in the list (incl. scrolling) and selects it. If the text cannot be found, throws a TestStepAbortedException.

Syntax:

public virtual void SelectValue(
	Point point, 
	string value
)

Parameters:

Parameter	Description
point	Type: Point The coordinates on the screen where the context shall be opened by right-clicking
value	Type: String The text that shall be selected in the context menu.

Exceptions:

Exception	Condition
ElementNotFoundException	When the context menu could not be found on the screen.
InteractionFailedException	When the context menu could not be opened after the configured amount of retries.
TestStepAbortedException	When the text value cannot be found in the context menu.

SelectValue(IEngineResult, String)

Opens the context menu, searches the text value in the list (incl. scrolling) and selects it. If the text cannot be found, throws a TestStepAbortedException.

Syntax:

public virtual void SelectValue(
	IEngineResult position, 
	string value
)

Parameters:

Parameter	Description
position	Type: IEngineResult The position of the element on which the context shall be opened by right-clicking
value	Type: String The text that shall be selected in the context menu.

Exceptions:

Exception	Condition
ElementNotFoundException	When the context menu could not be found on the screen.
InteractionFailedException	When the context menu could not be opened after the configured amount of retries.
TestStepAbortedException	When the text value cannot be found in the context menu.

SelectValueFromSubmenu

Opens the context menu, searches the first value from the parameter selections in the list and selects it to open the next submenu. Then the next value is found in the submenu and so on.

If the text cannot be found, throws a TestStepAbortedException.

Overload List

Name	Description
SelectValueFromSubmenu(Point, String[])	The position where the context menu shall be opened by right-clicking is provided as a Point
SelectValueFromSubmenu(IEngineResult, String[])	The position where the context menu shall be opened by right-clicking is provided as an IEngineResult

SelectValueFromSubmenu(Point, String[])

Syntax:

public void SelectValueFromSubmenu(
        Point point, 
        params string[] selections
)

Parameters:

Parameter	Description
point	Type: Point The coordinates on the screen where the context shall be opened by right-clicking
selections	Type: String[] The submenus and the value that shall be selected from the context menu. E.g. "File", "New", "Project"

Exceptions:

Exception	Condition
ElementNotFoundException	When the context menu could not be found on the screen.
InteractionFailedException	When the context menu could not be opened after the configured amount of retries.
TestStepAbortedException	When the text value cannot be found in the context menu.

SelectValueFromSubmenu(IEngineResult, String[])

Syntax:

public void SelectValueFromSubmenu(
        IEngineResult position, 
        params string[] selections
)

Parameters:

Parameter	Description
position	Type: IEngineResult The position of the element on which the context shall be opened by right-clicking
selections	Type: String[] The submenus and the value that shall be selected from the context menu. E.g. "File", "New", "Project"

Exceptions:

Exception	Condition
ElementNotFoundException	When the context menu could not be found on the screen.
InteractionFailedException	When the context menu could not be opened after the configured amount of retries.
TestStepAbortedException	When the text value cannot be found in the context menu.

VerifyValueInList

Opens a context menu and verifies if the provided value is present in the context menu (includes scrolling). Closes the context menu again.

Overload List

Name	Description
VerifyValueInList(Point, String, Boolean)	The position where the context menu shall be opened by right-clicking is provided as a Point
VerifyValueInList(IEngineResult, String, Boolean)	The position where the context menu shall be opened by right-clicking is provided as an IEngineResult

VerifyValueInList(Point, String, Boolean)

Syntax:

public virtual bool VerifyValueInList(
        Point point, 
        string value, 
        bool takeScreenshot = true
        )

Parameters:

Parameter	Description
point	Type: Point The coordinates on the screen where the context shall be opened by right-clicking
value	Type: String The text that shall be verified in the context menu.
takeScreenshot	Type: Boolean When true, a screenshot of the expanded context menu is taken, showing the value to verify.

Return Value:

Whether or not the text value could be found in the context menu.

Exceptions:

Exception	Condition
ElementNotFoundException	When the context menu could not be found on the screen.
InteractionFailedException	When the context menu could not be opened after the configured amount of retries.

VerifyValueInList(IEngineResult, String, Boolean)

Syntax:

public virtual bool VerifyValueInList(
        IEngineResult position, 
        string value, 
        bool takeScreenshot = true
)

Parameters:

Parameter	Description
position	Type: IEngineResult The position of the element on which the context shall be opened by right-clicking
value	Type: String The text that shall be verified in the context menu.
takeScreenshot	Type: Boolean When true, a screenshot of the expanded context menu is taken, showing the value to verify.

Return Value:

Whether or not the text value could be found in the context menu.

Exceptions:

Exception	Condition
ElementNotFoundException	When the context menu could not be found on the screen.
InteractionFailedException	When the context menu could not be opened after the configured amount of retries.