1 // Permission is hereby granted, free of charge, to any person obtaining
2 // a copy of this software and associated documentation files (the
3 // "Software"), to deal in the Software without restriction, including
4 // without limitation the rights to use, copy, modify, merge, publish,
5 // distribute, sublicense, and/or sell copies of the Software, and to
6 // permit persons to whom the Software is furnished to do so, subject to
7 // the following conditions:
9 // The above copyright notice and this permission notice shall be
10 // included in all copies or substantial portions of the Software.
12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 // Copyright (c) 2004-2005 Novell, Inc.
23 // Jackson Harper (jackson@ximian.com)
24 // Kazuki Oikawa (kazuki@panicode.com)
27 using System.Collections;
28 using System.ComponentModel;
29 using System.ComponentModel.Design;
31 using System.Drawing.Drawing2D;
32 using System.Runtime.InteropServices;
34 namespace System.Windows.Forms {
36 [Docking (DockingBehavior.Ask)]
37 [ClassInterface (ClassInterfaceType.AutoDispatch)]
38 [DefaultProperty("Nodes")]
39 [DefaultEvent("AfterSelect")]
40 [Designer("System.Windows.Forms.Design.TreeViewDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
41 public class TreeView : Control {
43 private string path_separator = "\\";
44 private int item_height = -1;
46 internal TreeNode root_node;
47 internal bool nodes_added;
48 private TreeNodeCollection nodes;
50 private TreeViewAction selection_action;
51 internal TreeNode selected_node;
52 private TreeNode pre_selected_node;
53 private TreeNode focused_node;
54 internal TreeNode highlighted_node;
55 private Rectangle mouse_rect;
56 private bool select_mmove;
58 private ImageList image_list;
59 private int image_index = -1;
60 private int selected_image_index = -1;
62 private string image_key;
63 private bool is_hovering;
64 private TreeNode mouse_click_node;
65 private bool right_to_left_layout;
66 private string selected_image_key;
67 private bool show_node_tool_tips;
68 private ImageList state_image_list;
69 private TreeNode tooltip_currently_showing;
70 private ToolTip tooltip_window;
71 private bool full_row_select;
72 private bool hot_tracking;
73 private int indent = 19;
75 private NodeLabelEditEventArgs edit_args;
76 private LabelEditTextBox edit_text_box;
77 internal TreeNode edit_node;
79 private bool checkboxes;
80 private bool label_edit;
81 private bool scrollable = true;
82 private bool show_lines = true;
83 private bool show_root_lines = true;
84 private bool show_plus_minus = true;
85 private bool hide_selection = true;
87 private int max_visible_order = -1;
88 internal VScrollBar vbar;
89 internal HScrollBar hbar;
90 private bool vbar_bounds_set;
91 private bool hbar_bounds_set;
92 internal int skipped_nodes;
93 internal int hbar_offset;
95 private int update_stack;
96 private bool update_needed;
99 private Color line_color;
100 private StringFormat string_format;
102 private int drag_begin_x = -1;
103 private int drag_begin_y = -1;
104 private long handle_count = 1;
106 private TreeViewDrawMode draw_mode;
108 IComparer tree_view_node_sorter;
111 #region Public Constructors
114 vbar = new ImplicitVScrollBar ();
115 hbar = new ImplicitHScrollBar ();
117 InternalBorderStyle = BorderStyle.Fixed3D;
118 base.background_color = ThemeEngine.Current.ColorWindow;
119 base.foreground_color = ThemeEngine.Current.ColorWindowText;
120 draw_mode = TreeViewDrawMode.Normal;
122 root_node = new TreeNode (this);
123 root_node.Text = "ROOT NODE";
124 nodes = new TreeNodeCollection (root_node);
125 root_node.SetNodes (nodes);
127 MouseDown += new MouseEventHandler (MouseDownHandler);
128 MouseUp += new MouseEventHandler(MouseUpHandler);
129 MouseMove += new MouseEventHandler(MouseMoveHandler);
130 SizeChanged += new EventHandler (SizeChangedHandler);
131 FontChanged += new EventHandler (FontChangedHandler);
132 LostFocus += new EventHandler (LostFocusHandler);
133 GotFocus += new EventHandler (GotFocusHandler);
134 MouseWheel += new MouseEventHandler(MouseWheelHandler);
135 VisibleChanged += new EventHandler (VisibleChangedHandler);
137 SetStyle (ControlStyles.UserPaint | ControlStyles.StandardClick | ControlStyles.UseTextForAccessibility, false);
139 string_format = new StringFormat ();
140 string_format.LineAlignment = StringAlignment.Center;
141 string_format.Alignment = StringAlignment.Center;
143 vbar.Visible = false;
144 hbar.Visible = false;
145 vbar.ValueChanged += new EventHandler (VScrollBarValueChanged);
146 hbar.ValueChanged += new EventHandler (HScrollBarValueChanged);
149 Controls.AddImplicit (vbar);
150 Controls.AddImplicit (hbar);
153 #endregion // Public Constructors
155 #region Public Instance Properties
156 public override Color BackColor {
157 get { return base.BackColor;}
159 base.BackColor = value;
168 [EditorBrowsable(EditorBrowsableState.Never)]
169 public override Image BackgroundImage {
170 get { return base.BackgroundImage; }
171 set { base.BackgroundImage = value; }
174 [DefaultValue(BorderStyle.Fixed3D)]
176 public BorderStyle BorderStyle {
177 get { return InternalBorderStyle; }
178 set { InternalBorderStyle = value; }
181 [DefaultValue(false)]
182 public bool CheckBoxes {
183 get { return checkboxes; }
185 if (value == checkboxes)
189 // Match a "bug" in the MS implementation where disabling checkboxes
190 // collapses the entire tree, but enabling them does not affect the
191 // state of the tree.
193 root_node.CollapseAllUncheck ();
197 // UIA Framework Event: CheckBoxes Changed
198 OnUIACheckBoxesChanged (EventArgs.Empty);
202 public override Color ForeColor {
203 get { return base.ForeColor; }
204 set { base.ForeColor = value; }
206 [DefaultValue(false)]
207 public bool FullRowSelect {
208 get { return full_row_select; }
210 if (value == full_row_select)
212 full_row_select = value;
217 public bool HideSelection {
218 get { return hide_selection; }
220 if (hide_selection == value)
222 hide_selection = value;
227 [DefaultValue(false)]
228 public bool HotTracking {
229 get { return hot_tracking; }
230 set { hot_tracking = value; }
234 [RelatedImageList ("ImageList")]
235 [RefreshProperties (RefreshProperties.Repaint)]
236 [TypeConverter (typeof (NoneExcludedImageIndexConverter))]
237 [Editor("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
239 public int ImageIndex {
240 get { return image_index; }
243 throw new ArgumentException ("'" + value + "' is not a valid value for 'value'. " +
244 "'value' must be greater than or equal to 0.");
246 if (image_index == value)
253 [RefreshProperties (RefreshProperties.Repaint)]
255 public ImageList ImageList {
256 get { return image_list; }
265 get { return indent; }
270 throw new ArgumentException ("'" + value + "' is not a valid value for 'Indent'. " +
271 "'Indent' must be less than or equal to 32000");
274 throw new ArgumentException ("'" + value + "' is not a valid value for 'Indent'. " +
275 "'Indent' must be greater than or equal to 0.");
282 public int ItemHeight {
284 if (item_height == -1)
285 return FontHeight + 3;
289 if (value == item_height)
296 internal int ActualItemHeight {
298 int res = ItemHeight;
299 if (ImageList != null && ImageList.ImageSize.Height > res)
300 res = ImageList.ImageSize.Height;
305 [DefaultValue(false)]
306 public bool LabelEdit {
307 get { return label_edit; }
311 // UIA Framework Event: LabelEdit Changed
312 OnUIALabelEditChanged (EventArgs.Empty);
316 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
317 [MergableProperty(false)]
319 public TreeNodeCollection Nodes {
320 get { return nodes; }
324 [EditorBrowsable (EditorBrowsableState.Never)]
325 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
326 public new Padding Padding {
327 get { return base.Padding; }
328 set { base.Padding = value; }
332 public string PathSeparator {
333 get { return path_separator; }
334 set { path_separator = value; }
338 [DefaultValue (false)]
339 public virtual bool RightToLeftLayout {
340 get { return right_to_left_layout; }
342 if (right_to_left_layout != value) {
343 right_to_left_layout = value;
344 OnRightToLeftLayoutChanged (EventArgs.Empty);
350 public bool Scrollable {
351 get { return scrollable; }
353 if (scrollable == value)
356 UpdateScrollBars (false);
361 [RelatedImageList ("ImageList")]
362 [TypeConverter (typeof (NoneExcludedImageIndexConverter))]
363 [Editor("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
365 public int SelectedImageIndex {
366 get { return selected_image_index; }
369 throw new ArgumentException ("'" + value + "' is not a valid value for 'value'. " +
370 "'value' must be greater than or equal to 0.");
372 UpdateNode (SelectedNode);
377 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
378 public TreeNode SelectedNode {
380 if (!IsHandleCreated)
381 return pre_selected_node;
382 return selected_node;
385 if (!IsHandleCreated) {
386 pre_selected_node = value;
390 if (selected_node == value) {
391 selection_action = TreeViewAction.Unknown;
396 TreeViewCancelEventArgs e = new TreeViewCancelEventArgs (value, false, selection_action);
403 Rectangle invalid = Rectangle.Empty;
405 if (selected_node != null) {
406 invalid = Bloat (selected_node.Bounds);
408 if (focused_node != null) {
409 invalid = Rectangle.Union (invalid,
410 Bloat (focused_node.Bounds));
414 invalid = Rectangle.Union (invalid, Bloat (value.Bounds));
416 highlighted_node = value;
417 selected_node = value;
418 focused_node = value;
420 if (full_row_select || draw_mode != TreeViewDrawMode.Normal) {
422 invalid.Width = ViewportRectangle.Width;
425 if (invalid != Rectangle.Empty)
426 Invalidate (invalid);
428 // We ensure its visible after we update because
429 // scrolling is used for insure visible
430 if (selected_node != null)
431 selected_node.EnsureVisible ();
434 OnAfterSelect (new TreeViewEventArgs (value, TreeViewAction.Unknown));
436 selection_action = TreeViewAction.Unknown;
440 private Rectangle Bloat (Rectangle rect)
450 public bool ShowLines {
451 get { return show_lines; }
453 if (show_lines == value)
460 [DefaultValue (false)]
461 public bool ShowNodeToolTips {
462 get { return show_node_tool_tips; }
463 set { show_node_tool_tips = value; }
467 public bool ShowPlusMinus {
468 get { return show_plus_minus; }
470 if (show_plus_minus == value)
472 show_plus_minus = value;
478 public bool ShowRootLines {
479 get { return show_root_lines; }
481 if (show_root_lines == value)
483 show_root_lines = value;
489 [EditorBrowsable (EditorBrowsableState.Never)]
490 [DefaultValue(false)]
492 get { return sorted; }
497 //LAMESPEC: The documentation says that setting this to true should sort alphabetically if TreeViewNodeSorter is set.
498 // There seems to be a bug in the Microsoft implementation.
499 if (sorted && tree_view_node_sorter == null) {
505 [DefaultValue (null)]
506 public ImageList StateImageList {
507 get { return state_image_list; }
509 state_image_list = value;
515 [EditorBrowsable(EditorBrowsableState.Never)]
517 public override string Text {
518 get { return base.Text; }
519 set { base.Text = value; }
523 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
524 public TreeNode TopNode {
526 if (root_node.FirstNode == null)
528 OpenTreeNodeEnumerator one = new OpenTreeNodeEnumerator (root_node.FirstNode);
530 for (int i = 0; i < skipped_nodes; i++)
532 return one.CurrentNode;
540 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
541 public IComparer TreeViewNodeSorter {
543 return tree_view_node_sorter;
546 tree_view_node_sorter = value;
547 if (tree_view_node_sorter != null) {
549 //LAMESPEC: The documentation says that setting this should set Sorted to false.
550 // There seems to be a bug in the Microsoft implementation.
557 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
558 public int VisibleCount {
560 return ViewportRectangle.Height / ActualItemHeight;
564 /// According to MSDN this property has no effect on the treeview
565 [EditorBrowsable (EditorBrowsableState.Never)]
566 protected override bool DoubleBuffered {
567 get { return base.DoubleBuffered; }
568 set { base.DoubleBuffered = value; }
571 [DefaultValue ("Color [Black]")]
572 public Color LineColor {
574 if (line_color == Color.Empty) {
575 Color res = ControlPaint.Dark (BackColor);
576 if (res == BackColor)
577 res = ControlPaint.Light (BackColor);
593 [RelatedImageList ("ImageList")]
594 [RefreshProperties (RefreshProperties.Repaint)]
595 [TypeConverter (typeof (ImageKeyConverter))]
596 [Editor ("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof (System.Drawing.Design.UITypeEditor))]
597 public string ImageKey {
598 get { return image_key; }
600 if (image_key == value)
610 [RelatedImageList ("ImageList")]
611 [RefreshProperties (RefreshProperties.Repaint)]
612 [TypeConverter (typeof (ImageKeyConverter))]
613 [Editor ("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof (System.Drawing.Design.UITypeEditor))]
614 public string SelectedImageKey {
615 get { return selected_image_key; }
617 if (selected_image_key == value)
619 selected_image_index = -1;
620 selected_image_key = value;
621 UpdateNode (SelectedNode);
626 [EditorBrowsable (EditorBrowsableState.Never)]
627 public override ImageLayout BackgroundImageLayout {
628 get { return base.BackgroundImageLayout; }
629 set { base.BackgroundImageLayout = value; }
632 [DefaultValue (TreeViewDrawMode.Normal)]
633 public TreeViewDrawMode DrawMode {
634 get { return draw_mode; }
635 set { draw_mode = value; }
637 #endregion // Public Instance Properties
639 #region UIA Framework Properties
640 internal ScrollBar UIAHScrollBar {
644 internal ScrollBar UIAVScrollBar {
647 #endregion // UIA Framework Properties
649 #region Protected Instance Properties
650 protected override CreateParams CreateParams {
652 CreateParams cp = base.CreateParams;
657 protected override Size DefaultSize {
658 get { return new Size (121, 97); }
661 #endregion // Protected Instance Properties
663 #region Public Instance Methods
664 public void BeginUpdate ()
669 public void EndUpdate ()
671 if (update_stack > 1) {
676 RecalculateVisibleOrder (root_node);
677 UpdateScrollBars (false);
678 // if (SelectedNode != null)
679 // SelectedNode.EnsureVisible ();
680 Invalidate (ViewportRectangle);
681 update_needed = false;
688 Sort (tree_view_node_sorter);
691 void Sort (IComparer sorter)
695 RecalculateVisibleOrder (root_node);
696 UpdateScrollBars (false);
700 void SetVScrollValue (int value)
702 if (value > vbar.Maximum)
703 value = vbar.Maximum;
704 else if (value < vbar.Minimum)
705 value = vbar.Minimum;
710 public void ExpandAll ()
713 root_node.ExpandAll ();
718 /// Everything below this is basically an emulation of a strange bug on MS
719 /// where they don't always scroll to the last node on ExpandAll
721 if (!IsHandleCreated)
725 foreach (TreeNode child in Nodes) {
726 if (child.Nodes.Count > 0)
733 if (IsHandleCreated && vbar.VisibleInternal) {
734 SetVScrollValue (vbar.Maximum - VisibleCount + 1);
736 RecalculateVisibleOrder (root_node);
737 UpdateScrollBars (true);
739 // Only move the top node if we now have a scrollbar
740 if (vbar.VisibleInternal) {
741 SetTop (Nodes [Nodes.Count - 1]);
742 SelectedNode = Nodes [Nodes.Count - 1];
747 public void CollapseAll ()
750 root_node.CollapseAll ();
753 if (vbar.VisibleInternal)
754 SetVScrollValue (vbar.Maximum - VisibleCount + 1);
757 public TreeNode GetNodeAt (Point pt) {
758 return GetNodeAt (pt.Y);
761 public TreeNode GetNodeAt (int x, int y)
763 return GetNodeAt (y);
766 private TreeNode GetNodeAtUseX (int x, int y) {
767 TreeNode node = GetNodeAt (y);
768 if (node == null || !(IsTextArea (node, x) || full_row_select))
774 public int GetNodeCount (bool includeSubTrees) {
775 return root_node.GetNodeCount (includeSubTrees);
778 public TreeViewHitTestInfo HitTest (Point pt)
780 return HitTest (pt.X, pt.Y);
783 public TreeViewHitTestInfo HitTest (int x, int y)
785 TreeNode n = GetNodeAt (y);
788 return new TreeViewHitTestInfo (null, TreeViewHitTestLocations.None);
790 if (IsTextArea (n, x))
791 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.Label);
792 else if (IsPlusMinusArea (n, x))
793 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.PlusMinus);
794 else if ((checkboxes || n.StateImage != null) && IsCheckboxArea (n, x))
795 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.StateImage);
796 else if (x > n.Bounds.Right)
797 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.RightOfLabel);
798 else if (IsImage (n, x))
799 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.Image);
801 return new TreeViewHitTestInfo (null, TreeViewHitTestLocations.Indent);
804 public override string ToString () {
805 int count = Nodes.Count;
807 return String.Concat (base.ToString (), ", Nodes.Count: 0");
808 return String.Concat (base.ToString (), ", Nodes.Count: ", count, ", Nodes[0]: ", Nodes [0]);
811 #endregion // Public Instance Methods
813 #region Protected Instance Methods
814 protected override void CreateHandle () {
815 base.CreateHandle ();
816 RecalculateVisibleOrder (root_node);
817 UpdateScrollBars (false);
819 if (pre_selected_node != null)
820 SelectedNode = pre_selected_node;
823 protected override void Dispose (bool disposing) {
827 base.Dispose (disposing);
830 protected OwnerDrawPropertyBag GetItemRenderStyles (TreeNode node, int state) {
831 return node.prop_bag;
834 protected override bool IsInputKey (Keys keyData)
836 if (IsHandleCreated && (keyData & Keys.Alt) == 0) {
837 switch (keyData & Keys.KeyCode) {
849 if (edit_node != null)
855 return base.IsInputKey (keyData);
858 protected override void OnKeyDown (KeyEventArgs e)
860 OpenTreeNodeEnumerator ne;
862 switch (e.KeyData & Keys.KeyCode) {
864 if (selected_node != null && selected_node.IsExpanded)
865 selected_node.Expand ();
868 if (selected_node != null && selected_node.IsExpanded)
869 selected_node.Collapse ();
872 if (selected_node != null) {
873 if (selected_node.IsExpanded && selected_node.Nodes.Count > 0)
874 selected_node.Collapse ();
876 TreeNode parent = selected_node.Parent;
877 if (parent != null) {
878 selection_action = TreeViewAction.ByKeyboard;
879 SelectedNode = parent;
885 if (selected_node != null) {
886 if (!selected_node.IsExpanded)
887 selected_node.Expand ();
889 TreeNode child = selected_node.FirstNode;
891 SelectedNode = child;
896 if (selected_node != null) {
897 ne = new OpenTreeNodeEnumerator (selected_node);
898 if (ne.MovePrevious () && ne.MovePrevious ()) {
899 selection_action = TreeViewAction.ByKeyboard;
900 SelectedNode = ne.CurrentNode;
905 if (selected_node != null) {
906 ne = new OpenTreeNodeEnumerator (selected_node);
907 if (ne.MoveNext () && ne.MoveNext ()) {
908 selection_action = TreeViewAction.ByKeyboard;
909 SelectedNode = ne.CurrentNode;
914 if (root_node.Nodes.Count > 0) {
915 ne = new OpenTreeNodeEnumerator (root_node.Nodes [0]);
916 if (ne.MoveNext ()) {
917 selection_action = TreeViewAction.ByKeyboard;
918 SelectedNode = ne.CurrentNode;
923 if (root_node.Nodes.Count > 0) {
924 ne = new OpenTreeNodeEnumerator (root_node.Nodes [0]);
925 while (ne.MoveNext ())
927 selection_action = TreeViewAction.ByKeyboard;
928 SelectedNode = ne.CurrentNode;
932 if (selected_node != null) {
933 ne = new OpenTreeNodeEnumerator (selected_node);
934 int move = VisibleCount;
935 for (int i = 0; i < move && ne.MoveNext (); i++) {
938 selection_action = TreeViewAction.ByKeyboard;
939 SelectedNode = ne.CurrentNode;
943 if (selected_node != null) {
944 ne = new OpenTreeNodeEnumerator (selected_node);
945 int move = VisibleCount;
946 for (int i = 0; i < move && ne.MovePrevious (); i++)
948 selection_action = TreeViewAction.ByKeyboard;
949 SelectedNode = ne.CurrentNode;
953 if (selected_node != null)
954 selected_node.ExpandAll ();
959 if (!e.Handled && checkboxes &&
960 selected_node != null &&
961 (e.KeyData & Keys.KeyCode) == Keys.Space) {
962 selected_node.check_reason = TreeViewAction.ByKeyboard;
963 selected_node.Checked = !selected_node.Checked;
968 protected override void OnKeyPress (KeyPressEventArgs e)
971 if (e.KeyChar == ' ')
975 protected override void OnKeyUp (KeyEventArgs e)
978 if ((e.KeyData & Keys.KeyCode) == Keys.Space)
982 protected override void OnMouseHover (EventArgs e)
984 base.OnMouseHover (e);
988 TreeNode tn = GetNodeAt (PointToClient (MousePosition));
991 MouseEnteredItem (tn);
994 protected override void OnMouseLeave (EventArgs e)
996 base.OnMouseLeave (e);
1000 if (tooltip_currently_showing != null)
1001 MouseLeftItem (tooltip_currently_showing);
1004 protected virtual void OnNodeMouseClick (TreeNodeMouseClickEventArgs e)
1006 TreeNodeMouseClickEventHandler eh = (TreeNodeMouseClickEventHandler)(Events[NodeMouseClickEvent]);
1011 protected virtual void OnNodeMouseDoubleClick (TreeNodeMouseClickEventArgs e)
1013 TreeNodeMouseClickEventHandler eh = (TreeNodeMouseClickEventHandler)(Events[NodeMouseDoubleClickEvent]);
1018 protected virtual void OnNodeMouseHover (TreeNodeMouseHoverEventArgs e)
1020 TreeNodeMouseHoverEventHandler eh = (TreeNodeMouseHoverEventHandler)(Events[NodeMouseHoverEvent]);
1025 protected virtual void OnItemDrag (ItemDragEventArgs e)
1027 ItemDragEventHandler eh = (ItemDragEventHandler)(Events [ItemDragEvent]);
1032 protected virtual void OnDrawNode(DrawTreeNodeEventArgs e) {
1033 DrawTreeNodeEventHandler eh = (DrawTreeNodeEventHandler)(Events[DrawNodeEvent]);
1038 [EditorBrowsable (EditorBrowsableState.Advanced)]
1039 protected virtual void OnRightToLeftLayoutChanged (EventArgs e) {
1040 EventHandler eh = (EventHandler)(Events[RightToLeftLayoutChangedEvent]);
1045 protected internal virtual void OnAfterCheck (TreeViewEventArgs e) {
1046 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterCheckEvent]);
1051 protected internal virtual void OnAfterCollapse (TreeViewEventArgs e) {
1052 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterCollapseEvent]);
1057 protected internal virtual void OnAfterExpand (TreeViewEventArgs e) {
1058 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterExpandEvent]);
1063 protected virtual void OnAfterLabelEdit (NodeLabelEditEventArgs e) {
1064 NodeLabelEditEventHandler eh = (NodeLabelEditEventHandler)(Events [AfterLabelEditEvent]);
1069 protected virtual void OnAfterSelect (TreeViewEventArgs e) {
1070 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterSelectEvent]);
1075 protected internal virtual void OnBeforeCheck (TreeViewCancelEventArgs e) {
1076 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeCheckEvent]);
1081 protected internal virtual void OnBeforeCollapse (TreeViewCancelEventArgs e) {
1082 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeCollapseEvent]);
1087 protected internal virtual void OnBeforeExpand (TreeViewCancelEventArgs e) {
1088 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeExpandEvent]);
1093 protected virtual void OnBeforeLabelEdit (NodeLabelEditEventArgs e) {
1094 NodeLabelEditEventHandler eh = (NodeLabelEditEventHandler)(Events [BeforeLabelEditEvent]);
1099 protected virtual void OnBeforeSelect (TreeViewCancelEventArgs e) {
1100 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeSelectEvent]);
1105 protected override void OnHandleCreated (EventArgs e) {
1106 base.OnHandleCreated (e);
1109 protected override void OnHandleDestroyed (EventArgs e) {
1110 base.OnHandleDestroyed (e);
1113 protected override void WndProc(ref Message m) {
1114 switch ((Msg) m.Msg) {
1116 case Msg.WM_LBUTTONDBLCLK:
1117 int val = m.LParam.ToInt32();
1118 DoubleClickHandler (null, new
1119 MouseEventArgs (MouseButtons.Left,
1121 (val>>16) & 0xffff, 0));
1123 case Msg.WM_CONTEXTMENU:
1124 if (WmContextMenu (ref m))
1129 base.WndProc (ref m);
1132 #endregion // Protected Instance Methods
1134 #region Internal & Private Methods and Properties
1135 internal override bool ScaleChildrenInternal {
1136 get { return false; }
1139 internal IntPtr CreateNodeHandle ()
1141 return (IntPtr) handle_count++;
1144 // According to MSDN docs, for these to be raised,
1145 // the click must occur over a TreeNode
1146 internal override void HandleClick (int clicks, MouseEventArgs me)
1148 if (GetNodeAt (me.Location) != null) {
1149 if ((clicks > 1) && GetStyle (ControlStyles.StandardDoubleClick)) {
1151 OnMouseDoubleClick (me);
1159 internal override bool IsInputCharInternal (char charCode)
1164 internal TreeNode NodeFromHandle (IntPtr handle)
1166 // This method is called rarely, so instead of maintaining a table
1167 // we just walk the tree nodes to find the matching handle
1168 return NodeFromHandleRecursive (root_node, handle);
1171 private TreeNode NodeFromHandleRecursive (TreeNode node, IntPtr handle)
1173 if (node.handle == handle)
1175 foreach (TreeNode child in node.Nodes) {
1176 TreeNode match = NodeFromHandleRecursive (child, handle);
1183 internal Rectangle ViewportRectangle {
1185 Rectangle res = ClientRectangle;
1187 if (vbar != null && vbar.Visible)
1188 res.Width -= vbar.Width;
1189 if (hbar != null && hbar.Visible)
1190 res.Height -= hbar.Height;
1195 private TreeNode GetNodeAt (int y)
1197 if (nodes.Count <= 0)
1200 OpenTreeNodeEnumerator o = new OpenTreeNodeEnumerator (TopNode);
1201 int move = y / ActualItemHeight;
1202 for (int i = -1; i < move; i++) {
1207 return o.CurrentNode;
1210 private bool IsTextArea (TreeNode node, int x)
1212 return node != null && node.Bounds.Left <= x && node.Bounds.Right >= x;
1215 private bool IsSelectableArea (TreeNode node, int x)
1219 int l = node.Bounds.Left;
1220 if (ImageList != null)
1221 l -= ImageList.ImageSize.Width;
1222 return l <= x && node.Bounds.Right >= x;
1226 private bool IsPlusMinusArea (TreeNode node, int x)
1228 if (node.Nodes.Count == 0 || (node.parent == root_node && !show_root_lines))
1231 int l = node.Bounds.Left + 5;
1233 if (show_root_lines || node.Parent != null)
1235 if (ImageList != null)
1236 l -= ImageList.ImageSize.Width + 3;
1239 // StateImage is basically a custom checkbox
1240 else if (node.StateImage != null)
1242 return (x > l && x < l + 8);
1245 private bool IsCheckboxArea (TreeNode node, int x)
1247 int l = CheckBoxLeft (node);
1248 return (x > l && x < l + 10);
1251 private bool IsImage (TreeNode node, int x)
1253 if (ImageList == null)
1256 int l = node.Bounds.Left;
1258 l -= ImageList.ImageSize.Width + 5;
1260 if (x >= l && x <= (l + ImageList.ImageSize.Width + 5))
1266 private int CheckBoxLeft (TreeNode node)
1268 int l = node.Bounds.Left + 5;
1270 if (show_root_lines || node.Parent != null)
1273 if (!show_root_lines && node.Parent == null)
1276 if (ImageList != null)
1277 l -= ImageList.ImageSize.Width + 3;
1282 internal void RecalculateVisibleOrder (TreeNode start)
1284 if (update_stack > 0)
1288 if (start == null) {
1292 order = start.visible_order;
1296 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (start);
1297 while (walk.MoveNext ()) {
1298 walk.CurrentNode.visible_order = order;
1302 max_visible_order = order;
1305 internal void SetTop (TreeNode node)
1309 order = Math.Max (0, node.visible_order - 1);
1311 if (!vbar.is_visible) {
1312 skipped_nodes = order;
1316 SetVScrollValue (Math.Min (order, vbar.Maximum - VisibleCount + 1));
1319 internal void SetBottom (TreeNode node)
1321 if (!vbar.is_visible)
1324 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (node);
1326 int bottom = ViewportRectangle.Bottom;
1328 while (walk.MovePrevious ()) {
1329 if (walk.CurrentNode.Bounds.Bottom <= bottom)
1334 int nv = vbar.Value + offset;
1335 if (vbar.Value + offset < vbar.Maximum) {
1336 SetVScrollValue (nv);
1339 Console.Error.WriteLine ("setting bottom to value greater then maximum ({0}, {1})",
1346 internal void UpdateBelow (TreeNode node)
1348 if (update_stack > 0) {
1349 update_needed = true;
1353 if (node == root_node) {
1354 Invalidate (ViewportRectangle);
1358 // We need to update the current node so the plus/minus block gets update too
1359 int top = Math.Max (node.Bounds.Top - 1, 0);
1360 Rectangle invalid = new Rectangle (0, top,
1361 Width, Height - top);
1362 Invalidate (invalid);
1365 internal void UpdateNode (TreeNode node)
1370 if (update_stack > 0) {
1371 update_needed = true;
1375 if (node == root_node) {
1380 Rectangle invalid = new Rectangle (0, node.Bounds.Top - 1, Width,
1381 node.Bounds.Height + 1);
1382 Invalidate (invalid);
1385 internal void UpdateNodePlusMinus (TreeNode node)
1387 if (update_stack > 0) {
1388 update_needed = true;
1392 int l = node.Bounds.Left + 5;
1394 if (show_root_lines || node.Parent != null)
1396 if (ImageList != null)
1397 l -= ImageList.ImageSize.Width + 3;
1401 Invalidate (new Rectangle (l, node.Bounds.Top, 8, node.Bounds.Height));
1404 internal override void OnPaintInternal (PaintEventArgs pe)
1406 Draw (pe.ClipRectangle, pe.Graphics);
1409 internal void CreateDashPen ()
1411 dash = new Pen (LineColor, 1);
1412 dash.DashStyle = DashStyle.Dot;
1415 private void Draw (Rectangle clip, Graphics dc)
1417 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (BackColor), clip);
1422 Rectangle viewport = ViewportRectangle;
1423 Rectangle original_clip = clip;
1424 if (clip.Bottom > viewport.Bottom)
1425 clip.Height = viewport.Bottom - clip.Top;
1427 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (TopNode);
1428 while (walk.MoveNext ()) {
1429 TreeNode current = walk.CurrentNode;
1431 // Haven't gotten to visible nodes yet
1432 if (current.GetY () + ActualItemHeight < clip.Top)
1435 // Past the visible nodes
1436 if (current.GetY () > clip.Bottom)
1439 DrawTreeNode (current, dc, clip);
1442 if (hbar.Visible && vbar.Visible) {
1443 Rectangle corner = new Rectangle (hbar.Right, vbar.Bottom, vbar.Width, hbar.Height);
1444 if (original_clip.IntersectsWith (corner))
1445 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (ThemeEngine.Current.ColorControl),
1450 private void DrawNodeState (TreeNode node, Graphics dc, int x, int y)
1453 if (StateImageList.Images[1] != null)
1454 dc.DrawImage (StateImageList.Images[1], new Rectangle (x, y, 16, 16));
1456 if (StateImageList.Images[0] != null)
1457 dc.DrawImage (StateImageList.Images[0], new Rectangle (x, y, 16, 16));
1461 private void DrawNodeCheckBox (TreeNode node, Graphics dc, int x, int middle)
1463 Pen pen = ThemeEngine.Current.ResPool.GetSizedPen(Color.Black, 2);
1464 dc.DrawRectangle (pen, x + 3, middle - 4, 11, 11);
1467 Pen check_pen = ThemeEngine.Current.ResPool.GetPen(Color.Black);
1472 Rectangle rect = new Rectangle (x + 4, middle - 3, check_size, check_size);
1474 for (int i = 0; i < lineWidth; i++) {
1475 dc.DrawLine (check_pen, rect.Left + 1, rect.Top + lineWidth + i, rect.Left + 3, rect.Top + 5 + i);
1476 dc.DrawLine (check_pen, rect.Left + 3, rect.Top + 5 + i, rect.Left + 7, rect.Top + 1 + i);
1481 private void DrawNodeLines (TreeNode node, Graphics dc, Rectangle clip, Pen dash, int x, int y, int middle)
1486 if (node.nodes.Count > 0 && show_plus_minus)
1491 if (show_root_lines || node.Parent != null)
1492 dc.DrawLine (dash, x - indent + ladjust, middle, x + radjust, middle);
1494 if (node.PrevNode != null || node.Parent != null) {
1496 dc.DrawLine (dash, x - indent + ladjust, node.Bounds.Top,
1497 x - indent + ladjust, middle - (show_plus_minus && node.Nodes.Count > 0 ? 4 : 0));
1500 if (node.NextNode != null) {
1502 dc.DrawLine (dash, x - indent + ladjust, middle + (show_plus_minus && node.Nodes.Count > 0 ? 4 : 0),
1503 x - indent + ladjust, node.Bounds.Bottom);
1508 if (show_plus_minus)
1510 TreeNode parent = node.Parent;
1511 while (parent != null) {
1512 if (parent.NextNode != null) {
1513 int px = parent.GetLinesX () - indent + ladjust;
1514 dc.DrawLine (dash, px, node.Bounds.Top, px, node.Bounds.Bottom);
1516 parent = parent.Parent;
1520 private void DrawNodeImage (TreeNode node, Graphics dc, Rectangle clip, int x, int y)
1522 if (!RectsIntersect (clip, x, y, ImageList.ImageSize.Width, ImageList.ImageSize.Height))
1525 int use_index = node.Image;
1527 if (use_index > -1 && use_index < ImageList.Images.Count)
1528 ImageList.Draw (dc, x, y, ImageList.ImageSize.Width, ImageList.ImageSize.Height, use_index);
1531 private void LabelEditFinished (object sender, EventArgs e)
1533 EndEdit (edit_node);
1536 internal void BeginEdit (TreeNode node)
1538 if (edit_node != null)
1539 EndEdit (edit_node);
1541 if (edit_text_box == null) {
1542 edit_text_box = new LabelEditTextBox ();
1543 edit_text_box.BorderStyle = BorderStyle.FixedSingle;
1544 edit_text_box.Visible = false;
1545 edit_text_box.EditingCancelled += new EventHandler (LabelEditCancelled);
1546 edit_text_box.EditingFinished += new EventHandler (LabelEditFinished);
1547 edit_text_box.TextChanged += new EventHandler (LabelTextChanged);
1548 Controls.Add (edit_text_box);
1551 node.EnsureVisible ();
1553 edit_text_box.Bounds = node.Bounds;
1554 edit_text_box.Text = node.Text;
1555 edit_text_box.Visible = true;
1556 edit_text_box.Focus ();
1557 edit_text_box.SelectAll ();
1559 edit_args = new NodeLabelEditEventArgs (node);
1560 OnBeforeLabelEdit (edit_args);
1564 if (edit_args.CancelEdit) {
1570 private void LabelEditCancelled (object sender, EventArgs e)
1572 edit_args.SetLabel (null);
1573 EndEdit (edit_node);
1576 private void LabelTextChanged (object sender, EventArgs e)
1578 int width = TextRenderer.MeasureTextInternal (edit_text_box.Text, edit_text_box.Font, false).Width + 4;
1579 edit_text_box.Width = width;
1581 if (edit_args != null)
1582 edit_args.SetLabel (edit_text_box.Text);
1585 internal void EndEdit (TreeNode node)
1587 if (edit_text_box != null && edit_text_box.Visible) {
1588 edit_text_box.Visible = false;
1593 // If we get a call to BeginEdit from any AfterLabelEdit handler,
1594 // the focus seems to always remain in the TreeView. This call seems
1595 // to synchronize the focus events - I don't like it but it works
1597 Application.DoEvents ();
1599 if (edit_node != null && edit_node == node) {
1602 NodeLabelEditEventArgs e = new NodeLabelEditEventArgs (edit_args.Node, edit_args.Label);
1604 OnAfterLabelEdit (e);
1609 if (e.Label != null)
1610 e.Node.Text = e.Label;
1613 // EndEdit ends editing even if not called on the editing node
1618 internal void CancelEdit (TreeNode node)
1620 edit_args.SetLabel (null);
1622 if (edit_text_box != null && edit_text_box.Visible) {
1623 edit_text_box.Visible = false;
1631 internal int GetNodeWidth (TreeNode node)
1633 Font font = node.NodeFont;
1634 if (node.NodeFont == null)
1636 return (int)TextRenderer.MeasureString (node.Text, font, 0, string_format).Width + 3;
1639 private void DrawSelectionAndFocus(TreeNode node, Graphics dc, Rectangle r)
1641 if (Focused && focused_node == node && !full_row_select) {
1642 ControlPaint.DrawFocusRectangle (dc, r, ForeColor, BackColor);
1644 if (draw_mode != TreeViewDrawMode.Normal)
1649 if (Focused && node == highlighted_node) {
1650 // Use the node's BackColor if is not empty, and is not actually the selected one (yet)
1651 Color back_color = node != selected_node && node.BackColor != Color.Empty ? node.BackColor :
1652 ThemeEngine.Current.ColorHighlight;
1653 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (back_color), r);
1655 } else if (!hide_selection && node == highlighted_node) {
1656 dc.FillRectangle (SystemBrushes.Control, r);
1658 // If selected_node is not the current highlighted one, use the color of the TreeView
1659 Color back_color = node == selected_node ? BackColor : node.BackColor;
1660 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (back_color), r);
1664 private void DrawStaticNode (TreeNode node, Graphics dc)
1666 if (!full_row_select || show_lines)
1667 DrawSelectionAndFocus(node, dc, node.Bounds);
1670 Font font = node.NodeFont;
1671 if (node.NodeFont == null)
1673 Color text_color = (Focused && node == highlighted_node ?
1674 ThemeEngine.Current.ColorHighlightText : node.ForeColor);
1675 if (text_color.IsEmpty)
1676 text_color = ForeColor;
1677 dc.DrawString (node.Text, font,
1678 ThemeEngine.Current.ResPool.GetSolidBrush (text_color),
1679 node.Bounds, string_format);
1682 private void DrawTreeNode (TreeNode node, Graphics dc, Rectangle clip)
1684 int child_count = node.nodes.Count;
1685 int y = node.GetY ();
1686 int middle = y + (ActualItemHeight / 2);
1688 if (full_row_select && !show_lines) {
1689 Rectangle r = new Rectangle (1, y, ViewportRectangle.Width - 2, ActualItemHeight);
1690 DrawSelectionAndFocus (node, dc, r);
1693 if (draw_mode == TreeViewDrawMode.Normal || draw_mode == TreeViewDrawMode.OwnerDrawText) {
1694 if ((show_root_lines || node.Parent != null) && show_plus_minus && child_count > 0)
1695 ThemeEngine.Current.TreeViewDrawNodePlusMinus (this, node, dc, node.GetLinesX () - Indent + 5, middle);
1697 if (checkboxes && state_image_list == null)
1698 DrawNodeCheckBox (node, dc, CheckBoxLeft (node) - 3, middle);
1700 if (checkboxes && state_image_list != null)
1701 DrawNodeState (node, dc, CheckBoxLeft (node) - 3, y);
1703 if (!checkboxes && node.StateImage != null)
1704 dc.DrawImage (node.StateImage, new Rectangle (CheckBoxLeft (node) - 3, y, 16, 16));
1707 DrawNodeLines (node, dc, clip, dash, node.GetLinesX (), y, middle);
1709 if (ImageList != null)
1710 DrawNodeImage (node, dc, clip, node.GetImageX (), y);
1713 if (draw_mode != TreeViewDrawMode.Normal) {
1714 dc.FillRectangle (Brushes.White, node.Bounds);
1715 TreeNodeStates tree_node_state = TreeNodeStates.Default;;
1716 if (node.IsSelected)
1717 tree_node_state = TreeNodeStates.Selected;
1719 tree_node_state |= TreeNodeStates.Checked;
1720 if (node == focused_node)
1721 tree_node_state |= TreeNodeStates.Focused;
1722 Rectangle node_bounds = node.Bounds;
1723 if (draw_mode == TreeViewDrawMode.OwnerDrawText) {
1728 node_bounds.Width = Width;
1731 DrawTreeNodeEventArgs e = new DrawTreeNodeEventArgs (dc, node, node_bounds, tree_node_state);
1738 if (!node.IsEditing)
1739 DrawStaticNode (node, dc);
1742 internal void UpdateScrollBars (bool force)
1744 if (!force && (IsDisposed || update_stack > 0 || !IsHandleCreated || !Visible))
1752 int item_height = ActualItemHeight;
1754 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (root_node);
1756 while (walk.MoveNext ()) {
1757 int r = walk.CurrentNode.Bounds.Right;
1761 height += item_height;
1764 height -= item_height; // root_node adjustment
1765 width += hbar_offset;
1767 if (height > ClientRectangle.Height) {
1770 if (width > ClientRectangle.Width - SystemInformation.VerticalScrollBarWidth)
1772 } else if (width > ClientRectangle.Width) {
1776 if (!vert && horz && height > ClientRectangle.Height - SystemInformation.HorizontalScrollBarHeight)
1781 int visible_height = horz ? ClientRectangle.Height - hbar.Height : ClientRectangle.Height;
1782 vbar.SetValues (Math.Max (0, max_visible_order - 2), visible_height / ActualItemHeight);
1784 vbar.Maximum = max_visible_order;
1785 vbar.LargeChange = ClientRectangle.Height / ItemHeight;
1788 if (!vbar_bounds_set) {
1789 vbar.Bounds = new Rectangle (ClientRectangle.Width - vbar.Width, 0, vbar.Width,
1790 ClientRectangle.Height -
1791 (horz ? SystemInformation.VerticalScrollBarWidth : 0));
1792 vbar_bounds_set = true;
1794 // We need to recalc the hbar if the vbar is now visible
1795 hbar_bounds_set = false;
1799 vbar.Visible = true;
1800 if (skipped_nodes > 0) {
1801 int skip = Math.Min (skipped_nodes, vbar.Maximum - VisibleCount + 1);
1803 vbar.SafeValueSet (skip);
1804 skipped_nodes = skip;
1808 RecalculateVisibleOrder (root_node);
1809 vbar.Visible = false;
1810 SetVScrollValue (0);
1811 vbar_bounds_set = false;
1815 hbar.SetValues (width + 1, ClientRectangle.Width - (vert ? SystemInformation.VerticalScrollBarWidth : 0));
1817 hbar.LargeChange = ClientRectangle.Width;
1818 hbar.Maximum = width + 1;
1821 if (!hbar_bounds_set) {
1822 hbar.Bounds = new Rectangle (0, ClientRectangle.Height - hbar.Height,
1823 ClientRectangle.Width - (vert ? SystemInformation.VerticalScrollBarWidth : 0),
1825 hbar_bounds_set = true;
1827 hbar.Visible = true;
1830 hbar.Visible = false;
1831 hbar_bounds_set = false;
1835 private void SizeChangedHandler (object sender, EventArgs e)
1837 if (IsHandleCreated) {
1838 if (max_visible_order == -1)
1839 RecalculateVisibleOrder (root_node);
1840 UpdateScrollBars (false);
1844 vbar.Bounds = new Rectangle (ClientRectangle.Width - vbar.Width, 0, vbar.Width,
1845 ClientRectangle.Height - (hbar.Visible ? SystemInformation.HorizontalScrollBarHeight : 0));
1849 hbar.Bounds = new Rectangle (0, ClientRectangle.Height - hbar.Height,
1850 ClientRectangle.Width - (vbar.Visible ? SystemInformation.VerticalScrollBarWidth : 0), hbar.Height);
1854 private void VScrollBarValueChanged (object sender, EventArgs e)
1856 EndEdit (edit_node);
1858 SetVScrollPos (vbar.Value, null);
1861 private void SetVScrollPos (int pos, TreeNode new_top)
1863 if (!vbar.VisibleInternal)
1869 if (skipped_nodes == pos)
1872 int diff = skipped_nodes - pos;
1873 skipped_nodes = pos;
1875 if (!IsHandleCreated)
1878 int y_move = diff * ActualItemHeight;
1879 XplatUI.ScrollWindow (Handle, ViewportRectangle, 0, y_move, false);
1882 /*private void SetVScrollTop (TreeNode new_top)
1884 vbar.Value = new_top.visible_order - VisibleCount;
1887 private void HScrollBarValueChanged(object sender, EventArgs e)
1889 EndEdit (edit_node);
1891 int old_offset = hbar_offset;
1892 hbar_offset = hbar.Value;
1894 if (hbar_offset < 0) {
1898 XplatUI.ScrollWindow (Handle, ViewportRectangle, old_offset - hbar_offset, 0, false);
1901 internal void ExpandBelow (TreeNode node, int count_to_next)
1903 if (update_stack > 0) {
1904 update_needed = true;
1908 // If node Bottom is less than 0, the node is above and not visible,
1909 // and we need to scroll the entire viewport
1910 int node_bottom = node.Bounds.Bottom >= 0 ? node.Bounds.Bottom : 0;
1911 Rectangle below = new Rectangle (0, node_bottom, ViewportRectangle.Width,
1912 ViewportRectangle.Height - node_bottom);
1914 int amount = count_to_next * ActualItemHeight;
1917 XplatUI.ScrollWindow (Handle, below, 0, amount, false);
1919 if (show_plus_minus) {
1920 Invalidate (new Rectangle (0, node.GetY (), Width, ActualItemHeight));
1924 internal void CollapseBelow (TreeNode node, int count_to_next)
1926 if (update_stack > 0) {
1927 update_needed = true;
1931 Rectangle below = new Rectangle (0, node.Bounds.Bottom, ViewportRectangle.Width,
1932 ViewportRectangle.Height - node.Bounds.Bottom);
1934 int amount = count_to_next * ActualItemHeight;
1937 XplatUI.ScrollWindow (Handle, below, 0, -amount, false);
1939 if (show_plus_minus) {
1940 Invalidate (new Rectangle (0, node.GetY (), Width, ActualItemHeight));
1944 private void MouseWheelHandler(object sender, MouseEventArgs e) {
1946 if (vbar == null || !vbar.is_visible) {
1951 SetVScrollValue (Math.Min (vbar.Value + SystemInformation.MouseWheelScrollLines, vbar.Maximum - VisibleCount + 1));
1953 SetVScrollValue (Math.Max (0, vbar.Value - SystemInformation.MouseWheelScrollLines));
1957 private void VisibleChangedHandler (object sender, EventArgs e)
1960 UpdateScrollBars (false);
1964 private void FontChangedHandler (object sender, EventArgs e)
1966 if (IsHandleCreated) {
1967 TreeNode top = TopNode;
1968 InvalidateNodeWidthRecursive (root_node);
1974 private void InvalidateNodeWidthRecursive (TreeNode node)
1976 node.InvalidateWidth ();
1977 foreach (TreeNode child in node.Nodes) {
1978 InvalidateNodeWidthRecursive (child);
1982 private void GotFocusHandler (object sender, EventArgs e)
1984 if (selected_node == null) {
1985 if (pre_selected_node != null) {
1986 SelectedNode = pre_selected_node;
1990 SelectedNode = TopNode;
1992 } else if (selected_node != null)
1993 UpdateNode (selected_node);
1996 private void LostFocusHandler (object sender, EventArgs e)
1998 UpdateNode (SelectedNode);
2001 private void MouseDownHandler (object sender, MouseEventArgs e)
2003 if (e.Button == MouseButtons.Right)
2006 TreeNode node = GetNodeAt (e.Y);
2010 mouse_click_node = node;
2012 if (show_plus_minus && IsPlusMinusArea (node, e.X) && e.Button == MouseButtons.Left) {
2015 } else if (checkboxes && IsCheckboxArea (node, e.X) && e.Button == MouseButtons.Left) {
2016 node.check_reason = TreeViewAction.ByMouse;
2017 node.Checked = !node.Checked;
2020 } else if (IsSelectableArea (node, e.X) || full_row_select) {
2021 TreeNode old_highlighted = highlighted_node;
2022 highlighted_node = node;
2023 if (label_edit && e.Clicks == 1 && highlighted_node == old_highlighted && e.Button == MouseButtons.Left) {
2025 } else if (highlighted_node != focused_node) {
2026 Size ds = SystemInformation.DragSize;
2027 mouse_rect.X = e.X - ds.Width;
2028 mouse_rect.Y = e.Y - ds.Height;
2029 mouse_rect.Width = ds.Width * 2;
2030 mouse_rect.Height = ds.Height * 2;
2032 select_mmove = true;
2035 Invalidate (highlighted_node.Bounds);
2036 if (old_highlighted != null)
2037 Invalidate (Bloat (old_highlighted.Bounds));
2044 private void MouseUpHandler (object sender, MouseEventArgs e) {
2045 TreeNode node = GetNodeAt (e.Y);
2047 if (node != null && node == mouse_click_node) {
2049 OnNodeMouseDoubleClick (new TreeNodeMouseClickEventArgs (node, e.Button, e.Clicks, e.X, e.Y));
2051 OnNodeMouseClick (new TreeNodeMouseClickEventArgs (node, e.Button, e.Clicks, e.X, e.Y));
2054 mouse_click_node = null;
2062 select_mmove = false;
2064 if (e.Button == MouseButtons.Right && selected_node != null) {
2065 Invalidate (highlighted_node.Bounds);
2066 highlighted_node = selected_node;
2067 Invalidate (selected_node.Bounds);
2071 TreeViewCancelEventArgs ce = new TreeViewCancelEventArgs (highlighted_node, false, TreeViewAction.ByMouse);
2072 OnBeforeSelect (ce);
2076 TreeNode prev_focused_node = focused_node;
2077 TreeNode prev_highlighted_node = highlighted_node;
2079 selected_node = highlighted_node;
2080 focused_node = highlighted_node;
2081 OnAfterSelect (new TreeViewEventArgs (selected_node, TreeViewAction.ByMouse));
2083 if (prev_highlighted_node != null) {
2084 if (prev_focused_node != null) {
2085 invalid = Rectangle.Union (Bloat (prev_focused_node.Bounds),
2086 Bloat (prev_highlighted_node.Bounds));
2088 invalid = Bloat (prev_highlighted_node.Bounds);
2092 invalid.Width = ViewportRectangle.Width;
2094 Invalidate (invalid);
2098 if (highlighted_node != null)
2099 Invalidate (highlighted_node.Bounds);
2101 highlighted_node = focused_node;
2102 selected_node = focused_node;
2103 if (selected_node != null)
2104 Invalidate (selected_node.Bounds);
2108 private void MouseMoveHandler (object sender, MouseEventArgs e) {
2109 // XXX - This should use HitTest and only fire when we are over
2110 // the important parts of a node, not things like gridlines or
2112 TreeNode tn = GetNodeAt (e.Location);
2114 if (tn != tooltip_currently_showing)
2115 MouseLeftItem (tooltip_currently_showing);
2117 if (tn != null && tn != tooltip_currently_showing)
2118 MouseEnteredItem (tn);
2120 if (e.Button == MouseButtons.Left || e.Button == MouseButtons.Right) {
2121 if (drag_begin_x != -1 && drag_begin_y != -1) {
2122 double rise = Math.Pow (drag_begin_x - e.X, 2);
2123 double run = Math.Pow (drag_begin_y - e.Y, 2);
2124 double move = Math.Sqrt (rise + run);
2126 TreeNode drag = GetNodeAtUseX (e.X, e.Y);
2129 OnItemDrag (new ItemDragEventArgs (e.Button, drag));
2138 // If there is enough movement before the mouse comes up,
2139 // selection is reverted back to the originally selected node
2140 if (!select_mmove || mouse_rect.Contains (e.X, e.Y))
2143 Invalidate (highlighted_node.Bounds);
2144 if (selected_node != null)
2145 Invalidate (selected_node.Bounds);
2146 if (focused_node != null)
2147 Invalidate (focused_node.Bounds);
2149 highlighted_node = selected_node;
2150 focused_node = selected_node;
2152 select_mmove = false;
2155 private void DoubleClickHandler (object sender, MouseEventArgs e) {
2156 TreeNode node = GetNodeAtUseX (e.X,e.Y);
2157 if(node != null && node.Nodes.Count > 0) {
2163 private bool RectsIntersect (Rectangle r, int left, int top, int width, int height)
2165 return !((r.Left > left + width) || (r.Right < left) ||
2166 (r.Top > top + height) || (r.Bottom < top));
2169 // Return true if message was handled, false to send it to base
2170 private bool WmContextMenu (ref Message m)
2175 pt = new Point (LowOrder ((int)m.LParam.ToInt32 ()), HighOrder ((int)m.LParam.ToInt32 ()));
2177 // This means it's a keyboard menu request
2178 if (pt.X == -1 || pt.Y == -1) {
2184 pt = new Point (tn.Bounds.Left, tn.Bounds.Top + (tn.Bounds.Height / 2));
2186 pt = PointToClient (pt);
2188 tn = GetNodeAt (pt);
2194 // At this point, we have a valid TreeNode
2195 if (tn.ContextMenu != null) {
2196 tn.ContextMenu.Show (this, pt);
2198 } else if (tn.ContextMenuStrip != null) {
2199 tn.ContextMenuStrip.Show (this, pt);
2203 // The node we found did not have its own menu, let the parent try to display its menu
2207 #region Stuff for ToolTips
2208 private void MouseEnteredItem (TreeNode item)
2210 tooltip_currently_showing = item;
2215 if (ShowNodeToolTips && !string.IsNullOrEmpty (tooltip_currently_showing.ToolTipText))
2216 ToolTipWindow.Present (this, tooltip_currently_showing.ToolTipText);
2218 OnNodeMouseHover (new TreeNodeMouseHoverEventArgs (tooltip_currently_showing));
2221 private void MouseLeftItem (TreeNode item)
2223 ToolTipWindow.Hide (this);
2224 tooltip_currently_showing = null;
2227 private ToolTip ToolTipWindow {
2229 if (tooltip_window == null)
2230 tooltip_window = new ToolTip ();
2232 return tooltip_window;
2237 #endregion // Internal & Private Methods and Properties
2240 static object ItemDragEvent = new object ();
2241 static object AfterCheckEvent = new object ();
2242 static object AfterCollapseEvent = new object ();
2243 static object AfterExpandEvent = new object ();
2244 static object AfterLabelEditEvent = new object ();
2245 static object AfterSelectEvent = new object ();
2246 static object BeforeCheckEvent = new object ();
2247 static object BeforeCollapseEvent = new object ();
2248 static object BeforeExpandEvent = new object ();
2249 static object BeforeLabelEditEvent = new object ();
2250 static object BeforeSelectEvent = new object ();
2251 static object DrawNodeEvent = new object ();
2252 static object NodeMouseClickEvent = new object ();
2253 static object NodeMouseDoubleClickEvent = new object();
2254 static object NodeMouseHoverEvent = new object ();
2255 static object RightToLeftLayoutChangedEvent = new object ();
2257 public event ItemDragEventHandler ItemDrag {
2258 add { Events.AddHandler (ItemDragEvent, value); }
2259 remove { Events.RemoveHandler (ItemDragEvent, value); }
2262 public event TreeViewEventHandler AfterCheck {
2263 add { Events.AddHandler (AfterCheckEvent, value); }
2264 remove { Events.RemoveHandler (AfterCheckEvent, value); }
2267 public event TreeViewEventHandler AfterCollapse {
2268 add { Events.AddHandler (AfterCollapseEvent, value); }
2269 remove { Events.RemoveHandler (AfterCollapseEvent, value); }
2272 public event TreeViewEventHandler AfterExpand {
2273 add { Events.AddHandler (AfterExpandEvent, value); }
2274 remove { Events.RemoveHandler (AfterExpandEvent, value); }
2277 public event NodeLabelEditEventHandler AfterLabelEdit {
2278 add { Events.AddHandler (AfterLabelEditEvent, value); }
2279 remove { Events.RemoveHandler (AfterLabelEditEvent, value); }
2282 public event TreeViewEventHandler AfterSelect {
2283 add { Events.AddHandler (AfterSelectEvent, value); }
2284 remove { Events.RemoveHandler (AfterSelectEvent, value); }
2287 public event TreeViewCancelEventHandler BeforeCheck {
2288 add { Events.AddHandler (BeforeCheckEvent, value); }
2289 remove { Events.RemoveHandler (BeforeCheckEvent, value); }
2292 public event TreeViewCancelEventHandler BeforeCollapse {
2293 add { Events.AddHandler (BeforeCollapseEvent, value); }
2294 remove { Events.RemoveHandler (BeforeCollapseEvent, value); }
2297 public event TreeViewCancelEventHandler BeforeExpand {
2298 add { Events.AddHandler (BeforeExpandEvent, value); }
2299 remove { Events.RemoveHandler (BeforeExpandEvent, value); }
2302 public event NodeLabelEditEventHandler BeforeLabelEdit {
2303 add { Events.AddHandler (BeforeLabelEditEvent, value); }
2304 remove { Events.RemoveHandler (BeforeLabelEditEvent, value); }
2307 public event TreeViewCancelEventHandler BeforeSelect {
2308 add { Events.AddHandler (BeforeSelectEvent, value); }
2309 remove { Events.RemoveHandler (BeforeSelectEvent, value); }
2312 public event DrawTreeNodeEventHandler DrawNode {
2313 add { Events.AddHandler (DrawNodeEvent, value); }
2314 remove { Events.RemoveHandler (DrawNodeEvent, value); }
2317 public event TreeNodeMouseClickEventHandler NodeMouseClick {
2318 add { Events.AddHandler (NodeMouseClickEvent, value); }
2319 remove { Events.RemoveHandler (NodeMouseClickEvent, value); }
2323 public event TreeNodeMouseClickEventHandler NodeMouseDoubleClick {
2324 add { Events.AddHandler (NodeMouseDoubleClickEvent, value); }
2325 remove { Events.RemoveHandler (NodeMouseDoubleClickEvent, value); }
2328 public event TreeNodeMouseHoverEventHandler NodeMouseHover {
2329 add { Events.AddHandler (NodeMouseHoverEvent, value); }
2330 remove { Events.RemoveHandler (NodeMouseHoverEvent, value); }
2333 public event EventHandler RightToLeftLayoutChanged {
2334 add { Events.AddHandler (RightToLeftLayoutChangedEvent, value); }
2335 remove { Events.RemoveHandler (RightToLeftLayoutChangedEvent, value); }
2339 [EditorBrowsable (EditorBrowsableState.Never)]
2340 public new event EventHandler BackgroundImageChanged {
2341 add { base.BackgroundImageChanged += value; }
2342 remove { base.BackgroundImageChanged -= value; }
2346 [EditorBrowsable (EditorBrowsableState.Never)]
2347 public new event EventHandler BackgroundImageLayoutChanged {
2348 add { base.BackgroundImageLayoutChanged += value; }
2349 remove { base.BackgroundImageLayoutChanged -= value; }
2353 [EditorBrowsable (EditorBrowsableState.Never)]
2354 public new event EventHandler PaddingChanged {
2355 add { base.PaddingChanged += value; }
2356 remove { base.PaddingChanged -= value; }
2359 [EditorBrowsable (EditorBrowsableState.Never)]
2361 public new event PaintEventHandler Paint {
2362 add { base.Paint += value; }
2363 remove { base.Paint -= value; }
2366 [EditorBrowsable (EditorBrowsableState.Never)]
2368 public new event EventHandler TextChanged {
2369 add { base.TextChanged += value; }
2370 remove { base.TextChanged -= value; }
2373 #region UIA Framework Events
2374 static object UIACheckBoxesChangedEvent = new object ();
2376 internal event EventHandler UIACheckBoxesChanged {
2377 add { Events.AddHandler (UIACheckBoxesChangedEvent, value); }
2378 remove { Events.RemoveHandler (UIACheckBoxesChangedEvent, value); }
2381 internal void OnUIACheckBoxesChanged (EventArgs e)
2383 EventHandler eh = (EventHandler) Events [UIACheckBoxesChangedEvent];
2388 static object UIALabelEditChangedEvent = new object ();
2390 internal event EventHandler UIALabelEditChanged {
2391 add { Events.AddHandler (UIALabelEditChangedEvent, value); }
2392 remove { Events.RemoveHandler (UIALabelEditChangedEvent, value); }
2395 internal void OnUIALabelEditChanged (EventArgs e)
2397 EventHandler eh = (EventHandler) Events [UIALabelEditChangedEvent];
2402 static object UIANodeTextChangedEvent = new object ();
2404 internal event TreeViewEventHandler UIANodeTextChanged {
2405 add { Events.AddHandler (UIANodeTextChangedEvent, value); }
2406 remove { Events.RemoveHandler (UIANodeTextChangedEvent, value); }
2409 internal void OnUIANodeTextChanged (TreeViewEventArgs e)
2411 TreeViewEventHandler eh =
2412 (TreeViewEventHandler) Events [UIANodeTextChangedEvent];
2417 static object UIACollectionChangedEvent = new object ();
2419 internal event CollectionChangeEventHandler UIACollectionChanged {
2420 add { Events.AddHandler (UIACollectionChangedEvent, value); }
2421 remove { Events.RemoveHandler (UIACollectionChangedEvent, value); }
2424 internal void OnUIACollectionChanged (object sender, CollectionChangeEventArgs e)
2426 CollectionChangeEventHandler eh =
2427 (CollectionChangeEventHandler) Events [UIACollectionChangedEvent];
2429 if (sender == root_node)
2434 #endregion // UIA Framework Events
2435 #endregion // Events