Word 365: do not announce font attribute toggle messages if raised from UIA notification event by josephsl · Pull Request #10990 · nvaccess/nvda

josephsl · 2020-04-13T01:37:22Z

Link to issue number:

Summary of the issue:

In recent Word 365 releases, NVDA will announce font attribute toggle message up to two times - a message defined by NVDA ,and a second time thanks to UIA notification event.

Description of how this pull request fixes the issue:

Builds on an earlier work on Word 365 UIA notification event suppression (#10851):

Adds a dedicated list in UIA.WordDocument class listing activity ID's NVDA should ignore.
Adds AccSN1, the activity Id for font attribute toggle messages.

Testing performed:

Tested to make sure font attribute toggle messages are announced only once with Word 365, and verified that there was no regression with previous work on Word 365 fix.

Known issues with pull request:

None

Change log entry:

Nothing to add, but if a what's new entry should be provided, a wording similar to #10851 is ideal, this time talking about font attribute toggle commands such as toggling bold.

Thanks.

Summary by CodeRabbit

Bug Fixes
- Improved handling of Word 365 notifications to prevent unnecessary announcements for specific edit functions, enhancing the user experience by reducing noise.

…tions that should be silenced under a dedicated list. Re nvaccess#10950. To prepare for cases where additional UIA notification activity Id's must be silenced, collect them under a dedicated list. In addition to AccSN2 (delete back word), add AccSN1 (font attributes toggle).

…eed if activity ID's are listed under no activity ID's list. Re nvaccess#10950.

…ss#10950. Comment from Reef Turner (NV Access): rename noNotificationActivityIds to suppressedActivityIds which makes more sense and is more concise.

michaelDCurran · 2020-04-15T09:45:55Z

These notifications are needed in Windows 10 Mail and other future scenarios where the Office object model is unavailable. We should somehow still allow the notifications in these situations.
The WinwordSelectionObject property on the NVDAObject for the document will be None in these scenarios.

josephsl · 2020-04-15T10:00:07Z

Hi, true. I think in the long term, we will need to think about what to do with font attribute toggle announcements for object model based implementation. This also means discussing translations with Microsoft. Thanks.

josephsl · 2020-04-16T02:01:16Z

Hi,

Regarding Windows 10 Mail, when trying to change font attributes, NVDA does not announce changes - no UIA notification event at all, I'm afraid. Things cna change though.

Thanks.

feerrenrut · 2020-04-16T16:57:19Z

Could this problem (differences in desired UIA notifications between mail and word) be addressed by fetching the list of ignored UIA notifications from the appmodule?

josephsl · 2020-04-16T17:19:51Z

Hi,

Possibly yes, but there are cases where it might not be the case:

UIA objects may span across apps: different apps may use the same UIA object, especially if it is provided by XAML and other frameworks. If these elements raise UIA notification event, locating apps where this happens might become a challenge.
Other ways to determine notification announcements: Word 365 comes with WinwordSelectionObject and does raise UIA notification event, whereas Windows 10 Mail does not come with this object nor fires notification events.

In the short term, it will be possible to let app modules tell NVDA whether or not UIA notification event should be passed onto UIA objects (app modules handle events before NVDA objects do). If it is implemented (I'm willing to do so once new feature PR freeze ends), it will lay the foundation to resolve Windows 10 Calculator bug (even then, Calculator app module must inform NVDA as to when to suppress UIA notification events). In the long term, app vendors should be reminded that UIA notification events are meant for essential information - Edge and Alarms and Clock apps are examples of good use of notification event.

Thanks for bringing this up.

josephsl · 2021-04-05T13:03:59Z

Hi,

2021 update: upon further testing, it appears a different approach is needed - a UIA notification event handler for Word app module, made more easier as there is already a proof of concept with a different app module (see Windows 10 App Essentials add-on). I'll rework this PR and perhaps target this for 2021.2 or later.

Thanks.

josephsl · 2021-04-05T13:05:30Z

Hi,

By the way, the rework plan also calls for transferring UIA notification event handler from Word document UIA object to Word app module unless UIA notification event is raised when changing fonts in other Office 365 applications.

Thanks.

feerrenrut · 2021-04-07T06:02:10Z

I'm going to mark this as a draft while work is on going.

josephsl · 2021-04-07T06:07:59Z

Hi, thanks – probably won’t work on this until 2021.2 cycle is under way.

josephsl · 2021-05-10T15:08:39Z

Hi,
Although I couldn't generate a debug log, it turns out UIA notification event can be seen in Outlook, therefore it justifies WordDocument object scope for dealing with UIA notification event.

Reopening the PR for review (targeting 2021.2).

seanbudd · 2021-05-21T02:19:53Z

These notifications are needed in Windows 10 Mail and other future scenarios where the Office object model is unavailable. We should somehow still allow the notifications in these situations.
The WinwordSelectionObject property on the NVDAObject for the document will be None in these scenarios.

I'm hesitant to review this as I'm not confident this comment has been addressed. Is Windows 10 mail (and other scenarios Mick mentioned here that could arise) reporting this properly? Could we add system tests for Windows 10 mail?

josephsl · 2021-05-21T02:27:14Z

Hi, it will depend on what activity Id will be used by Windows 10 Mail for notifications like this. Also, you need to create an email account in order to test things with Mail, and it might not be available on the VM AppVeyor is using because Mail is a universal (modern) app with changes at least once a year (making the UI and UX a bit unpredictable; you can assume that smoke tests involving universal apps such as Windows 10 Mail app are a no go if AppVeyor VM uses Windows Server LTSC (2019 is the latest one at the moment) which do not come with Mail and other apps). Thanks.

seanbudd · 2021-06-07T02:04:14Z

@michaelDCurran - requesting your review here as per your previous comment, as we are unsure what the future impacts of merging this fix would be.

These notifications are needed in Windows 10 Mail and other future scenarios where the Office object model is unavailable. We should somehow still allow the notifications in these situations.
The WinwordSelectionObject property on the NVDAObject for the document will be None in these scenarios.

I'm hesitant to review this as I'm not confident this comment has been addressed. Is Windows 10 mail (and other scenarios Mick mentioned here that could arise) reporting this properly?

josephsl · 2021-06-07T02:10:38Z

Hi, not that I know of. Like any universal app, Windows 10 Mail can change without notice (we had a debacle last year where Microsoft released a combined Mail and Calendar app with a different executable name, only to pull the experiment a few months later and the apps were separated again). As for UIA notification event, the most important thing is the activity Id, and the pull request I submitted would apply if Windows 10 Mail (current or future) raises UIA notification event with the same activity Id described. Thanks.

josephsl · 2024-05-29T00:12:23Z

Hi, I don’t have access to MDAG+Word 365 combination at all (wish I did). Thanks.

seanbudd · 2024-05-30T02:44:22Z

I think this PR needs wider testing then. Can anyone test these scenarios and report back?

@coderabbitai can you summarise the discussion on this PR?

coderabbitai · 2024-05-30T02:45:04Z

Tip

For best results, initiate chat on the files or code changes.

@seanbudd, here's a summary of the discussion on this PR:

Overview

The PR aims to address the issue of duplicate announcements of font attribute toggles in Word 365 by suppressing certain UIA notifications. This builds on previous work to manage UIA notifications more effectively in NVDA.

Key Discussion Points

UIA Notifications in Word:
- The PR initially focuses on preventing double announcements in Word by ignoring specific UIA notifications identified by their activity IDs.
- Concerns were raised about how these changes might affect other applications like Windows 10 Mail, especially in scenarios where the Office object model is unavailable.
Compatibility Across Office Versions:
- Participants discussed the behavior of UIA notifications in different versions of Office, noting that only certain commands (like Ctrl+B/I/U) trigger UIA notifications in newer versions.
- There were reports of inconsistent behavior depending on the cursor's position and the state of formatting commands, which led to discussions about the reliability of UIA notifications.
Impact on Other Applications:
- The discussion highlighted the need for a flexible approach that could adapt to different applications and environments. The idea of fetching ignored UIA notifications from the app module was proposed but noted to have potential limitations due to shared UIA objects across applications.
Proposed Solutions and Technical Challenges:
- Suggestions included moving the UIA notification handler from the Word document UIA object to the Word app module and creating configurable options for managing UIA notifications.
- The technical feasibility and long-term maintenance of these solutions were debated, with insights into the complexity of implementing such changes.
Testing and Future Considerations:
- The need for extensive testing was emphasized, particularly in environments like Microsoft Defender Application Guard (MDAG) and across different Office versions.
- Future updates from Microsoft and the evolution of Office applications like Project Monarch were mentioned as factors that could influence the handling of UIA notifications.

Conclusion

The discussion reflects a complex interplay of technical challenges, application behaviors, and user experience considerations. The community is leaning towards a cautious approach, favoring thorough testing and configurable solutions to accommodate the diverse needs of NVDA users across different Microsoft Office environments.

Please let me know if there are specific aspects of the discussion you would like to delve deeper into or if further clarification is needed on any points.

Adriani90 · 2024-05-30T21:39:47Z

I cannot reproduce these mistranslated examples reported in #10950 with NVDA last alpha and Microsoft 365 MSO (Version 2405 Build 16.0.17628.20006) 64 Bit in german or romanian language.
But those messages are probably properly translated by Microsoft in these languages. It seems only spanish was impacted in that issue.

@ivnc, @nvdaes could you test whether the issue with double reportings is still occuring for you in the wrong translation?
If the translation is now correct, I think this PR is not really needed anymore.
The message provided by NVDA is interupted by the UIA notification, but it is really hard to distinduish that there are two messages spoken actually unless you look into the log file.
I think instead of dropping the whole UIA notifications, it might be better to contact Microsoft and suggest to them to translate the UIA messages in your Office language properly.

nvdaes · 2024-05-31T05:14:24Z

Now I can listen right translated messages, but I distinguish that the start of the message is briefly interrupted, repeating the first character. I've tested control+n (bold/negrita), control+s (underline/subrayado), and control+k (italic/cursiva), in Word 365, Windows 11.

Adriani90 · 2024-05-31T05:53:19Z

In this case it might be better to rather stick to the UIA notifications and make NVDA supress its own messages in these cases for Office 365 in case the current behavior is disturbing.Von meinem iPhone gesendetAm 31.05.2024 um 07:14 schrieb Noelia Ruiz Martínez ***@***.***>: Now I can listen right translated messages, but I distinguish that the start of the message is briefly interrupted, repeating the first character. I've tested control+n (bold/negrita), control+s (underline/subrayado), and control+k (italic/cursiva), in Word 365, Windows 11. —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you commented.Message ID: ***@***.***>

josephsl · 2024-05-31T12:22:34Z

Hi, for consumers, that solution might work since people might be using newer Microsoft 365 releases. However, don’t forget about our recent discussion of corporate mode where we discussed tendency for enterprises to use older software releases – some of them using older Word versions without UIA notification event handler included. Thanks.

Adriani90 · 2024-05-31T13:26:27Z

Is it possible to supress NVVDA messages for MS Office 365 only?Von meinem iPhone gesendetAm 31.05.2024 um 15:22 schrieb Joseph Lee ***@***.***>: Hi, for consumers, that solution might work since people might be using newer Microsoft 365 releases. However, don’t forget about our recent discussion of corporate mode where we discussed tendency for enterprises to use older software releases – some of them using older Word versions without UIA notification event handler included. Thanks. —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you commented.Message ID: ***@***.***>

CyrilleB79 · 2024-05-31T14:48:27Z

@Adriani90 the situation is more complex. The decision to use object model or UIA notifications should be base on various parameters: Office version (2013 / 2016 / 365, etc.), Office build version, software used (Word or Outlook), Windows version (8.1 or 10/11) and running in MDAG or not.

You need to read all the comments for more context; be careful: given the high number of comments, some of them are hidden so you'll have to display them.

Adriani90 · 2024-05-31T14:59:31Z

In my case I tested with objectModel and still the UIA notifications are translated properly. MDAG I will test as well soon, but you can be sure that in 365 the UIA notifications are fired properly with objectModel and also when UIA is enabled. You can test yourself.In Office 2016, the NVDA messages should definitely remain.Von meinem iPhone gesendetAm 31.05.2024 um 17:48 schrieb Cyrille Bougot ***@***.***>: @Adriani90 the situation is more complex. The decision to use object model or UIA notifications should be base on various parameters: Office version (2013 / 2016 / 365, etc.), Office build version, software used (Word or Outlook), Windows version (8.1 or 10/11) and running in MDAG or not. You need to read all the comments for more context; be careful: given the high number of comments, some of them are hidden so you'll have to display them. —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***>

CyrilleB79 · 2024-05-31T21:30:24Z

In my case I tested with objectModel and still the UIA notifications are translated properly. MDAG I will test as well soon, but you can be sure that in 365 the UIA notifications are fired properly with objectModel and also when UIA is enabled. You can test yourself.In Office 2016, the NVDA messages should definitely remain.

@Adriani90 to be clear and avoid any confusion, UIA vs object model notifications upon formatting command are by no mean controlled by the option "Use UI Automation to access Microsoft Word document controls" in advanced settings.

coderabbitai · 2024-06-27T23:01:20Z

Walkthrough

The recent update to the WordDocument class in wordDocument.py introduces a check within the event_UIA_notification method. This check prevents NVDA from announcing specific Microsoft Word edit functions by verifying if the activityId is among the predefined suppressedActivityIds. These modifications address redundant notifications for font attribute changes observed in the latest Word 365 releases.

Changes

File	Change Summary
source/NVDAObjects/UIA/wordDocument.py	Updated `event_UIA_notification` method logic to include a check for `activityId` in `suppressedActivityIds` to suppress announcements for specific edit functions. Added the `suppressedActivityIds` list to the `WordDocument` class.

Sequence Diagram(s)

The changes provided are mainly refinements to existing functionality, focusing on filtering out specific notifications. Therefore, a sequence diagram is not necessary for this explanation.

Assessment against linked issues

Objective	Addressed	Explanation
Prevent NVDA from announcing duplicate notifications for font attribute changes in Word 365 (#10950)	✅
Ensure the notifications are suppressed for specific recent Word 365 releases' edits (#10950)	✅

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 23cb96b and 8f73f22.

Files selected for processing (1)

source/NVDAObjects/UIA/wordDocument.py (1 hunks)

Additional context used

Path-based instructions (1)

source/NVDAObjects/UIA/wordDocument.py (2)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious.

Pattern **/*.py: _, pgettext, ngettext, and ngettext are defined globally, errors for this being undefined can be ignored.

Additional comments not posted (1)

source/NVDAObjects/UIA/wordDocument.py (1)
565-568: Clarify the purpose of suppressedActivityIds entries.

The list suppressedActivityIds is correctly initialized with activity IDs that should be suppressed. However, the comments could be more descriptive to explain why these IDs are chosen without needing to refer to the issue tracker.
-		"AccSN1",  # #10950: font attributes
+		"AccSN1",  # Suppress duplicate announcements for font attribute changes
-		"AccSN2",  # #10851: delete activity ID
+		"AccSN2",  # Suppress duplicate announcements for delete actions

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

seanbudd · 2024-09-02T00:06:36Z

We're considering trialling this PR for wider testing by merging early in an alpha cycle. Any thoughts @josephsl ?

josephsl · 2024-09-02T00:14:09Z

Hi, let’s get the show going – feel free to merge it whenever you are ready (while I may not respond to all issues arising from it, I’ll keep an eye on it from time to time; do ping me if I do need to resolve some things). Thanks.

josephsl added 2 commits April 12, 2020 18:28

NVDAObjects/UIA/word document: do not let UIA notification event proc…

ce3e1df

…eed if activity ID's are listed under no activity ID's list. Re nvaccess#10950.

feerrenrut added app/microsoft-office bug bug/double-speaking labels Apr 14, 2020

feerrenrut reviewed Apr 14, 2020

View reviewed changes

Comment thread source/NVDAObjects/UIA/wordDocument.py Outdated

NVDAObjects/UIA/wordDocument: noNotification -> suppressed. Re nvacce…

02cbf87

…ss#10950. Comment from Reef Turner (NV Access): rename noNotificationActivityIds to suppressedActivityIds which makes more sense and is more concise.

dpy013 mentioned this pull request Apr 23, 2020

Touch interaction: allow users to disable touch support completely #10557

Merged

josephsl added 2 commits March 15, 2021 11:12

Merge branch 'master' into i10950

08cea48

Merge branch 'master' into i10950

af00499

feerrenrut marked this pull request as draft April 7, 2021 06:02

Merge branch 'master' into i10950

dddb61e

josephsl marked this pull request as ready for review May 10, 2021 15:08

josephsl requested a review from a team as a code owner May 10, 2021 15:08

josephsl requested a review from seanbudd May 10, 2021 15:08

seanbudd requested a review from michaelDCurran June 7, 2021 02:01

seanbudd added the blocked/needs-testing label May 30, 2024

seanbudd added the blocked label Jun 7, 2024

josephsl added 2 commits June 27, 2024 16:52

Merge commit '9ea256659' into i10950

f5c5b22

renormalize files

62318ba

josephsl requested a review from a team as a code owner June 27, 2024 23:01

josephsl requested a review from Qchristensen June 27, 2024 23:01

Merge branch 'master' into i10950

8f73f22

coderabbitai Bot reviewed Jun 27, 2024

View reviewed changes

Comment thread source/NVDAObjects/UIA/wordDocument.py

seanbudd added merge-early Merge Early in a developer cycle and removed blocked labels Sep 2, 2024

seanbudd closed this Sep 2, 2024

seanbudd reopened this Sep 2, 2024

seanbudd merged commit ec3d033 into nvaccess:master Sep 2, 2024

github-actions Bot added this to the 2025.1 milestone Sep 2, 2024

CyrilleB79 mentioned this pull request Sep 20, 2024

Speech feedback on more Word formatting shortcuts #17197

Merged

5 tasks

josephsl deleted the i10950 branch November 4, 2024 12:51

Uh oh!

Conversation

josephsl commented Apr 13, 2020 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of how this pull request fixes the issue:

Testing performed:

Known issues with pull request:

Change log entry:

Summary by CodeRabbit

Uh oh!

Uh oh!

michaelDCurran commented Apr 15, 2020

Uh oh!

josephsl commented Apr 15, 2020 via email • edited by feerrenrut Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

josephsl commented Apr 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

feerrenrut commented Apr 16, 2020

Uh oh!

josephsl commented Apr 16, 2020

Uh oh!

josephsl commented Apr 5, 2021

Uh oh!

josephsl commented Apr 5, 2021

Uh oh!

feerrenrut commented Apr 7, 2021

Uh oh!

josephsl commented Apr 7, 2021 via email

Uh oh!

josephsl commented May 10, 2021

Uh oh!

seanbudd commented May 21, 2021

Uh oh!

josephsl commented May 21, 2021 via email

Uh oh!

seanbudd commented Jun 7, 2021

Uh oh!

josephsl commented Jun 7, 2021 via email

Uh oh!

josephsl commented May 29, 2024 via email

Uh oh!

seanbudd commented May 30, 2024

Uh oh!

coderabbitai Bot commented May 30, 2024

Overview

Key Discussion Points

Conclusion

Uh oh!

Adriani90 commented May 30, 2024

Uh oh!

nvdaes commented May 31, 2024

Uh oh!

Adriani90 commented May 31, 2024 via email

Uh oh!

josephsl commented May 31, 2024 via email

Uh oh!

Adriani90 commented May 31, 2024 via email

Uh oh!

CyrilleB79 commented May 31, 2024

Uh oh!

Adriani90 commented May 31, 2024 via email

Uh oh!

CyrilleB79 commented May 31, 2024

Uh oh!

coderabbitai Bot commented Jun 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

josephsl commented Apr 13, 2020 •

edited by coderabbitai Bot

Loading

josephsl commented Apr 15, 2020 via email •

edited by feerrenrut

Loading

josephsl commented Apr 16, 2020 •

edited

Loading

coderabbitai Bot commented Jun 27, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)