C# Class BitrixAQA.Selenium.Framework.WebItem

Класс включает набор методов и переменных для объектов

Show file Open project: BitrixQA/BitrixAQA Class Usage Examples

Public Properties

Property	Type	Description
by	OpenQA.Selenium.By
description	string
innerHTML	string
innerText	string
value	string

Public Methods

Method	Description
AssertHTMLContaining ( string containingString, string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет присутствие подстроки в innerHTML объекта. true - совпадение найдено, false - совпадение не найдено.
AssertHTMLMatching ( string pattern, string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет присутствие подстроки в innerHTML объекта по заданному регекс-паттерну. true - совпадение найдено, false - совпадение не найдено Можно задать сообщение в лог если true и если false. По умолчанию сообщений нет.
AssertHTMLNOTContaining ( string containingString, string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет отстствие подстроки в innerHTML объекта. true - совпадение найдено, false - совпадение не найдено.
AssertHTMLNOTMatching ( string pattern, string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет отсутствие подстроки в innerHTML объекта по заданному регекс-паттерну. true - совпадение не найдено, false - совпадение найдено
AssertTextContaining ( string containingString, string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет присутствие подстроки в innerText объекта. true - совпадение найдено, false - совпадение не найдено Можно задать сообщение в лог если true и если false. По умолчанию сообщений нет.
AssertTextMatching ( string pattern, string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет присутствие подстроки в innerText объекта по заданному регекс-паттерну. true - совпадение найдено, false - совпадение не найдено Можно задать сообщение в лог если true и если false. По умолчанию сообщений нет.
AssertTextNOTContaining ( string notContainingString, string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет отсутствие заданной подстроки в innerText объекта. true - подстрока отсутствует, false - подстрока присутствует
AssertTextNOTMatching ( string pattern, string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет отсутствие подстроки в innerText объекта по заданному регекс-паттерну. true - совпадение найдено, false - совпадение не найдено
Click ( bool checkErrors = true, bool ScrollToObject = true, int x, int y ) : void	Клик по WebItem. Аналог WebDriver.Click()
ClickAndWait ( double secondsToWait = 0.5, bool ScrollToObject = true, bool checkErrors = true, int x, int y, bool NoRefresh = false ) : void	Клик по WebItem. Аналог WebDriver.Click() После клика ждет заданное количество времени. Опционально, по умолчанию 1 секунда.
DeselectItems ( bool checkErrors = true ) : void	Метод сбрасывается значение в элемент типа Select. Причём снимает ВСЕ значения даже если хоть одно должно быть.
Displayed ( string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет, что элемент отображается. style="display". Можно задать сообщение в лог если true и если false. По умолчанию в лог ничего не пишется
DoubleClick ( bool checkErrors = true ) : void	Метод реализует действие двойной клик по WebItem
DragAndDrop ( WebItem WebItemToDrop, bool isAdmin = false, bool ScrollToObject = true ) : void	Метод реализует действие драгндроп от одного элемента до другого
Exists ( string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет, существует ли объект в данный момент на странице. Можно задать сообщения в лог если true и если false. По умолчанию сообщений нет.
GetAttribute ( string attributeName, bool writeToLog = false ) : string	Получает значение указанного атрибута WebItem. Аналог WebDriver.GetAttribute()
MouseOver ( bool ScrollToObject = true ) : void	Метод реализует действие наведения указателя мыши на WebItem
MouseOverNoHover ( ) : void	Метод реализует действие наведения указателя мыши
NOTDisplayed ( string trueMessage = "", string falseMessage = "" ) : bool	Метод проверяет, что элемент не отображается. style="display". Можно задать сообщение в лог если true и если false
NOTExists ( string trueMessage = null, string falseMessage = null ) : bool	Метод проверяет, что объект не существует в данный момент на странице. Можно задать сообщения в лог если true и если false
PasteText ( string text, bool ClearBeforePaste = true, bool ScrollToObject = true, bool HideMessage = false ) : void	Метод вставляет указанный текст в WebItem комбинацией клавиш shift+ins. Опционально - очищать текст в контроле перед вставкой. По умолчанию true - очищать. Опционально: скролить фокус к объекту. По умолчанию true - скролить.
RightClickAndWait ( int secondsToWait = 1, bool ScrollToObject = true, bool checkErrors = true, int x, int y ) : void	Клик по WebItem. Аналог WebDriver.Click() После клика ждет заданное количество времени. Опционально, по умолчанию 1 секунда.
Scroll ( ) : void	Метод реализует скроллинг страницы до элемента
SelectItemByText ( string text ) : void	Метод выбирает значение из выпадающего списка по тексту. Метод выбирает элемент по найденному вхождению. Аналог SelectElement.SelectByText()
SelectItemByText_Direct ( string text ) : void	Метод выбирает значение из выпадающего списка по тексту. Метод выбирает элемент по найденному вхождению. Аналог SelectElement.SelectByText()
SelectItemByValue ( string value, bool checkErrors = true ) : void	Метод выбирает значение из выпадающего списка по value. Аналог SelectElement.SelectByValue()
Selected ( ) : bool	Возвращает отмеченность объекта (selected). true - выбран (отмечен), false - не выбран (не отмечен). Применим только для чекбоксов и радиобатонов. Аналог WebDriver.Selected()
SendKeys ( string text, bool clearBeforeSend = true, bool HideMessage = false, bool checkErrors = true ) : void	Метод посылает указанный текст в WebItem. Опционально - очищать текст в контроле перед посылом. По умолчанию - true, очищать. Аналог WebDriver.FindElement().SendKeys()
SwitchToFrame ( ) : void	Метод переключает на выбранный фрейм. Аналог WebDriver.SwitchTo().Frame()
WaitElementDisplayed ( int secondsToWait = 1 ) : bool	Метод реализует ожидание отображения объекта (Displayed) заданное количество времени (секунд) По умолчанию ожидание - 1 секунда.
WaitElementPresent ( int secondsToWait = 1 ) : bool	Метод реализует ожидание появления объекта заданное количество времени (секунд) По умолчанию ожидание - 1 секунда
WaitTextPresent ( string text, int secondsToWait ) : bool	Метод реализует ожидание появления текста в объекте заданное количество секунд. Текст приводится к нижнему регистру
WaitWhileElementDisplayed ( int waitInterval = 1 ) : void	Ждем пока элемент отображается (Displayed). Интервал ожидания можно задать в секундах. По умолчанию 1 секунда
WaitWhileElementExists ( int waitInterval = 1 ) : void	Метод реализует ожидание, пока элемент существует. Интервал ожидания можно задать в секундах. По умолчанию 1 секунда
WaitWhileTextPresents ( string text ) : void	Метод реализует ожидание, пока текст в объекте существует. Интервал ожидания 1 секунда
WebItem ( By by, string description ) : System	Метод реализует поиск объекта на странице

Method Details

AssertHTMLContaining() public method

Метод проверяет присутствие подстроки в innerHTML объекта. true - совпадение найдено, false - совпадение не найдено.

public AssertHTMLContaining ( string containingString, string trueMessage = "", string falseMessage = "" ) : bool
containingString	string	Строка которую ищем
trueMessage	string	Сообщение в лог, если совпадение найдено
falseMessage	string	Сообщение в лог, если совпадение не найдено. Автоматически добавится скриншот и эксепшн
return	bool

AssertHTMLMatching() public method

Метод проверяет присутствие подстроки в innerHTML объекта по заданному регекс-паттерну. true - совпадение найдено, false - совпадение не найдено Можно задать сообщение в лог если true и если false. По умолчанию сообщений нет.

public AssertHTMLMatching ( string pattern, string trueMessage = "", string falseMessage = "" ) : bool
pattern	string	Регекс паттерн
trueMessage	string	Сообщение в лог, если совпадение найдено
falseMessage	string	Сообщение в лог, если совпадение не найдено. Автоматически добавится скриншот и эксепшн
return	bool

AssertHTMLNOTContaining() public method

Метод проверяет отстствие подстроки в innerHTML объекта. true - совпадение найдено, false - совпадение не найдено.

public AssertHTMLNOTContaining ( string containingString, string trueMessage = "", string falseMessage = "" ) : bool
containingString	string	Строка которую ищем
trueMessage	string	Сообщение в лог, если совпадение найдено
falseMessage	string	Сообщение в лог, если совпадение не найдено. Автоматически добавится скриншот и эксепшн
return	bool

AssertHTMLNOTMatching() public method

Метод проверяет отсутствие подстроки в innerHTML объекта по заданному регекс-паттерну. true - совпадение не найдено, false - совпадение найдено

public AssertHTMLNOTMatching ( string pattern, string trueMessage = "", string falseMessage = "" ) : bool
pattern	string	Регекс паттерн
trueMessage	string	Сообщение в лог, если совпадение не найдено
falseMessage	string	Сообщение в лог, если совпадение найдено. Автоматически добавится скриншот и эксепшн
return	bool

AssertTextContaining() public method

Метод проверяет присутствие подстроки в innerText объекта. true - совпадение найдено, false - совпадение не найдено Можно задать сообщение в лог если true и если false. По умолчанию сообщений нет.

public AssertTextContaining ( string containingString, string trueMessage = "", string falseMessage = "" ) : bool
containingString	string	Строка которую ищем
trueMessage	string	Сообщение в лог, если совпадение найдено
falseMessage	string	Сообщение в лог, если совпадение не найдено. Автоматически добавится скриншот и эксепшн
return	bool

AssertTextMatching() public method

Метод проверяет присутствие подстроки в innerText объекта по заданному регекс-паттерну. true - совпадение найдено, false - совпадение не найдено Можно задать сообщение в лог если true и если false. По умолчанию сообщений нет.

public AssertTextMatching ( string pattern, string trueMessage = "", string falseMessage = "" ) : bool
pattern	string	Регекс паттерн
trueMessage	string	Сообщение в лог, если совпадение найдено
falseMessage	string	Сообщение в лог, если совпадение не найдено. Автоматически добавится скриншот и эксепшн
return	bool

AssertTextNOTContaining() public method

Метод проверяет отсутствие заданной подстроки в innerText объекта. true - подстрока отсутствует, false - подстрока присутствует

public AssertTextNOTContaining ( string notContainingString, string trueMessage = "", string falseMessage = "" ) : bool
notContainingString	string	Строка которую не должны найти
trueMessage	string	Сообщение в лог, если совпадение не найдено
falseMessage	string	Сообщение в лог, если совпадение найдено. Автоматически добавится скриншот и эксепшн
return	bool

AssertTextNOTMatching() public method

Метод проверяет отсутствие подстроки в innerText объекта по заданному регекс-паттерну. true - совпадение найдено, false - совпадение не найдено

public AssertTextNOTMatching ( string pattern, string trueMessage = "", string falseMessage = "" ) : bool
pattern	string	Регекс паттерн
trueMessage	string	Сообщение в лог, если совпадение не найдено
falseMessage	string	Сообщение в лог, если совпадение найдено. Автоматически добавится скриншот и эксепшн
return	bool

Click() public method

Клик по WebItem. Аналог WebDriver.Click()

public Click ( bool checkErrors = true, bool ScrollToObject = true, int x, int y ) : void
checkErrors	bool	Проверить наличие ошибок. По умолчанию true - проверить
ScrollToObject	bool	Меняет скроллирование до объекта(по умолчанию: отключено для админской части и включено для публичной) /// Соответственно true включает скролл в адимнке и выключает в публичке
x	int	координата x для клика относительно верхнего левого угла объекта
y	int	координата y для клика относительно верхнего левого угла объекта
return	void

ClickAndWait() public method

Клик по WebItem. Аналог WebDriver.Click() После клика ждет заданное количество времени. Опционально, по умолчанию 1 секунда.

public ClickAndWait ( double secondsToWait = 0.5, bool ScrollToObject = true, bool checkErrors = true, int x, int y, bool NoRefresh = false ) : void
secondsToWait	double	Время ожидания, секунд
ScrollToObject	bool	Меняет скроллирование до объекта(по умолчанию: отключено для админской части и включено для публичной) /// Соответственно true включает скролл в адимнке и выключает в публичке
checkErrors	bool	Проверить наличие ошибок. По умолчанию true - проверить
x	int	координата x для клика относительно верхнего левого угла объекта
y	int	координата y для клика относительно верхнего левого угла объекта
NoRefresh	bool	Если задан - рефреш страницы при зависании не производится
return	void

DeselectItems() public method

Метод сбрасывается значение в элемент типа Select. Причём снимает ВСЕ значения даже если хоть одно должно быть.

public DeselectItems ( bool checkErrors = true ) : void
checkErrors	bool	Проверка на ошибки
return	void

Displayed() public method

Метод проверяет, что элемент отображается. style="display". Можно задать сообщение в лог если true и если false. По умолчанию в лог ничего не пишется

public Displayed ( string trueMessage = "", string falseMessage = "" ) : bool
trueMessage	string	Сообщение в лог, если элемент отображается (true)
falseMessage	string	Сообщение в лог, если элемент не отображается (false)
return	bool

DoubleClick() public method

Метод реализует действие двойной клик по WebItem

public DoubleClick ( bool checkErrors = true ) : void
checkErrors	bool	Проверить наличие ошибок. По умолчанию true - проверить
return	void

DragAndDrop() public method

Метод реализует действие драгндроп от одного элемента до другого

public DragAndDrop ( WebItem WebItemToDrop, bool isAdmin = false, bool ScrollToObject = true ) : void
WebItemToDrop	WebItem	Объект на котором дропаем первый объект
isAdmin	bool	Признак админки
ScrollToObject	bool	Скроллить ли до объекта
return	void

Exists() public method

Метод проверяет, существует ли объект в данный момент на странице. Можно задать сообщения в лог если true и если false. По умолчанию сообщений нет.

public Exists ( string trueMessage = "", string falseMessage = "" ) : bool
trueMessage	string	Сообщение в лог, если элемент существует (true)
falseMessage	string	Сообщение в лог, если элемент не существует (false)
return	bool

GetAttribute() public method

Получает значение указанного атрибута WebItem. Аналог WebDriver.GetAttribute()

public GetAttribute ( string attributeName, bool writeToLog = false ) : string
attributeName	string	Название атрибута, значение которого надо выбрать
writeToLog	bool	Записать в лог значение атрибута, true - записать в лог, false (по умолчанию) - не записывать
return	string

MouseOver() public method

Метод реализует действие наведения указателя мыши на WebItem

public MouseOver ( bool ScrollToObject = true ) : void
ScrollToObject	bool	Меняет скроллирование до объекта(по умолчанию: отключено для админской части и включено для публичной) /// Соответственно true включает скролл в адимнке и выключает в публичке
return	void

MouseOverNoHover() public method

Метод реализует действие наведения указателя мыши

public MouseOverNoHover ( ) : void
return	void

NOTDisplayed() public method

Метод проверяет, что элемент не отображается. style="display". Можно задать сообщение в лог если true и если false

public NOTDisplayed ( string trueMessage = "", string falseMessage = "" ) : bool
trueMessage	string	Сообщение в лог, если элемент не отображается (true)
falseMessage	string	Сообщение в лог, если элемент отображается (false)
return	bool

NOTExists() public method

Метод проверяет, что объект не существует в данный момент на странице. Можно задать сообщения в лог если true и если false

public NOTExists ( string trueMessage = null, string falseMessage = null ) : bool
trueMessage	string	Сообщение в лог, если элемент не существует (true)
falseMessage	string	Сообщение в лог, если элемент существует (false)
return	bool

PasteText() public method

Метод вставляет указанный текст в WebItem комбинацией клавиш shift+ins. Опционально - очищать текст в контроле перед вставкой. По умолчанию true - очищать. Опционально: скролить фокус к объекту. По умолчанию true - скролить.

public PasteText ( string text, bool ClearBeforePaste = true, bool ScrollToObject = true, bool HideMessage = false ) : void
text	string	Вставляемый текст
ClearBeforePaste	bool	очистить элемент перед вставкой. true - очистить, false - нет
ScrollToObject	bool	скроллить фокус к объекту. По умолчанию true - скроллить
HideMessage	bool	Скрывать ли текс в контейнер
return	void

RightClickAndWait() public method

public RightClickAndWait ( int secondsToWait = 1, bool ScrollToObject = true, bool checkErrors = true, int x, int y ) : void
secondsToWait	int	Время ожидания, секунд
ScrollToObject	bool	Меняет скроллирование до объекта(по умолчанию: отключено для админской части и включено для публичной) /// Соответственно true включает скролл в адимнке и выключает в публичке
checkErrors	bool	Проверить наличие ошибок. По умолчанию true - проверить
x	int	координата x для клика относительно верхнего левого угла объекта
y	int	координата y для клика относительно верхнего левого угла объекта
return	void

Scroll() public method

Метод реализует скроллинг страницы до элемента

public Scroll ( ) : void
return	void

SelectItemByText() public method

Метод выбирает значение из выпадающего списка по тексту. Метод выбирает элемент по найденному вхождению. Аналог SelectElement.SelectByText()

public SelectItemByText ( string text ) : void
text	string	Значение списка, которое надо выбрать
return	void

SelectItemByText_Direct() public method

public SelectItemByText_Direct ( string text ) : void
text	string	Значение списка, которое надо выбрать
return	void

SelectItemByValue() public method

Метод выбирает значение из выпадающего списка по value. Аналог SelectElement.SelectByValue()

public SelectItemByValue ( string value, bool checkErrors = true ) : void
value	string	Значение списка, которое надо выбрать
checkErrors	bool	Проверять или нет ошибки
return	void

Selected() public method

Возвращает отмеченность объекта (selected). true - выбран (отмечен), false - не выбран (не отмечен). Применим только для чекбоксов и радиобатонов. Аналог WebDriver.Selected()

public Selected ( ) : bool
return	bool

SendKeys() public method

Метод посылает указанный текст в WebItem. Опционально - очищать текст в контроле перед посылом. По умолчанию - true, очищать. Аналог WebDriver.FindElement().SendKeys()

public SendKeys ( string text, bool clearBeforeSend = true, bool HideMessage = false, bool checkErrors = true ) : void
text	string	Текст, который надо послать в WebItem
clearBeforeSend	bool	Очистить текст в контроле перед посылом текста. true - очистить, false - нет
HideMessage	bool	Скрывать ли текс в контейнер
checkErrors	bool	Проверять или нет ошибки
return	void

SwitchToFrame() public method

Метод переключает на выбранный фрейм. Аналог WebDriver.SwitchTo().Frame()

public SwitchToFrame ( ) : void
return	void

WaitElementDisplayed() public method

Метод реализует ожидание отображения объекта (Displayed) заданное количество времени (секунд) По умолчанию ожидание - 1 секунда.

public WaitElementDisplayed ( int secondsToWait = 1 ) : bool
secondsToWait	int	Сколько секунд ждать
return	bool

WaitElementPresent() public method

Метод реализует ожидание появления объекта заданное количество времени (секунд) По умолчанию ожидание - 1 секунда

public WaitElementPresent ( int secondsToWait = 1 ) : bool
secondsToWait	int	Сколько секунд ждать
return	bool

WaitTextPresent() public method

Метод реализует ожидание появления текста в объекте заданное количество секунд. Текст приводится к нижнему регистру

public WaitTextPresent ( string text, int secondsToWait ) : bool
text	string	текст, появление которого ожидаем
secondsToWait	int	сколько секунд ждать
return	bool

WaitWhileElementDisplayed() public method

Ждем пока элемент отображается (Displayed). Интервал ожидания можно задать в секундах. По умолчанию 1 секунда

public WaitWhileElementDisplayed ( int waitInterval = 1 ) : void
waitInterval	int	интервал ожидания в секундах
return	void

WaitWhileElementExists() public method

Метод реализует ожидание, пока элемент существует. Интервал ожидания можно задать в секундах. По умолчанию 1 секунда

public WaitWhileElementExists ( int waitInterval = 1 ) : void
waitInterval	int	интервал ожидания в секундах
return	void

WaitWhileTextPresents() public method

Метод реализует ожидание, пока текст в объекте существует. Интервал ожидания 1 секунда

public WaitWhileTextPresents ( string text ) : void
text	string	текст
return	void

WebItem() public method

Метод реализует поиск объекта на странице

public WebItem ( By by, string description ) : System
by	OpenQA.Selenium.By	Механизм поиска объекта. По XPath, Id и т.д.
description	string	Описание объекта для лога
return	System

Property Details

by public property

Способ поиска элемента WebItem

public By,OpenQA.Selenium by
return	OpenQA.Selenium.By

description public property

Описание объекта WebItem. Используется для записи в лог, как имя объекта. Обязательно для заполнения

public string description
return	string

innerHTML public property

Переменная возвращает InnerHTML объекта

public string innerHTML
return	string

innerText public property

Переменная возвращает InnerText объекта. Аналог WebDriver.FindElement().Text

public string innerText
return	string

value public property

Переменная возвращает value объекта

public string value
return	string