Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 29, 2025

Summary

Updates the ToolTip.AutoPopDelay property documentation to accurately reflect the different behaviors between Windows 10 and Windows 11, addressing a behavioral change that was causing developer confusion.

Problem

The existing documentation incorrectly stated that "The maximum time you can delay a popup is 5000 milliseconds" as a universal rule. However, this behavior varies significantly between Windows versions:

  • Windows 10: The 5000ms limit is enforced - values greater than 5000ms are clamped to 5000ms
  • Windows 11: The default value causes tooltips to remain visible indefinitely, and when set to custom values, there is no 5000ms restriction

This discrepancy between documentation and actual behavior was causing confusion for developers targeting different Windows versions.

Changes

Replaced the misleading universal statement with platform-specific documentation that clearly explains:

  1. Windows 10 behavior: Maximum limit of 5000ms with clamping of higher values
  2. Windows 11 behavior: Default value enables infinite tooltips, custom values have no 5000ms limit
  3. Recommendation: Continue to use the Show() method for precise control over ToolTip display timing

Impact

  • Developers now have accurate information about platform-specific ToolTip behavior
  • Reduces confusion when ToolTips behave differently than documented on Windows 11
  • Maintains backward compatibility while documenting the behavioral change

Fixes https://github.com/dotnet/dotnet-api-docs/issues/{issue_number}

Original prompt

This section details on the original issue you should resolve

<issue_title>[Breaking change]: ToolTip.AutoPopDelay documentation does not match Win11 behavior</issue_title>
<issue_description>### Description

The official documentation for ToolTip.AutoPopDelay states that the maximum value is 5000 milliseconds. However, in practice, this limit only applies to Windows 10. On Windows 11, the default value causes tooltips to remain visible indefinitely, and if set to a custom value, there is no 5000 ms restriction—the tooltip displays for the specified duration. This discrepancy between documentation and actual behavior can cause confusion for developers. The documentation should be updated to clarify the maximum value and describe the different behaviors on Windows 10 and Windows 11.

Version

.NET 8

Previous behavior

On Windows 10, the default value for ToolTip.AutoPopDelay causes the tooltip to disappear after a set duration (not infinite).
The maximum value for ToolTip.AutoPopDelay is limited to 5000 milliseconds. Setting a value greater than 5000 ms will have no effect; the tooltip will disappear after 5000 ms.

New behavior

On Windows 11, the default value for ToolTip.AutoPopDelay causes tooltips to remain visible indefinitely (infinite tooltip).
When ToolTip.AutoPopDelay is set to a non-default value, the tooltip displays for the specified duration, and this value is not limited to 5000 ms.

Type of breaking change

  • Binary incompatible: Existing binaries might encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation.
  • Source incompatible: When recompiled using the new SDK or component or to target the new runtime, existing source code might require source changes to compile successfully.
  • Behavioral change: Existing binaries might behave differently at run time.

Reason for change

The official documentation incorrectly states that the maximum value for ToolTip.AutoPopDelay is 5000 milliseconds. However, actual behavior differs between Windows 10 and Windows 11, and there is no 5000 ms limit enforced in all cases. The documentation needs to be updated to accurately reflect the real behavior and platform differences.

Recommended action

Update the documentation for ToolTip.AutoPopDelay to accurately describe the maximum value limits and platform-specific behavior:

  • Clearly state that on Windows 10, the maximum value is 5000 milliseconds.
  • Clarify that on Windows 11, the default value can result in infinite tooltips, and custom values are not limited to 5000 ms.
  • Remove or revise any statements that incorrectly generalize the 5000 ms maximum.
  • Add remarks section to explain the difference in behavior between Windows 10 and Windows 11.

Feature area

Windows Forms

Affected APIs

No response


Associated WorkItem - 486223</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes dotnet/docs#47960

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] [Breaking change]: ToolTip.AutoPopDelay documentation does not match Win11 behavior Update ToolTip.AutoPopDelay documentation to reflect platform-specific behavior Sep 29, 2025
@Copilot Copilot AI requested a review from gewarren September 29, 2025 17:30
Copilot finished work on behalf of gewarren September 29, 2025 17:30
@gewarren gewarren marked this pull request as ready for review September 29, 2025 17:50
@gewarren gewarren requested a review from LeafShi1 September 29, 2025 17:51
@gewarren gewarren enabled auto-merge (squash) September 29, 2025 17:51
Copy link
Member

@merriemcgaw merriemcgaw left a comment

Choose a reason for hiding this comment

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

lgtm

@gewarren gewarren merged commit ce0c82a into main Sep 29, 2025
5 checks passed
@gewarren gewarren deleted the copilot/fix-16d41389-dfef-4d83-bb44-6fdd9f584baa branch September 29, 2025 18:20
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.

[Breaking change]: ToolTip.AutoPopDelay documentation does not match Win11 behavior
3 participants