fix issue #12589 Keyboard tooltip of toolStripDropDown item keeps displaying when tab to other control #12750

Epica3055 · 2025-01-10T06:28:25Z

Root cause

winforms/src/System.Windows.Forms/src/System/Windows/Forms/Controls/ToolStrips/ToolStrip.cs

Lines 4489 to 4518 in 012e82d

    
           internal void UpdateToolTip(ToolStripItem? item, bool refresh = false) 
        
           { 
        
               if (!ShowItemToolTips || (item == _currentlyActiveTooltipItem && !refresh) || ToolTip is null) 
        
               { 
        
                   return; 
        
               } 
        
               if (item != _currentlyActiveTooltipItem) 
        
               { 
        
                   ToolTip.Hide(this); 
        
                   if (!refresh) 
        
                   { 
        
                       _currentlyActiveTooltipItem = item; 
        
                   } 
        
               } 
        
               if (_currentlyActiveTooltipItem is not null && !GetToolStripState(STATE_DRAGGING) && Cursor.Current is { } currentCursor) 
        
               { 
        
                   Point cursorLocation = Cursor.Position; 
        
                   cursorLocation.Y += Cursor.Size.Height - currentCursor.HotSpot.Y; 
        
                   cursorLocation = WindowsFormsUtils.ConstrainToScreenBounds(new Rectangle(cursorLocation, s_onePixel)).Location; 
        
                   ToolTip.Show( 
        
                       _currentlyActiveTooltipItem.ToolTipText, 
        
                       this, 
        
                       PointToClient(cursorLocation), 
        
                       ToolTip.AutoPopDelay); 
        
               } 
        
           }

ToolStrip.UpdateToolTip can be used to show or hide the ToolTip of ToolStrip.
But we didn't update tooltip when Enter key is hit on ToolStripItem.

Proposed changes

Update ToolTip when Enter key is hit on ToolStripItem

Screenshots

Before

Keyboard tooltip of toolStripDropDown item keeps displaying when tab to other control:

ToolTipIssue.mp4

After

issues_12589_01.mp4

Test methodology

Manually

Microsoft Reviewers: Open in CodeFlow

…ps displaying when tab to other control

codecov · 2025-01-10T06:59:22Z

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 76.15329%. Comparing base (a54a4a9) to head (7e0c89e).
Report is 27 commits behind head on main.

Additional details and impacted files

@@                 Coverage Diff                 @@
##                main      #12750         +/-   ##
===================================================
+ Coverage   76.12836%   76.15329%   +0.02492%     
===================================================
  Files           3188        3192          +4     
  Lines         640086      640168         +82     
  Branches       47233       47237          +4     
===================================================
+ Hits          487287      487509        +222     
+ Misses        149269      149132        -137     
+ Partials        3530        3527          -3

Flag	Coverage Δ
Debug	`76.15329% <0.00000%> (+0.02492%)`	⬆️
integration	`18.16708% <0.00000%> (ø)`
production	`50.05870% <0.00000%> (+0.04639%)`	⬆️
test	`97.02829% <ø> (+0.00001%)`	⬆️
unit	`47.27043% <0.00000%> (+0.02720%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Tanya-Solyanik

@Epica3055 - please get this change tested by @Olina-Zhang's team

fix issue dotnet#12589 Keyboard tooltip of toolStripDropDown item kee…

7e0c89e

…ps displaying when tab to other control

Epica3055 requested a review from a team as a code owner January 10, 2025 06:28

dotnet-policy-service bot assigned Epica3055 Jan 10, 2025

Tanya-Solyanik reviewed Jan 10, 2025

View reviewed changes

Tanya-Solyanik 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 Jan 10, 2025

Tanya-Solyanik approved these changes Jan 13, 2025

View reviewed changes

Tanya-Solyanik removed the waiting-for-testing The PR is awaiting manual testing by the primary team; no action is yet required from the author(s) label Jan 13, 2025

Epica3055 merged commit de5575c into dotnet:main Jan 14, 2025
8 checks passed

dotnet-policy-service bot added this to the 10.0 Preview1 milestone Jan 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix issue #12589 Keyboard tooltip of toolStripDropDown item keeps displaying when tab to other control #12750

fix issue #12589 Keyboard tooltip of toolStripDropDown item keeps displaying when tab to other control #12750

Epica3055 commented Jan 10, 2025 •

edited by dotnet-policy-service bot

Loading

codecov bot commented Jan 10, 2025 •

edited

Loading

Tanya-Solyanik left a comment

	internal void UpdateToolTip(ToolStripItem? item, bool refresh = false)
	{
	if (!ShowItemToolTips \|\| (item == _currentlyActiveTooltipItem && !refresh) \|\| ToolTip is null)
	{
	return;
	}

	if (item != _currentlyActiveTooltipItem)
	{
	ToolTip.Hide(this);
	if (!refresh)
	{
	_currentlyActiveTooltipItem = item;
	}
	}

	if (_currentlyActiveTooltipItem is not null && !GetToolStripState(STATE_DRAGGING) && Cursor.Current is { } currentCursor)
	{
	Point cursorLocation = Cursor.Position;
	cursorLocation.Y += Cursor.Size.Height - currentCursor.HotSpot.Y;

	cursorLocation = WindowsFormsUtils.ConstrainToScreenBounds(new Rectangle(cursorLocation, s_onePixel)).Location;

	ToolTip.Show(
	_currentlyActiveTooltipItem.ToolTipText,
	this,
	PointToClient(cursorLocation),
	ToolTip.AutoPopDelay);
	}
	}

fix issue #12589 Keyboard tooltip of toolStripDropDown item keeps displaying when tab to other control #12750

fix issue #12589 Keyboard tooltip of toolStripDropDown item keeps displaying when tab to other control #12750

Conversation

Epica3055 commented Jan 10, 2025 • edited by dotnet-policy-service bot Loading

Root cause

Proposed changes

Screenshots

Before

After

Test methodology

Microsoft Reviewers: Open in CodeFlow

codecov bot commented Jan 10, 2025 • edited Loading

Codecov Report

Tanya-Solyanik left a comment

Choose a reason for hiding this comment

Epica3055 commented Jan 10, 2025 •

edited by dotnet-policy-service bot

Loading

codecov bot commented Jan 10, 2025 •

edited

Loading