Skip to content

Recalculate the node position of the TreeView when DrawMode = TreeViewDrawMode.OwnerDrawText #12698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

Recalculate the node position of the TreeView when DrawMode = TreeViewDrawMode.OwnerDrawText #12698

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8da2d04
Rebase main
LeafShi1 Mar 6, 2025
78fbc33
Rebase main
LeafShi1 Mar 6, 2025
c817ae8
Replace AssemblyRef with Assemblies
LeafShi1 Mar 6, 2025
3fe9c5c
Merge branch 'Issue_12681_fix_recalculate_node_position' of https://g…
LeafShi1 Mar 6, 2025
5cb9458
Redraw editTextBox
LeafShi1 Mar 7, 2025
e67cf6d
Add comment for BeginInvoke((MethodInvoker)
LeafShi1 Mar 12, 2025
69e6e3d
Add update comment and optimize method CalculatePreferredHeight
LeafShi1 Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 105 additions & 5 deletions src/System.Windows.Forms/System/Windows/Forms/Controls/TreeView/TreeView.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2579,7 +2579,31 @@ private LRESULT TvnBeginLabelEdit(NMTVDISPINFOW nmtvdi)
if (!e.CancelEdit)
{
_labelEdit = new TreeViewLabelEditNativeWindow(this);
IntPtr editHandle = PInvokeCore.SendMessage(this, PInvoke.TVM_GETEDITCONTROL);
_labelEdit.AssignHandle(PInvokeCore.SendMessage(this, PInvoke.TVM_GETEDITCONTROL));

BeginInvoke((MethodInvoker)(() =>
Copy link
Member

Choose a reason for hiding this comment

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

When would this be happening on anything but the UI thread? What exactly are we waiting for with "fully initialized"? What has to happen before we do this?

Copy link
Member Author

@LeafShi1 LeafShi1 Mar 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

When would this be happening on anything but the UI thread? What exactly are we waiting for with "fully initialized"? What has to happen before we do this?

This is just a comment on BeginInvoke((MethodInvoker)), but Windows Forms controls cannot be called across threads, so the comment on cross-thread calls seems redundant.

I tried calling PInvoke.SetWindowPos directly here, and although it was executed, it had no effect, so I added BeginInvoke((MethodInvoker)) here to ensure that all properties and states of the EditControl have been set and layout completed before performing the repositioning.

Reposition the edit text box to fix the issue The right border of the node's checkbox is not visible in the edit mode of the node

image

Copy link
Contributor

@Tanya-Solyanik Tanya-Solyanik Apr 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe you should pump messages after setting windows position? Application.DoEvents. But this change seems to be too complicated and risky, I suggest gropping it and re-visiting this bug if reported by customers. @merriemcgaw @JeremyKuhne - Thoughts?

{
// Use BeginInvoke to queue the operation for later execution,
// Ensures that the logic runs after the TreeView control's edit control is fully initialized.
// And this code adjusts the position and size of the edit control
// to accommodate the DPI scaling for high-resolution displays.
if (e.Node is not null)
{
float dpiScale = (float)DeviceDpi / ScaleHelper.OneHundredPercentLogicalDpi;

PInvoke.SetWindowPos(
(HWND)editHandle,
HWND.Null,
e.Node.Bounds.X,
e.Node.Bounds.Y,
e.Node.Bounds.Width + (int)(dpiScale * 10),
e.Node.Bounds.Height + 2,
SET_WINDOW_POS_FLAGS.SWP_NOZORDER
| SET_WINDOW_POS_FLAGS.SWP_FRAMECHANGED
| SET_WINDOW_POS_FLAGS.SWP_SHOWWINDOW);
}
}));
}

return (LRESULT)(e.CancelEdit ? 1 : 0);
Expand Down Expand Up @@ -2734,6 +2758,16 @@ private unsafe void CustomDraw(ref Message m)
// as background color.
if (_drawMode == TreeViewDrawMode.OwnerDrawText)
{
// When the node is being edited,
// set the text color and background color to the same color so that the text is hidden
// goto default to ensure the default drawing behavior is executed instead of a custom drawing.
if (node is { IsEditing: true })
{
nmtvcd->clrText = ColorTranslator.ToWin32(BackColor);
nmtvcd->clrTextBk = ColorTranslator.ToWin32(BackColor);
goto default;
}

nmtvcd->clrText = nmtvcd->clrTextBk;
m.ResultInternal = (LRESULT)(nint)(PInvoke.CDRF_NEWFONT | PInvoke.CDRF_NOTIFYPOSTPAINT);
return;
Expand Down Expand Up @@ -2792,6 +2826,11 @@ private unsafe void CustomDraw(ref Message m)
nmtvcd->clrTextBk = ColorTranslator.ToWin32(riBack);
}

if (node is { IsEditing: true })
{
nmtvcd->clrTextBk = ColorTranslator.ToWin32(BackColor);
}

if (renderinfo is not null && renderinfo.Font is not null)
{
// Mess with the DC directly...
Expand Down Expand Up @@ -2826,8 +2865,36 @@ private unsafe void CustomDraw(ref Message m)
{
Rectangle bounds = node.Bounds;
Size textSize = TextRenderer.MeasureText(node.Text, node.TreeView!.Font);
Point textLoc = new(AppContextSwitches.MoveTreeViewTextLocationOnePixel ? bounds.X : bounds.X - 1, bounds.Y);
bounds = new Rectangle(textLoc, new Size(textSize.Width, bounds.Height));
Point textLocation = new(AppContextSwitches.MoveTreeViewTextLocationOnePixel ? bounds.X : bounds.X - 1, bounds.Y);
bounds = new Rectangle(textLocation, new Size(textSize.Width, bounds.Height));

Rectangle fillRectangle = new Rectangle(textLocation, new(textSize.Width, bounds.Height));
Rectangle focusRectangle = new Rectangle(textLocation, new(textSize.Width, bounds.Height));

if (RightToLeft == RightToLeft.Yes && RightToLeftLayout)
{
int borderWidth = BorderStyle switch
{
BorderStyle.FixedSingle => 1,
BorderStyle.Fixed3D => 2,
_ => 0
};

// Reverse the X-axis drawing coordinates of the rectangle.
int invertedX = Width - bounds.X - textSize.Width - borderWidth * 2;

// Subtract the scroll bar width when the scroll bar appears.
if (Height - borderWidth * 2 < CalculatePreferredHeight())
{
float dpiScale = (float)DeviceDpi / (float)ScaleHelper.InitialSystemDpi;
invertedX -= (int)(SystemInformation.VerticalScrollBarWidth * Math.Round(dpiScale, 2));
}

// To ensure that the right side of the fillRectangle does not
// touch the left edge of the node prefix symbol, 1 pixel is subtracted here.
fillRectangle = new Rectangle(new Point(invertedX - 1, bounds.Y), new(textSize.Width, bounds.Height));
focusRectangle = new Rectangle(new Point(invertedX, bounds.Y), new(textSize.Width, bounds.Height));
}

DrawTreeNodeEventArgs e = new(g, node, bounds, (TreeNodeStates)(nmtvcd->nmcd.uItemState));
OnDrawNode(e);
Expand All @@ -2843,14 +2910,14 @@ private unsafe void CustomDraw(ref Message m)
// Draw the actual node.
if ((curState & TreeNodeStates.Selected) == TreeNodeStates.Selected)
{
g.FillRectangle(SystemBrushes.Highlight, bounds);
ControlPaint.DrawFocusRectangle(g, bounds, color, SystemColors.Highlight);
g.FillRectangle(SystemBrushes.Highlight, fillRectangle);
ControlPaint.DrawFocusRectangle(g, focusRectangle, color, SystemColors.Highlight);
TextRenderer.DrawText(g, node.Text, font, bounds, color, TextFormatFlags.Default);
}
else
{
using var brush = BackColor.GetCachedSolidBrushScope();
g.FillRectangle(brush, bounds);
g.FillRectangle(brush, fillRectangle);

TextRenderer.DrawText(g, node.Text, font, bounds, color, TextFormatFlags.Default);
}
Expand All @@ -2870,6 +2937,39 @@ private unsafe void CustomDraw(ref Message m)
}
}

/// <summary>
/// Calculate the preferred height of the entire tree.
/// </summary>
private int CalculatePreferredHeight()
{
// Nested method to recursively calculate the height of each node and its child nodes.
static int CountExpandedNodes(TreeNode node)
{
int count = 1; // Count the current node

// If the node is expanded, recursively calculate count its child nodes.
if (node.IsExpanded)
{
foreach (TreeNode childNode in node.Nodes)
{
count += CountExpandedNodes(childNode);
}
}

return count;
}

int expandedNodeCount = 0;
// Iterate through all top-level nodes to count the total number of expanded nodes.
foreach (TreeNode node in Nodes)
{
expandedNodeCount += CountExpandedNodes(node);
}

// Calculate the total height based on the number of expanded nodes.
return expandedNodeCount * ItemHeight;
}

/// <summary>
/// Generates colors for each item. This can be overridden to provide colors on a per state/per node
/// basis, rather than using the ForeColor/BackColor/NodeFont properties on TreeNode.
Expand Down