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 {
37 [Docking (DockingBehavior.Ask)]
38 [ClassInterface (ClassInterfaceType.AutoDispatch)]
40 [DefaultProperty("Nodes")]
41 [DefaultEvent("AfterSelect")]
42 [Designer("System.Windows.Forms.Design.TreeViewDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
43 public class TreeView : Control {
45 private string path_separator = "\\";
46 private int item_height = -1;
48 internal TreeNode root_node;
49 internal bool nodes_added;
50 private TreeNodeCollection nodes;
52 private TreeViewAction selection_action;
53 internal TreeNode selected_node;
54 private TreeNode pre_selected_node;
55 private TreeNode focused_node;
56 internal TreeNode highlighted_node;
57 private Rectangle mouse_rect;
58 private bool select_mmove;
60 private ImageList image_list;
61 private int image_index = -1;
62 private int selected_image_index = -1;
65 private string image_key;
66 private bool is_hovering;
67 private TreeNode mouse_click_node;
68 private bool right_to_left_layout;
69 private string selected_image_key;
70 private bool show_node_tool_tips;
71 private ImageList state_image_list;
72 private TreeNode tooltip_currently_showing;
73 private ToolTip tooltip_window;
75 private bool full_row_select;
76 private bool hot_tracking;
77 private int indent = 19;
79 private NodeLabelEditEventArgs edit_args;
80 private LabelEditTextBox edit_text_box;
81 internal TreeNode edit_node;
83 private bool checkboxes;
84 private bool label_edit;
85 private bool scrollable = true;
86 private bool show_lines = true;
87 private bool show_root_lines = true;
88 private bool show_plus_minus = true;
89 private bool hide_selection = true;
91 private int max_visible_order = -1;
92 private VScrollBar vbar;
93 private HScrollBar hbar;
94 private bool vbar_bounds_set;
95 private bool hbar_bounds_set;
96 internal int skipped_nodes;
97 internal int hbar_offset;
99 private int update_stack;
100 private bool update_needed;
103 private Color line_color;
104 private StringFormat string_format;
106 private int drag_begin_x = -1;
107 private int drag_begin_y = -1;
108 private long handle_count = 1;
110 private TreeViewDrawMode draw_mode;
113 IComparer tree_view_node_sorter;
117 #region Public Constructors
120 vbar = new ImplicitVScrollBar ();
121 hbar = new ImplicitHScrollBar ();
123 InternalBorderStyle = BorderStyle.Fixed3D;
124 base.background_color = ThemeEngine.Current.ColorWindow;
125 base.foreground_color = ThemeEngine.Current.ColorWindowText;
127 root_node = new TreeNode (this);
128 root_node.Text = "ROOT NODE";
129 nodes = new TreeNodeCollection (root_node);
130 root_node.SetNodes (nodes);
132 MouseDown += new MouseEventHandler (MouseDownHandler);
133 MouseUp += new MouseEventHandler(MouseUpHandler);
134 MouseMove += new MouseEventHandler(MouseMoveHandler);
135 SizeChanged += new EventHandler (SizeChangedHandler);
136 FontChanged += new EventHandler (FontChangedHandler);
137 LostFocus += new EventHandler (LostFocusHandler);
138 GotFocus += new EventHandler (GotFocusHandler);
139 MouseWheel += new MouseEventHandler(MouseWheelHandler);
140 VisibleChanged += new EventHandler (VisibleChangedHandler);
142 SetStyle (ControlStyles.UserPaint | ControlStyles.StandardClick
144 | ControlStyles.UseTextForAccessibility
148 string_format = new StringFormat ();
149 string_format.LineAlignment = StringAlignment.Center;
150 string_format.Alignment = StringAlignment.Center;
152 vbar.Visible = false;
153 hbar.Visible = false;
154 vbar.ValueChanged += new EventHandler (VScrollBarValueChanged);
155 hbar.ValueChanged += new EventHandler (HScrollBarValueChanged);
158 Controls.AddImplicit (vbar);
159 Controls.AddImplicit (hbar);
163 #endregion // Public Constructors
165 #region Public Instance Properties
166 public override Color BackColor {
167 get { return base.BackColor;}
169 base.BackColor = value;
178 [EditorBrowsable(EditorBrowsableState.Never)]
179 public override Image BackgroundImage {
180 get { return base.BackgroundImage; }
181 set { base.BackgroundImage = value; }
184 [DefaultValue(BorderStyle.Fixed3D)]
186 public BorderStyle BorderStyle {
187 get { return InternalBorderStyle; }
188 set { InternalBorderStyle = value; }
191 [DefaultValue(false)]
192 public bool CheckBoxes {
193 get { return checkboxes; }
195 if (value == checkboxes)
199 // Match a "bug" in the MS implementation where disabling checkboxes
200 // collapses the entire tree, but enabling them does not affect the
201 // state of the tree.
203 root_node.CollapseAllUncheck ();
209 public override Color ForeColor {
210 get { return base.ForeColor; }
211 set { base.ForeColor = value; }
213 [DefaultValue(false)]
214 public bool FullRowSelect {
215 get { return full_row_select; }
217 if (value == full_row_select)
219 full_row_select = value;
224 public bool HideSelection {
225 get { return hide_selection; }
227 if (hide_selection == value)
229 hide_selection = value;
234 [DefaultValue(false)]
235 public bool HotTracking {
236 get { return hot_tracking; }
237 set { hot_tracking = value; }
242 [RelatedImageList ("ImageList")]
243 [RefreshProperties (RefreshProperties.Repaint)]
244 [TypeConverter (typeof (NoneExcludedImageIndexConverter))]
247 [TypeConverter (typeof (TreeViewImageIndexConverter))]
249 [Editor("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
251 public int ImageIndex {
252 get { return image_index; }
255 throw new ArgumentException ("'" + value + "' is not a valid value for 'value'. " +
256 "'value' must be greater than or equal to 0.");
258 if (image_index == value)
266 [RefreshProperties (RefreshProperties.Repaint)]
269 public ImageList ImageList {
270 get { return image_list; }
279 get { return indent; }
284 throw new ArgumentException ("'" + value + "' is not a valid value for 'Indent'. " +
285 "'Indent' must be less than or equal to 32000");
288 throw new ArgumentException ("'" + value + "' is not a valid value for 'Indent'. " +
289 "'Indent' must be greater than or equal to 0.");
299 public int ItemHeight {
301 if (item_height == -1)
302 return FontHeight + 3;
306 if (value == item_height)
313 internal int ActualItemHeight {
315 int res = ItemHeight;
316 if (ImageList != null && ImageList.ImageSize.Height > res)
317 res = ImageList.ImageSize.Height;
322 [DefaultValue(false)]
323 public bool LabelEdit {
324 get { return label_edit; }
325 set { label_edit = value; }
328 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
329 [MergableProperty(false)]
331 public TreeNodeCollection Nodes {
332 get { return nodes; }
337 [EditorBrowsable (EditorBrowsableState.Never)]
338 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
339 public new Padding Padding {
340 get { return base.Padding; }
341 set { base.Padding = value; }
346 public string PathSeparator {
347 get { return path_separator; }
348 set { path_separator = value; }
353 [DefaultValue (false)]
354 public virtual bool RightToLeftLayout {
355 get { return right_to_left_layout; }
357 if (right_to_left_layout != value) {
358 right_to_left_layout = value;
359 OnRightToLeftLayoutChanged (EventArgs.Empty);
366 public bool Scrollable {
367 get { return scrollable; }
369 if (scrollable == value)
372 UpdateScrollBars (false);
378 [RelatedImageList ("ImageList")]
379 [TypeConverter (typeof (NoneExcludedImageIndexConverter))]
382 [TypeConverter (typeof (TreeViewImageIndexConverter))]
384 [Editor("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
386 public int SelectedImageIndex {
387 get { return selected_image_index; }
390 throw new ArgumentException ("'" + value + "' is not a valid value for 'value'. " +
391 "'value' must be greater than or equal to 0.");
393 UpdateNode (SelectedNode);
398 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
399 public TreeNode SelectedNode {
401 if (!IsHandleCreated)
402 return pre_selected_node;
403 return selected_node;
406 if (!IsHandleCreated) {
407 pre_selected_node = value;
411 if (selected_node == value) {
412 selection_action = TreeViewAction.Unknown;
417 TreeViewCancelEventArgs e = new TreeViewCancelEventArgs (value, false, selection_action);
424 Rectangle invalid = Rectangle.Empty;
426 if (selected_node != null) {
427 invalid = Bloat (selected_node.Bounds);
429 if (focused_node != null) {
430 invalid = Rectangle.Union (invalid,
431 Bloat (focused_node.Bounds));
435 invalid = Rectangle.Union (invalid, Bloat (value.Bounds));
437 highlighted_node = value;
438 selected_node = value;
439 focused_node = value;
441 if (full_row_select || draw_mode != TreeViewDrawMode.Normal) {
443 invalid.Width = ViewportRectangle.Width;
446 if (invalid != Rectangle.Empty)
447 Invalidate (invalid);
449 // We ensure its visible after we update because
450 // scrolling is used for insure visible
451 if (selected_node != null)
452 selected_node.EnsureVisible ();
455 OnAfterSelect (new TreeViewEventArgs (value, TreeViewAction.Unknown));
457 selection_action = TreeViewAction.Unknown;
461 private Rectangle Bloat (Rectangle rect)
471 public bool ShowLines {
472 get { return show_lines; }
474 if (show_lines == value)
482 [DefaultValue (false)]
483 public bool ShowNodeToolTips {
484 get { return show_node_tool_tips; }
485 set { show_node_tool_tips = value; }
490 public bool ShowPlusMinus {
491 get { return show_plus_minus; }
493 if (show_plus_minus == value)
495 show_plus_minus = value;
501 public bool ShowRootLines {
502 get { return show_root_lines; }
504 if (show_root_lines == value)
506 show_root_lines = value;
513 [EditorBrowsable (EditorBrowsableState.Never)]
515 [DefaultValue(false)]
517 get { return sorted; }
523 //LAMESPEC: The documentation says that setting this to true should sort alphabetically if TreeViewNodeSorter is set.
524 // There seems to be a bug in the Microsoft implementation.
525 if (sorted && tree_view_node_sorter == null) {
539 [DefaultValue (null)]
540 public ImageList StateImageList {
541 get { return state_image_list; }
543 state_image_list = value;
550 [EditorBrowsable(EditorBrowsableState.Never)]
552 public override string Text {
553 get { return base.Text; }
554 set { base.Text = value; }
558 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
559 public TreeNode TopNode {
561 if (root_node.FirstNode == null)
563 OpenTreeNodeEnumerator one = new OpenTreeNodeEnumerator (root_node.FirstNode);
565 for (int i = 0; i < skipped_nodes; i++)
567 return one.CurrentNode;
578 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
579 public IComparer TreeViewNodeSorter {
581 return tree_view_node_sorter;
584 tree_view_node_sorter = value;
585 if (tree_view_node_sorter != null) {
587 //LAMESPEC: The documentation says that setting this should set Sorted to false.
588 // There seems to be a bug in the Microsoft implementation.
596 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
597 public int VisibleCount {
599 return ViewportRectangle.Height / ActualItemHeight;
604 /// According to MSDN this property has no effect on the treeview
605 [EditorBrowsable (EditorBrowsableState.Never)]
606 protected override bool DoubleBuffered {
607 get { return base.DoubleBuffered; }
608 set { base.DoubleBuffered = value; }
613 [DefaultValue ("Color [Black]")]
620 if (line_color == Color.Empty) {
621 Color res = ControlPaint.Dark (BackColor);
622 if (res == BackColor)
623 res = ControlPaint.Light (BackColor);
639 [RelatedImageList ("ImageList")]
640 [RefreshProperties (RefreshProperties.Repaint)]
641 [TypeConverter (typeof (ImageKeyConverter))]
642 [Editor ("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof (System.Drawing.Design.UITypeEditor))]
643 public string ImageKey {
644 get { return image_key; }
646 if (image_key == value)
656 [RelatedImageList ("ImageList")]
657 [RefreshProperties (RefreshProperties.Repaint)]
658 [TypeConverter (typeof (ImageKeyConverter))]
659 [Editor ("System.Windows.Forms.Design.ImageIndexEditor, " + Consts.AssemblySystem_Design, typeof (System.Drawing.Design.UITypeEditor))]
660 public string SelectedImageKey {
661 get { return selected_image_key; }
663 if (selected_image_key == value)
665 selected_image_index = -1;
666 selected_image_key = value;
667 UpdateNode (SelectedNode);
674 [EditorBrowsable (EditorBrowsableState.Never)]
675 public override ImageLayout BackgroundImageLayout {
676 get { return base.BackgroundImageLayout; }
677 set { base.BackgroundImageLayout = value; }
682 [DefaultValue (TreeViewDrawMode.Normal)]
683 public TreeViewDrawMode DrawMode {
684 get { return draw_mode; }
685 set { draw_mode = value; }
688 #endregion // Public Instance Properties
690 #region Protected Instance Properties
691 protected override CreateParams CreateParams {
693 CreateParams cp = base.CreateParams;
698 protected override Size DefaultSize {
699 get { return new Size (121, 97); }
702 #endregion // Protected Instance Properties
704 #region Public Instance Methods
705 public void BeginUpdate ()
710 public void EndUpdate ()
712 if (update_stack > 1) {
717 RecalculateVisibleOrder (root_node);
718 UpdateScrollBars (false);
719 // if (SelectedNode != null)
720 // SelectedNode.EnsureVisible ();
721 Invalidate (ViewportRectangle);
722 update_needed = false;
730 Sort (Nodes.Count >= 2 ? tree_view_node_sorter : null);
734 void Sort (IComparer sorter)
737 RecalculateVisibleOrder (root_node);
738 UpdateScrollBars (false);
742 public void ExpandAll ()
745 root_node.ExpandAll ();
750 /// Everything below this is basically an emulation of a strange bug on MS
751 /// where they don't always scroll to the last node on ExpandAll
754 if (!IsHandleCreated)
759 foreach (TreeNode child in Nodes) {
760 if (child.Nodes.Count > 0)
767 if (IsHandleCreated && vbar.VisibleInternal) {
768 vbar.Value = vbar.Maximum - VisibleCount + 1;
770 RecalculateVisibleOrder (root_node);
771 UpdateScrollBars (true);
772 SetTop (Nodes [Nodes.Count - 1]);
773 SelectedNode = Nodes [Nodes.Count - 1];
778 public void CollapseAll ()
780 TreeNode walk = TopNode;
782 while (walk.parent != root_node)
786 root_node.CollapseAll ();
792 public TreeNode GetNodeAt (Point pt) {
793 return GetNodeAt (pt.Y);
796 public TreeNode GetNodeAt (int x, int y)
798 return GetNodeAt (y);
801 private TreeNode GetNodeAtUseX (int x, int y) {
802 TreeNode node = GetNodeAt (y);
803 if (node == null || !(IsTextArea (node, x) || full_row_select))
809 public int GetNodeCount (bool includeSubTrees) {
810 return root_node.GetNodeCount (includeSubTrees);
814 public TreeViewHitTestInfo HitTest (Point pt)
816 return HitTest (pt.X, pt.Y);
819 public TreeViewHitTestInfo HitTest (int x, int y)
821 TreeNode n = GetNodeAt (y);
824 return new TreeViewHitTestInfo (null, TreeViewHitTestLocations.None);
826 if (IsTextArea (n, x))
827 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.Label);
828 else if (IsPlusMinusArea (n, x))
829 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.PlusMinus);
830 else if ((checkboxes || n.StateImage != null) && IsCheckboxArea (n, x))
831 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.StateImage);
832 else if (x > n.Bounds.Right)
833 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.RightOfLabel);
834 else if (IsImage (n, x))
835 return new TreeViewHitTestInfo (n, TreeViewHitTestLocations.Image);
837 return new TreeViewHitTestInfo (null, TreeViewHitTestLocations.Indent);
841 public override string ToString () {
842 int count = Nodes.Count;
844 return String.Concat (base.ToString (), "Node Count: 0");
845 return String.Concat (base.ToString (), "Node Count: ", count, " Nodes[0]: ", Nodes [0]);
849 #endregion // Public Instance Methods
851 #region Protected Instance Methods
852 protected override void CreateHandle () {
853 base.CreateHandle ();
854 RecalculateVisibleOrder (root_node);
855 UpdateScrollBars (false);
857 if (pre_selected_node != null)
858 SelectedNode = pre_selected_node;
861 protected override void Dispose (bool disposing) {
865 base.Dispose (disposing);
868 protected OwnerDrawPropertyBag GetItemRenderStyles (TreeNode node, int state) {
869 return node.prop_bag;
872 protected override bool IsInputKey (Keys keyData)
874 if (IsHandleCreated && (keyData & Keys.Alt) == 0) {
875 switch (keyData & Keys.KeyCode) {
887 if (edit_node != null)
893 return base.IsInputKey (keyData);
896 protected override void OnKeyDown (KeyEventArgs e)
898 OpenTreeNodeEnumerator ne;
900 switch (e.KeyData & Keys.KeyCode) {
902 if (selected_node != null && selected_node.IsExpanded)
903 selected_node.Expand ();
906 if (selected_node != null && selected_node.IsExpanded)
907 selected_node.Collapse ();
910 if (selected_node != null) {
911 if (selected_node.IsExpanded && selected_node.Nodes.Count > 0)
912 selected_node.Collapse ();
914 TreeNode parent = selected_node.Parent;
915 if (parent != null) {
916 selection_action = TreeViewAction.ByKeyboard;
917 SelectedNode = parent;
923 if (selected_node != null) {
924 if (!selected_node.IsExpanded)
925 selected_node.Expand ();
927 TreeNode child = selected_node.FirstNode;
929 SelectedNode = child;
934 if (selected_node != null) {
935 ne = new OpenTreeNodeEnumerator (selected_node);
936 if (ne.MovePrevious () && ne.MovePrevious ()) {
937 selection_action = TreeViewAction.ByKeyboard;
938 SelectedNode = ne.CurrentNode;
943 if (selected_node != null) {
944 ne = new OpenTreeNodeEnumerator (selected_node);
945 if (ne.MoveNext () && ne.MoveNext ()) {
946 selection_action = TreeViewAction.ByKeyboard;
947 SelectedNode = ne.CurrentNode;
952 if (root_node.Nodes.Count > 0) {
953 ne = new OpenTreeNodeEnumerator (root_node.Nodes [0]);
954 if (ne.MoveNext ()) {
955 selection_action = TreeViewAction.ByKeyboard;
956 SelectedNode = ne.CurrentNode;
961 if (root_node.Nodes.Count > 0) {
962 ne = new OpenTreeNodeEnumerator (root_node.Nodes [0]);
963 while (ne.MoveNext ())
965 selection_action = TreeViewAction.ByKeyboard;
966 SelectedNode = ne.CurrentNode;
970 if (selected_node != null) {
971 ne = new OpenTreeNodeEnumerator (selected_node);
972 int move = VisibleCount;
973 for (int i = 0; i < move && ne.MoveNext (); i++) {
976 selection_action = TreeViewAction.ByKeyboard;
977 SelectedNode = ne.CurrentNode;
981 if (selected_node != null) {
982 ne = new OpenTreeNodeEnumerator (selected_node);
983 int move = VisibleCount;
984 for (int i = 0; i < move && ne.MovePrevious (); i++)
986 selection_action = TreeViewAction.ByKeyboard;
987 SelectedNode = ne.CurrentNode;
991 if (selected_node != null)
992 selected_node.ExpandAll ();
997 if (!e.Handled && checkboxes &&
998 selected_node != null &&
999 (e.KeyData & Keys.KeyCode) == Keys.Space) {
1000 selected_node.check_reason = TreeViewAction.ByKeyboard;
1001 selected_node.Checked = !selected_node.Checked;
1006 protected override void OnKeyPress (KeyPressEventArgs e)
1008 base.OnKeyPress (e);
1009 if (e.KeyChar == ' ')
1013 protected override void OnKeyUp (KeyEventArgs e)
1016 if ((e.KeyData & Keys.KeyCode) == Keys.Space)
1021 protected override void OnMouseHover (EventArgs e)
1023 base.OnMouseHover (e);
1027 TreeNode tn = GetNodeAt (PointToClient (MousePosition));
1030 MouseEnteredItem (tn);
1033 protected override void OnMouseLeave (EventArgs e)
1035 base.OnMouseLeave (e);
1037 is_hovering = false;
1039 if (tooltip_currently_showing != null)
1040 MouseLeftItem (tooltip_currently_showing);
1043 protected virtual void OnNodeMouseClick (TreeNodeMouseClickEventArgs e)
1045 TreeNodeMouseClickEventHandler eh = (TreeNodeMouseClickEventHandler)(Events[NodeMouseClickEvent]);
1050 protected virtual void OnNodeMouseDoubleClick (TreeNodeMouseClickEventArgs e)
1052 TreeNodeMouseClickEventHandler eh = (TreeNodeMouseClickEventHandler)(Events[NodeMouseDoubleClickEvent]);
1057 protected virtual void OnNodeMouseHover (TreeNodeMouseHoverEventArgs e)
1059 TreeNodeMouseHoverEventHandler eh = (TreeNodeMouseHoverEventHandler)(Events[NodeMouseHoverEvent]);
1065 protected virtual void OnItemDrag (ItemDragEventArgs e)
1067 ItemDragEventHandler eh = (ItemDragEventHandler)(Events [ItemDragEvent]);
1073 protected virtual void OnDrawNode(DrawTreeNodeEventArgs e) {
1074 DrawTreeNodeEventHandler eh = (DrawTreeNodeEventHandler)(Events[DrawNodeEvent]);
1079 [EditorBrowsable (EditorBrowsableState.Advanced)]
1080 protected virtual void OnRightToLeftLayoutChanged (EventArgs e) {
1081 EventHandler eh = (EventHandler)(Events[RightToLeftLayoutChangedEvent]);
1087 protected internal virtual void OnAfterCheck (TreeViewEventArgs e) {
1088 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterCheckEvent]);
1093 protected internal virtual void OnAfterCollapse (TreeViewEventArgs e) {
1094 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterCollapseEvent]);
1099 protected internal virtual void OnAfterExpand (TreeViewEventArgs e) {
1100 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterExpandEvent]);
1105 protected virtual void OnAfterLabelEdit (NodeLabelEditEventArgs e) {
1106 NodeLabelEditEventHandler eh = (NodeLabelEditEventHandler)(Events [AfterLabelEditEvent]);
1111 protected virtual void OnAfterSelect (TreeViewEventArgs e) {
1112 TreeViewEventHandler eh = (TreeViewEventHandler)(Events [AfterSelectEvent]);
1117 protected internal virtual void OnBeforeCheck (TreeViewCancelEventArgs e) {
1118 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeCheckEvent]);
1123 protected internal virtual void OnBeforeCollapse (TreeViewCancelEventArgs e) {
1124 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeCollapseEvent]);
1129 protected internal virtual void OnBeforeExpand (TreeViewCancelEventArgs e) {
1130 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeExpandEvent]);
1135 protected virtual void OnBeforeLabelEdit (NodeLabelEditEventArgs e) {
1136 NodeLabelEditEventHandler eh = (NodeLabelEditEventHandler)(Events [BeforeLabelEditEvent]);
1141 protected virtual void OnBeforeSelect (TreeViewCancelEventArgs e) {
1142 TreeViewCancelEventHandler eh = (TreeViewCancelEventHandler)(Events [BeforeSelectEvent]);
1147 protected override void OnHandleCreated (EventArgs e) {
1148 base.OnHandleCreated (e);
1151 protected override void OnHandleDestroyed (EventArgs e) {
1152 base.OnHandleDestroyed (e);
1155 protected override void WndProc(ref Message m) {
1156 switch ((Msg) m.Msg) {
1158 case Msg.WM_LBUTTONDBLCLK:
1159 int val = m.LParam.ToInt32();
1160 DoubleClickHandler (null, new
1161 MouseEventArgs (MouseButtons.Left,
1163 (val>>16) & 0xffff, 0));
1166 case Msg.WM_CONTEXTMENU:
1167 if (WmContextMenu (ref m))
1173 base.WndProc (ref m);
1176 #endregion // Protected Instance Methods
1178 #region Internal & Private Methods and Properties
1179 internal override bool ScaleChildrenInternal {
1180 get { return false; }
1183 internal IntPtr CreateNodeHandle ()
1185 return (IntPtr) handle_count++;
1188 // According to MSDN docs, for these to be raised,
1189 // the click must occur over a TreeNode
1190 internal override void HandleClick (int clicks, MouseEventArgs me)
1192 if (GetNodeAt (me.Location) != null) {
1193 if ((clicks > 1) && GetStyle (ControlStyles.StandardDoubleClick)) {
1195 OnDoubleClick(EventArgs.Empty);
1197 OnClick(EventArgs.Empty);
1200 OnMouseDoubleClick (me);
1209 internal override bool IsInputCharInternal (char charCode)
1214 internal TreeNode NodeFromHandle (IntPtr handle)
1216 // This method is called rarely, so instead of maintaining a table
1217 // we just walk the tree nodes to find the matching handle
1218 return NodeFromHandleRecursive (root_node, handle);
1221 private TreeNode NodeFromHandleRecursive (TreeNode node, IntPtr handle)
1223 if (node.handle == handle)
1225 foreach (TreeNode child in node.Nodes) {
1226 TreeNode match = NodeFromHandleRecursive (child, handle);
1233 internal Rectangle ViewportRectangle {
1235 Rectangle res = ClientRectangle;
1237 if (vbar != null && vbar.Visible)
1238 res.Width -= vbar.Width;
1239 if (hbar != null && hbar.Visible)
1240 res.Height -= hbar.Height;
1245 private TreeNode GetNodeAt (int y)
1247 if (nodes.Count <= 0)
1250 OpenTreeNodeEnumerator o = new OpenTreeNodeEnumerator (TopNode);
1251 int move = y / ActualItemHeight;
1252 for (int i = -1; i < move; i++) {
1257 return o.CurrentNode;
1260 private bool IsTextArea (TreeNode node, int x)
1262 return node != null && node.Bounds.Left <= x && node.Bounds.Right >= x;
1265 private bool IsSelectableArea (TreeNode node, int x)
1269 int l = node.Bounds.Left;
1270 if (ImageList != null)
1271 l -= ImageList.ImageSize.Width;
1272 return l <= x && node.Bounds.Right >= x;
1276 private bool IsPlusMinusArea (TreeNode node, int x)
1278 if (node.Nodes.Count == 0 || (node.parent == root_node && !show_root_lines))
1281 int l = node.Bounds.Left + 5;
1283 if (show_root_lines || node.Parent != null)
1285 if (ImageList != null)
1286 l -= ImageList.ImageSize.Width + 3;
1290 // StateImage is basically a custom checkbox
1291 else if (node.StateImage != null)
1294 return (x > l && x < l + 8);
1297 private bool IsCheckboxArea (TreeNode node, int x)
1299 int l = CheckBoxLeft (node);
1300 return (x > l && x < l + 10);
1304 private bool IsImage (TreeNode node, int x)
1306 if (ImageList == null)
1309 int l = node.Bounds.Left;
1311 l -= ImageList.ImageSize.Width + 5;
1313 if (x >= l && x <= (l + ImageList.ImageSize.Width + 5))
1320 private int CheckBoxLeft (TreeNode node)
1322 int l = node.Bounds.Left + 5;
1324 if (show_root_lines || node.Parent != null)
1326 if (ImageList != null)
1327 l -= ImageList.ImageSize.Width + 3;
1332 internal void RecalculateVisibleOrder (TreeNode start)
1334 if (update_stack > 0)
1338 if (start == null) {
1342 order = start.visible_order;
1346 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (start);
1347 while (walk.MoveNext ()) {
1348 walk.CurrentNode.visible_order = order;
1352 max_visible_order = order;
1355 internal void SetTop (TreeNode node)
1359 order = Math.Max (0, node.visible_order - 1);
1361 if (!vbar.is_visible) {
1362 skipped_nodes = order;
1366 vbar.Value = Math.Min (order, vbar.Maximum - VisibleCount + 1);
1369 internal void SetBottom (TreeNode node)
1371 if (!vbar.is_visible)
1374 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (node);
1376 int bottom = ViewportRectangle.Bottom;
1378 while (walk.MovePrevious ()) {
1379 if (walk.CurrentNode.Bounds.Bottom <= bottom)
1384 int nv = vbar.Value + offset;
1385 if (vbar.Value + offset < vbar.Maximum) {
1389 Console.Error.WriteLine ("setting bottom to value greater then maximum ({0}, {1})",
1396 internal void UpdateBelow (TreeNode node)
1398 if (update_stack > 0) {
1399 update_needed = true;
1403 if (node == root_node) {
1404 Invalidate (ViewportRectangle);
1408 // We need to update the current node so the plus/minus block gets update too
1409 int top = Math.Max (node.Bounds.Top - 1, 0);
1410 Rectangle invalid = new Rectangle (0, top,
1411 Width, Height - top);
1412 Invalidate (invalid);
1415 internal void UpdateNode (TreeNode node)
1420 if (update_stack > 0) {
1421 update_needed = true;
1425 if (node == root_node) {
1430 Rectangle invalid = new Rectangle (0, node.Bounds.Top - 1, Width,
1431 node.Bounds.Height + 1);
1432 Invalidate (invalid);
1435 internal void UpdateNodePlusMinus (TreeNode node)
1437 if (update_stack > 0) {
1438 update_needed = true;
1442 int l = node.Bounds.Left + 5;
1444 if (show_root_lines || node.Parent != null)
1446 if (ImageList != null)
1447 l -= ImageList.ImageSize.Width + 3;
1451 Invalidate (new Rectangle (l, node.Bounds.Top, 8, node.Bounds.Height));
1454 internal override void OnPaintInternal (PaintEventArgs pe)
1456 Draw (pe.ClipRectangle, pe.Graphics);
1459 internal void CreateDashPen ()
1461 dash = new Pen (LineColor, 1);
1462 dash.DashStyle = DashStyle.Dot;
1465 private void Draw (Rectangle clip, Graphics dc)
1467 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (BackColor), clip);
1472 Rectangle viewport = ViewportRectangle;
1473 Rectangle original_clip = clip;
1474 if (clip.Bottom > viewport.Bottom)
1475 clip.Height = viewport.Bottom - clip.Top;
1477 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (TopNode);
1478 while (walk.MoveNext ()) {
1479 TreeNode current = walk.CurrentNode;
1481 // Haven't gotten to visible nodes yet
1482 if (current.GetY () + ActualItemHeight < clip.Top)
1485 // Past the visible nodes
1486 if (current.GetY () > clip.Bottom)
1489 DrawTreeNode (current, dc, clip);
1492 if (hbar.Visible && vbar.Visible) {
1493 Rectangle corner = new Rectangle (hbar.Right, vbar.Bottom, vbar.Width, hbar.Height);
1494 if (original_clip.IntersectsWith (corner))
1495 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (ThemeEngine.Current.ColorControl),
1500 private void DrawNodePlusMinus (TreeNode node, Graphics dc, int x, int middle)
1502 int height = ActualItemHeight - 2;
1503 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (BackColor), (x + 4) - (height / 2), node.GetY() + 1, height, height);
1505 dc.DrawRectangle (SystemPens.ControlDarkDark, x, middle - 4, 8, 8);
1507 if (node.IsExpanded) {
1508 dc.DrawLine (SystemPens.ControlDarkDark, x + 2, middle, x + 6, middle);
1510 dc.DrawLine (SystemPens.ControlDarkDark, x + 2, middle, x + 6, middle);
1511 dc.DrawLine (SystemPens.ControlDarkDark, x + 4, middle - 2, x + 4, middle + 2);
1516 private void DrawNodeState (TreeNode node, Graphics dc, int x, int y)
1519 if (StateImageList.Images[1] != null)
1520 dc.DrawImage (StateImageList.Images[1], new Rectangle (x, y, 16, 16));
1522 if (StateImageList.Images[0] != null)
1523 dc.DrawImage (StateImageList.Images[0], new Rectangle (x, y, 16, 16));
1528 private void DrawNodeCheckBox (TreeNode node, Graphics dc, int x, int middle)
1530 Pen pen = ThemeEngine.Current.ResPool.GetSizedPen(Color.Black, 2);
1531 dc.DrawRectangle (pen, x + 3, middle - 4, 11, 11);
1534 Pen check_pen = ThemeEngine.Current.ResPool.GetPen(Color.Black);
1539 Rectangle rect = new Rectangle (x + 5, middle - 2, check_size, check_size);
1541 for (int i = 0; i < lineWidth; i++) {
1542 dc.DrawLine (check_pen, rect.Left + 1, rect.Top + lineWidth + i, rect.Left + 3, rect.Top + 5 + i);
1543 dc.DrawLine (check_pen, rect.Left + 3, rect.Top + 5 + i, rect.Left + 7, rect.Top + 1 + i);
1548 private void DrawNodeLines (TreeNode node, Graphics dc, Rectangle clip, Pen dash, int x, int y, int middle)
1553 if (node.nodes.Count > 0 && show_plus_minus)
1558 dc.DrawLine (dash, x - indent + ladjust, middle, x + radjust, middle);
1560 if (node.PrevNode != null || node.Parent != null) {
1562 dc.DrawLine (dash, x - indent + ladjust, node.Bounds.Top,
1563 x - indent + ladjust, middle - (show_plus_minus && node.Nodes.Count > 0 ? 4 : 0));
1566 if (node.NextNode != null) {
1568 dc.DrawLine (dash, x - indent + ladjust, middle + (show_plus_minus && node.Nodes.Count > 0 ? 4 : 0),
1569 x - indent + ladjust, node.Bounds.Bottom);
1574 if (show_plus_minus)
1576 TreeNode parent = node.Parent;
1577 while (parent != null) {
1578 if (parent.NextNode != null) {
1579 int px = parent.GetLinesX () - indent + ladjust;
1580 dc.DrawLine (dash, px, node.Bounds.Top, px, node.Bounds.Bottom);
1582 parent = parent.Parent;
1586 private void DrawNodeImage (TreeNode node, Graphics dc, Rectangle clip, int x, int y)
1588 // Rectangle r = new Rectangle (x, y + 2, ImageList.ImageSize.Width, ImageList.ImageSize.Height);
1590 if (!RectsIntersect (clip, x, y, ImageList.ImageSize.Width, ImageList.ImageSize.Height))
1593 if (ImageList == null)
1598 if (!node.IsSelected) {
1599 if (node.ImageIndex > -1 && node.ImageIndex < ImageList.Images.Count) {
1600 use_index = node.ImageIndex;
1601 } else if (ImageIndex > -1 && ImageIndex < ImageList.Images.Count) {
1602 use_index = ImageIndex;
1605 if (node.SelectedImageIndex > -1 && node.SelectedImageIndex < ImageList.Images.Count) {
1606 use_index = node.SelectedImageIndex;
1607 } else if (SelectedImageIndex > -1 && SelectedImageIndex < ImageList.Images.Count) {
1608 use_index = SelectedImageIndex;
1614 if (!node.IsSelected) {
1615 if (use_index == -1 && !String.IsNullOrEmpty (node.ImageKey)) {
1616 use_index = image_list.Images.IndexOfKey (node.ImageKey);
1619 if (use_index == -1 && !String.IsNullOrEmpty (ImageKey)) {
1620 use_index = image_list.Images.IndexOfKey (ImageKey);
1623 if (use_index == -1 && !String.IsNullOrEmpty (node.SelectedImageKey)) {
1624 use_index = image_list.Images.IndexOfKey (node.SelectedImageKey);
1627 if (use_index == -1 && !String.IsNullOrEmpty (SelectedImageKey)) {
1628 use_index = image_list.Images.IndexOfKey (SelectedImageKey);
1633 if (use_index == -1 && ImageList.Images.Count > 0) {
1637 if (use_index != -1) {
1638 ImageList.Draw (dc, x, y, ImageList.ImageSize.Width,
1639 ImageList.ImageSize.Height, use_index);
1643 private void LabelEditFinished (object sender, EventArgs e)
1645 EndEdit (edit_node);
1648 internal void BeginEdit (TreeNode node)
1650 if (edit_node != null)
1651 EndEdit (edit_node);
1653 if (edit_text_box == null) {
1654 edit_text_box = new LabelEditTextBox ();
1655 edit_text_box.BorderStyle = BorderStyle.FixedSingle;
1656 edit_text_box.Visible = false;
1657 edit_text_box.EditingCancelled += new EventHandler (LabelEditCancelled);
1658 edit_text_box.EditingFinished += new EventHandler (LabelEditFinished);
1659 edit_text_box.TextChanged += new EventHandler (LabelTextChanged);
1660 Controls.Add (edit_text_box);
1663 node.EnsureVisible ();
1665 edit_text_box.Bounds = node.Bounds;
1666 edit_text_box.Text = node.Text;
1667 edit_text_box.Visible = true;
1668 edit_text_box.Focus ();
1669 edit_text_box.SelectAll ();
1671 edit_args = new NodeLabelEditEventArgs (node);
1672 OnBeforeLabelEdit (edit_args);
1676 if (edit_args.CancelEdit) {
1682 private void LabelEditCancelled (object sender, EventArgs e)
1684 edit_args.SetLabel (null);
1685 EndEdit (edit_node);
1688 private void LabelTextChanged (object sender, EventArgs e)
1690 int width = TextRenderer.MeasureTextInternal (edit_text_box.Text, edit_text_box.Font, false).Width + 4;
1691 edit_text_box.Width = width;
1693 if (edit_args != null)
1694 edit_args.SetLabel (edit_text_box.Text);
1697 internal void EndEdit (TreeNode node)
1699 if (edit_text_box != null && edit_text_box.Visible) {
1700 edit_text_box.Visible = false;
1705 // If we get a call to BeginEdit from any AfterLabelEdit handler,
1706 // the focus seems to always remain in the TreeView. This call seems
1707 // to synchronize the focus events - I don't like it but it works
1709 Application.DoEvents ();
1711 if (edit_node != null && edit_node == node) {
1714 NodeLabelEditEventArgs e = new NodeLabelEditEventArgs (edit_args.Node, edit_args.Label);
1716 OnAfterLabelEdit (e);
1721 if (e.Label != null)
1722 e.Node.Text = e.Label;
1725 // EndEdit ends editing even if not called on the editing node
1730 internal void CancelEdit (TreeNode node)
1732 edit_args.SetLabel (null);
1734 if (edit_text_box != null && edit_text_box.Visible) {
1735 edit_text_box.Visible = false;
1743 internal int GetNodeWidth (TreeNode node)
1745 Font font = node.NodeFont;
1746 if (node.NodeFont == null)
1748 return (int)TextRenderer.MeasureString (node.Text, font, 0, string_format).Width + 3;
1751 private void DrawSelectionAndFocus(TreeNode node, Graphics dc, Rectangle r)
1753 if (Focused && focused_node == node && !full_row_select) {
1754 ControlPaint.DrawFocusRectangle (dc, r, ForeColor, BackColor);
1756 if (draw_mode != TreeViewDrawMode.Normal)
1760 if (Focused && node == highlighted_node) {
1761 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (ThemeEngine.Current.ColorHighlight), r);
1762 } else if (!hide_selection && node == highlighted_node) {
1763 dc.FillRectangle (SystemBrushes.Control, r);
1765 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (node.BackColor), r);
1769 private void DrawStaticNode (TreeNode node, Graphics dc)
1771 if (!full_row_select || show_lines)
1772 DrawSelectionAndFocus(node, dc, node.Bounds);
1775 Font font = node.NodeFont;
1776 if (node.NodeFont == null)
1778 Color text_color = (Focused && node == highlighted_node ?
1779 ThemeEngine.Current.ColorHighlightText : node.ForeColor);
1780 if (text_color.IsEmpty)
1781 text_color = ForeColor;
1782 dc.DrawString (node.Text, font,
1783 ThemeEngine.Current.ResPool.GetSolidBrush (text_color),
1784 node.Bounds, string_format);
1787 private void DrawTreeNode (TreeNode node, Graphics dc, Rectangle clip)
1789 int child_count = node.nodes.Count;
1790 int y = node.GetY ();
1791 int middle = y + (ActualItemHeight / 2);
1793 if (full_row_select && !show_lines) {
1794 Rectangle r = new Rectangle (1, y, ViewportRectangle.Width - 2, ActualItemHeight);
1795 DrawSelectionAndFocus (node, dc, r);
1798 if (draw_mode == TreeViewDrawMode.Normal || draw_mode == TreeViewDrawMode.OwnerDrawText) {
1799 if ((show_root_lines || node.Parent != null) && show_plus_minus && child_count > 0)
1800 DrawNodePlusMinus (node, dc, node.GetLinesX () - Indent + 5, middle);
1803 if (checkboxes && state_image_list == null)
1804 DrawNodeCheckBox (node, dc, CheckBoxLeft (node) - 3, middle);
1806 if (checkboxes && state_image_list != null)
1807 DrawNodeState (node, dc, CheckBoxLeft (node) - 3, y);
1809 if (!checkboxes && node.StateImage != null)
1810 dc.DrawImage (node.StateImage, new Rectangle (CheckBoxLeft (node) - 3, y, 16, 16));
1813 DrawNodeCheckBox (node, dc, CheckBoxLeft (node) - 3, middle);
1817 DrawNodeLines (node, dc, clip, dash, node.GetLinesX (), y, middle);
1819 if (ImageList != null)
1820 DrawNodeImage (node, dc, clip, node.GetImageX (), y);
1825 if (draw_mode != TreeViewDrawMode.Normal) {
1826 dc.FillRectangle (Brushes.White, node.Bounds);
1827 TreeNodeStates tree_node_state = TreeNodeStates.Default;;
1828 if (node.IsSelected)
1829 tree_node_state = TreeNodeStates.Selected;
1831 tree_node_state |= TreeNodeStates.Checked;
1832 if (node == focused_node)
1833 tree_node_state |= TreeNodeStates.Focused;
1834 Rectangle node_bounds = node.Bounds;
1835 if (draw_mode == TreeViewDrawMode.OwnerDrawText) {
1840 node_bounds.Width = Width;
1843 DrawTreeNodeEventArgs e = new DrawTreeNodeEventArgs (dc, node, node_bounds, tree_node_state);
1851 if (!node.IsEditing)
1852 DrawStaticNode (node, dc);
1855 internal void UpdateScrollBars (bool force)
1857 if (!force && (IsDisposed || update_stack > 0 || !IsHandleCreated || !Visible))
1866 OpenTreeNodeEnumerator walk = new OpenTreeNodeEnumerator (root_node);
1868 while (walk.MoveNext ()) {
1869 int r = walk.CurrentNode.Bounds.Right;
1870 int b = walk.CurrentNode.Bounds.Bottom;
1878 // Remove scroll adjustments
1879 if (nodes.Count > 0)
1880 height -= nodes [0].Bounds.Top;
1881 width += hbar_offset;
1883 if (height > ClientRectangle.Height) {
1886 if (width > ClientRectangle.Width - SystemInformation.VerticalScrollBarWidth)
1888 } else if (width > ClientRectangle.Width) {
1892 if (!vert && horz && height > ClientRectangle.Height - SystemInformation.HorizontalScrollBarHeight)
1897 int visible_height = horz ? ClientRectangle.Height - hbar.Height : ClientRectangle.Height;
1898 vbar.SetValues (Math.Max (0, max_visible_order - 2), visible_height / ActualItemHeight);
1900 vbar.Maximum = max_visible_order;
1901 vbar.LargeChange = ClientRectangle.Height / ItemHeight;
1904 if (!vbar_bounds_set) {
1905 vbar.Bounds = new Rectangle (ClientRectangle.Width - vbar.Width, 0, vbar.Width,
1906 ClientRectangle.Height -
1907 (horz ? SystemInformation.VerticalScrollBarWidth : 0));
1908 vbar_bounds_set = true;
1910 // We need to recalc the hbar if the vbar is now visible
1911 hbar_bounds_set = false;
1915 vbar.Visible = true;
1916 if (skipped_nodes > 0) {
1917 int skip = Math.Min (skipped_nodes, vbar.Maximum - VisibleCount + 1);
1920 skipped_nodes = skip;
1924 RecalculateVisibleOrder (root_node);
1925 vbar.Visible = false;
1926 vbar_bounds_set = false;
1930 hbar.SetValues (width + 1, ClientRectangle.Width - (vert ? SystemInformation.VerticalScrollBarWidth : 0));
1932 hbar.LargeChange = ClientRectangle.Width;
1933 hbar.Maximum = width + 1;
1936 if (!hbar_bounds_set) {
1937 hbar.Bounds = new Rectangle (0, ClientRectangle.Height - hbar.Height,
1938 ClientRectangle.Width - (vert ? SystemInformation.VerticalScrollBarWidth : 0),
1940 hbar_bounds_set = true;
1942 hbar.Visible = true;
1945 hbar.Visible = false;
1946 hbar_bounds_set = false;
1950 private void SizeChangedHandler (object sender, EventArgs e)
1952 if (IsHandleCreated) {
1953 if (max_visible_order == -1)
1954 RecalculateVisibleOrder (root_node);
1955 UpdateScrollBars (false);
1959 vbar.Bounds = new Rectangle (ClientRectangle.Width - vbar.Width, 0, vbar.Width,
1960 ClientRectangle.Height - (hbar.Visible ? SystemInformation.HorizontalScrollBarHeight : 0));
1964 hbar.Bounds = new Rectangle (0, ClientRectangle.Height - hbar.Height,
1965 ClientRectangle.Width - (vbar.Visible ? SystemInformation.VerticalScrollBarWidth : 0), hbar.Height);
1969 private void VScrollBarValueChanged (object sender, EventArgs e)
1971 EndEdit (edit_node);
1973 SetVScrollPos (vbar.Value, null);
1976 private void SetVScrollPos (int pos, TreeNode new_top)
1981 if (skipped_nodes == pos)
1984 int diff = skipped_nodes - pos;
1985 skipped_nodes = pos;
1987 if (!IsHandleCreated)
1990 int y_move = diff * ActualItemHeight;
1991 XplatUI.ScrollWindow (Handle, ViewportRectangle, 0, y_move, false);
1994 /*private void SetVScrollTop (TreeNode new_top)
1996 vbar.Value = new_top.visible_order - VisibleCount;
1999 private void HScrollBarValueChanged(object sender, EventArgs e)
2001 EndEdit (edit_node);
2003 int old_offset = hbar_offset;
2004 hbar_offset = hbar.Value;
2006 if (hbar_offset < 0) {
2010 XplatUI.ScrollWindow (Handle, ViewportRectangle, old_offset - hbar_offset, 0, false);
2013 internal void ExpandBelow (TreeNode node, int count_to_next)
2015 if (update_stack > 0) {
2016 update_needed = true;
2020 // If node Bottom is less than 0, the node is above and not visible,
2021 // and we need to scroll the entire viewport
2022 int node_bottom = node.Bounds.Bottom >= 0 ? node.Bounds.Bottom : 0;
2023 Rectangle below = new Rectangle (0, node_bottom, ViewportRectangle.Width,
2024 ViewportRectangle.Height - node_bottom);
2026 int amount = count_to_next * ActualItemHeight;
2029 XplatUI.ScrollWindow (Handle, below, 0, amount, false);
2031 if (show_plus_minus) {
2032 Invalidate (new Rectangle (0, node.GetY (), Width, ActualItemHeight));
2036 internal void CollapseBelow (TreeNode node, int count_to_next)
2038 if (update_stack > 0) {
2039 update_needed = true;
2043 Rectangle below = new Rectangle (0, node.Bounds.Bottom, ViewportRectangle.Width,
2044 ViewportRectangle.Height - node.Bounds.Bottom);
2046 int amount = count_to_next * ActualItemHeight;
2049 XplatUI.ScrollWindow (Handle, below, 0, -amount, false);
2051 if (show_plus_minus) {
2052 Invalidate (new Rectangle (0, node.GetY (), Width, ActualItemHeight));
2056 private void MouseWheelHandler(object sender, MouseEventArgs e) {
2058 if (vbar == null || !vbar.is_visible) {
2063 vbar.Value = Math.Min(vbar.Value + SystemInformation.MouseWheelScrollLines, vbar.Maximum - VisibleCount + 1);
2065 vbar.Value = Math.Max(0, vbar.Value - SystemInformation.MouseWheelScrollLines);
2069 private void VisibleChangedHandler (object sender, EventArgs e)
2072 UpdateScrollBars (false);
2076 private void FontChangedHandler (object sender, EventArgs e)
2078 if (IsHandleCreated) {
2079 TreeNode top = TopNode;
2080 InvalidateNodeWidthRecursive (root_node);
2086 private void InvalidateNodeWidthRecursive (TreeNode node)
2088 node.InvalidateWidth ();
2089 foreach (TreeNode child in node.Nodes) {
2090 InvalidateNodeWidthRecursive (child);
2094 private void GotFocusHandler (object sender, EventArgs e)
2096 if (selected_node == null) {
2097 if (pre_selected_node != null) {
2098 SelectedNode = pre_selected_node;
2102 SelectedNode = TopNode;
2104 } else if (selected_node != null)
2105 UpdateNode (selected_node);
2108 private void LostFocusHandler (object sender, EventArgs e)
2110 UpdateNode (SelectedNode);
2113 private void MouseDownHandler (object sender, MouseEventArgs e)
2115 if (e.Button == MouseButtons.Right)
2118 TreeNode node = GetNodeAt (e.Y);
2123 mouse_click_node = node;
2126 if (show_plus_minus && IsPlusMinusArea (node, e.X)) {
2129 } else if (checkboxes && IsCheckboxArea (node, e.X)) {
2130 node.check_reason = TreeViewAction.ByMouse;
2131 node.Checked = !node.Checked;
2134 } else if (IsSelectableArea (node, e.X) || full_row_select) {
2135 TreeNode old_highlighted = highlighted_node;
2136 highlighted_node = node;
2137 if (label_edit && e.Clicks == 1 && highlighted_node == old_highlighted) {
2139 } else if (highlighted_node != focused_node) {
2140 Size ds = SystemInformation.DragSize;
2141 mouse_rect.X = e.X - ds.Width;
2142 mouse_rect.Y = e.Y - ds.Height;
2143 mouse_rect.Width = ds.Width * 2;
2144 mouse_rect.Height = ds.Height * 2;
2146 select_mmove = true;
2149 Invalidate (highlighted_node.Bounds);
2150 if (old_highlighted != null)
2151 Invalidate (Bloat (old_highlighted.Bounds));
2155 private void MouseUpHandler (object sender, MouseEventArgs e) {
2157 TreeNode node = GetNodeAt (e.Y);
2159 if (node != null && node == mouse_click_node) {
2161 OnNodeMouseDoubleClick (new TreeNodeMouseClickEventArgs (node, e.Button, e.Clicks, e.X, e.Y));
2163 OnNodeMouseClick (new TreeNodeMouseClickEventArgs (node, e.Button, e.Clicks, e.X, e.Y));
2166 mouse_click_node = null;
2175 select_mmove = false;
2177 if (e.Button == MouseButtons.Right && selected_node != null) {
2178 Invalidate (highlighted_node.Bounds);
2179 highlighted_node = selected_node;
2180 Invalidate (selected_node.Bounds);
2184 TreeViewCancelEventArgs ce = new TreeViewCancelEventArgs (highlighted_node, false, TreeViewAction.ByMouse);
2185 OnBeforeSelect (ce);
2189 TreeNode prev_focused_node = focused_node;
2190 TreeNode prev_highlighted_node = highlighted_node;
2192 selected_node = highlighted_node;
2193 focused_node = highlighted_node;
2194 OnAfterSelect (new TreeViewEventArgs (selected_node, TreeViewAction.ByMouse));
2196 if (prev_focused_node != null) {
2197 invalid = Rectangle.Union (Bloat (prev_focused_node.Bounds),
2198 Bloat (prev_highlighted_node.Bounds));
2200 invalid = Bloat (prev_highlighted_node.Bounds);
2203 if (full_row_select || draw_mode != TreeViewDrawMode.Normal) {
2205 invalid.Width = ViewportRectangle.Width;
2208 Invalidate (invalid);
2210 highlighted_node = focused_node;
2211 selected_node = focused_node;
2215 private void MouseMoveHandler (object sender, MouseEventArgs e) {
2217 // XXX - This should use HitTest and only fire when we are over
2218 // the important parts of a node, not things like gridlines or
2220 TreeNode tn = GetNodeAt (e.Location);
2222 if (tn != tooltip_currently_showing)
2223 MouseLeftItem (tooltip_currently_showing);
2225 if (tn != null && tn != tooltip_currently_showing)
2226 MouseEnteredItem (tn);
2229 if (e.Button == MouseButtons.Left || e.Button == MouseButtons.Right) {
2230 if (drag_begin_x == -1 && drag_begin_y == -1) {
2234 double rise = Math.Pow (drag_begin_x - e.X, 2);
2235 double run = Math.Pow (drag_begin_y - e.Y, 2);
2236 double move = Math.Sqrt (rise + run);
2238 TreeNode drag = GetNodeAtUseX (e.X, e.Y);
2241 OnItemDrag (new ItemDragEventArgs (e.Button, drag));
2250 // If there is enough movement before the mouse comes up,
2251 // selection is reverted back to the originally selected node
2252 if (!select_mmove || mouse_rect.Contains (e.X, e.Y))
2255 Invalidate (highlighted_node.Bounds);
2256 Invalidate (selected_node.Bounds);
2257 Invalidate (focused_node.Bounds);
2259 highlighted_node = selected_node;
2260 focused_node = selected_node;
2262 select_mmove = false;
2265 private void DoubleClickHandler (object sender, MouseEventArgs e) {
2266 TreeNode node = GetNodeAtUseX (e.X,e.Y);
2273 private bool RectsIntersect (Rectangle r, int left, int top, int width, int height)
2275 return !((r.Left > left + width) || (r.Right < left) ||
2276 (r.Top > top + height) || (r.Bottom < top));
2280 // Return true if message was handled, false to send it to base
2281 private bool WmContextMenu (ref Message m)
2286 pt = new Point (LowOrder ((int)m.LParam.ToInt32 ()), HighOrder ((int)m.LParam.ToInt32 ()));
2288 // This means it's a keyboard menu request
2289 if (pt.X == -1 || pt.Y == -1) {
2295 pt = new Point (tn.Bounds.Left, tn.Bounds.Top + (tn.Bounds.Height / 2));
2297 pt = PointToClient (pt);
2299 tn = GetNodeAt (pt);
2305 // At this point, we have a valid TreeNode
2306 if (tn.ContextMenu != null) {
2307 tn.ContextMenu.Show (this, pt);
2309 } else if (tn.ContextMenuStrip != null) {
2310 tn.ContextMenuStrip.Show (this, pt);
2314 // The node we found did not have its own menu, let the parent try to display its menu
2319 #region Stuff for ToolTips
2321 private void MouseEnteredItem (TreeNode item)
2323 tooltip_currently_showing = item;
2328 if (ShowNodeToolTips && !string.IsNullOrEmpty (tooltip_currently_showing.ToolTipText))
2329 ToolTipWindow.Present (this, tooltip_currently_showing.ToolTipText);
2331 OnNodeMouseHover (new TreeNodeMouseHoverEventArgs (tooltip_currently_showing));
2334 private void MouseLeftItem (TreeNode item)
2336 ToolTipWindow.Hide (this);
2337 tooltip_currently_showing = null;
2340 private ToolTip ToolTipWindow {
2342 if (tooltip_window == null)
2343 tooltip_window = new ToolTip ();
2345 return tooltip_window;
2351 #endregion // Internal & Private Methods and Properties
2354 static object ItemDragEvent = new object ();
2355 static object AfterCheckEvent = new object ();
2356 static object AfterCollapseEvent = new object ();
2357 static object AfterExpandEvent = new object ();
2358 static object AfterLabelEditEvent = new object ();
2359 static object AfterSelectEvent = new object ();
2360 static object BeforeCheckEvent = new object ();
2361 static object BeforeCollapseEvent = new object ();
2362 static object BeforeExpandEvent = new object ();
2363 static object BeforeLabelEditEvent = new object ();
2364 static object BeforeSelectEvent = new object ();
2366 static object DrawNodeEvent = new object ();
2367 static object NodeMouseClickEvent = new object ();
2368 static object NodeMouseDoubleClickEvent = new object();
2369 static object NodeMouseHoverEvent = new object ();
2370 static object RightToLeftLayoutChangedEvent = new object ();
2373 public event ItemDragEventHandler ItemDrag {
2374 add { Events.AddHandler (ItemDragEvent, value); }
2375 remove { Events.RemoveHandler (ItemDragEvent, value); }
2378 public event TreeViewEventHandler AfterCheck {
2379 add { Events.AddHandler (AfterCheckEvent, value); }
2380 remove { Events.RemoveHandler (AfterCheckEvent, value); }
2383 public event TreeViewEventHandler AfterCollapse {
2384 add { Events.AddHandler (AfterCollapseEvent, value); }
2385 remove { Events.RemoveHandler (AfterCollapseEvent, value); }
2388 public event TreeViewEventHandler AfterExpand {
2389 add { Events.AddHandler (AfterExpandEvent, value); }
2390 remove { Events.RemoveHandler (AfterExpandEvent, value); }
2393 public event NodeLabelEditEventHandler AfterLabelEdit {
2394 add { Events.AddHandler (AfterLabelEditEvent, value); }
2395 remove { Events.RemoveHandler (AfterLabelEditEvent, value); }
2398 public event TreeViewEventHandler AfterSelect {
2399 add { Events.AddHandler (AfterSelectEvent, value); }
2400 remove { Events.RemoveHandler (AfterSelectEvent, value); }
2403 public event TreeViewCancelEventHandler BeforeCheck {
2404 add { Events.AddHandler (BeforeCheckEvent, value); }
2405 remove { Events.RemoveHandler (BeforeCheckEvent, value); }
2408 public event TreeViewCancelEventHandler BeforeCollapse {
2409 add { Events.AddHandler (BeforeCollapseEvent, value); }
2410 remove { Events.RemoveHandler (BeforeCollapseEvent, value); }
2413 public event TreeViewCancelEventHandler BeforeExpand {
2414 add { Events.AddHandler (BeforeExpandEvent, value); }
2415 remove { Events.RemoveHandler (BeforeExpandEvent, value); }
2418 public event NodeLabelEditEventHandler BeforeLabelEdit {
2419 add { Events.AddHandler (BeforeLabelEditEvent, value); }
2420 remove { Events.RemoveHandler (BeforeLabelEditEvent, value); }
2423 public event TreeViewCancelEventHandler BeforeSelect {
2424 add { Events.AddHandler (BeforeSelectEvent, value); }
2425 remove { Events.RemoveHandler (BeforeSelectEvent, value); }
2429 public event DrawTreeNodeEventHandler DrawNode {
2430 add { Events.AddHandler (DrawNodeEvent, value); }
2431 remove { Events.RemoveHandler (DrawNodeEvent, value); }
2434 public event TreeNodeMouseClickEventHandler NodeMouseClick {
2435 add { Events.AddHandler (NodeMouseClickEvent, value); }
2436 remove { Events.RemoveHandler (NodeMouseClickEvent, value); }
2440 public event TreeNodeMouseClickEventHandler NodeMouseDoubleClick {
2441 add { Events.AddHandler (NodeMouseDoubleClickEvent, value); }
2442 remove { Events.RemoveHandler (NodeMouseDoubleClickEvent, value); }
2445 public event TreeNodeMouseHoverEventHandler NodeMouseHover {
2446 add { Events.AddHandler (NodeMouseHoverEvent, value); }
2447 remove { Events.RemoveHandler (NodeMouseHoverEvent, value); }
2450 public event EventHandler RightToLeftLayoutChanged {
2451 add { Events.AddHandler (RightToLeftLayoutChangedEvent, value); }
2452 remove { Events.RemoveHandler (RightToLeftLayoutChangedEvent, value); }
2457 [EditorBrowsable (EditorBrowsableState.Never)]
2458 public new event EventHandler BackgroundImageChanged {
2459 add { base.BackgroundImageChanged += value; }
2460 remove { base.BackgroundImageChanged -= value; }
2465 [EditorBrowsable (EditorBrowsableState.Never)]
2466 public new event EventHandler BackgroundImageLayoutChanged {
2467 add { base.BackgroundImageLayoutChanged += value; }
2468 remove { base.BackgroundImageLayoutChanged -= value; }
2472 [EditorBrowsable (EditorBrowsableState.Never)]
2473 public new event EventHandler PaddingChanged {
2474 add { base.PaddingChanged += value; }
2475 remove { base.PaddingChanged -= value; }
2479 [EditorBrowsable (EditorBrowsableState.Never)]
2481 public new event PaintEventHandler Paint {
2482 add { base.Paint += value; }
2483 remove { base.Paint -= value; }
2486 [EditorBrowsable (EditorBrowsableState.Never)]
2488 public new event EventHandler TextChanged {
2489 add { base.TextChanged += value; }
2490 remove { base.TextChanged -= value; }
2492 #endregion // Events