cp.ui.SearchField.md

docs » cp.ui.SearchField

---

A TextField with a subrole of AXSearchField.

API Overview

• Functions - API calls offered directly by the extension
• matchesSearch
• Methods - API calls which can only be made on an object returned by a constructor
• SearchField

API Documentation

Functions

matchesSearch

Signature	cp.ui.SearchField.matchesSearch(element) -> boolean
Type	Function
Description	Checks to see if an element is a AXTextField with a subrole of AXSearchField.
Parameters	element - An axuielementObject to check.
Returns	true if matches, otherwise false.

Methods

SearchField

Signature	cp.ui.SearchField(parent, uiFinder[, convertFn]) -> cp.ui.SearchField
Type	Method
Description	Creates a new SearchField. They have a parent and a finder function.
Parameters	parent - The parent object. uiFinder - The function will return the axuielement for the SearchField. convertFn - (optional) If provided, will be passed the string value when returning.
Returns	The new SearchField.