The default value is not displayed in the correct position after setting SelectedObject property for PropertyGird control #4593

Jessie-Zhang01 · 2021-02-23T08:33:49Z

.NET Core Version: .Net SDK 6.0.100-preview.2.21120.3, .Net SDK 5.0.104 from March 2021 Update Test Pass
Have you experienced this same bug with .NET Framework?:
No

Problem description:
The default value is not displayed in the correct position after setting SelectedObject property for PropertyGird control. It seems to be displayed in the upper left corner of the propertygrid.

Expected behavior:
After setting the SelectedObject property for the PropertyGird control, it should display correct default values.

More Info:
This is a regression issue, it cannot reproduce on .Net SDK 5.0.103 and .Net SDK 6.0.100-preview.2.21111.1, but can reproduce on .Net SDK 5.0.104 from March 2021 Update Test Pass and .Net SDK 6.0.100-preview.2.21112.1.

Minimal repro:

Create a WinForms .Net Core application.
Add a PropertyGird control to Form.
Press F4 to go to the Property Browser Window, set its SelectedObject property to Form1.
Build and run the application, observe the PropertyGrid.

Or

Extract the attached project and open it.
Test.zip
Build and run this application, observe the PropertyGrid.

RussKie · 2021-02-24T08:01:50Z

This is a regression surfaced by #4525. Before #4525 any modifications to a Graphics object would be correctly applied, as the code would follow this path:

winforms/src/System.Windows.Forms.Primitives/src/System/Windows/Forms/DeviceContextHdcScope.cs

Lines 52 to 55 in 7b6d433

    
           public DeviceContextHdcScope( 
        
               IDeviceContext deviceContext, 
        
               bool applyGraphicsState = true, 
        
               bool saveHdcState = false) : this (

Since #4525 we rely on flags passed into DrawTextInternal completely side-stepping any modifications applied to a Graphics object. PropertyGrid performs clipping and transformations when rendering values:

winforms/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/PropertyGridView.cs

Lines 1395 to 1438 in 7b6d433

    
           protected virtual void DrawValueEntry(Graphics g, int row, ref Rectangle clipRect) 
        
           { 
        
               GridEntry gridEntry = GetGridEntryFromRow(row); 
        
               if (gridEntry is null) 
        
               { 
        
                   return; 
        
               } 
        
               Debug.WriteLineIf(GridViewDebugPaint.TraceVerbose, "Drawing value for property " + gridEntry.PropertyLabel); 
        
               Rectangle r = GetRectangle(row, ROWVALUE); 
        
               Point newOrigin = new Point(r.X, r.Y); 
        
               Rectangle cr = Rectangle.Intersect(clipRect, r); 
        
               if (cr.IsEmpty) 
        
               { 
        
                   return; 
        
               } 
        
               AdjustOrigin(g, newOrigin, ref r); 
        
               cr.Offset(-newOrigin.X, -newOrigin.Y); 
        
               try 
        
               { 
        
                   try 
        
                   { 
        
                       gridEntry.PaintValue( 
        
                           null, 
        
                           g, 
        
                           r, 
        
                           cr, 
        
                           GridEntry.PaintValueFlags.FetchValue 
        
                               | GridEntry.PaintValueFlags.PaintInPlace 
        
                               | GridEntry.PaintValueFlags.CheckShouldSerialize); 
        
                   } 
        
                   catch 
        
                   { 
        
                   } 
        
               } 
        
               finally 
        
               { 
        
                   ResetOrigin(g); 
        
               } 
        
           }

It looks like an oversight (or a sad omission during the WindowsGraphics-related cleanups) that the value-rendering procedure doesn't explicitly request to preserve the graphics modifications:

winforms/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs

Lines 2365 to 2366 in 7b6d433

    
           User32.DT format = User32.DT.EDITCONTROL | User32.DT.EXPANDTABS | User32.DT.NOCLIP 
        
               | User32.DT.SINGLELINE | User32.DT.NOPREFIX;

winforms/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs

Lines 2385 to 2392 in 7b6d433

    
           TextRenderer.DrawTextInternal( 
        
               g, 
        
               text, 
        
               GetFont(boldFont: valueModified), 
        
               textRectangle, 
        
               textColor, 
        
               backColor, 
        
               (TextFormatFlags)format);

...whilst the label rendering code does:

winforms/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs

Line 2085 in 7b6d433

    
           TextRenderer.DrawText(g, strLabel, font, textRect, textColor, PropertyGrid.MeasureTextHelper.GetTextRendererFlags());

winforms/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGrid.cs

Lines 5322 to 5326 in 7b6d433

    
           public static TextFormatFlags GetTextRendererFlags() 
        
           { 
        
               return TextFormatFlags.PreserveGraphicsClipping | 
        
                       TextFormatFlags.PreserveGraphicsTranslateTransform; 
        
           }

This looks a fix:

diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs
index 75b07f49c..41f095bd6 100644
--- a/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs
+++ b/src/System.Windows.Forms/src/System/Windows/Forms/PropertyGridInternal/GridEntry.cs
@@ -2389,7 +2389,7 @@ namespace System.Windows.Forms.PropertyGridInternal
                 textRectangle,
                 textColor,
                 backColor,
-                (TextFormatFlags)format);
+                (TextFormatFlags)format | PropertyGrid.MeasureTextHelper.GetTextRendererFlags());
 
             ValueToolTipLocation = doToolTip ? new Point(rect.X + 2, rect.Y - 1) : InvalidPoint;
         }

Before	After

May also worth adding this as a guard:

diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/TextRenderer.cs b/src/System.Windows.Forms/src/System/Windows/Forms/TextRenderer.cs
index d05a1e8f5..05272586f 100644
--- a/src/System.Windows.Forms/src/System/Windows/Forms/TextRenderer.cs
+++ b/src/System.Windows.Forms/src/System/Windows/Forms/TextRenderer.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System.Diagnostics;
 using System.Drawing;
 using System.Drawing.Text;
 using static Interop;
@@ -603,7 +604,7 @@ namespace System.Windows.Forms
         /// </summary>
         private static ApplyGraphicsProperties GetApplyStateFlags(IDeviceContext deviceContext, TextFormatFlags textFormatFlags)
         {
-            if (deviceContext is not Graphics)
+            if (deviceContext is not Graphics graphics)
             {
                 return ApplyGraphicsProperties.None;
             }
@@ -619,6 +620,16 @@ namespace System.Windows.Forms
                 apply |= ApplyGraphicsProperties.TranslateTransform;
             }
 
+            Debug.Assert(apply.HasFlag(ApplyGraphicsProperties.Clipping)
+                || graphics.Clip is null
+                || graphics.Clip.GetHrgn(graphics) == IntPtr.Zero,
+                "Must preserve Graphics clipping region!");
+
+            Debug.Assert(apply.HasFlag(ApplyGraphicsProperties.TranslateTransform)
+                || graphics.Transform is null
+                || graphics.Transform.IsIdentity,
+                "Must preserve Graphics transformation!");
+
             return apply;
         }
     }

JeremyKuhne · 2021-02-24T19:10:14Z

Your fix looks right, and I like the assert.

merriemcgaw · 2021-02-24T23:02:24Z

Agreed - we should get this in 5.0.5 for sure.

kirsan31 · 2021-02-25T08:25:38Z

Am I understand right, that this regression will be introduced in 5.0.4 anyway?

RussKie · 2021-02-25T09:47:27Z

5.0.4 has been snapped few weeks ago, and is about to be released. Unfortunately it is too late in the cycle to undo or fix it in this release. Sadly we messed it up, sorry.

kirsan31 · 2021-02-25T09:51:15Z

Thanks for the info (forewarned is forearmed). We need to stick with 5.0.3 then...
This is just that rare case when updating .Net with windows update is not very good ))))

RussKie · 2021-02-25T09:54:24Z

This issue will noted in the release notes, I just hadn't have a chance to add it yet.

RussKie · 2021-02-25T23:07:29Z

I've updated the known issues docs, these will be published when 5.0.4 and 6.0p2 are released

The fix introduced in dotnet#4525 has redirected the `PropertyGrid` value rendering through a different code path which only relies on flags passed into `DrawTextInternal` completely side-stepping any modifications applied to the `Graphics` object. However the `PropertyGrid` value rendering routines do modify the `Graphics` object (applying clipping and transformations) but do not pass the necessary flags to `DrawTextInternal`. Fix by applying the necessary flags to preserve the `Graphics` modifications, and add debug-time asserts to check that necessary flags are applies, if the underlying `Graphics` object is modified. Fixes dotnet#4593

The fix introduced in #4525 has redirected the `PropertyGrid` value rendering through a different code path which only relies on flags passed into `DrawTextInternal` completely side-stepping any modifications applied to the `Graphics` object. However the `PropertyGrid` value rendering routines do modify the `Graphics` object (applying clipping and transformations) but do not pass the necessary flags to `DrawTextInternal`. Fix by applying the necessary flags to preserve the `Graphics` modifications, and add debug-time asserts to check that necessary flags are applies, if the underlying `Graphics` object is modified. Fixes #4593

The fix introduced in dotnet#4525 has redirected the `PropertyGrid` value rendering through a different code path which only relies on flags passed into `DrawTextInternal` completely side-stepping any modifications applied to the `Graphics` object. However the `PropertyGrid` value rendering routines do modify the `Graphics` object (applying clipping and transformations) but do not pass the necessary flags to `DrawTextInternal`. Fix by applying the necessary flags to preserve the `Graphics` modifications, and add debug-time asserts to check that necessary flags are applies, if the underlying `Graphics` object is modified. Fixes dotnet#4593 (cherry picked from commit 34cdcf6)

kirsan31 · 2021-03-10T06:55:12Z

@RussKie

I've updated the known issues docs, these will be published when 5.0.4 and 6.0p2 are released

I think the doc must point out that this is only 5.0.4 issue. Сurrent text indicates an error in all versions up to 5.0.5...

RussKie · 2021-03-10T07:25:59Z

The changelog is updated to reflect the state of the current release.

kirsan31 · 2021-03-10T07:29:59Z

The changelog is updated to reflect the state of the current release.

Forgot to post link of the doc - sorry :( I meant this: https://github.com/dotnet/core/blob/main/release-notes/5.0/5.0-known-issues.md

The fix introduced in #4525 has redirected the `PropertyGrid` value rendering through a different code path which only relies on flags passed into `DrawTextInternal` completely side-stepping any modifications applied to the `Graphics` object. However the `PropertyGrid` value rendering routines do modify the `Graphics` object (applying clipping and transformations) but do not pass the necessary flags to `DrawTextInternal`. Fix by applying the necessary flags to preserve the `Graphics` modifications, and add debug-time asserts to check that necessary flags are applies, if the underlying `Graphics` object is modified. Fixes #4593 (cherry picked from commit 34cdcf6)

kirsan31 · 2021-03-10T10:27:46Z

@RussKie Any advice how to specify exact runtime version with framework-dependent applications?
RuntimeFrameworkVersion doesn't work :(((

For framework-dependent applications, the RuntimeFrameworkVersion specifies the minimum required runtime framework version.

Initially, I didn't read the documentation carefully and was sure that the RuntimeFrameworkVersion is what we need...

OMG I didn't realize the magnitude of the whole problem - 5.0.3 will be overwritten with 5.0.4 by WU anyway. We have big big troubles now... 😭

Am I understand right, that on machines where 5.0.4 will be installed the only options are:

self-contained deployment.
manually install 5.0.3 and delete 5.0.4 from c:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App\.

?

RussKie · 2021-03-17T00:18:25Z

I'm afraid I don't know enough about the .NET deployments via the WU. Manually it is possible to install the runtimes side-by-side.
Please direct any questions about the WU to the dotnet/sdk repo.

You can define how you wish the runtime to be resolved, please check https://github.com/dotnet/runtime/blob/main/docs/design/features/framework-version-resolution.md
You may also find this useful: https://docs.microsoft.com/dotnet/core/deploying/runtime-patch-selection

Zheng-Li01 · 2021-03-22T07:22:14Z

Verified the issue with latest 6.0.100-preview.3.21169.6, the issue has been fixed that the PropertyGird control display correctly as below screenshot.

Jessie-Zhang01 · 2021-03-22T08:13:18Z

Verified the issue with .Net SDK 5.0.202 from April 2021 Update Test Pass, this issue is fixed.

Jessie-Zhang01 added the 💥 regression-preview Regression from a preview release label Feb 23, 2021

RussKie added the priority-0 Work that we can't release without label Feb 24, 2021

RussKie assigned RussKie and JeremyKuhne Feb 24, 2021

RussKie added this to the 5.0.5 milestone Feb 24, 2021

RussKie mentioned this issue Feb 24, 2021

Properly apply translation and clipping in TextRenderer #4525

Merged

RussKie mentioned this issue Feb 25, 2021

fix PropertyGrid value rendering #4610

Merged

ghost added the 🚧 work in progress Work that is current in progress label Feb 25, 2021

RussKie mentioned this issue Feb 25, 2021

fix PropertyGrid value rendering (servicing 5.0) #4611

Merged

RussKie linked a pull request Mar 2, 2021 that will close this issue

fix PropertyGrid value rendering (servicing 5.0) #4611

Merged

RussKie closed this as completed in #4610 Mar 2, 2021

ghost removed the 🚧 work in progress Work that is current in progress label Mar 10, 2021

kirsan31 mentioned this issue Mar 11, 2021

Propertygrid displays all values in top-left corner of component #4673

Closed

RussKie removed this from the 5.0.5 milestone Mar 12, 2021

RussKie mentioned this issue Mar 12, 2021

[5.0.101] Published single file binary crashes on startup with 0x80070002 in EnableVisualStyles() #4397

Closed

kirsan31 mentioned this issue Mar 12, 2021

The PropertyGrid displays properties of selected object incorrectly with Net 5.0 Windows app (Core) #3919

Closed

RussKie removed the priority-0 Work that we can't release without label Mar 17, 2021

kirsan31 mentioned this issue Mar 18, 2021

What's the matter with PropertyGrid in NET5.0 #4699

Closed

GaryHughes mentioned this issue Apr 6, 2021

PropertyGrid is broken in .NET 5.0.4 GaryHughes/FixClient#2

Closed

ghost locked as resolved and limited conversation to collaborators Jan 29, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

The default value is not displayed in the correct position after setting SelectedObject property for PropertyGird control #4593

The default value is not displayed in the correct position after setting SelectedObject property for PropertyGird control #4593

Jessie-Zhang01 commented Feb 23, 2021 •

edited

Loading

RussKie commented Feb 24, 2021

JeremyKuhne commented Feb 24, 2021

merriemcgaw commented Feb 24, 2021

kirsan31 commented Feb 25, 2021 •

edited

Loading

RussKie commented Feb 25, 2021 via email •

edited by ghost

Loading

kirsan31 commented Feb 25, 2021 •

edited

Loading

RussKie commented Feb 25, 2021 via email •

edited by ghost

Loading

RussKie commented Feb 25, 2021

kirsan31 commented Mar 10, 2021 •

edited

Loading

RussKie commented Mar 10, 2021

kirsan31 commented Mar 10, 2021

kirsan31 commented Mar 10, 2021 •

edited

Loading

RussKie commented Mar 17, 2021

Zheng-Li01 commented Mar 22, 2021

Jessie-Zhang01 commented Mar 22, 2021

The default value is not displayed in the correct position after setting SelectedObject property for PropertyGird control #4593

The default value is not displayed in the correct position after setting SelectedObject property for PropertyGird control #4593

Comments

Jessie-Zhang01 commented Feb 23, 2021 • edited Loading

RussKie commented Feb 24, 2021

JeremyKuhne commented Feb 24, 2021

merriemcgaw commented Feb 24, 2021

kirsan31 commented Feb 25, 2021 • edited Loading

RussKie commented Feb 25, 2021 via email • edited by ghost Loading

kirsan31 commented Feb 25, 2021 • edited Loading

RussKie commented Feb 25, 2021 via email • edited by ghost Loading

RussKie commented Feb 25, 2021

kirsan31 commented Mar 10, 2021 • edited Loading

RussKie commented Mar 10, 2021

kirsan31 commented Mar 10, 2021

kirsan31 commented Mar 10, 2021 • edited Loading

RussKie commented Mar 17, 2021

Zheng-Li01 commented Mar 22, 2021

Jessie-Zhang01 commented Mar 22, 2021

Jessie-Zhang01 commented Feb 23, 2021 •

edited

Loading

kirsan31 commented Feb 25, 2021 •

edited

Loading

RussKie commented Feb 25, 2021 via email •

edited by ghost

Loading

kirsan31 commented Feb 25, 2021 •

edited

Loading

RussKie commented Feb 25, 2021 via email •

edited by ghost

Loading

kirsan31 commented Mar 10, 2021 •

edited

Loading

kirsan31 commented Mar 10, 2021 •

edited

Loading