Struct uiautomation::core::UIMatcher

pub struct UIMatcher { /* private fields */ }

Defines filter conditions to match specific UI Element.

UIMatcher can find first element or find all elements.

Implementations

impl UIMatcher

pub fn new(automation: UIAutomation) -> Self

Creates a matcher with automation.

pub fn mode(self, search_mode: UIMatcherMode) -> Self

Sets the searching mode. UIMatcherMode::Control is default mode.

pub fn from(self, element: UIElement) -> Self

Sets the root element of the UIAutomation tree whitch should be searched from.

The root element is desktop by default.

pub fn from_ref(self, element: &UIElement) -> Self

Sets the root element of the UIAutomation tree whitch should be searched from. The element is cloned internally.

The root element is desktop by default.

pub fn depth(self, depth: u32) -> Self

Sets the depth of the search path. The default depth is 7.

pub fn timeout(self, timeout: u64) -> Self

Sets the the time in millionseconds for matching element. The default timeout is 3000 millionseconds(3 seconds).

The UIMatcher will not retry to find when you set timeout to 0.

A timeout error will occur after this time.

pub fn interval(self, interval: u64) -> Self

Set the interval time in millionseconds for retrying. The default interval time is 100 millionseconds.

pub fn filter(self, filter: Box<dyn MatcherFilter>) -> Self

Appends a filter condition which is used as and logic.

pub fn filter_fn<F>(self, f: Box<F>) -> Self

where F: Fn(&UIElement) -> Result<bool> + 'static,

Appends a filter function which is used as and logic.

Examples:

use uiautomation::core::UIAutomation;
use uiautomation::core::UIElement;
 
let automation = UIAutomation::new().unwrap();
let matcher = automation.create_matcher().filter_fn(Box::new(|e: &UIElement| {
    let framework_id = e.get_framework_id()?;
    let class_name = e.get_classname()?;
     
    Ok("Win32" == framework_id && class_name.starts_with("Shell"))
})).timeout(0);
let element = matcher.find_first();
assert!(element.is_ok());

pub fn name<S: Into<String>>(self, name: S) -> Self

Append a filter whitch match specific casesensitive name.

pub fn contains_name<S: Into<String>>(self, name: S) -> Self

Append a filter whitch name contains specific text (ignore casesensitive).

pub fn match_name<S: Into<String>>(self, name: S) -> Self

Append a filter whitch matches specific name (ignore casesensitive).

pub fn classname<S: Into<String>>(self, classname: S) -> Self

Filters by classname.

pub fn control_type(self, control_type: ControlType) -> Self

Filters by control type.

pub fn reset(self) -> Self

Clears all filters.

pub fn debug(self, debug: bool) -> Self

Set debug as true to enable debug mode. The debug mode is false by default.

pub fn find_first(&self) -> Result<UIElement>

Finds first element.

pub fn find_all(&self) -> Result<Vec<UIElement>>

Finds all elements.

Trait Implementations

impl Debug for UIMatcher

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.