Skip to content

Commit 59b79ee

Browse files
committed
DOC(More standardised documents)
1 parent 719b4b0 commit 59b79ee

23 files changed

+85
-44
lines changed

Diff for: README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ See LICENCE.txt for details.
3030
* [UIAutomation for Powershell](http://uiautomation.codeplex.com/documentation)
3131
* [TestStack.White](https://github.com/TestStack/White)
3232
* [UI Automation - A wrapper around Microsoft's UI Automation libraries.](https://github.com/vijayakumarsuraj/UIAutomation)
33-
33+
* [Automation Spy Blog entry](http://www.automationspy.com/post-25_12_2014.html)
3434
* [Functional GUI Testing Automation Patterns](https://www.infoq.com/articles/gui-automation-patterns)
3535

Diff for: docs/button.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
#Discovery
1+
# Discovery
22
* See [Element Discovery](element-discovery.md)
33

4-
:Methods
4+
# Methods
55

6-
:Name
7-
:Value
8-
:Click
9-
:Focus
6+
## Name
7+
## Value
8+
## Click
9+
##Focus

Diff for: docs/checkbox.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
14
```
25
AutomationCheckBox check = window.getCheckBox(0);
36
check.toggle();
@@ -10,9 +13,9 @@ try {
1013
}
1114
```
1215

13-
: Methods
16+
# Methods
1417

15-
:Name
16-
:Value
17-
:Toggle
18-
:ToggleState
18+
## Name
19+
## Value
20+
## Toggle
21+
## ToggleState

Diff for: docs/combobox.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
14
```
25
AutomationComboBox cb1 = window.getCombobox("AutomatedCombobox1");
36
String oldTxt = cb1.text();
47
cb1.setText("Replacements");
58
String txt = cb1.text();
6-
```
9+
```
10+
11+
# Methods

Diff for: docs/custom.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
The Custom control type covers a multitude of non-standard controls. Mostly these have been wrapped up in a single type - Custom, but where specific implementations are known, then sub-classes of Custom have been created - for example [Word](Word) has a AutomationDocumentPage, which is different enough from a standard Custom control to have a specific implementation.
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
4+
The Custom control type covers a multitude of non-standard controls. Mostly these have been wrapped up in a single
5+
type - Custom, but where specific implementations are known, then sub-classes of Custom have been created - for
6+
example [Word](Word) has a AutomationDocumentPage, which is different enough from a standard Custom
7+
control to have a specific implementation.

Diff for: docs/developer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,4 +134,4 @@ The controls that have been implemented reflect the requirements for automating
134134
* [Events](events.md)
135135

136136
## Other languages
137-
* [Scala](scala.md)
137+
* [Scala](scala.md)

Diff for: docs/document.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
14
```
25
AutomationDocument document = applicationWindow.getDocument(0);
36

Diff for: docs/editbox.md

+2-11
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,2 @@
1-
Edit boxes can be located by index, or by name.
2-
3-
```
4-
AutomationEditBox user = window.getEditBox(0);
5-
user.setText("USER1");
6-
```
7-
8-
```
9-
AutomationEditBox user = window.getEditBox("edtBox1");
10-
user.setText("USER1");
11-
```
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)

Diff for: docs/grids.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
## DataGrid
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
23

3-
### WFP
4+
## WFP
45
```
56
AutomationDataGrid grid = window.getDataGrid(0);
67
AutomationDataGridCell cell = grid.getItem(0,0);
78
String itemName = item.name();
89
```
910

10-
### Delphi
11+
## Delphi
1112

1213
The [DelphiUIAutomation](https://github.com/markhumphreysjhc/DelphiUIAutomation) project introduced some Delphi controls that implement IUIAutomation providers, allowing them to be accessed by automation. The TAutomatedStringGrid is one of these, as the base Delphi (as of XE5 at least) control does not implement the Grid or Table interfaces and so is opaque to automation. In order to get the element associated with the specific TAutomationStringGrid, then this is done in the following manner.
1314

Diff for: docs/hyperlink.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
14
```
25
AutomationHyperlink link = window.getHyperlink(0);
36
link.click();

Diff for: docs/maskedit.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
14
The [DelphiUIAutomation](https://github.com/markhumphreysjhc/DelphiUIAutomation) project introduced some Delphi controls that implement IUIAutomation providers, allowing them to be accessed by automation. The Delphi implementation of a masked edit is another of these.
25

36
There does not seem to be an equivalent WPF control.

Diff for: docs/panel.md

+3-10
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,4 @@
1-
Panels (or Panes) are generic containers for other controls.
2-
3-
They can be found using an index, or by the name, as shown in this example.
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
43

5-
```
6-
AutomationPanel pane = window.getPanel("Document1");
7-
logger.info(pane.name());
8-
logger.info(pane.getClassName());
9-
AutomationPanel pane1 = pane.getPanel(0);
10-
logger.info(pane1.name());
11-
```
4+
Panels (or Panes) are generic containers for other controls.

Diff for: docs/progressbar.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
14
```
25
AutomationProgressBar progress = applicationWindow.getProgressBar(0);
36
logger.info("Progress = " + progress.getRangeValue());

Diff for: docs/radiobutton.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
14
```
25
AutomationRadioButton radio = window.getRadioButton(1);
36
radio.selectItem();

Diff for: docs/ribbon.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
14
The ribbon control is a complex structure, but the tree of controls is navigable, as the snippet below shows (automating the Windows Explorer), finding the button associated with the Preview Pane and clicking on it to turn it on/off.
25

36
```

Diff for: docs/slider.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
14
```
25
AutomationSlider slider = applicationWindow.getSlider(0);
36
logger.info("Slider value = " + slider.getRangeValue());

Diff for: docs/splitbutton.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
14
```
25
AutomationSplitButton split = panes.getSplitButton("Navigation pane");
36
split.click();

Diff for: docs/statusbar.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
4+
# Example
5+
16
```
27
AutomationStatusBar statusBar = window.getStatusBar();
38
AutomationTextBox tb1 = statusBar.getTextBox(1);

Diff for: docs/tab.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
4+
# Example
5+
16
```
27
AutomationTab tab = applicationWindow.getTab(0);
38
tab.selectTabPage("Details");

Diff for: docs/textbox.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1-
#Discovery
1+
# Discovery
22
* See [Element Discovery](element-discovery.md)
3+
4+
# Example

Diff for: docs/toolbar.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
4+
# Example
5+
16
```
27
AutomationToolBar toolbar = applicationWindow.getToolBar(0);
38
logger.info("Toolbar name is " + toolbar.name()); // Blank in default WPF

Diff for: docs/treeview.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# Discovery
2+
* See [Element Discovery](element-discovery.md)
3+
4+
# Example
15
```
26
AutomationTreeView tree = window.getTreeView(0);
37

Diff for: docs/treewalker.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
1-
This uses the ContentViewWalker to get elements marked as being content elements.
2-
3-
## See also
4-
* [Automation Spy Blog entry](http://www.automationspy.com/post-25_12_2014.html)
1+
This uses the ContentViewWalker to get elements marked as being content elements.

0 commit comments

Comments
 (0)