Fix ScrollableControl scrollbar synchronization after property-driven display position updates#14658
Fix ScrollableControl scrollbar synchronization after property-driven display position updates#14658abineshPalanisamy wants to merge 3 commits into
Conversation
Added the fix for the Fix_Issue_3614
Added the unit test cases for Fix_Issue_3614
|
@abineshPalanisamy please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by .NET Foundation and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and .NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
There was a problem hiding this comment.
Pull request overview
This PR fixes a scrollbar state desynchronization in ScrollableControl when the display position is updated via the ScrollProperties.Value (property-driven) path, addressing #3614.
Changes:
- Synchronize scrollbars after
SetDisplayRectLocation(x, y)inScrollableControl.SetDisplayFromScrollProps(int x, int y)by callingSyncScrollbars(true). - Add regression tests to verify managed (
HorizontalScroll.Value) and native (GetScrollInfo) horizontal scroll positions remain aligned after property-driven display position updates.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/System.Windows.Forms/System/Windows/Forms/Scrolling/ScrollableControl.cs | Adds a missing SyncScrollbars(true) call to keep native and managed scrollbar state consistent after display rect updates from scroll properties. |
| src/test/unit/System.Windows.Forms/System/Windows/Forms/ScrollableControlTests.cs | Adds tests validating horizontal display offset updates keep DisplayRectangle, managed scroll value, and native scrollbar position in sync. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| PInvoke.GetScrollInfo(control, SCROLLBAR_CONSTANTS.SB_HORZ, ref info); | ||
| return info.nPos; |
There was a problem hiding this comment.
Addressed the review feedback by validating the GetScrollInfo return value
Addressed the review correction for Fix_Issue_3614
Fixes #3614
Proposed changes
ScrollableControl.SetDisplayFromScrollProps(int x, int y)to explicitly callSyncScrollbars(true)afterSetDisplayRectLocation(x, y). This ensures that the scrollbar state is synchronized after the display rectangle position changes through the property-driven scroll path.SetDisplayFromScrollPropsflow while completing the missing scrollbar synchronization step required after the display position is updated.ScrollableControlTestsfor property-driven horizontal scroll position updates to verify that display position changes and scrollbar synchronization remain consistent. The WinForms test suite already containsScrollableControlTests.cs, which is the appropriate location for this regression coverage.Root cause
ScrollProperties.Valueupdates the display position viaSetDisplayFromScrollProps(...).SyncScrollbars(true), which was missing in this path.Customer Impact
Regression?
Risk
Screenshots
Before
Scrollable_Before_fix.mp4
After
Scrollable_After_fix.mp4
Test methodology
SyncScrollbars(true)afterSetDisplayRectLocation(...)resolves the inconsistency between the display rectangle position and the scrollbar state in the property-driven path.ScrollableControlTeststo validate that:SetDisplayFromScrollProps(...)synchronizes the managed and native horizontal scrollbar positions, andAccessibility testing
Test environment(s)
Microsoft Reviewers: Open in CodeFlow