https://github.com/soul-master/aquery

Window automation-based Query (a fluent jQuery-like API)
https://github.com/soul-master/aquery

Last synced: 9 days ago
JSON representation

Window automation-based Query (a fluent jQuery-like API)

• Host: GitHub
• URL: https://github.com/soul-master/aquery
• Owner: Soul-Master
• License: apache-2.0
• Created: 2015-12-04T06:31:09.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-13T07:47:44.000Z (about 9 years ago)
• Last Synced: 2024-11-08T23:32:49.358Z (2 months ago)
• Language: C#
• Size: 280 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[aQuery](https://github.com/Soul-Master/aQuery)

==================================================

aQuery is a fast, small, and feature-rich C# library that based on [Windows Automation API](https://msdn.microsoft.com/en-us/library/windows/desktop/ff486375(v=vs.85).aspx). It makes things like Windows control traversal and manipulation much simpler with an easy-to-use API that works across variety of desktop control like C++ control, windows forms or even WPF. With a combination of versatility and extensibility, aQuery has changed the way that people write automation on Windows application.

Overview

---------

![Overview image](https://cdn.rawgit.com/Soul-Master/aQuery/master/aQuery/Overview.PNG)

Here is the simplest form of aQuery syntax. The following statement use aQuery to select window element with ProcessId equals `1234`

```C#

// Syntax of C# 6.0

using static aQuery.aQuery;

var window = a("window[ProcessId=1234]");

```

After you can retrieve element from given `context` (default context is desktop), you can manipulate it via built-in methods like the following statements.

```C#

// Trigger click via InvokePattern

window.Click();

```

*[InvokePattern](https://msdn.microsoft.com/en-us/library/system.windows.automation.invokepattern(v=vs.110).aspx) represents controls that initiate or perform a single, unambiguous action and do not maintain state when activated.

Selectors

---------

As you know, the hardest part of automating application on Windows desktop is selecting control. Normally, application isn't designed to be queried. Control structure doesn't look simple just like normal web page.

![Calculator App](https://cdn.rawgit.com/Soul-Master/aQuery/master/demo/Calculator1.png)

Most of control properties that we can retrieve via  [AutomationElement](https://msdn.microsoft.com/en-us/library/system.windows.automation.automationelement(v=vs.110).aspx) doesn't unique. We cannot select control by using only one property.

![Calculator App](https://cdn.rawgit.com/Soul-Master/aQuery/master/demo/Calculator2.png) 

So I decide to simplify this process by creating aQuery (AutomationElement wrapper) that can query element with jQuery-syntax like command. This is the syntax that currently supports by aQuery.

```text

'{Name Property}' {LocalizedControlType}[{PropertyName}={PropertyValue}]:{filterName}({filterValue})

```

For selecting title bar of Calculator, you can use one of the following selectors if it doesn't duplicate with other controls.

- `"'Calculator'"` specify only Name property

- `"title bar"` specify only LocalizedControlType property

- `"'Calculator' title bar"` specify by Name and LocalizedControlType properties

- `[AutomationId=TitleBar][ControlType=ControlType.TitleBar]` specify by some properties

- `title bar:first` specify by `LocalizedControlType` property and get the first one

For more example, please look at source code of [aQuery.Amibroker](https://github.com/Soul-Master/aQuery/tree/master/aQuery.Amibroker) project. It contains a lot of useful code for using aQuery.