Navigation Menu

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.

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

Use WordDocument of Winword appModule both with IAccessible and UIA. #12904

merged 4 commits into from Oct 5, 2021


Copy link

@CyrilleB79 CyrilleB79 commented Oct 4, 2021

Link to issue number:


Fix-up of #11824.

Summary of the issue:

The class appModules.winword.WinwordWordDocument is used only in Word if using IAccessible, whereas it should be used with both IAccessible and UIA. This leads to the following consequences when using UIA for Word:

  • Toggle change tracking script (ctrl+shift+E) is not vocalized in Word when NVDA uses UIA to access information; this script works only if NVDA uses IAccessible for Word.
  • The class appModules.winword.WinwordWordDocument is used in some gestures.ini files (fr, it, pt_PT) to localize scripts corresponding to shortcuts that operate only in Word, not in Outlook; e.g. ctrl+R that performs left paragraph indent in French Word instead of left paragraph alignment in French Outlook.

Description of how this pull request fixes the issue:

Use the class appModules.winword.WinwordWordDocument with both IAccessible and UIA.

Testing strategy:

Perform the following two tests with the following versions of Word 2016:

  • newer Word 2016 using UIA: version '16.0.14430.20234'
  • older Word 2016 using IAccessible: version '16.0.5188.1000'

Test 1:
Test that the toggle change tracking is reported when pressing the corresponding shortcut (specifically ctrl+shift+R on my French Office version).
Note: for anyone wanting to test on English Office and NVDA, the shortcut is ctrl+shift+E.

Test 2:
On French Word and French NVDA, test that the script increasing left paragraph indent reports the new indentation when the corresponding shortcut is pressed.
Note: Cannot be tested on English versions of Word and NVDA. Similar tests can be done however for Italian and Portuguese (pt_PT).

Known issues with pull request:


Change log entries:

Bug fixes

When accessing MS Word with UIA, , change tracking command and some other localized commands are now reported in Word . (#12904)

Code Review Checklist:

  • Pull Request description:
    • description is up to date
    • change log entries
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • API is compatible with existing add-ons.
  • Documentation:
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English

Copy link

This pr now builds. Any remaining reason why this is a draft?

@CyrilleB79 CyrilleB79 marked this pull request as ready for review October 5, 2021 07:08
@CyrilleB79 CyrilleB79 requested a review from a team as a code owner October 5, 2021 07:08
Copy link
Collaborator Author

It was in draft since I still had to test on the older version of Word (IAccessible). It is now done and I have updated the initial description accordingly.
So this PR is ready.

@michaelDCurran michaelDCurran merged commit 5b63e3b into nvaccess:master Oct 5, 2021
@nvaccessAuto nvaccessAuto added this to the 2021.3 milestone Oct 5, 2021
@CyrilleB79 CyrilleB79 deleted the UIAWordAppModule branch October 5, 2021 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

None yet

4 participants