Add focus rectangle to PrintPreviewControl by v-elnovikova · Pull Request #9477 · dotnet/winforms

v-elnovikova · 2023-07-12T14:35:35Z

Fixes #9275

Proposed changes

Replace native scrolling with VScrollBar and HScrollBar controls. Native scrolling did not allow drawing focus rectangle that would include scrollbars.
Draw focus rectangle when PrintPreviewControl has focus.
Revert hiding PrintPreviewControl.TabStop property from Designer (see PR Hiding TabStop property of PrintPreviewControl from Designer and setting the default value as false. #7529). Default value is left false to avoid breaking existing code.
Modify PrintPreviewControlAccessibleObject class to include new scrollbars.
Clean up the code.

Customer Impact

User can switch focus to PrintPreviewControl with Tab key.
PrintPreviewControl shows its focus state.

Regression?

No

Risk

PrintPreviewControl AccessibilityConject now lacks Scroll pattern support. It needs to be added in separate PR.

Screenshots

Before

Focus rectangle is not visible:

before.mp4

After

Focus is visible:

after.mp4

This is how Focus rectangle looks in High Contrast themes:

Test methodology

Manual

Test environment(s)

.NET 8.0.100-preview.4.23260.5

Microsoft Reviewers: Open in CodeFlow

Tanya-Solyanik · 2023-07-12T19:02:21Z

Test failure is in the PrintPreview control -
System.NullReferenceException : Object reference not set to an instance of an object.

Stack trace
at System.Windows.Forms.PrintPreviewControl.Dispose(Boolean disposing) in //src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewControl.cs:line 85
at System.ComponentModel.Component.Dispose()
at System.Windows.Forms.Tests.Control_ControlAccessibleObjectTests.ControlAccessibleObject_FragmentNavigate_ParentIsToolStrip_IfControlIsUsedAsToolStripItem(Type type) in //src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/Control.ControlAccessibleObjectTests.cs:line 1501
at InvokeStub_Control_ControlAccessibleObjectTests.ControlAccessibleObject_FragmentNavigate_ParentIsToolStrip_IfControlIsUsedAsToolStripItem(Object, Object, IntPtr*)
at System.Reflection.MethodInvoker.Invoke(Object obj, IntPtr* args, BindingFlags invokeAttr)

Tanya-Solyanik

Please send this to testing and review the change history for the change that hid the TabStop to see if we had updated the docs . If we did, then please prepare a docs issue to roll this back.

src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewControl.cs

Tanya-Solyanik · 2023-07-12T21:12:45Z

Would it make sense to add new unit tests for the new accessible object?

Tanya-Solyanik · 2023-07-14T21:03:03Z

Tests are still failing -
System.NullReferenceException : Object reference not set to an instance of an object.

Stack trace
at System.Windows.Forms.PrintPreviewControl.Dispose(Boolean disposing) in //src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewControl.cs:line 85
at System.ComponentModel.Component.Dispose()
at System.Windows.Forms.Tests.Control_ControlAccessibleObjectTests.ControlAccessibleObject_FragmentNavigate_ParentIsToolStrip_IfControlIsUsedAsToolStripItem(Type type) in //src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/Control.ControlAccessibleObjectTests.cs:line 1486
at InvokeStub_Control_ControlAccessibleObjectTests.ControlAccessibleObject_FragmentNavigate_ParentIsToolStrip_IfControlIsUsedAsToolStripItem(Object, Object, IntPtr*)
at System.Reflection.MethodInvoker.Invoke(Object obj, IntPtr* args, BindingFlags invokeAttr)

dmitrii-drobotov

Nice work!

src/System.Windows.Forms/src/PublicAPI.Shipped.txt

src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewControl.cs

...ws.Forms/src/System/Windows/Forms/PrintPreviewControl.PrintPreviewControlAccessibleObject.cs

src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewControl.cs

- replace native scrollbars with HScrollBar and VScrollBar controls; - draw focus rectangle - modify UIA tree to include new scrollbars.

…efault value is left 'false'.

- renamed fields to start with underscore; - reordered class members to improve readability; - refactored size calculation methods to avoid unnecessary casts.

- moved PrintPreviewControlAccessibleObject file to Printing folder; - reverted adding SR resource strings; - added FragmentNavigate method for PrintPreviewControlAccessibleObject; - added custom AccessibleObject classes for scrollbars, to maintain UIA tree integrity; - added unit tests.

…eviewControl

Tanya-Solyanik · 2023-07-19T19:17:17Z

This fixes bug discovered in an accessibility test pass, it should be shipped in NET8 per the SLA, thus moving it into the NET8 milestone. Risk is in incomplete implementation of the accessibility features, and should not affect the runtime functionality of the control

…eviewControl

Tanya-Solyanik

Thank you!

v-elnovikova requested a review from a team as a code owner July 12, 2023 14:35

ghost assigned v-elnovikova Jul 12, 2023

v-elnovikova added the waiting-review This item is waiting on review by one or more members of team label Jul 12, 2023

v-elnovikova requested review from Epica3055, LeafShi1, SimonZhao888, Tanya-Solyanik, dkazennov and dmitrii-drobotov July 12, 2023 14:36

Tanya-Solyanik reviewed Jul 12, 2023

View reviewed changes

src/System.Windows.Forms/src/System/Windows/Forms/Printing/PrintPreviewControl.cs Outdated Show resolved Hide resolved

Tanya-Solyanik added the waiting-author-feedback The team requires more information from the author label Jul 12, 2023

v-elnovikova force-pushed the Issue_9275_Adding_Focus_Rectangle_To_PrintPreviewControl branch from 8c78a55 to 5fd1590 Compare July 14, 2023 07:59

ghost removed the waiting-author-feedback The team requires more information from the author label Jul 14, 2023

dreddy-work added waiting-author-feedback The team requires more information from the author and removed waiting-review This item is waiting on review by one or more members of team labels Jul 14, 2023

dmitrii-drobotov reviewed Jul 17, 2023

View reviewed changes

ghost removed the waiting-author-feedback The team requires more information from the author label Jul 18, 2023

v-elnovikova added 3 commits July 18, 2023 20:00

Rework scrolling in PrintPreviewControl:

2d6ea9f

- replace native scrollbars with HScrollBar and VScrollBar controls; - draw focus rectangle - modify UIA tree to include new scrollbars.

Reverted hiding PrintPreviewControl.TabStop property from Designer. D…

24b2fd5

…efault value is left 'false'.

Code cleanup:

9fa8a30

- renamed fields to start with underscore; - reordered class members to improve readability; - refactored size calculation methods to avoid unnecessary casts.

v-elnovikova force-pushed the Issue_9275_Adding_Focus_Rectangle_To_PrintPreviewControl branch from 823aafd to 1328a94 Compare July 18, 2023 18:16

v-elnovikova force-pushed the Issue_9275_Adding_Focus_Rectangle_To_PrintPreviewControl branch from 1328a94 to c5d84eb Compare July 19, 2023 09:04

Merge branch 'main' into Issue_9275_Adding_Focus_Rectangle_To_PrintPr…

7e6f251

…eviewControl

v-elnovikova added the waiting-review This item is waiting on review by one or more members of team label Jul 19, 2023

PR feedback:�- set scrollbars' TabStop to false

e1f369e

Tanya-Solyanik removed the waiting-review This item is waiting on review by one or more members of team label Jul 19, 2023

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 Jul 19, 2023

Tanya-Solyanik previously approved these changes Jul 19, 2023

View reviewed changes

Tanya-Solyanik added this to the .NET 8.0 milestone Jul 19, 2023

Tanya-Solyanik requested a review from dreddy-work July 19, 2023 19:14

Fixed: focus rectangle not visible when no document is previewed.

f92f6f3

v-elnovikova dismissed Tanya-Solyanik’s stale review via f92f6f3 July 21, 2023 10:15

Merge branch 'main' into Issue_9275_Adding_Focus_Rectangle_To_PrintPr…

a7550e0

…eviewControl

v-elnovikova force-pushed the Issue_9275_Adding_Focus_Rectangle_To_PrintPreviewControl branch from ed8eeaa to a7550e0 Compare July 21, 2023 14:43

Fixed PublicAPI.Shipped.txt

49dd769

dmitrii-drobotov approved these changes Jul 26, 2023

View reviewed changes

Tanya-Solyanik approved these changes Jul 26, 2023

View reviewed changes

Tanya-Solyanik added ready-to-merge PRs that are ready to merge but worth notifying the internal team. and removed waiting-review This item is waiting on review by one or more members of team labels Jul 26, 2023

dreddy-work merged commit 6678f53 into dotnet:main Jul 26, 2023

ghost modified the milestones: .NET 8.0, 8.0 RC1 Jul 26, 2023

ghost removed the ready-to-merge PRs that are ready to merge but worth notifying the internal team. label Jul 26, 2023

v-elnovikova deleted the Issue_9275_Adding_Focus_Rectangle_To_PrintPreviewControl branch July 27, 2023 09:03

v-elnovikova mentioned this pull request Jul 27, 2023

PrintPreviewControl lacks UI Automation Scroll pattern support #9584

Closed

John-Qiao mentioned this pull request Jul 28, 2023

System.ArgumentOutOfRangeException: Value of '-22' is not valid for 'LargeChange'. #9596

Closed

ghost locked as resolved and limited conversation to collaborators Aug 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add focus rectangle to PrintPreviewControl#9477

Add focus rectangle to PrintPreviewControl#9477
dreddy-work merged 9 commits intodotnet:mainfrom
v-elnovikova:Issue_9275_Adding_Focus_Rectangle_To_PrintPreviewControl

v-elnovikova commented Jul 12, 2023 •

edited by ghost

Loading

Uh oh!

Tanya-Solyanik commented Jul 12, 2023

Uh oh!

Tanya-Solyanik left a comment

Uh oh!

Uh oh!

Tanya-Solyanik commented Jul 12, 2023

Uh oh!

Tanya-Solyanik commented Jul 14, 2023

Uh oh!

dmitrii-drobotov left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Tanya-Solyanik commented Jul 19, 2023 •

edited

Loading

Uh oh!

Tanya-Solyanik left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

v-elnovikova commented Jul 12, 2023 • edited by ghost 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!

Tanya-Solyanik commented Jul 12, 2023

Uh oh!

Tanya-Solyanik left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Tanya-Solyanik commented Jul 12, 2023

Uh oh!

Tanya-Solyanik commented Jul 14, 2023

Uh oh!

dmitrii-drobotov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Tanya-Solyanik commented Jul 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Tanya-Solyanik left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

v-elnovikova commented Jul 12, 2023 •

edited by ghost

Loading

Tanya-Solyanik commented Jul 19, 2023 •

edited

Loading