Skip to content

Elements list is now available in Microsoft Word straight away without having to enable browse mode first - #12051

Merged
michaelDCurran merged 1 commit into
masterfrom
i12050
Mar 3, 2021
Merged

Elements list is now available in Microsoft Word straight away without having to enable browse mode first#12051
michaelDCurran merged 1 commit into
masterfrom
i12050

Conversation

@michaelDCurran

@michaelDCurran michaelDCurran commented Feb 9, 2021

Copy link
Copy Markdown
Member

Link to issue number:

Fixes #12050

Summary of the issue:

Documentation for NVDA stated that Elements list (NVDA+f7) was available in focus mode. Although this wa strue for web documents and Excel, it was missed for Microsoft Word.

Description of how this pull request fixes the issue:

A treeInterceptor is now created for Microsoft Word documents (both with UIA enabled or disabled) but the treeInteceptor is defauled to focus mode. Thus Elements list is available straight away. This is the exact same approach as taken by the treeInterceptor for Microsoft Excel.

Testing strategy:

Manual testing done:

  • Ensured UIA in Microsoft Word document controls was disabled in NVDA's davanced settings.
  • Opened Microsoft Word.
  • Typed a line of text and formatted it as a heading with shift+alt+rightArrow
  • Pressed NVDA+f7 to bring up the Elements list.
  • Restarted NvDA.
  • Enabled UIA in Microsoft Word document controls in NVDA's advanced settings.
  • Typed a line of text and formatted it as a heading with shift+alt+rightArrow
  • Pressed NVDA+f7 to bring up the Elements list.

In theory a system test could be created for this, however this would require appveyor vms including Microsoft Word, which is something we would need to look into in the future.
I don't believe unit tests really apply to this kind of infrastructure change.

Known issues with pull request:

This change means that a treeInterceptor is now always created for Word documents. Although Word document treeInterceptors are not in any way heavy (they don't cache much at all) it is still a change which could affect the lifetime of treeInterceptors or other objects in NVDA.
I think this is very low risk, but either this needs to be tested on another rc for a while by heavy users of Microsoft Word, or we hold off until 2021.1 and make an edit to the 2020.4 documentation excluding Microsoft Word.

Change log entry:

None needed.

Code Review Checklist:

This checklist is a reminder of things commonly forgotten in a new PR.
Please do a self-review to check these items.
Reviewers will not approve the PR until these are met.

  • Pull Request description is up to date.
  • Unit tests.
  • System (end to end) tests.
  • Manual tests.
  • User Documentation.
  • Change log entry.
  • Context sensitive help for GUI changes.

@AppVeyorBot

This comment has been minimized.

@AppVeyorBot

This comment has been minimized.

@CyrilleB79

This comment has been minimized.

@michaelDCurran

This comment has been minimized.

@feerrenrut

This comment has been minimized.

@LeonarddeR

Copy link
Copy Markdown
Collaborator

Have you tested this with the "Enable browse mode on page load" browse mode setting disabled? It should work fine, but just in case it doesn't...

… a treeInterceptor created straight way, but with passThrough (focus mode) enabled. Thus, NVDA+f7 (elements list) is now available with out having to switch to browse mode in Microsoft Word first.
@michaelDCurran
michaelDCurran changed the base branch from beta to master February 10, 2021 21:03
@michaelDCurran

Copy link
Copy Markdown
Member Author

NV Access has decided that this is too large of a change so close to a release. Thus it has now been rebased on master for NVDA 2021.1.
The work-around in Microsoft Word is simply to press NVDA+space twice to force browse mode and go back to focus mode, then elements list will be available in focus mode.

@michaelDCurran michaelDCurran added this to the 2021.1 milestone Feb 10, 2021

@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 to me.

@michaelDCurran
michaelDCurran merged commit db664be into master Mar 3, 2021
@michaelDCurran
michaelDCurran deleted the i12050 branch March 3, 2021 07:10
michaelDCurran added a commit that referenced this pull request May 5, 2021
… now get a treeInterceptor created straight way, but with passThrough (focus mode) enabled. Thus, NVDA+f7 (elements list) is now available with out having to switch to browse mode in Microsoft Word first. (#12051)"

This reverts commit db664be.
michaelDCurran added a commit that referenced this pull request May 5, 2021
… now get a treeInterceptor created straight way, but with passThrough (focus mode) enabled. Thus, NVDA+f7 (elements list) is now available with out having to switch to browse mode in Microsoft Word first. (#12051)" (#12365)

This reverts pr #12051 commit db664be.

Fixes #12117

Summary of the issue:
In both Outlook and Windows 10 Mail, a Microsoft Word document control is used to display content of received emails and emails currently being composed. In NVDA 2020.4, NVDA would use browse mode for reading emails, but not for writing emails.
However, after merging of pr #12051 browse mode is no longer used by default when reading emails. This is because the base Microsoft Word document NVDAObject now creates a TreeInterceptor all the time, but set to focus mode, so that elements list is always available in Microsoft Word.
But as hxMail and Outlook implementations assumed browse mode would be available for the TreeInterceptor always, and only created the TreeInterceptor in the reading pane, Windows 10 mail and Outlook ended up getting no treeInterceptor for writing email (ok) but for reading email it got a treeInterceptor but set to focus mode (not okay).

Description of how this pull request fixes the issue:
Reverts pr #12051 .
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.

NVDA+f7 does not bring up elements list in Word initially (2020.4rc1)

5 participants