Skip to content

Fix ScrollableControl scrollbar synchronization after property-driven display position updates#14658

Open
abineshPalanisamy wants to merge 2 commits into
dotnet:mainfrom
abineshPalanisamy:Fix_Issue_3614
Open

Fix ScrollableControl scrollbar synchronization after property-driven display position updates#14658
abineshPalanisamy wants to merge 2 commits into
dotnet:mainfrom
abineshPalanisamy:Fix_Issue_3614

Conversation

@abineshPalanisamy

@abineshPalanisamy abineshPalanisamy commented Jun 18, 2026

Copy link
Copy Markdown

Fixes #3614

Proposed changes

  • Update ScrollableControl.SetDisplayFromScrollProps(int x, int y) to explicitly call SyncScrollbars(true) after SetDisplayRectLocation(x, y). This ensures that the scrollbar state is synchronized after the display rectangle position changes through the property-driven scroll path.
  • Preserve the existing SetDisplayFromScrollProps flow while completing the missing scrollbar synchronization step required after the display position is updated.
  • Add unit test coverage in ScrollableControlTests for property-driven horizontal scroll position updates to verify that display position changes and scrollbar synchronization remain consistent. The WinForms test suite already contains ScrollableControlTests.cs, which is the appropriate location for this regression coverage.

Root cause

  • The issue occurs in the property-driven scroll path where ScrollProperties.Value updates the display position via SetDisplayFromScrollProps(...).
  • SetDisplayRectLocation(int x, int y) updates the display position but does not update the scrollbar state.
  • Since no synchronization step was performed afterward, the display rectangle and scrollbar state became inconsistent, causing stale UI during continuous scrolling.
  • Other WinForms paths already pair SetDisplayRectLocation(...) with SyncScrollbars(true), which was missing in this path.

Customer Impact

  • Fixes the stale UI/content issue that occurs when the horizontal scroll position is updated through the property-driven path during the continuous drag scenario described in the issue. After the fix, the visible panel content stays aligned with the final scrollbar position.
  • Prevents cases where the scrollbar position changes correctly but the displayed content does not update to reflect the new horizontal position until a later layout or synchronization step occurs.

Regression?

  • No

Risk

  • Low.
  • The change is scoped only to ScrollableControl.SetDisplayFromScrollProps(...), which is invoked through the property-driven scroll update path (ScrollProperties.UpdateDisplayPosition()).
  • Adds only the missing synchronization step (SyncScrollbars(true)) after SetDisplayRectLocation(...), aligning with existing ScrollableControl patterns used in other position update paths.
  • No layout changes; avoids broader side effects.

Screenshots

Before

Scrollable_Before_fix.mp4

After

Scrollable_After_fix.mp4

Test methodology

  • Reproduced the issue scenario described in the GitHub issue, where the horizontal scrollbar position changes through the drag/outside/re-enter interaction and the visible content becomes stale.
  • Verified that calling SyncScrollbars(true) after SetDisplayRectLocation(...) resolves the inconsistency between the display rectangle position and the scrollbar state in the property-driven path.
  • Added unit tests in ScrollableControlTests to validate that:
    • updating the display position through SetDisplayFromScrollProps(...) synchronizes the managed and native horizontal scrollbar positions, and
    • repeated property-driven horizontal position updates remain synchronized.
  • Verified that the fix addresses the missing synchronization step without changing the broader scrollbar recalculation behavior outside this path.

Accessibility testing

Test environment(s)

  • 11.0.100-preview.3.26170.106
Microsoft Reviewers: Open in CodeFlow

Added the fix for the Fix_Issue_3614
Added the unit test cases for Fix_Issue_3614
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

@abineshPalanisamy please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

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.

DTS: USER32!SetScrollInfo is not called as expected when you drag the scrollbar over the window

1 participant