Class AutoSuggestBox

Defines a wrapper for the core UWP AutoSuggestBox control.

Inheritance

System.Object

ElementWrapper<WindowsElement>

WindowsElementWrapper

AutoSuggestBox

Implements

IElementWrapper<WindowsElement>

Inherited Members

WindowsElementWrapper.Driver

WindowsElementWrapper.VerifyDriverElementShown(By, Nullable<TimeSpan>)

WindowsElementWrapper.VerifyDriverElementsShown(By, Nullable<TimeSpan>)

ElementWrapper<WindowsElement>.Element

ElementWrapper<WindowsElement>.ElementDriver

ElementWrapper<WindowsElement>.IsVisible

ElementWrapper<WindowsElement>.IsEnabled

ElementWrapper<WindowsElement>.Click()

ElementWrapper<WindowsElement>.GetAttribute(String)

ElementWrapper<WindowsElement>.FindElement(By)

ElementWrapper<WindowsElement>.VerifyElementNotShown(By)

ElementWrapper<WindowsElement>.VerifyElementShown(By)

ElementWrapper<WindowsElement>.VerifyElementShown(By, Nullable<TimeSpan>)

ElementWrapper<WindowsElement>.VerifyElementsShown(By)

ElementWrapper<WindowsElement>.VerifyElementsShown(By, Nullable<TimeSpan>)

Namespace: Legerity.Windows.Elements.Core

Assembly: Legerity.Windows.dll

Syntax

public class AutoSuggestBox : WindowsElementWrapper, IElementWrapper<WindowsElement>

Constructors

| Improve this Doc View Source

AutoSuggestBox(WindowsElement)

Initializes a new instance of the AutoSuggestBox class.

Declaration

public AutoSuggestBox(WindowsElement element)

Parameters

Type	Name	Description
WindowsElement	element	The reference.

Properties

| Improve this Doc View Source

SuggestionList

Gets the element associated with the suggestion list when the SuggestionsPopup is shown.

Declaration

public virtual ListView SuggestionList { get; }

Property Value

Type	Description
ListView

| Improve this Doc View Source

SuggestionsPopup

Gets the element associated with the suggestions popup.

Declaration

public virtual AppiumWebElement SuggestionsPopup { get; }

Property Value

Type	Description
AppiumWebElement

| Improve this Doc View Source

Text

Gets the value of the auto-suggest box.

Declaration

public virtual string Text { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

TextBox

Gets the element associated with the text box.

Declaration

public virtual TextBox TextBox { get; }

Property Value

Type	Description
TextBox

Methods

| Improve this Doc View Source

SelectSuggestion(String)

Selects a suggestion from the auto-suggest box.

Declaration

public virtual void SelectSuggestion(string suggestion)

Parameters

Type	Name	Description
System.String	suggestion	The suggestion to select.

Exceptions

Type	Condition
ElementNotShownException	Thrown when the suggestions popup is not shown.
ElementsNotShownException	Thrown when no elements are shown for the expected locator.

| Improve this Doc View Source

SelectSuggestion(String, String, Int32)

Selects a suggestion from the auto-suggest box.

Declaration

public virtual void SelectSuggestion(string value, string suggestion, int popupWaitTimeout = 2000)

Parameters

Type	Name	Description
System.String	value	The initial value to set.
System.String	suggestion	The suggestion to select.
System.Int32	popupWaitTimeout	The timeout to wait for the suggestions popup to appear. Defaults to 2000ms.

Exceptions

Type	Condition
ElementNotShownException	Thrown when the suggestions popup is not shown.
ElementsNotShownException	Thrown when no elements are shown for the expected locator.

| Improve this Doc View Source

SelectSuggestionByPartialSuggestion(String, String, Int32)

Selects a suggestion from the auto-suggest box.

Declaration

public virtual void SelectSuggestionByPartialSuggestion(string value, string partialSuggestion, int popupWaitTimeout = 2000)

Parameters

Type	Name	Description
System.String	value	The initial value to set.
System.String	partialSuggestion	The partial suggestion match to select.
System.Int32	popupWaitTimeout	The timeout to wait for the suggestions popup to appear. Defaults to 2000ms.

Exceptions

Type	Condition
ElementNotShownException	Thrown when the suggestions popup is not shown.
ElementsNotShownException	Thrown when no elements are shown for the expected locator.

| Improve this Doc View Source

SetText(String)

Sets the value of the auto-suggest box.

Declaration

public virtual void SetText(string value)

Parameters

Type	Name	Description
System.String	value	The value to set.

Operators

| Improve this Doc View Source

Implicit(AppiumWebElement to AutoSuggestBox)

Allows conversion of a to the AutoSuggestBox without direct casting.

Declaration

public static implicit operator AutoSuggestBox(AppiumWebElement element)

Parameters

Type	Name	Description
AppiumWebElement	element	The .

Returns

Type	Description
AutoSuggestBox	The AutoSuggestBox.

| Improve this Doc View Source

Implicit(RemoteWebElement to AutoSuggestBox)

Allows conversion of a to the AutoSuggestBox without direct casting.

Declaration

public static implicit operator AutoSuggestBox(RemoteWebElement element)

Parameters

Type	Name	Description
RemoteWebElement	element	The .

Returns

Type	Description
AutoSuggestBox	The AutoSuggestBox.

| Improve this Doc View Source

Implicit(WindowsElement to AutoSuggestBox)

Allows conversion of a to the AutoSuggestBox without direct casting.

Declaration

public static implicit operator AutoSuggestBox(WindowsElement element)

Parameters

Type	Name	Description
WindowsElement	element	The .

Returns

Type	Description
AutoSuggestBox	The AutoSuggestBox.

Implements

IElementWrapper<TElement>

Extension Methods

WindowsElementWrapperExtensions.TryWaitUntil<TElementWrapper, TResult>(TElementWrapper, Func<TElementWrapper, TResult>, Nullable<TimeSpan>, Int32, Action<Exception>)

WindowsElementWrapperExtensions.WaitUntil<TElementWrapper, TResult>(TElementWrapper, Func<TElementWrapper, TResult>, Nullable<TimeSpan>, Int32)