UIAutomation

https://docs.rs/uiautomation/latest/uiautomation/
Admin
UIAutomation is a Rust crate that wraps Windows UI Automation interfaces, enabling developers to...
Tokens:141,816
Snippets:1,961
Trust Score:9.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Create and Start Processes

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html?search=u32+-%3E+bool

Examples of creating and starting processes using the Process struct.

```rust
use uiautomation::processes::Process;
 
let p = Process::create("notepad.exe");
assert!(p.is_ok());
```

```rust
use uiautomation::processes::Process;
let p = Process::start("copy README.md README.md.bak");
assert!(p.is_ok());
```

--------------------------------

### show_info usage example

Source: https://docs.rs/uiautomation/latest/uiautomation/dialogs/fn.show_info.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Example call to display an information dialog with specific text and caption.

```rust
uiautomation::dialogs::show_info("This is my info.", "INFO");
```

--------------------------------

### Clipboard usage example

Source: https://docs.rs/uiautomation/latest/uiautomation/clipboards/struct.Clipboard.html

Demonstrates opening the clipboard, setting text, and retrieving it.

```rust
let clipboard = uiautomation::clipboards::Clipboard::open().unwrap();
clipboard.set_text("hello").unwrap();
let text = clipboard.get_text().unwrap();
assert_eq!(text, "hello");
```

--------------------------------

### start_listening

Source: https://docs.rs/uiautomation/latest/uiautomation/patterns/struct.UISynchronizedInputPattern.html?search=

Starts listening for the specified synchronized input type.

```APIDOC
## pub fn start_listening(&self, input_type: SynchronizedInputType) -> Result<()>

### Description
Starts listening for the specified synchronized input type.

### Parameters
- **input_type** (SynchronizedInputType) - Required - The type of synchronized input to listen for.
```

--------------------------------

### Process::start

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html

Starts a process by command line without waiting for an idle state.

```APIDOC
## pub fn start<S: Into<String>>(command: S) -> Result<Self>

### Description
Start a process by command line. This process will not wait for idle state.
```

--------------------------------

### Process::start

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Starts a process by command line without waiting for an idle state.

```APIDOC
## pub fn start<S: Into<String>>(command: S) -> Result<Self>

### Description
Starts a process by command line. This process will not wait for idle state.

### Parameters
- **command** (S: Into<String>) - Required - The command line to execute.

### Example
```rust
use uiautomation::processes::Process;
let p = Process::start("copy README.md README.md.bak");
assert!(p.is_ok());
```
```

--------------------------------

### Create Tree Walker Example

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIAutomation.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates how to initialize the automation client and use a tree walker to navigate the UI element hierarchy.

```rust
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());
```

--------------------------------

### Usage Example for query_yes_no

Source: https://docs.rs/uiautomation/latest/uiautomation/dialogs/fn.query_yes_no.html?search=

Demonstrates how to trigger a query dialog and handle the boolean return value.

```rust
use uiautomation::dialogs::*;
 
if query_yes_no("Are your sure?", "QUERY") {
    show_message("Oh! Yes!!!", "ANSWERED");
}
```

--------------------------------

### Usage example for query_yes_no_cancel

Source: https://docs.rs/uiautomation/latest/uiautomation/dialogs/fn.query_yes_no_cancel.html?search=u32+-%3E+bool

Demonstrates how to handle the return value of the dialog using pattern matching.

```rust
use uiautomation::dialogs::*;
 
match query_yes_no_cancel("Do you want to do this?", "QUERY") {
    Some(ret) => show_message(if ret { "YES!" } else { "OK!!" }, "ANSWER"),
    None => show_message("I don't known.", "ANSWER")
}
```

--------------------------------

### Create Matcher Example

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIAutomation.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates using a UIMatcher to find specific UI elements with defined criteria like depth, timeout, and class name.

```rust
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!")
}
```

--------------------------------

### Usage Example for show_warn

Source: https://docs.rs/uiautomation/latest/uiautomation/dialogs/fn.show_warn.html?search=std%3A%3Avec

Displays a warning dialog with the specified text and caption.

```rust
uiautomation::dialogs::show_warn("This is my warn.", "WARN");
```

--------------------------------

### Start a process without idle wait

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html

Starts a process immediately without waiting for an idle state.

```rust
use uiautomation::processes::Process;
let p = Process::start("copy README.md README.md.bak");
assert!(p.is_ok());
```

--------------------------------

### Mouse::new

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Mouse.html

Creates a new Mouse instance to simulate mouse events. This is the starting point for chaining configuration methods.

```APIDOC
## Mouse::new

### Description
Creates a `Mouse` to simulate mouse event.

### Method
```rust
pub fn new() -> Self
```
```

--------------------------------

### Keyboard::begin_hold_keys

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Keyboard.html?search=std%3A%3Avec

Starts holding specific keys until released.

```APIDOC
## pub fn begin_hold_keys(&mut self, keys: &str) -> Result<()>

### Description
Simulates starting to hold `keys` on the keyboard. The keys remain held until `end_hold_keys()` is called.
```

--------------------------------

### Screenshot::capture_desktop

Source: https://docs.rs/uiautomation/latest/uiautomation/screenshots/struct.Screenshot.html

Captures the entire desktop across all monitors, handling multi-monitor setups.

```APIDOC
## Screenshot::capture_desktop

### Description
Captures the entire desktop across all monitors. This method unions all monitor rectangles and captures the combined area. Negative coordinates are supported for multi-monitor setups.

### Signature
```rust
pub fn capture_desktop() -> Result<Self>
```
```

--------------------------------

### Keyboard::begin_hold_keys

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Keyboard.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Starts holding specific keys until end_hold_keys is called.

```APIDOC
## pub fn begin_hold_keys(&mut self, keys: &str) -> Result<()>

### Description
Simulates starting to hold `keys` on the keyboard. The keys will be released when `end_hold_keys()` is invoked.
```

--------------------------------

### Usage of show_message

Source: https://docs.rs/uiautomation/latest/uiautomation/dialogs/fn.show_message.html?search=u32+-%3E+bool

Example demonstrating how to import and call the show_message function with different text and caption arguments.

```rust
use uiautomation::dialogs::show_message;
 
show_message("Hello, I'm OK.", "INFO");
show_message("My Message.", "Test");
```

--------------------------------

### Implement UIPattern for UI patterns

Source: https://docs.rs/uiautomation/latest/uiautomation/patterns/trait.UIPattern.html?search=

Examples of implementing the UIPattern trait for various UI pattern types.

```rust
impl UIPattern for UIAnnotationPattern {
    const TYPE: UIPatternType = UIPatternType::Annotation
}
```

```rust
impl UIPattern for UICustomNavigationPattern {
    const TYPE: UIPatternType = UIPatternType::CustomNavigation
}
```

```rust
impl UIPattern for UIDockPattern {
    const TYPE: UIPatternType = UIPatternType::Dock
}
```

```rust
impl UIPattern for UIDragPattern {
    const TYPE: UIPatternType = UIPatternType::Drag
}
```

```rust
impl UIPattern for UIDropTargetPattern {
    const TYPE: UIPatternType = UIPatternType::DropTarget
}
```

```rust
impl UIPattern for UIExpandCollapsePattern {
    const TYPE: UIPatternType = UIPatternType::ExpandCollapse
}
```

```rust
impl UIPattern for UIGridItemPattern {
    const TYPE: UIPatternType = UIPatternType::GridItem
}
```

```rust
impl UIPattern for UIGridPattern {
    const TYPE: UIPatternType = UIPatternType::Grid
}
```

```rust
impl UIPattern for UIInvokePattern {
    const TYPE: UIPatternType = UIPatternType::Invoke
}
```

```rust
impl UIPattern for UIItemContainerPattern {
    const TYPE: UIPatternType = UIPatternType::ItemContainer
}
```

```rust
impl UIPattern for UILegacyIAccessiblePattern {
    const TYPE: UIPatternType = UIPatternType::LegacyIAccessible
}
```

```rust
impl UIPattern for UIMultipleViewPattern {
    const TYPE: UIPatternType = UIPatternType::MultipleView
}
```

```rust
impl UIPattern for UIRangeValuePattern {
    const TYPE: UIPatternType = UIPatternType::RangeValue
}
```

```rust
impl UIPattern for UIScrollItemPattern {
    const TYPE: UIPatternType = UIPatternType::ScrollItem
}
```

```rust
impl UIPattern for UIScrollPattern {
    const TYPE: UIPatternType = UIPatternType::Scroll
}
```

```rust
impl UIPattern for UISelectionItemPattern {
    const TYPE: UIPatternType = UIPatternType::SelectionItem
}
```

```rust
impl UIPattern for UISelectionPattern {
    const TYPE: UIPatternType = UIPatternType::Selection
}
```

```rust
impl UIPattern for UISpreadsheetItemPattern {
    const TYPE: UIPatternType = UIPatternType::SpreadsheetItem
}
```

```rust
impl UIPattern for UISpreadsheetPattern {
    const TYPE: UIPatternType = UIPatternType::Spreadsheet
}
```

```rust
impl UIPattern for UIStylesPattern {
    const TYPE: UIPatternType = UIPatternType::Styles
}
```

```rust
impl UIPattern for UISynchronizedInputPattern {
    const TYPE: UIPatternType = UIPatternType::SynchronizedInput
}
```

```rust
impl UIPattern for UITableItemPattern {
    const TYPE: UIPatternType = UIPatternType::TableItem
}
```

```rust
impl UIPattern for UITablePattern {
    const TYPE: UIPatternType = UIPatternType::Table
}
```

```rust
impl UIPattern for UITextChildPattern {
    const TYPE: UIPatternType = UIPatternType::TextChild
}
```

```rust
impl UIPattern for UITextEditPattern {
    const TYPE: UIPatternType = UIPatternType::TextEdit
}
```

```rust
impl UIPattern for UITextPattern {
    const TYPE: UIPatternType = UIPatternType::Text
}
```

```rust
impl UIPattern for UITogglePattern {
    const TYPE: UIPatternType = UIPatternType::Toggle
}
```

```rust
impl UIPattern for UITransformPattern {
    const TYPE: UIPatternType = UIPatternType::Transform
}
```

```rust
impl UIPattern for UIValuePattern {
    const TYPE: UIPatternType = UIPatternType::Value
}
```

```rust
impl UIPattern for UIVirtualizedItemPattern {
    const TYPE: UIPatternType = UIPatternType::VirtualizedItem
}
```

```rust
impl UIPattern for UIWindowPattern {
    const TYPE: UIPatternType = UIPatternType::Window
}
```

--------------------------------

### CustomNavigation::navigate

Source: https://docs.rs/uiautomation/latest/uiautomation/controls/struct.HeaderItemControl.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the next element in the specified direction within the logical UI tree.

```APIDOC
## fn navigate(&self, direction: NavigateDirection) -> Result<UIElement>

### Description
Retrieves the next UI element in the specified direction relative to the current HeaderItemControl within the logical UI tree.

### Parameters
- **direction** (NavigateDirection) - Required - The direction in which to navigate the UI tree.
```

--------------------------------

### Implement Control for UI elements

Source: https://docs.rs/uiautomation/latest/uiautomation/controls/trait.Control.html?search=

Examples of implementing the Control trait for various UI elements by defining their specific ControlType.

```rust
impl Control for AppBarControl {
    const TYPE: ControlType = ControlType::AppBar
}
```

```rust
impl Control for ButtonControl {
    const TYPE: ControlType = ControlType::Button
}
```

```rust
impl Control for CalendarControl {
    const TYPE: ControlType = ControlType::Calendar
}
```

```rust
impl Control for CheckBoxControl {
    const TYPE: ControlType = ControlType::CheckBox
}
```

```rust
impl Control for ComboBoxControl {
    const TYPE: ControlType = ControlType::ComboBox
}
```

```rust
impl Control for DataGridControl {
    const TYPE: ControlType = ControlType::DataGrid
}
```

```rust
impl Control for DataItemControl {
    const TYPE: ControlType = ControlType::DataItem
}
```

```rust
impl Control for DocumentControl {
    const TYPE: ControlType = ControlType::Document
}
```

```rust
impl Control for EditControl {
    const TYPE: ControlType = ControlType::Edit
}
```

```rust
impl Control for GroupControl {
    const TYPE: ControlType = ControlType::Group
}
```

```rust
impl Control for HeaderControl {
    const TYPE: ControlType = ControlType::Header
}
```

```rust
impl Control for HeaderItemControl {
    const TYPE: ControlType = ControlType::HeaderItem
}
```

```rust
impl Control for HyperlinkControl {
    const TYPE: ControlType = ControlType::Hyperlink
}
```

```rust
impl Control for ImageControl {
    const TYPE: ControlType = ControlType::Image
}
```

```rust
impl Control for ListControl {
    const TYPE: ControlType = ControlType::List
}
```

```rust
impl Control for ListItemControl {
    const TYPE: ControlType = ControlType::ListItem
}
```

```rust
impl Control for MenuBarControl {
    const TYPE: ControlType = ControlType::MenuBar
}
```

```rust
impl Control for MenuControl {
    const TYPE: ControlType = ControlType::Menu
}
```

```rust
impl Control for MenuItemControl {
    const TYPE: ControlType = ControlType::MenuItem
}
```

```rust
impl Control for PaneControl {
    const TYPE: ControlType = ControlType::Pane
}
```

```rust
impl Control for ProgressBarControl {
    const TYPE: ControlType = ControlType::ProgressBar
}
```

```rust
impl Control for RadioButtonControl {
    const TYPE: ControlType = ControlType::RadioButton
}
```

```rust
impl Control for ScrollBarControl {
    const TYPE: ControlType = ControlType::ScrollBar
}
```

```rust
impl Control for SemanticZoomControl {
    const TYPE: ControlType = ControlType::SemanticZoom
}
```

```rust
impl Control for SeparatorControl {
    const TYPE: ControlType = ControlType::Separator
}
```

```rust
impl Control for SliderControl {
    const TYPE: ControlType = ControlType::Slider
}
```

```rust
impl Control for SpinnerControl {
    const TYPE: ControlType = ControlType::Spinner
}
```

```rust
impl Control for SplitButtonControl {
    const TYPE: ControlType = ControlType::SplitButton
}
```

```rust
impl Control for StatusBarControl {
    const TYPE: ControlType = ControlType::StatusBar
}
```

```rust
impl Control for TabControl {
    const TYPE: ControlType = ControlType::Tab
}
```

```rust
impl Control for TabItemControl {
    const TYPE: ControlType = ControlType::TabItem
}
```

```rust
impl Control for TableControl {
    const TYPE: ControlType = ControlType::Table
}
```

```rust
impl Control for TextControl {
    const TYPE: ControlType = ControlType::Text
}
```

```rust
impl Control for ThumbControl {
    const TYPE: ControlType = ControlType::Thumb
}
```

```rust
impl Control for TitleBarControl {
    const TYPE: ControlType = ControlType::TitleBar
}
```

```rust
impl Control for ToolBarControl {
    const TYPE: ControlType = ControlType::ToolBar
}
```

```rust
impl Control for ToolTipControl {
    const TYPE: ControlType = ControlType::ToolTip
}
```

```rust
impl Control for TreeControl {
    const TYPE: ControlType = ControlType::Tree
}
```

```rust
impl Control for TreeItemControl {
    const TYPE: ControlType = ControlType::TreeItem
}
```

```rust
impl Control for WindowControl {
    const TYPE: ControlType = ControlType::Window
}
```

--------------------------------

### Capture Entire Desktop Screenshot

Source: https://docs.rs/uiautomation/latest/uiautomation/screenshots/struct.Screenshot.html

Captures the entire desktop area across all monitors. Supports negative coordinates for multi-monitor setups. Returns a Result containing the Screenshot or an error.

```rust
pub fn capture_desktop() -> Result<Self>
```

--------------------------------

### Run a configured process

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html

Demonstrates building a process with custom directory settings and executing it.

```rust
use uiautomation::processes::Process;
 
let ping = Process::new("ping.exe localhost -n 1").current_directory("C:/").run().unwrap();
ping.wait().unwrap();
```

--------------------------------

### show_error Usage Example

Source: https://docs.rs/uiautomation/latest/uiautomation/dialogs/fn.show_error.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Example of calling the show_error function with specific text and caption arguments.

```rust
uiautomation::dialogs::show_error("This is my error.", "ERROR");
```

--------------------------------

### pub fn realize(&self) -> Result<()>

Source: https://docs.rs/uiautomation/latest/uiautomation/patterns/struct.UIVirtualizedItemPattern.html?search=

Makes the virtualized item fully available as a UI Automation element.

```APIDOC
## pub fn realize(&self) -> Result<()>

### Description
Makes the virtualized item fully available as a UI Automation element.

### Returns
- **Result<()>** - Returns Ok(()) if the operation succeeds, or an error if it fails.
```

--------------------------------

### Retrieve child condition

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UINotCondition.html?search=

Method to get the condition that is being negated.

```rust
pub fn get_child(&self) -> Result<UICondition>
```

--------------------------------

### UIAutomation::new

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIAutomation.html?search=

Creates a new UIAutomation client instance and initializes the COM library with COINIT_MULTITHREADED.

```APIDOC
## pub fn new() -> Result<UIAutomation>

### Description
Creates a uiautomation client instance. This method initializes the COM library each time, sets the thread’s concurrency model as `COINIT_MULTITHREADED`.
```

--------------------------------

### realize

Source: https://docs.rs/uiautomation/latest/uiautomation/patterns/struct.UIVirtualizedItemPattern.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Makes the virtualized item fully accessible as a UI Automation element.

```APIDOC
## pub fn realize(&self) -> Result<()>

### Description
Makes the virtualized item fully accessible as a UI Automation element. This method is used to ensure that a virtualized item is realized in the UI Automation tree.

### Returns
- **Result<()>** - Returns Ok(()) if successful, or an error if the operation fails.
```

--------------------------------

### realize

Source: https://docs.rs/uiautomation/latest/uiautomation/patterns/struct.UIVirtualizedItemPattern.html

Makes the virtualized item fully accessible as a UI Automation element.

```APIDOC
## pub fn realize(&self) -> Result<()>

### Description
Makes the virtualized item fully accessible as a UI Automation element.

### Returns
- **Result<()>** - Returns Ok(()) if successful, or an error if the operation fails.
```

--------------------------------

### Rect Property Accessors

Source: https://docs.rs/uiautomation/latest/uiautomation/types/struct.Rect.html?search=

Methods to get and set the individual coordinates of the rectangle.

```APIDOC
## Property Accessors

### Methods
- **get_left() -> i32**: Retrieves the left coordinate.
- **set_left(left: i32)**: Sets the left coordinate.
- **get_top() -> i32**: Retrieves the top coordinate.
- **set_top(top: i32)**: Sets the top coordinate.
- **get_right() -> i32**: Retrieves the right coordinate.
- **set_right(right: i32)**: Sets the right coordinate.
- **get_bottom() -> i32**: Retrieves the bottom coordinate.
- **set_bottom(bottom: i32)**: Sets the bottom coordinate.
```

--------------------------------

### Process::new

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html

Initializes a new Process instance that can be configured before execution.

```APIDOC
## pub fn new<S: Into<String>>(command: S) -> Self

### Description
Create a process by `command`. This process will not startup until it is called by `run()`.
```

--------------------------------

### Mouse Initialization and Configuration

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Mouse.html?search=std%3A%3Avec

Methods to create a new Mouse instance and configure its behavior such as interval, move time, and automatic movement.

```APIDOC
## Mouse::new()
Creates a new Mouse instance to simulate mouse events.

## Mouse::interval(interval: u64)
Sets the interval time between events in milliseconds. Default is 100.

## Mouse::move_time(move_time: u64)
Sets the mouse move time in milliseconds. Default is 500.

## Mouse::auto_move(auto_move: bool)
Sets whether to move the cursor to the click point automatically. Default is true.

## Mouse::holdkeys(holdkeys: &str)
Sets the holdkeys (e.g., {Shift}, {Ctrl}{Alt}) to be held during mouse clicks.
```

--------------------------------

### Define TextPatternRangeEndpoint Enum

Source: https://docs.rs/uiautomation/latest/uiautomation/types/enum.TextPatternRangeEndpoint.html

The enum structure representing the start and end points of a text range.

```rust
#[repr(i32)]
pub enum TextPatternRangeEndpoint {
    Start = 0,
    End = 1,
}
```

--------------------------------

### UIAutomation::new

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIAutomation.html?search=std%3A%3Avec

Creates a new UIAutomation client instance and initializes the COM library with the multithreaded concurrency model.

```APIDOC
### pub fn new() -> Result<UIAutomation>

Creates a uiautomation client instance. This method initializes the COM library each time, setting the thread’s concurrency model as `COINIT_MULTITHREADED`.
```

--------------------------------

### Input::new

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Input.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new, empty Input instance.

```APIDOC
### fn new()

Creates a new empty `Input` instance.
```

--------------------------------

### Process::run

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Executes the configured process.

```APIDOC
## pub fn run(self) -> Result<Self>

### Description
Run the current process configured via new() and builder methods.

### Example
```rust
use uiautomation::processes::Process;
let ping = Process::new("ping.exe localhost -n 1").current_directory("C:/").run().unwrap();
ping.wait().unwrap();
```
```

--------------------------------

### find_item_by_property

Source: https://docs.rs/uiautomation/latest/uiautomation/patterns/struct.UIItemContainerPattern.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves a UI element from the container that matches the specified property and value, starting the search after the provided element.

```APIDOC
## pub fn find_item_by_property(&self, start_after: UIElement, property: UIProperty, value: Variant) -> Result<UIElement>

### Description
Searches for a UI element within the container that matches the given property and value. The search begins after the specified `start_after` element.

### Parameters
- **start_after** (UIElement) - The element after which to begin the search.
- **property** (UIProperty) - The property to match against.
- **value** (Variant) - The value of the property to search for.

### Returns
- **Result<UIElement>** - Returns the found UIElement if successful, or an error if the operation fails.
```

--------------------------------

### Using query_yes_no_cancel

Source: https://docs.rs/uiautomation/latest/uiautomation/dialogs/fn.query_yes_no_cancel.html

Demonstrates how to use `query_yes_no_cancel` to display a dialog and react to the user's input. Requires `show_message` to display feedback.

```rust
use uiautomation::dialogs::*

match query_yes_no_cancel("Do you want to do this?", "QUERY") {
    Some(ret) => show_message(if ret { "YES!" } else { "OK!!" }, "ANSWER"),
    None => show_message("I don't known.", "ANSWER")
}
```

--------------------------------

### find_item_by_property

Source: https://docs.rs/uiautomation/latest/uiautomation/patterns/struct.UIItemContainerPattern.html?search=u32+-%3E+bool

Searches for an item within the container that matches the specified property and value, starting the search after the provided element.

```APIDOC
## pub fn find_item_by_property(&self, start_after: UIElement, property: UIProperty, value: Variant) -> Result<UIElement>

### Description
Retrieves an element from the container that matches the given property and value. The search begins after the specified `start_after` element.

### Parameters
- **start_after** (UIElement) - The element after which to begin the search.
- **property** (UIProperty) - The property to match against.
- **value** (Variant) - The value to match for the specified property.

### Returns
- **Result<UIElement>** - Returns the found UIElement if successful, or an error if the item could not be found or an automation error occurred.
```

--------------------------------

### UIItemContainerPattern::find_item_by_property

Source: https://docs.rs/uiautomation/latest/uiautomation/patterns/struct.UIItemContainerPattern.html?search=

Searches for an item within the container that matches the specified property and value, starting the search after the provided UIElement.

```APIDOC
## fn find_item_by_property(&self, start_after: UIElement, property: UIProperty, value: Variant) -> Result<UIElement>

### Description
Retrieves an element from the container that matches the given property and value. The search begins after the specified `start_after` element.

### Parameters
- **start_after** (UIElement) - The element after which to begin the search.
- **property** (UIProperty) - The property to match against.
- **value** (Variant) - The value to match for the specified property.

### Returns
- **Result<UIElement>** - Returns the found UIElement or an error if the operation fails.
```

--------------------------------

### Process::create

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates and runs a process by command line, waiting for an idle state for 0.5 seconds.

```APIDOC
## pub fn create<S: Into<String>>(command: S) -> Result<Self>

### Description
Creates and runs a process by command line. This process will wait for idle state for 0.5s before returning.

### Parameters
- **command** (S: Into<String>) - Required - The command line to execute.

### Example
```rust
use uiautomation::processes::Process;
let p = Process::create("notepad.exe");
assert!(p.is_ok());
```
```

--------------------------------

### Process::create

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html

Creates and runs a process by command line, waiting for an idle state for 0.5 seconds.

```APIDOC
## pub fn create<S: Into<String>>(command: S) -> Result<Self>

### Description
Create and run a process by command line. This process will wait for idle state for 0.5s before returning.
```

--------------------------------

### Filtering with filter_fn

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIMatcher.html

Example of using a custom filter function to match elements based on framework ID and class name.

```rust
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());
```

--------------------------------

### Process::create

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html?search=

Creates and runs a process by command line, waiting for an idle state for 0.5 seconds.

```APIDOC
## pub fn create<S: Into<String>>(command: S) -> Result<Self>

### Description
Creates and runs a process by command line. This process will wait for idle state for 0.5s before returning.

### Parameters
- **command** (S: Into<String>) - Required - The command line to execute.
```

--------------------------------

### Clipboard::new

Source: https://docs.rs/uiautomation/latest/uiautomation/clipboards/struct.Clipboard.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new clipboard instance.

```APIDOC
## pub fn new() -> Result<Self>

### Description
Creates a new clipboard instance.
```

--------------------------------

### find_item_by_property

Source: https://docs.rs/uiautomation/latest/uiautomation/actions/trait.ItemContainer.html?search=

Retrieves an element within a containing element, based on a specified property value. It searches for a UIElement starting after the provided element.

```APIDOC
## fn find_item_by_property(&self, start_after: UIElement, property_id: i32, value: Variant) -> Result<UIElement>

### Description
Searches for a UIElement starting after the `start_after` item, returning the first item whose property matches the specified value.

### Parameters
- **start_after** (UIElement) - The element to start the search after.
- **property_id** (i32) - The ID of the property to match.
- **value** (Variant) - The value to match against the property.

### Returns
- **Result<UIElement>** - Returns the found UIElement or an error if the search fails.
```

--------------------------------

### Create a Mouse Instance

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Mouse.html

Creates a new Mouse instance for simulating mouse events. Configuration methods can be chained before use.

```rust
use uiautomation::inputs::Mouse;
use uiautomation::types::Point;
 
let mouse = Mouse::new().move_time(800);
```

--------------------------------

### Initialize Parser

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Parser.html

Creates a new instance of the Parser. Use this to initialize the parser with error handling preferences.

```rust
pub fn new(ignore_err: bool) -> Self>
```

--------------------------------

### find_item_by_property

Source: https://docs.rs/uiautomation/latest/uiautomation/actions/trait.ItemContainer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves an element within a containing element, based on a specified property value. It searches for a UIElement starting after the provided element.

```APIDOC
## fn find_item_by_property

### Description
Retrieves an element within a containing element, based on a specified property value. Searches for a UIElement starting after the provided element, returning the first item that matches the specified property value.

### Signature
`fn find_item_by_property(&self, start_after: UIElement, property_id: i32, value: Variant) -> Result<UIElement>`

### Parameters
- **start_after** (UIElement) - The element to start the search after.
- **property_id** (i32) - The identifier of the property to match.
- **value** (Variant) - The value to match against the property.

### Returns
- **Result<UIElement>** - Returns the found UIElement or an error if the operation fails.
```

--------------------------------

### Keyboard::new

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Keyboard.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new instance of the Keyboard struct to simulate typing keys.

```APIDOC
## pub fn new() -> Self

### Description
Create a keyboard to simulate typing keys.
```

--------------------------------

### Chain fallible operations with and_then

Source: https://docs.rs/uiautomation/latest/uiautomation/errors/type.Result.html?search=

Use and_then to chain operations that return a Result. The second example demonstrates handling filesystem metadata errors.

```rust
assert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));
assert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err("overflowed"));
assert_eq!(Err("not a number").and_then(sq_then_to_string), Err("not a number"));
```

```rust
use std::{io::ErrorKind, path::Path};

// Note: on Windows "/" maps to "C:\"
let root_modified_time = Path::new("/").metadata().and_then(|md| md.modified());
assert!(root_modified_time.is_ok());

let should_fail = Path::new("/bad/path").metadata().and_then(|md| md.modified());
assert!(should_fail.is_err());
assert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
```

--------------------------------

### pub fn set_foregrand(&self) -> Result<bool>

Source: https://docs.rs/uiautomation/latest/uiautomation/controls/struct.WindowControl.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Brings the thread that created the specified window into the foreground and activates the window.

```APIDOC
## set_foregrand

### Description
Brings the thread that created the specified window into the foreground and activates the window.

### Signature
`pub fn set_foregrand(&self) -> Result<bool>`

### Returns
- **Result<bool>** - Returns Ok(true) if the window was successfully brought to the foreground, otherwise returns an error or false.
```

--------------------------------

### Screenshot::new

Source: https://docs.rs/uiautomation/latest/uiautomation/screenshots/struct.Screenshot.html

Creates a new screenshot instance from raw pixel data, width, and height.

```APIDOC
## Screenshot::new

### Description
Creates a new screenshot from raw pixel data.

### Signature
```rust
pub fn new(pixels: Vec<u8>, width: u32, height: u32) -> Self
```
```

--------------------------------

### Get Screenshot Dimensions and Pixel Data

Source: https://docs.rs/uiautomation/latest/uiautomation/screenshots/struct.Screenshot.html

Retrieves the width, height, raw pixel data, and pixel format of the screenshot. Pixel data is in BGRA format by default.

```rust
pub fn width(&self) -> u32
```

```rust
pub fn height(&self) -> u32
```

```rust
pub fn pixels(&self) -> &[u8]
```

```rust
pub fn format(&self) -> PixelFormat
```

--------------------------------

### UIMatcher Configuration and Search

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIMatcher.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for configuring the UIMatcher instance and executing searches for UI elements.

```APIDOC
## UIMatcher Methods

### new(automation: UIAutomation) -> Self
Creates a new UIMatcher instance associated with the provided UIAutomation object.

### mode(search_mode: UIMatcherMode) -> Self
Sets the searching mode (default: UIMatcherMode::Control).

### from(element: UIElement) -> Self
Sets the root element for the search (default: desktop).

### depth(depth: u32) -> Self
Sets the search depth (default: 7).

### timeout(timeout: u64) -> Self
Sets the search timeout in milliseconds (default: 3000).

### interval(interval: u64) -> Self
Sets the retry interval in milliseconds (default: 100).

### filter(filter: Box<dyn MatcherFilter>) -> Self
Appends a filter condition using 'and' logic.

### filter_fn<F>(f: Box<F>) -> Self
Appends a custom filter function.

### name(name: S) -> Self
Filters by case-sensitive name.

### contains_name(name: S) -> Self
Filters by name containing specific text (case-insensitive).

### match_name(name: S) -> Self
Filters by name matching specific text (case-insensitive).

### classname(classname: S) -> Self
Filters by classname.

### control_type(control_type: ControlType) -> Self
Filters by control type.

### process_id(pid: u32) -> Self
Filters by process ID.

### reset() -> Self
Clears all applied filters.

### find_first() -> Result<UIElement>
Executes the search and returns the first matching element.

### find_all() -> Result<Vec<UIElement>>
Executes the search and returns all matching elements.
```

--------------------------------

### find_item_by_property

Source: https://docs.rs/uiautomation/latest/uiautomation/actions/trait.ItemContainer.html

Retrieves an element within a containing element, based on a specified property value. It searches for a UIElement starting after the provided element that matches the given property ID and value.

```APIDOC
## fn find_item_by_property(&self, start_after: UIElement, property_id: i32, value: Variant) -> Result<UIElement>

### Description
Retrieves an element within a containing element, based on a specified property value. Searches for a UIElement starting after the `start_after` item, returning the first item whose property matches the specified value.

### Parameters
- **start_after** (UIElement) - The element to start the search after.
- **property_id** (i32) - The ID of the property to match.
- **value** (Variant) - The value to match against the property.

### Returns
- **Result<UIElement>** - Returns the found UIElement or an error if the operation fails.
```

--------------------------------

### Using query_yes_no

Source: https://docs.rs/uiautomation/latest/uiautomation/dialogs/fn.query_yes_no.html

Demonstrates how to use the query_yes_no function to ask for user confirmation. The dialog will show the provided text and caption. If the user selects 'Yes', a message box is displayed.

```rust
use uiautomation::dialogs::*

if query_yes_no("Are your sure?", "QUERY") {
    show_message("Oh! Yes!!!", "ANSWERED");
}
```

--------------------------------

### Navigation Methods

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UITreeWalker.html?search=

Methods for traversing the UI Automation tree, including standard and cache-enabled variants.

```rust
pub fn get_parent(&self, element: &UIElement) -> Result<UIElement>
```

```rust
pub fn get_parent_build_cache( &self, element: &UIElement, cache_request: &UICacheRequest, ) -> Result<UIElement>
```

```rust
pub fn get_first_child(&self, element: &UIElement) -> Result<UIElement>
```

```rust
pub fn get_first_child_build_cache( &self, element: &UIElement, cache_request: &UICacheRequest, ) -> Result<UIElement>
```

```rust
pub fn get_last_child(&self, element: &UIElement) -> Result<UIElement>
```

```rust
pub fn get_last_child_build_cache( &self, element: &UIElement, cache_request: &UICacheRequest, ) -> Result<UIElement>
```

```rust
pub fn get_next_sibling(&self, element: &UIElement) -> Result<UIElement>
```

```rust
pub fn get_next_sibling_build_cache( &self, element: &UIElement, cache_request: &UICacheRequest, ) -> Result<UIElement>
```

```rust
pub fn get_previous_sibling(&self, element: &UIElement) -> Result<UIElement>
```

```rust
pub fn get_previous_sibling_build_cache( &self, element: &UIElement, cache_request: &UICacheRequest, ) -> Result<UIElement>
```

```rust
pub fn normalize(&self, element: &UIElement) -> Result<UIElement>
```

```rust
pub fn normalize_build_cache( &self, element: &UIElement, cache_request: &UICacheRequest, ) -> Result<UIElement>
```

```rust
pub fn get_condition(&self) -> Result<UICondition>
```

```rust
pub fn get_children(&self, element: &UIElement) -> Option<Vec<UIElement>>
```

```rust
pub fn get_children_build_cache( &self, element: &UIElement, cache_request: &UICacheRequest, ) -> Option<Vec<UIElement>>
```

--------------------------------

### Double Click at Specific Position

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Mouse.html

Simulates a mouse double-click event at a specified screen coordinate. It's recommended to get the current cursor position if a specific target isn't provided.

```rust
use uiautomation::inputs::Mouse;
 
let mouse = Mouse::new();
let pos = Mouse::get_cursor_pos().unwrap();
mouse.double_click(&pos).unwrap();
```

--------------------------------

### UIAutomation::create_matcher

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIAutomation.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a UIMatcher instance to help find specific UI elements.

```APIDOC
## pub fn create_matcher(&self) -> UIMatcher

### Description
Creates a UIMatcher which helps to find some UIElement.
```

--------------------------------

### Parser::new

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Parser.html?search=u32+-%3E+bool

Creates a new instance of the Parser.

```APIDOC
## pub fn new(ignore_err: bool) -> Self

### Description
Creates a new Parser instance. The ignore_err parameter determines whether the parser should ignore errors during processing.

### Parameters
- **ignore_err** (bool) - Required - Determines if errors should be ignored.
```

--------------------------------

### Screenshot::new

Source: https://docs.rs/uiautomation/latest/uiautomation/screenshots/struct.Screenshot.html?search=u32+-%3E+bool

Creates a new screenshot instance from raw pixel data.

```APIDOC
## pub fn new(pixels: Vec<u8>, width: u32, height: u32) -> Self

### Description
Creates a new screenshot from raw pixel data.

### Parameters
- **pixels** (Vec<u8>) - Raw pixel data.
- **width** (u32) - Width of the screenshot in pixels.
- **height** (u32) - Height of the screenshot in pixels.
```

--------------------------------

### UIMatcher Configuration and Execution

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIMatcher.html

Methods for configuring the search criteria and executing the search for UI elements.

```APIDOC
## UIMatcher Methods

### Configuration
- **new(automation: UIAutomation) -> Self**: Creates a new matcher instance.
- **mode(search_mode: UIMatcherMode) -> Self**: Sets the search mode (default: UIMatcherMode::Control).
- **from(element: UIElement) -> Self**: Sets the root element for the search.
- **depth(depth: u32) -> Self**: Sets the search depth (default: 7).
- **timeout(timeout: u64) -> Self**: Sets the search timeout in milliseconds (default: 3000).
- **interval(interval: u64) -> Self**: Sets the retry interval in milliseconds (default: 100).

### Filtering
- **filter(filter: Box<dyn MatcherFilter>) -> Self**: Appends a custom filter condition.
- **filter_fn(f: Box<F>) -> Self**: Appends a closure-based filter function.
- **name(name: S) -> Self**: Filters by exact case-sensitive name.
- **contains_name(name: S) -> Self**: Filters by name containing text (case-insensitive).
- **match_name(name: S) -> Self**: Filters by exact name (case-insensitive).
- **classname(classname: S) -> Self**: Filters by class name.
- **control_type(control_type: ControlType) -> Self**: Filters by control type.
- **process_id(pid: u32) -> Self**: Filters by process ID.
- **reset() -> Self**: Clears all applied filters.

### Execution
- **find_first() -> Result<UIElement>**: Searches for the first matching element.
- **find_all() -> Result<Vec<UIElement>>**: Searches for all matching elements.
```

--------------------------------

### TryFrom<UIElement> Implementations

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIElement.html?search=std%3A%3Avec

The library provides TryFrom implementations for various UI controls, allowing conversion from a generic UIElement to a specific control type. If the conversion fails, an Error is returned.

```APIDOC
## fn try_from(value: &UIElement) -> Result<Self>

### Description
Attempts to convert a generic UIElement reference into a specific control type (e.g., ButtonControl, CheckBoxControl).

### Parameters
- **value** (&UIElement) - Required - The UIElement instance to convert.

### Returns
- **Result<Self>** - Returns the specific control type if successful, or an Error if the conversion is not possible.
```

--------------------------------

### Clipboard::new_for

Source: https://docs.rs/uiautomation/latest/uiautomation/clipboards/struct.Clipboard.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new clipboard instance with the specified owner window.

```APIDOC
## pub fn new_for(owner: Handle) -> Result<Self>

### Description
Creates a new clipboard instance with the specified owner window.
```

--------------------------------

### Process Configuration Methods

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html

Methods to configure the process before execution.

```APIDOC
## Configuration Methods

- **application(application: S)**: Set the name of the module to be executed.
- **command(command: S)**: Set the command line to be executed.
- **current_directory(dir: S)**: Set the current directory for the process.
- **wait_for_idle(milliseconds: u32)**: Set to wait until the process is idle or the timeout elapses.
```

--------------------------------

### Simulate Keyboard Input with send_keys

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIElement.html?search=

Simulates complex keyboard input including special keys and modifiers. Requires an initialized UIAutomation instance.

```rust
use uiautomation::core::UIAutomation;

let automation = UIAutomation::new().unwrap();
let root = automation.get_root_element().unwrap();
root.send_keys("{Win}D", 0).unwrap();
```

--------------------------------

### Clipboard::open

Source: https://docs.rs/uiautomation/latest/uiautomation/clipboards/struct.Clipboard.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Opens the clipboard for the current active window.

```APIDOC
## pub fn open() -> Result<Self>

### Description
Open the clipboard for the current active window. This method will try to open the clipboard multiple times if it fails.
```

--------------------------------

### Create a process with idle wait

Source: https://docs.rs/uiautomation/latest/uiautomation/processes/struct.Process.html

Initializes and runs a process, waiting 0.5s for an idle state.

```rust
use uiautomation::processes::Process;
 
let p = Process::create("notepad.exe");
assert!(p.is_ok());
```

--------------------------------

### UIAutomation::get_root_element

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIAutomation.html?search=u32+-%3E+bool

Retrieves the UI Automation element representing the desktop.

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

### Description
Retrieves the UI Automation element that represents the desktop.
```

--------------------------------

### pub fn new() -> Self

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Input.html?search=std%3A%3Avec

Creates a new instance of the Input struct.

```APIDOC
### pub fn new()

Creates a new, empty Input instance.
```

--------------------------------

### show_context_menu

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIElement.html

Programmatically invokes a context menu on the target element.

```APIDOC
## pub fn show_context_menu(&self) -> Result<()>

### Description
Programmatically invokes a context menu on the target element.
```

--------------------------------

### UIAutomation::create_matcher

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIAutomation.html?search=std%3A%3Avec

Creates a UIMatcher instance to help locate specific UI elements based on criteria.

```APIDOC
### pub fn create_matcher(&self) -> UIMatcher

Creates a UIMatcher which helps to find some UIElement.
```

--------------------------------

### show_info

Source: https://docs.rs/uiautomation/latest/uiautomation/dialogs/fn.show_info.html

Shows an information message dialog with an OK button and a INFO icon.

```APIDOC
## show_info

### Description
Shows an information message dialog with an `OK` button and a `INFO` icon.

### Signature
```rust
pub fn show_info(text: &str, caption: &str)
```

### Example
```rust
uiautomation::dialogs::show_info("This is my info.", "INFO");
```
```

--------------------------------

### set_foregrand

Source: https://docs.rs/uiautomation/latest/uiautomation/controls/struct.WindowControl.html

Brings the thread that created the specified window into the foreground and activates the window.

```APIDOC
## pub fn set_foregrand(&self) -> Result<bool>

### Description
Brings the thread that created the specified window into the foreground and activates the window.

### Returns
- **Result<bool>** - Returns Ok(true) if the window was successfully brought to the foreground, otherwise returns an error or false.
```

--------------------------------

### Navigate Method

Source: https://docs.rs/uiautomation/latest/uiautomation/patterns/struct.UICustomNavigationPattern.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Navigates in a specified direction using the custom navigation pattern.

```rust
pub fn navigate(&self, direction: NavigateDirection) -> Result<UIElement>
```

--------------------------------

### UIElement Relationship and Action Methods

Source: https://docs.rs/uiautomation/latest/uiautomation/core/struct.UIElement.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods to retrieve related UI elements and perform actions like setting focus.

```APIDOC
## get_labeled_by
Retrieves the element that contains the text label for this element.

## get_cached_labeled_by
Retrieves the cached element that contains the text label for this element.

## get_controller_for
Retrieves an array of elements for which this element serves as the controller.

## get_cached_controller_for
Retrieves a cached array of elements for which this element serves as the controller.

## get_described_by
Retrieves an array of elements that describe this element.

## get_cached_described_by
Retrieves a cached array of elements that describe this element.

## get_flows_to
Retrieves an array of elements that indicates the reading order after the current element.

## get_cached_flows_to
Retrieves a cached array of elements that indicates the reading order after the current element.

## get_provider_description
Retrieves a description of the provider for this element.

## get_cached_provider_description
Retrieves a cached description of the provider for this element.

## set_focus
Sets the keyboard focus to this UI Automation element.
```

--------------------------------

### UIDockPattern Methods

Source: https://docs.rs/uiautomation/latest/uiautomation/patterns/struct.UIDockPattern.html?search=std%3A%3Avec

Methods for interacting with the dock position of a UI element.

```rust
pub fn get_dock_position(&self) -> Result<DockPosition>
```

```rust
pub fn get_cached_dock_position(&self) -> Result<DockPosition>
```

```rust
pub fn set_dock_position(&self, position: DockPosition) -> Result<()>
```

--------------------------------

### Clipboard::open_for

Source: https://docs.rs/uiautomation/latest/uiautomation/clipboards/struct.Clipboard.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Opens the clipboard for the specified owner window.

```APIDOC
## pub fn open_for(owner: Handle) -> Result<Self>

### Description
Open the clipboard for the specified owner window. This method will try to open the clipboard multiple times if it fails.
```

--------------------------------

### Window Management Methods

Source: https://docs.rs/uiautomation/latest/uiautomation/controls/struct.WindowControl.html?search=u32+-%3E+bool

Methods for controlling the state and lifecycle of a window.

```APIDOC
## Window Management

### close()
Closes the window.

### wait_for_input_idle(milliseconds: i32) -> Result<bool>
Blocks the calling code for the specified time or until the process enters an idle state.

### get_window_visual_state() -> Result<WindowVisualState>
Retrieves the current visual state (normal, maximized, or minimized).

### set_window_visual_state(state: WindowVisualState) -> Result<()>
Sets the window to a specific visual state.

### is_modal() -> Result<bool>
Checks if the window is modal.

### is_topmost() -> Result<bool>
Checks if the window is the topmost element.
```

--------------------------------

### Show Info Dialog

Source: https://docs.rs/uiautomation/latest/uiautomation/dialogs/fn.show_info.html

Use this function to display a simple information message to the user. It requires the message text and a caption for the dialog window.

```rust
uiautomation::dialogs::show_info("This is my info.", "INFO");
```

--------------------------------

### pub fn create_unicode_inputs(&self) -> Result<Vec<INPUT>>

Source: https://docs.rs/uiautomation/latest/uiautomation/inputs/struct.Input.html?search=std%3A%3Avec

Generates Unicode-based input items, which is more robust but may differ from standard keyboard simulation.

```APIDOC
### pub fn create_unicode_inputs(&self) -> Result<Vec<INPUT>>

Creates unicode inputs. This is more robust but might not simulate key presses like from a real keyboard.
```
Tokens:
Raw