[Keyboard][Accessibility]: Fixing activation DataGridView cell tooltips with using a keyboard #1681

vladimir-krestov · 2019-08-23T10:28:08Z

Original bug:

Bug 528682: Accessibility: WinForm DataGridView's CellErrorTextNeeded tooltip data isn't accessible to customers only using the keyboard

Proposed changes

Implement IKeyboardToolTip interface for DataGridViewCell class to use the KeyboardToolTipStateMachine
Add ProcessControlShiftF10Keys method to have the ability to activate/deactivate a cell tooltip using hotkeys (Control+Shift+F10 like as WPF)
Add IsActivatedByKeyboard property which stores keyboard tooltip state
Add KeyboardToolTip property which stores keyboard tooltip info and settings

Propose to set for the keyboard tooltip InitialDelay and ReshowDelay equal to 0.5 seconds (see gif below).

~~Add public ShowCellKeyboardToolTips property to enable users to turn on/off keyboard tooltips display~~

~~ShowCellToolTips property turn on/off keyboard and mouse tooltips activation together~~

~~ShowCellKeyboardToolTips property turn on/off keyboard tooltips activation only (ShowCellToolTips property must be true)~~

Use ShowCellToolTips to enable users to turn on/off mouse and keyboard tooltips display
Add default tooltip text to resources for all cells (needs review translation)

Customer Impact

Now a user has a possibility to get DataGridView cell tooltip text or error text with using only a keyboard (Tab/arrow navigation, hotkeys)
Minor bugs of mouse and keyboard tooltip conflicts have little impact on users

Regression?

No

Risk

Adding public ShowCellKeyboardToolTips property is risky. In the future, it will be problematic to change the implementation of keyboard tooltip activation without affecting users who already use this property.
Instead, we can use ShowCellToolTips property, but it turns on/off both keyboard and mouse tooltips activation
None. It was decided to use ShowCellToolTips property only.

Screenshots

Before

There is no way to activate a tooltip using a keyboard

After

Cell tooltips are displayed when tab/keyboard arrow navigation
Cell tooltip is activated/deactivated when clicking Control+Shift+F10 hotkey (end of the gif)

Test methodology

Manual testing

Test environment(s)

Microsoft Windows [Version 10.0.18362.239]
.NET Core Version: 3.0.100-preview9-013722

Microsoft Reviewers: Open in CodeFlow

codecov · 2019-08-23T10:37:00Z

Codecov Report

Merging #1681 into release/3.1 will increase coverage by 0.00548%.
The diff coverage is 32.6087%.

@@                 Coverage Diff                  @@
##           release/3.1      #1681         +/-   ##
====================================================
+ Coverage     26.14871%   26.1542%   +0.00549%     
====================================================
  Files              804        804                 
  Lines           267845     268022        +177     
  Branches         37979      38008         +29     
====================================================
+ Hits             70038      70099         +61     
- Misses          192797     192903        +106     
- Partials          5010       5020         +10

Flag	Coverage Δ
#Debug	`26.1542% <32.6087%> (+0.00548%)`	⬆️
#production	`26.1542% <32.6087%> (+0.00548%)`	⬆️
#test	`100% <ø> (ø)`	⬆️

src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.Methods.cs

src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCell.cs

src/System.Windows.Forms/src/System/Windows/Forms/ToolTip.cs

src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCell.cs

vladimir-krestov

Currently, there are 3 minor bugs:

Sometimes the keyboard tooltip disappears if a mouse was located in its place.
Sometimes after calling the mouse tooltip and selecting a cell using the keyboard, the keyboard tooltip does not appear.

Sometimes a keyboard tooltip flickers near the mouse pointer when a cell selecting if set a short initialization time for the tooltip. This will be fixed as a separate issue because this bug is present in the ToolStrip of the master branch.

src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.cs

src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCell.cs

src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.cs

vladimir-krestov · 2019-09-02T13:34:58Z

@RussKie, could you please confirm the following changes:

DataGridViewButtonCell/DataGridViewImageCell have default tooltip localized text as "Button"/"Image" if tooltip text is not set
(It was were added to resources)
By default, KeyboardToolTip has ReshowDelay = 0.5s and InitialDelay = 0.5s.
(Please see gifs)

RussKie · 2019-09-02T14:04:56Z

DataGridViewButtonCell/DataGridViewImageCell have default tooltip localized text as "Button"/"Image" if tooltip text is not set
(It was were added to resources)

By default, KeyboardToolTip has ReshowDelay = 0.5s and InitialDelay = 0.5s.
(Please see gifs)

👍
If further changes will be required we'll add make them later. Thank you

vladimir-krestov · 2019-09-04T06:27:35Z

Merge conflicts and commits list will be fixed after test issues fixing.

vladimir-krestov · 2019-09-19T12:05:55Z

Testers approved this fix.

src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCell.cs

src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.cs

Fixed mouse tooltip conflicts Implemented got-lost focus event handling. Added hooking when add column or row Implemented unhooking Added Image and Button resources Added hotkeys Code refactoring Removed ShowCellErrorsKeyboardTooTip property. Changed an access to keyboard tooltips Fixed CancelToolTipPopup Fixed resources Some code refactoring Deactivated mouse tooltip when DataGridView get focus Fixed tooltip activation when sorting Fixed review points Removed extra spaces Fixed CI build error Fixed review points Fixed a tooltip activation when adding a row. Fxed GetNeighboringToolsRectangles method Added cell neighbors unit test Code refactoring Fixed test issues Fixed OnLostFocus method Code refactoring Fixed getting cell ToolTip text. Made code refactoring. Code refactoring Fixed hooking Fixed test issues 2 Removed extra spaces Code refactoring

merriemcgaw · 2019-09-24T17:28:11Z

Business case approved. Please merge when @RussKie approves the code.

merriemcgaw · 2019-09-24T17:28:43Z

Business case approved. Please merge when @RussKie approves the code.

vladimir-krestov added a11y-MAS High Priority - Accessibility violation of Microsoft Accessibility Standards 🚧 work in progress Work that is current in progress labels Aug 23, 2019

vladimir-krestov requested a review from a team as a code owner August 23, 2019 10:28

vladimir-krestov self-assigned this Aug 23, 2019

vladimir-krestov force-pushed the dev/v-vlkres/DataGridViewToolTip branch from a8c0eec to 38aada1 Compare August 23, 2019 13:59

RussKie reviewed Aug 23, 2019

View reviewed changes

vladimir-krestov commented Aug 26, 2019

View reviewed changes

vladimir-krestov force-pushed the dev/v-vlkres/DataGridViewToolTip branch from 0238069 to 4a809c0 Compare August 26, 2019 12:27

RussKie reviewed Aug 26, 2019

View reviewed changes

src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.cs Outdated Show resolved Hide resolved

src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCell.cs Show resolved Hide resolved

RussKie suggested changes Aug 27, 2019

View reviewed changes

src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.cs Outdated Show resolved Hide resolved

ghost added waiting-author-feedback The team requires more information from the author and removed waiting-author-feedback The team requires more information from the author labels Aug 27, 2019

vladimir-krestov added the waiting-for-testing The PR is awaiting manual testing by the primary team; no action is yet required from the author(s) label Sep 3, 2019

vladimir-krestov changed the base branch from master to release/3.0 September 4, 2019 06:23

vladimir-krestov force-pushed the dev/v-vlkres/DataGridViewToolTip branch from a79286f to b5b0a9f Compare September 9, 2019 14:06

vladimir-krestov mentioned this pull request Sep 9, 2019

[Translation] Adding default DataGridView cells ToolTip text to resources #1836

Closed

RussKie added this to the 3.1 milestone Sep 9, 2019

vladimir-krestov changed the base branch from release/3.0 to release/3.1 September 10, 2019 09:40

vladimir-krestov force-pushed the dev/v-vlkres/DataGridViewToolTip branch 2 times, most recently from 5b66df7 to a85b3b4 Compare September 17, 2019 12:21

vladimir-krestov added waiting-approval and removed waiting-for-testing The PR is awaiting manual testing by the primary team; no action is yet required from the author(s) labels Sep 19, 2019

RussKie removed a11y-MAS High Priority - Accessibility violation of Microsoft Accessibility Standards 🚧 work in progress Work that is current in progress labels Sep 19, 2019

RussKie previously approved these changes Sep 19, 2019

View reviewed changes

src/System.Windows.Forms/src/System/Windows/Forms/DataGridViewCell.cs Outdated Show resolved Hide resolved

src/System.Windows.Forms/src/System/Windows/Forms/DataGridView.cs Outdated Show resolved Hide resolved

vladimir-krestov dismissed RussKie’s stale review via c57e84f September 22, 2019 09:24

vladimir-krestov force-pushed the dev/v-vlkres/DataGridViewToolTip branch 2 times, most recently from c57e84f to 9867270 Compare September 22, 2019 09:33

vladimir-krestov force-pushed the dev/v-vlkres/DataGridViewToolTip branch from 9867270 to 0fc4044 Compare September 22, 2019 10:04

vladimir-krestov changed the title ~~WIP: [Keyboard][Accessibility]: Fixing activation DataGridView cell tooltips with using a keyboard~~ [Keyboard][Accessibility]: Fixing activation DataGridView cell tooltips with using a keyboard Sep 23, 2019

RussKie assigned merriemcgaw and unassigned vladimir-krestov Sep 24, 2019

RussKie approved these changes Sep 24, 2019

View reviewed changes

RussKie removed the waiting-approval label Sep 24, 2019

RussKie merged commit 066b5db into release/3.1 Sep 24, 2019

RussKie deleted the dev/v-vlkres/DataGridViewToolTip branch September 24, 2019 21:39

RussKie mentioned this pull request Oct 8, 2019

The CellFormatting event of datagridview cannot be fired for cells that are not headers #2048

Closed

vladimir-krestov mentioned this pull request Feb 12, 2020

DataGridView Tip is not normal #2812

Closed

ghost locked as resolved and limited conversation to collaborators Feb 4, 2022

[Keyboard][Accessibility]: Fixing activation DataGridView cell tooltips with using a keyboard #1681

[Keyboard][Accessibility]: Fixing activation DataGridView cell tooltips with using a keyboard #1681

Uh oh!

Conversation

vladimir-krestov commented Aug 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Customer Impact

Regression?

Risk

Screenshots

Before

After

Test methodology

Test environment(s)

Microsoft Reviewers: Open in CodeFlow

Uh oh!

codecov bot commented Aug 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vladimir-krestov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vladimir-krestov commented Sep 2, 2019

Uh oh!

RussKie commented Sep 2, 2019

Uh oh!

vladimir-krestov commented Sep 4, 2019

Uh oh!

vladimir-krestov commented Sep 19, 2019

Uh oh!

Uh oh!

Uh oh!

merriemcgaw commented Sep 24, 2019

Uh oh!

merriemcgaw commented Sep 24, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

vladimir-krestov commented Aug 23, 2019 •

edited

Loading

codecov bot commented Aug 23, 2019 •

edited

Loading