Skip to content

Commit

Permalink
Added documentation for all accessibility samples and removed samples…
Browse files Browse the repository at this point in the history
… targeting Windows Forms
  • Loading branch information
Harikm committed Aug 16, 2015
1 parent 339379f commit 7ee94f9
Show file tree
Hide file tree
Showing 40 changed files with 48 additions and 2,782 deletions.
8 changes: 5 additions & 3 deletions Accessibility/FetchTimer/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@

# %Sample% sample
# FetchTimer Sample

This sample shows how to use the %objective
This sample demonstrates some aspects of caching (prefetching) in Microsoft UI Automation and supplies comparative performance values.
After launching the sample, leave it in the foreground while moving the cursor over various elements on the desktop. Press Alt+G to retrieve the AutomationElement at the cursor. The sample performs three tests: fetching the element without caching, fetching it with caching, and updating the cache.
You can set the scope and caching mode of element retrieval by using the checkboxes.

## Remarks

The sample is designed to demonstrate the use of CacheRequest and related classes and methods, but does not necessarily reflect a real-world implementation of UI Automation caching as a whole.

## Build the sample

Expand Down
12 changes: 6 additions & 6 deletions Accessibility/FindText/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@

# %Sample% sample
# TextPattern Search and Selection Sample
This sample demonstrates the Microsoft UI Automation TextPattern and TextPatternRange classes.

This sample shows how to use the %objective
The sample consists of a WPF client and the choice of a FlowDocumentReader (Windows Presentation Foundation (WPF)) target or a WordPad (Win32) target. The client uses the TextPattern control pattern class and the TextPatternRange class to interact with the text controls in the target.

## Remarks
The functionality demonstrated by the sample includes the ability to search for and select a string of text within the target, manipulate the existing selections within the target by expanding or contracting them to a specific TextUnit, and navigate forward or backward within the text of the target.

## Remarks
Three WPF documents are provided in the Content folder of the TextProvider project.

## Build the sample

The easiest way to use these samples without using Git is to download the zip file containing the current version (using the link below or by clicking the "Download ZIP" button on the repo page). You can then unzip the entire archive and use the samples in [Visual Studio 2015](https://www.visualstudio.com/wpf-vs).

### Deploying the sample

- Select Build > Deploy Solution.

### Deploying and running the sample

- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging.

15 changes: 9 additions & 6 deletions Accessibility/FocusTracker/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@

# %Sample% sample
# TrackFocus Sample
This sample tracks the input focus on the desktop and displays information about focus changes, using Microsoft UI Automation. This is a simple console application that might be used as a starting-point for an application that uses UI Automation to track events on the desktop.
The program announces when the input focus changes. If the focus moves to a different application window, the caption of the window is announced. If the focus moves within an application window, the type and name of the control being read are announced.
To know when the focus switches from one application to another, the program keeps a list of the runtime identifiers of all open top-level windows. In response to each focus-changed event, a TreeWalker is used to find the parent window, and that window is compared with the last window that had focus.

This sample shows how to use the %objective
The program subscribes to three event types:

## Remarks
- Structure changed. The only event of interest is the addition of a new top-level window.
- Focus changed. All events are captured.
- Window closed. When a top-level window is closed, its runtime ID is removed from the list.

For simplicity, no caching is done. A full-scale application would likely cache all immediate children of an application window as soon as that window received focus.

## Build the sample

The easiest way to use these samples without using Git is to download the zip file containing the current version (using the link below or by clicking the "Download ZIP" button on the repo page). You can then unzip the entire archive and use the samples in [Visual Studio 2015](https://www.visualstudio.com/wpf-vs).

### Deploying the sample

- Select Build > Deploy Solution.

### Deploying and running the sample

- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging.

6 changes: 0 additions & 6 deletions Accessibility/FragmentProvider/App.config

This file was deleted.

11 changes: 0 additions & 11 deletions Accessibility/FragmentProvider/Availability.cs

This file was deleted.

Loading

0 comments on commit 7ee94f9

Please sign in to comment.