Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature Request: Automation Properties #2099

Closed
2 of 5 tasks
carlos-zamora opened this issue Jul 25, 2019 · 1 comment · Fixed by #4805
Closed
2 of 5 tasks

Feature Request: Automation Properties #2099

carlos-zamora opened this issue Jul 25, 2019 · 1 comment · Fixed by #4805
Assignees
@carlos-zamora
Labels
Area-Accessibility Issues related to accessibility Issue-Task It's a feature request, but it doesn't really need a major design. Priority-0 Bugs that we consider release-blocking/recall-class (P0) Product-Terminal The new Windows Terminal. Resolution-Fix-Committed Fix is checked in, but it might be 3-4 weeks until a release.
Milestone
Terminal v1.0

Comments

@carlos-zamora
Copy link
Member

carlos-zamora commented Jul 25, 2019 •
edited
Loading

Summary of the new feature/enhancement

Our automation peer (TermControlAutomationPeer) should provide appropriate default values for TermControl's accessibility related information (AutomationProperties).

Our xaml elements could probably use this too. This way, we'll know what we're interacting with when traversing the UIA tree.

Edit: Here's a list to track progress for which UIElements have the proper automation properties:

  • TerminalControl
  • Search Control
  • TSF Input Control
  • Tabs
  • MinMaxCloseControl

Some of this work may overlap with #2102, because we don't need proper labels for things that don't need to appear in the tree.
@carlos-zamora carlos-zamora added Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. Area-Accessibility Issues related to accessibility Product-Terminal The new Windows Terminal. labels Jul 25, 2019
@ghost ghost added the Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting label Jul 25, 2019
@carlos-zamora carlos-zamora self-assigned this Jul 25, 2019
@carlos-zamora carlos-zamora removed the Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting label Jul 25, 2019
@carlos-zamora carlos-zamora mentioned this issue Jul 29, 2019
Closed
@carlos-zamora carlos-zamora added this to the August Releases milestone Jul 31, 2019
@cinnamon-msft cinnamon-msft added the Priority-0 Bugs that we consider release-blocking/recall-class (P0) label Jan 23, 2020
@DHowett-MSFT DHowett-MSFT added Issue-Task It's a feature request, but it doesn't really need a major design. and removed Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. labels Jan 23, 2020
@cinnamon-msft cinnamon-msft added the Help Wanted We encourage anyone to jump in on these. label Jan 23, 2020
@DHowett-MSFT
Copy link
Contributor

@carlos-zamora you have the talking stick for this issue. Unassign when you're done.

@carlos-zamora carlos-zamora mentioned this issue Feb 11, 2020
Closed
22 tasks
@carlos-zamora carlos-zamora removed the Help Wanted We encourage anyone to jump in on these. label Feb 21, 2020
@carlos-zamora carlos-zamora mentioned this issue Feb 26, 2020
Merged
1 task
DHowett-MSFT pushed a commit that referenced this issue Feb 28, 2020
@carlos-zamora
Define Automation Properties for TermControl (#4732)
74cd9db 
Defines the following automation properties for a Terminal Control:
- [**Orientation**](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.automation.peers.automationpeer.getorientationcore):
  - The orientation of the control
  - None --> Vertical
- [**Name**](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.automation.peers.automationpeer.getnamecore):
  - The name as used by assistive technology and other Microsoft UI
    Automation clients. Generally presented by automation clients as the
    primary way to identify an element (along with the control type)
  - "" --> <profile name>
- [**HelpText**](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.automation.peers.automationpeer.gethelptextcore):
  - The help text. Generally presented by automation clients if
    requested by the user. This would be something that you would normally
    expect to appear from tooltips.
  - "" --> <tab title>
- [**LiveSetting**](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.automation.peers.automationpeer.getlivesettingcore):
  - reports the live setting notification behavior. A representation of
    how assertive this control should be when content changes.
  - none --> Polite

## Detailed Description of the Pull Request / Additional comments
ProfileName had to be added to the TerminalSettings (IControlSettings)
to pass that information along to the automation peer. In the rare event
that somebody purposefully decided to make their ProfileName empty, we
fallback to the tab title.


## Validation Steps Performed
Verified using Accessibility Insights and inspect.exe

This is are some examples of the information a general user can expect
to receive about a Terminal Control.

- Type: Terminal Control
- Name: Command Prompt
- Help Text (if requested): Command Prompt - ping bing.com

- Type: Terminal Control
- Name: Ubuntu
- Help Text (if requested): cazamor@PC-cazamor:/mnt/c/Users/cazamor$

Note, it is generally read by an automation client as follows:
"<type>, <name>"

References #2099 - Automation Properties for TerminalControl, Search Box
References #2142 - Localization

Closes #2142
This was referenced Mar 4, 2020
Closed
Merged
@ghost ghost added the In-PR This issue has a related PR label Mar 4, 2020
@ghost ghost closed this as completed in #4805 Mar 5, 2020
ghost pushed a commit that referenced this issue Mar 5, 2020
Polish AutomationProperties and UIA Tree Navigation (#4805)
27342db 
AutomationProperties of interest in this PR include...
- Name: the name of a UI element (generally used as the main identifier
  for it)
- HelpText: an additional description for a more complex UI element
- AccessibilityView[1]
  - Raw: hide from the UIA tree. Only navigate to this if you know what
    you're doing
  - Control: a control without any content in it. Basically, a point at
    which the user can make a decision as to how to navigate the tree or
    invoke an action.
  - Content: a control that also has content to present to the user.

I set a few more AutomationProperties throughout Windows Terminal...
- MinMaxClose Control: hidden (we can/should rely on the true buttons
  that we are hiding)
- SplitButton: Name and Help text (currently ignored due to #4804, but
  having it in the resource file won't cause any problems)
- SearchBox: added a more specific name to the close button
- BackgroundImage: hide it

## References
A few additional work items have been created for tracking...
- SplitButton: #4804

## PR Checklist
* [X] Closes #2099 
* [X] Closes #2102 

## Validation Steps Performed
Verified using Accessibility Insights and Inspect.exe

[1] https://docs.microsoft.com/en-us/windows/win32/winauto/uiauto-treeoverview
@ghost ghost added Resolution-Fix-Committed Fix is checked in, but it might be 3-4 weeks until a release. and removed In-PR This issue has a related PR labels Mar 5, 2020
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@carlos-zamora carlos-zamora

Labels
Area-Accessibility Issues related to accessibility Issue-Task It's a feature request, but it doesn't really need a major design. Priority-0 Bugs that we consider release-blocking/recall-class (P0) Product-Terminal The new Windows Terminal. Resolution-Fix-Committed Fix is checked in, but it might be 3-4 weeks until a release.
Projects
None yet
Milestone
Terminal v1.0
Development

Successfully merging a pull request may close this issue.

Polish AutomationProperties and UIA Tree Navigation microsoft/terminal
3 participants
@carlos-zamora @DHowett-MSFT @cinnamon-msft