Skip to content

Revert UI a in ms word by default#12989

Merged
michaelDCurran merged 3 commits into
betafrom
revertUIAInMSWordByDefault
Oct 27, 2021
Merged

Revert UI a in ms word by default#12989
michaelDCurran merged 3 commits into
betafrom
revertUIAInMSWordByDefault

Conversation

@michaelDCurran

Copy link
Copy Markdown
Member

Link to issue number:

None.

Summary of the issue:

We have tried to switch to using UI automation to access MS Word documents by default in NVDA 2021.3. However, there are still several issues remaining with our UIA support. Switching to UIA by default should be held back until these are addressed.
Some of these include:

Over the last couple of months our UIA support has had a lot of fixes and improvements, mainly spured on by the apparent need to switch due to NVDA and MS Word not playing well together with the introduction of Modern Comments in MS Word build 13901. However, a work around has been found for #12982 now, making the swich less of a high priority.

Description of how this pull request fixes the issue:

Reverts #12859
Reverts #12854
Reverts #12770

Testing strategy:

With a build of MS Word 13901 or highera dn NVDA advanced setting: use UIA to access MS Word documents when available turned off, Open a Word document and ensure that UIA is not being used to access the document.
When the document is focused, the name of the focused object is "Microsoft Word document" and the role is "edit".

Known issues with pull request:

None known.

Change log entries:

New features
Changes
Bug fixes
For Developers

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

seanbudd
seanbudd previously approved these changes Oct 26, 2021
@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 4186c119e4

…build 16.0.13901 and above (#12770)"

This reverts commit e38b5b4.
@michaelDCurran

Copy link
Copy Markdown
Member Author

Note that this pr no longer removes the relevant line from changes.t2t - this will be done in a separate pr long with fixing the release blurb. This is so that a new revert commit for this pr can be applied onto master at a later date, reintroducing UIA by default in MS Word.

@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit a6f97c93f2

@feerrenrut feerrenrut left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

Checked the revert by looking at the diff for the _UIAHandler.py file between this commit (34f1dbb16) and the commit on master prior to the merge of the first PR to be reverted (Use UIA to access MS Word documents by default for MS Office build 160.13901 and above (#12770) which is MS Word with 2cc3aa4 UIA: ensure document is appropriately scrolled when programmatically setting the caret (#12851)

git diff 2cc3aa4..34f1dbb16 -- source/_UIAHandler.py

The only changes were introduced by:

  • UIA: use layout invalidated event to announce suggestion count across modern apps on Windows 10 and later (#12791)

@michaelDCurran michaelDCurran merged commit 2027702 into beta Oct 27, 2021
@michaelDCurran michaelDCurran deleted the revertUIAInMSWordByDefault branch October 27, 2021 02:03
michaelDCurran added a commit that referenced this pull request Oct 27, 2021
In pr #12989 NVDA no longer defaults to using UIA in MS Word build 13901 or higher.
This pr removes the relevant line from changes.t2t.
Note that the release blurb for 2021.3 did not explicitly mention this feature thus did not need to be updated.
michaelDCurran added a commit that referenced this pull request Mar 8, 2022
…#13437)

Microsoft Word 2016 exposes a rich UI Automation implementation. For some time now, users have been able to optionally turn this on with an advanced setting. NVDA's support for MS Word via UIA has major performance advantages over the older object model support, so NVDA should use the UIA support by default where available. However, as the UIA implementation improved throughout Office 2016's lifetime, we should only enable our support for recent builds of Office 2016, specifically for build 15000 and higher, and when only on Windows 11.
This was previously tried in pr #12770 but reverted in pr #12989
The main argument for reverting was the lack of math support, and ability to report line column and section numbers.
These have all been since addressed.

Description of how this pull request fixes the issue:
NVDA now uses UI Automation to access Microsoft Word document controls by default when on Windows 11, for Microsoft Word version 16.0.15000 and higher.
The Use UI Automation to access Microsoft Word document controls when available checkbox has been replaced with a combo box with the following values:
• Default (where suitable)
• Only where necessary: where the Microsoft Word object model is not available at all
• Where suitable: Windows 11 / Microsoft Word version 16.0.15000 or higher, or where the Microsoft Word object model is unavailable
• Always: where ever UI automation is available in Microsoft word (no matter how complete).
If the older checkbox was previously checked, the setting will be set to Always.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants