Struct uiautomation::core::UIAutomation

pub struct UIAutomation { /* private fields */ }

A wrapper for windows IUIAutomation interface.

Exposes methods that enable Microsoft UI Automation client applications to discover, access, and filter UI Automation elements.

Implementations

impl UIAutomation

pub fn new() -> Result<UIAutomation>

Creates a uiautomation client instance.

This method initializes the COM library each time, sets the thread’s concurrency model as COINIT_MULTITHREADED.

pub fn new_direct() -> Result<UIAutomation>

Creates a uiautomation client instance without initializing the COM library.

The COM library should be initialized manually before invoking.

pub fn compare_elements( &self, element1: &UIElement, element2: &UIElement ) -> Result<bool>

Compares two UI Automation elements to determine whether they represent the same underlying UI element.

pub fn element_from_handle(&self, hwnd: Handle) -> Result<UIElement>

Retrieves a UI Automation element for the specified window.

pub fn element_from_handle_build_cache( &self, hwnd: Handle, cache_request: &UICacheRequest ) -> Result<UIElement>

Retrieves a UI Automation element for the specified window, prefetches the requested properties and control patterns, and stores the prefetched items in the cache.

pub fn element_from_point(&self, point: Point) -> Result<UIElement>

Retrieves the UI Automation element at the specified point on the desktop.

pub fn element_from_point_build_cache( &self, point: Point, cache_request: &UICacheRequest ) -> Result<UIElement>

Retrieves the UI Automation element at the specified point on the desktop, prefetches the requested properties and control patterns, and stores the prefetched items in the cache.

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

Retrieves the UI Automation element that has the input focus.

pub fn get_focused_element_build_cache( &self, cache_request: &UICacheRequest ) -> Result<UIElement>

Retrieves the UI Automation element that has the input focus, prefetches the requested properties and control patterns, and stores the prefetched items in the cache.

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

Retrieves the UI Automation element that represents the desktop.

pub fn get_root_element_build_cache( &self, cache_request: &UICacheRequest ) -> Result<UIElement>

Retrieves the UI Automation element that represents the desktop, prefetches the requested properties and control patterns, and stores the prefetched items in the cache.

pub fn create_tree_walker(&self) -> Result<UITreeWalker>

Retrieves a tree walker object that can be used to traverse the Microsoft UI Automation tree.

Examples

use uiautomation::UIAutomation;
 
let automation = UIAutomation::new().unwrap();
let root = automation.get_root_element().unwrap();
let walker = automation.create_tree_walker().unwrap();
let child = walker.get_first_child(&root);
assert!(child.is_ok());

pub fn filter_tree_walker(&self, condition: UICondition) -> Result<UITreeWalker>

Retrieves a filtered tree walker object that can be used to traverse the Microsoft UI Automation tree.

pub fn get_raw_view_walker(&self) -> Result<UITreeWalker>

Retrieves a tree walker object used to traverse an unfiltered view of the Microsoft UI Automation tree.

pub fn get_control_view_condition(&self) -> Result<UICondition>

Retrieves a predefined UICondition that selects control elements.

pub fn get_control_view_walker(&self) -> Result<UITreeWalker>

Retrieves a predefined UITreeWalker interface that selects control elements.

pub fn get_content_view_condition(&self) -> Result<UICondition>

Retrieves a predefined UICondition that selects content elements.

pub fn get_content_view_walker(&self) -> Result<UITreeWalker>

Retrieves a UITreeWalker interface used to discover content elements.

pub fn create_matcher(&self) -> UIMatcher

Creates a UIMatcher which helps to find some UIElement.

Examples

use uiautomation::UIAutomation;
 
let automation = UIAutomation::new().unwrap();
let matcher = automation.create_matcher().depth(3).timeout(1000).classname("Start");
if let Ok(start_menu) = matcher.find_first() {
    println!("Found startmenu!")
}

pub fn create_true_condition(&self) -> Result<UICondition>

Retrieves a predefined condition that selects all elements.

pub fn create_false_condition(&self) -> Result<UICondition>

Creates a condition that is always false.

pub fn create_not_condition( &self, condition: UICondition ) -> Result<UICondition>

Creates a condition that is the negative of a specified condition.

pub fn create_and_condition( &self, condition1: UICondition, condition2: UICondition ) -> Result<UICondition>

Creates a condition that selects elements that match both of two conditions.

pub fn create_or_condition( &self, condition1: UICondition, condition2: UICondition ) -> Result<UICondition>

Creates a combination of two conditions where a match exists if either of the conditions is true.

pub fn create_property_condition( &self, property: UIProperty, value: Variant, flags: Option<PropertyConditionFlags> ) -> Result<UICondition>

Creates a condition that selects elements that have a property with the specified value, using optional flags.

pub fn create_cache_request(&self) -> Result<UICacheRequest>

Creates a UICacheRequest object that specifies the properties and control patterns to be cached for an element.

Trait Implementations

impl AsRef<IUIAutomation> for UIAutomation

fn as_ref(&self) -> &IUIAutomation

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for UIAutomation

fn clone(&self) -> UIAutomation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UIAutomation

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

Formats the value using the given formatter.

impl From<IUIAutomation> for UIAutomation

fn from(automation: IUIAutomation) -> Self

Converts to this type from the input type.

impl Into<IUIAutomation> for UIAutomation

fn into(self) -> IUIAutomation

Converts this type into the (usually inferred) input type.