4 // Permission is hereby granted, free of charge, to any person obtaining
5 // a copy of this software and associated documentation files (the
6 // "Software"), to deal in the Software without restriction, including
7 // without limitation the rights to use, copy, modify, merge, publish,
8 // distribute, sublicense, and/or sell copies of the Software, and to
9 // permit persons to whom the Software is furnished to do so, subject to
10 // the following conditions:
12 // The above copyright notice and this permission notice shall be
13 // included in all copies or substantial portions of the Software.
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 // Copyright (c) 2006 Jonathan Pobst
26 // Jonathan Pobst (monkey@jpobst.com)
33 using System.ComponentModel;
34 using System.Runtime.InteropServices;
36 namespace System.Windows.Forms
38 [DefaultEvent ("Click")]
39 [DefaultProperty ("Text")]
40 [DesignTimeVisible (false)]
42 [Designer ("System.Windows.Forms.Design.ToolStripItemDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
43 public abstract class ToolStripItem : Component, IDropTarget, IComponent, IDisposable
45 #region Private Variables
46 private AccessibleObject accessibility_object;
47 private string accessible_default_action_description;
48 private bool allow_drop;
49 private ToolStripItemAlignment alignment;
50 private AnchorStyles anchor;
51 private bool available;
52 private bool auto_size;
53 private bool auto_tool_tip;
54 private Color back_color;
55 private Image background_image;
56 private ImageLayout background_image_layout;
57 private Rectangle bounds;
58 private bool can_select;
59 private ToolStripItemDisplayStyle display_style;
60 private DockStyle dock;
61 private bool double_click_enabled;
63 private Size explicit_size;
65 private Color fore_color;
67 private ContentAlignment image_align;
68 private int image_index;
69 private string image_key;
70 private ToolStripItemImageScaling image_scaling;
71 private Color image_transparent_color;
72 private bool is_disposed;
73 internal bool is_pressed;
74 private bool is_selected;
75 private Padding margin;
76 private MergeAction merge_action;
77 private int merge_index;
79 private ToolStripItemOverflow overflow;
80 private ToolStrip owner;
81 internal ToolStripItem owner_item;
82 private Padding padding;
83 private ToolStripItemPlacement placement;
84 private RightToLeft right_to_left;
85 private bool right_to_left_auto_mirror_image;
88 private ContentAlignment text_align;
89 private ToolStripTextDirection text_direction;
90 private TextImageRelation text_image_relation;
91 private string tool_tip_text;
94 private EventHandler frame_handler; // For animating images
95 private ToolStrip parent;
96 private Size text_size;
99 #region Public Constructors
100 protected ToolStripItem ()
101 : this (String.Empty, null, null, String.Empty)
105 protected ToolStripItem (string text, Image image, EventHandler onClick)
106 : this (text, image, onClick, String.Empty)
110 protected ToolStripItem (string text, Image image, EventHandler onClick, string name)
112 this.alignment = ToolStripItemAlignment.Left;
113 this.anchor = AnchorStyles.Left | AnchorStyles.Top;
114 this.auto_size = true;
115 this.auto_tool_tip = this.DefaultAutoToolTip;
116 this.available = true;
117 this.back_color = Color.Empty;
118 this.background_image_layout = ImageLayout.Tile;
119 this.can_select = true;
120 this.display_style = this.DefaultDisplayStyle;
121 this.dock = DockStyle.None;
123 this.fore_color = Color.Empty;
125 this.image_align = ContentAlignment.MiddleCenter;
126 this.image_index = -1;
127 this.image_key = string.Empty;
128 this.image_scaling = ToolStripItemImageScaling.SizeToFit;
129 this.image_transparent_color = Color.Empty;
130 this.margin = this.DefaultMargin;
131 this.merge_action = MergeAction.Append;
132 this.merge_index = -1;
134 this.overflow = ToolStripItemOverflow.AsNeeded;
135 this.padding = this.DefaultPadding;
136 this.placement = ToolStripItemPlacement.None;
137 this.right_to_left = RightToLeft.Inherit;
138 this.bounds.Size = this.DefaultSize;
140 this.text_align = ContentAlignment.MiddleCenter;
141 this.text_direction = DefaultTextDirection;
142 this.text_image_relation = TextImageRelation.ImageBeforeText;
145 this.Click += onClick;
146 OnLayout (new LayoutEventArgs (null, string.Empty));
150 #region Public Properties
152 [EditorBrowsable (EditorBrowsableState.Advanced)]
153 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
154 public AccessibleObject AccessibilityObject {
156 if (this.accessibility_object == null)
157 this.accessibility_object = CreateAccessibilityInstance ();
159 return this.accessibility_object;
164 [EditorBrowsable (EditorBrowsableState.Advanced)]
165 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
166 public string AccessibleDefaultActionDescription {
168 if (this.accessibility_object == null)
171 return this.accessible_default_action_description;
173 set { this.accessible_default_action_description = value; }
177 [DefaultValue (null)]
178 public string AccessibleDescription {
180 if (this.accessibility_object == null)
183 return this.AccessibilityObject.Description;
185 set { this.AccessibilityObject.description = value; }
189 [DefaultValue (null)]
190 public string AccessibleName {
192 if (this.accessibility_object == null)
195 return this.AccessibilityObject.Name;
197 set { this.AccessibilityObject.Name = value; }
200 [DefaultValue (AccessibleRole.Default)]
201 public AccessibleRole AccessibleRole {
204 if (this.accessibility_object == null)
205 return AccessibleRole.Default;
207 return this.AccessibilityObject.Role;
209 set { this.AccessibilityObject.role = value; }
212 [DefaultValue (ToolStripItemAlignment.Left)]
213 public ToolStripItemAlignment Alignment {
214 get { return this.alignment; }
216 if (!Enum.IsDefined (typeof (ToolStripItemAlignment), value))
217 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ToolStripItemAlignment", value));
219 if (this.alignment != value) {
220 this.alignment = value;
221 this.CalculateAutoSize ();
228 [DefaultValue (false)]
229 [EditorBrowsable (EditorBrowsableState.Advanced)]
230 public virtual bool AllowDrop {
231 get { return this.allow_drop; }
232 set { this.allow_drop = value; }
236 [DefaultValue (AnchorStyles.Top | AnchorStyles.Left)]
237 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
238 public AnchorStyles Anchor {
239 get { return this.anchor; }
240 set { this.anchor = value; }
244 [DefaultValue (true)]
245 [DesignerSerializationVisibility (DesignerSerializationVisibility.Visible)]
246 [RefreshProperties (RefreshProperties.All)]
247 public bool AutoSize {
248 get { return this.auto_size; }
250 this.auto_size = value;
251 this.CalculateAutoSize ();
255 [DefaultValue (false)]
256 public bool AutoToolTip {
257 get { return this.auto_tool_tip; }
258 set { this.auto_tool_tip = value; }
262 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
263 public bool Available {
264 get { return this.available; }
266 if (this.available != value) {
270 if (this.parent != null)
271 parent.PerformLayout ();
273 OnAvailableChanged (EventArgs.Empty);
274 OnVisibleChanged (EventArgs.Empty);
279 public virtual Color BackColor {
281 if (back_color != Color.Empty)
285 return parent.BackColor;
287 return Control.DefaultBackColor;
290 if (this.back_color != value) {
292 OnBackColorChanged (EventArgs.Empty);
299 [DefaultValue (null)]
300 public virtual Image BackgroundImage {
301 get { return this.background_image; }
303 if (this.background_image != value) {
304 this.background_image = value;
311 [DefaultValue (ImageLayout.Tile)]
312 public virtual ImageLayout BackgroundImageLayout {
313 get { return this.background_image_layout; }
315 if (this.background_image_layout != value) {
316 this.background_image_layout = value;
323 public virtual Rectangle Bounds {
324 get { return this.bounds; }
328 public virtual bool CanSelect {
329 get { return this.can_select; }
333 public Rectangle ContentRectangle {
335 // ToolStripLabels don't have a border
336 if (this is ToolStripLabel || this is ToolStripStatusLabel)
337 return new Rectangle (0, 0, this.bounds.Width, this.bounds.Height);
339 if (this is ToolStripDropDownButton && (this as ToolStripDropDownButton).ShowDropDownArrow)
340 return new Rectangle (2, 2, this.bounds.Width - 13, this.bounds.Height - 4);
342 return new Rectangle (2, 2, this.bounds.Width - 4, this.bounds.Height - 4);
346 public virtual ToolStripItemDisplayStyle DisplayStyle {
347 get { return this.display_style; }
349 if (this.display_style != value) {
350 this.display_style = value;
351 this.CalculateAutoSize ();
352 OnDisplayStyleChanged (EventArgs.Empty);
358 public bool IsDisposed {
359 get { return this.is_disposed; }
363 [DefaultValue (DockStyle.None)]
364 public DockStyle Dock {
365 get { return this.dock; }
367 if (this.dock != value) {
368 if (!Enum.IsDefined (typeof (DockStyle), value))
369 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for DockStyle", value));
372 this.CalculateAutoSize ();
377 [DefaultValue (false)]
378 public bool DoubleClickEnabled {
379 get { return this.double_click_enabled; }
380 set { this.double_click_enabled = value; }
384 [DefaultValue (true)]
385 public virtual bool Enabled {
398 if (this.enabled != value) {
399 this.enabled = value;
400 OnEnabledChanged (EventArgs.Empty);
407 public virtual Font Font {
418 if (this.font != value) {
420 this.CalculateAutoSize ();
421 this.OnFontChanged (EventArgs.Empty);
427 public virtual Color ForeColor {
429 if (fore_color != Color.Empty)
433 return parent.ForeColor;
435 return Control.DefaultForeColor;
438 if (this.fore_color != value) {
439 this.fore_color = value;
440 this.OnForeColorChanged (EventArgs.Empty);
447 [EditorBrowsable (EditorBrowsableState.Always)]
448 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
450 get { return this.Size.Height; }
452 this.Size = new Size (this.Size.Width, value);
453 this.explicit_size.Height = value;
456 this.CalculateAutoSize ();
457 this.OnBoundsChanged ();
464 public virtual Image Image {
466 if (this.image != null)
469 if (this.image_index >= 0)
470 if (this.owner != null && this.owner.ImageList != null && this.owner.ImageList.Images.Count > this.image_index)
471 return this.owner.ImageList.Images[this.image_index];
474 if (!string.IsNullOrEmpty (this.image_key))
475 if (this.owner != null && this.owner.ImageList != null && this.owner.ImageList.Images.Count > this.image_index)
476 return this.owner.ImageList.Images[this.image_key];
481 if (this.image != value) {
485 this.image_index = -1;
486 this.image_key = string.Empty;
487 this.CalculateAutoSize ();
496 [DefaultValue (ContentAlignment.MiddleCenter)]
497 public ContentAlignment ImageAlign {
498 get { return this.image_align; }
500 if (!Enum.IsDefined (typeof (ContentAlignment), value))
501 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ContentAlignment", value));
503 if (image_align != value) {
504 this.image_align = value;
505 this.CalculateAutoSize ();
512 [RelatedImageList ("Owner.ImageList")]
513 [TypeConverter (typeof (NoneExcludedImageIndexConverter))]
514 [RefreshProperties (RefreshProperties.Repaint)]
515 [Editor ("System.Windows.Forms.Design.ToolStripImageIndexEditor, " + Consts.AssemblySystem_Design, typeof (System.Drawing.Design.UITypeEditor))]
516 public int ImageIndex {
517 get { return this.image_index; }
519 if (this.image_index != value) {
520 // Lamespec: MSDN says ArgumentException, tests say otherwise
522 throw new ArgumentOutOfRangeException ("ImageIndex cannot be less than -1");
524 this.image_index = value;
526 this.image_key = string.Empty;
527 this.CalculateAutoSize ();
535 [RelatedImageList ("Owner.ImageList")]
536 [TypeConverter (typeof (ImageKeyConverter))]
537 [RefreshProperties (RefreshProperties.Repaint)]
538 [Editor ("System.Windows.Forms.Design.ToolStripImageIndexEditor, " + Consts.AssemblySystem_Design, typeof (System.Drawing.Design.UITypeEditor))]
539 public string ImageKey {
540 get { return this.image_key; }
542 if (this.image_key != value) {
544 this.image_index = -1;
545 this.image_key = value;
546 this.CalculateAutoSize ();
553 [DefaultValue (ToolStripItemImageScaling.SizeToFit)]
554 public ToolStripItemImageScaling ImageScaling {
555 get { return this.image_scaling; }
557 if (image_scaling != value) {
558 this.image_scaling = value;
559 this.CalculateAutoSize ();
565 public Color ImageTransparentColor {
566 get { return this.image_transparent_color; }
567 set { this.image_transparent_color = value; }
571 public bool IsOnDropDown {
573 if (this.parent != null && this.parent is ToolStripDropDown)
581 public bool IsOnOverflow {
582 get { return this.placement == ToolStripItemPlacement.Overflow; }
585 public Padding Margin {
586 get { return this.margin; }
589 this.CalculateAutoSize ();
593 [DefaultValue (MergeAction.Append)]
594 public MergeAction MergeAction {
595 get { return this.merge_action; }
597 if (!Enum.IsDefined (typeof (MergeAction), value))
598 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for MergeAction", value));
600 this.merge_action = value;
605 public int MergeIndex {
606 get { return this.merge_index; }
607 set { this.merge_index = value; }
610 [DefaultValue (null)]
613 get { return this.name; }
614 set { this.name = value; }
617 [DefaultValue (ToolStripItemOverflow.AsNeeded)]
618 public ToolStripItemOverflow Overflow {
619 get { return this.overflow; }
621 if (this.overflow != value) {
622 if (!Enum.IsDefined (typeof (ToolStripItemOverflow), value))
623 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ToolStripItemOverflow", value));
625 this.overflow = value;
628 owner.PerformLayout ();
634 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
635 public ToolStrip Owner {
636 get { return this.owner; }
638 if (this.owner != value) {
639 if (this.owner != null)
640 this.owner.Items.Remove (this);
643 value.Items.Add (this);
651 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
652 public ToolStripItem OwnerItem {
653 get { return this.owner_item; }
656 public virtual Padding Padding {
657 get { return this.padding; }
659 this.padding = value;
660 this.CalculateAutoSize ();
666 public ToolStripItemPlacement Placement {
667 get { return this.placement; }
671 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
672 public virtual bool Pressed { get { return this.is_pressed; } }
674 [MonoTODO ("Stub, not implemented")]
676 public virtual RightToLeft RightToLeft {
677 get { return this.right_to_left; }
679 if (this.right_to_left != value) {
680 this.right_to_left = value;
681 this.OnRightToLeftChanged (EventArgs.Empty);
687 [DefaultValue (false)]
688 public bool RightToLeftAutoMirrorImage {
689 get { return this.right_to_left_auto_mirror_image; }
691 if (this.right_to_left_auto_mirror_image != value) {
692 this.right_to_left_auto_mirror_image = value;
699 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
700 public virtual bool Selected { get { return this.is_selected; } }
703 public virtual Size Size {
705 if (!this.AutoSize && this.explicit_size != Size.Empty)
706 return this.explicit_size;
708 return this.bounds.Size;
711 this.bounds.Size = value;
712 this.explicit_size = value;
715 this.CalculateAutoSize ();
716 this.OnBoundsChanged ();
721 [Localizable (false)]
723 [DefaultValue (null)]
724 [TypeConverter (typeof (StringConverter))]
726 get { return this.tag; }
727 set { this.tag = value; }
732 public virtual string Text
734 get { return this.text; }
736 if (this.text != value) {
739 this.CalculateAutoSize ();
741 this.OnTextChanged (EventArgs.Empty);
747 [DefaultValue (ContentAlignment.MiddleCenter)]
748 public virtual ContentAlignment TextAlign {
749 get { return this.text_align; }
751 if (!Enum.IsDefined (typeof (ContentAlignment), value))
752 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ContentAlignment", value));
754 if (this.text_align != value) {
755 this.text_align = value;
756 this.CalculateAutoSize ();
761 public virtual ToolStripTextDirection TextDirection {
763 if (this.text_direction == ToolStripTextDirection.Inherit) {
764 if (this.Parent != null)
765 return this.Parent.TextDirection;
767 return ToolStripTextDirection.Horizontal;
770 return this.text_direction;
773 if (!Enum.IsDefined (typeof (ToolStripTextDirection), value))
774 throw new InvalidEnumArgumentException (string.Format ("Enum argument value '{0}' is not valid for ToolStripTextDirection", value));
776 if (this.text_direction != value) {
777 this.text_direction = value;
778 this.CalculateAutoSize ();
785 [DefaultValue (TextImageRelation.ImageBeforeText)]
786 public TextImageRelation TextImageRelation {
787 get { return this.text_image_relation; }
789 this.text_image_relation = value;
790 this.CalculateAutoSize ();
796 [Editor ("System.ComponentModel.Design.MultilineStringEditor, " + Consts.AssemblySystem_Design,
797 "System.Drawing.Design.UITypeEditor, " + Consts.AssemblySystem_Drawing)]
798 public string ToolTipText {
799 get { return this.tool_tip_text; }
800 set { this.tool_tip_text = value; }
804 public bool Visible {
806 if (this.parent == null)
809 return this.visible && this.parent.Visible;
812 if (this.visible != value) {
813 this.available = value;
814 this.SetVisibleCore (value);
815 if (this.Owner != null)
816 this.Owner.PerformLayout ();
822 [EditorBrowsable (EditorBrowsableState.Always)]
823 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
825 get { return this.Size.Width; }
827 this.Size = new Size (value, this.Size.Height);
828 this.explicit_size.Width = value;
831 this.CalculateAutoSize ();
832 this.OnBoundsChanged ();
839 #region Protected Properties
840 protected virtual bool DefaultAutoToolTip { get { return false; } }
841 protected virtual ToolStripItemDisplayStyle DefaultDisplayStyle { get { return ToolStripItemDisplayStyle.ImageAndText; } }
842 protected internal virtual Padding DefaultMargin { get { return new Padding (0, 1, 0, 2); } }
843 protected virtual Padding DefaultPadding { get { return new Padding (); } }
844 protected virtual Size DefaultSize { get { return new Size (23, 23); } }
845 protected internal virtual bool DismissWhenClicked { get { return true; } }
847 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
848 protected internal ToolStrip Parent {
849 get { return this.parent; }
851 if (this.parent != value) {
852 ToolStrip old_parent = this.parent;
854 OnParentChanged(old_parent, this.parent);
858 protected internal virtual bool ShowKeyboardCues { get { return false; } }
861 #region Public Methods
863 [EditorBrowsable (EditorBrowsableState.Advanced)]
864 public DragDropEffects DoDragDrop (Object data, DragDropEffects allowedEffects)
866 return allowedEffects;
869 public ToolStrip GetCurrentParent ()
874 public virtual Size GetPreferredSize (Size constrainingSize)
876 return this.CalculatePreferredSize (constrainingSize);
879 public void Invalidate ()
882 parent.Invalidate (this.bounds);
885 public void Invalidate (Rectangle r)
888 parent.Invalidate (r);
891 public void PerformClick ()
893 this.OnClick (EventArgs.Empty);
896 [EditorBrowsable (EditorBrowsableState.Never)]
897 public virtual void ResetBackColor () { this.BackColor = Color.Empty; }
899 [EditorBrowsable (EditorBrowsableState.Never)]
900 public virtual void ResetDisplayStyle () { this.display_style = this.DefaultDisplayStyle; }
902 [EditorBrowsable (EditorBrowsableState.Never)]
903 public virtual void ResetFont () { this.font = null; }
905 [EditorBrowsable (EditorBrowsableState.Never)]
906 public virtual void ResetForeColor () { this.ForeColor = Color.Empty; }
908 [EditorBrowsable (EditorBrowsableState.Never)]
909 public virtual void ResetImage () { this.image = null; }
911 [EditorBrowsable (EditorBrowsableState.Never)]
912 public void ResetMargin () { this.margin = this.DefaultMargin; }
914 [EditorBrowsable (EditorBrowsableState.Never)]
915 public void ResetPadding () { this.padding = this.DefaultPadding; }
917 [EditorBrowsable (EditorBrowsableState.Never)]
918 public virtual void ResetRightToLeft () { this.right_to_left = RightToLeft.Inherit; }
920 [EditorBrowsable (EditorBrowsableState.Never)]
921 public virtual void ResetTextDirection () { this.TextDirection = this.DefaultTextDirection; }
923 public void Select ()
925 if (!this.is_selected && this.CanSelect) {
926 this.is_selected = true;
928 if (this.Visible && this.Parent.Focused && this is ToolStripControlHost)
929 (this as ToolStripControlHost).Focus ();
932 this.Parent.NotifySelectedChanged (this);
933 OnUIASelectionChanged ();
937 public override string ToString ()
943 #region Protected Methods
944 [EditorBrowsable (EditorBrowsableState.Advanced)]
945 protected virtual AccessibleObject CreateAccessibilityInstance ()
947 return new ToolStripItemAccessibleObject (this);
950 protected override void Dispose (bool disposing)
952 if (!is_disposed && disposing)
960 base.Dispose (disposing);
963 protected internal virtual bool IsInputChar (char charCode)
968 protected internal virtual bool IsInputKey (Keys keyData)
973 protected virtual void OnAvailableChanged (EventArgs e)
975 EventHandler eh = (EventHandler)(Events [AvailableChangedEvent]);
980 [EditorBrowsable (EditorBrowsableState.Advanced)]
981 protected virtual void OnBackColorChanged (EventArgs e)
983 EventHandler eh = (EventHandler)(Events [BackColorChangedEvent]);
988 protected virtual void OnBoundsChanged ()
990 OnLayout (new LayoutEventArgs(null, string.Empty));
993 protected virtual void OnClick (EventArgs e)
995 EventHandler eh = (EventHandler)(Events [ClickEvent]);
1000 [EditorBrowsable (EditorBrowsableState.Advanced)]
1001 protected virtual void OnDisplayStyleChanged (EventArgs e)
1003 EventHandler eh = (EventHandler)(Events [DisplayStyleChangedEvent]);
1008 protected virtual void OnDoubleClick (EventArgs e)
1010 EventHandler eh = (EventHandler)(Events [DoubleClickEvent]);
1014 if (!double_click_enabled)
1018 [EditorBrowsable (EditorBrowsableState.Advanced)]
1019 protected virtual void OnDragDrop (DragEventArgs dragEvent)
1021 DragEventHandler eh = (DragEventHandler)(Events[DragDropEvent]);
1023 eh (this, dragEvent);
1026 [EditorBrowsable (EditorBrowsableState.Advanced)]
1027 protected virtual void OnDragEnter (DragEventArgs dragEvent)
1029 DragEventHandler eh = (DragEventHandler)(Events[DragEnterEvent]);
1031 eh (this, dragEvent);
1034 [EditorBrowsable (EditorBrowsableState.Advanced)]
1035 protected virtual void OnDragLeave (EventArgs e)
1037 EventHandler eh = (EventHandler)(Events[DragLeaveEvent]);
1042 [EditorBrowsable (EditorBrowsableState.Advanced)]
1043 protected virtual void OnDragOver (DragEventArgs dragEvent)
1045 DragEventHandler eh = (DragEventHandler)(Events[DragOverEvent]);
1047 eh (this, dragEvent);
1050 protected virtual void OnEnabledChanged (EventArgs e)
1052 EventHandler eh = (EventHandler)(Events [EnabledChangedEvent]);
1057 [EditorBrowsable (EditorBrowsableState.Advanced)]
1058 protected virtual void OnFontChanged (EventArgs e)
1062 [EditorBrowsable (EditorBrowsableState.Advanced)]
1063 protected virtual void OnForeColorChanged (EventArgs e)
1065 EventHandler eh = (EventHandler)(Events [ForeColorChangedEvent]);
1070 [EditorBrowsable (EditorBrowsableState.Advanced)]
1071 protected virtual void OnGiveFeedback (GiveFeedbackEventArgs giveFeedbackEvent)
1073 GiveFeedbackEventHandler eh = (GiveFeedbackEventHandler)(Events[GiveFeedbackEvent]);
1075 eh (this, giveFeedbackEvent);
1078 protected virtual void OnLayout (LayoutEventArgs e)
1082 protected virtual void OnLocationChanged (EventArgs e)
1084 EventHandler eh = (EventHandler)(Events [LocationChangedEvent]);
1089 protected virtual void OnMouseDown (MouseEventArgs e)
1092 this.is_pressed = true;
1095 MouseEventHandler eh = (MouseEventHandler)(Events [MouseDownEvent]);
1101 protected virtual void OnMouseEnter (EventArgs e)
1105 EventHandler eh = (EventHandler)(Events [MouseEnterEvent]);
1110 protected virtual void OnMouseHover (EventArgs e)
1113 EventHandler eh = (EventHandler)(Events [MouseHoverEvent]);
1119 protected virtual void OnMouseLeave (EventArgs e)
1121 if (this.CanSelect) {
1122 this.is_selected = false;
1123 this.is_pressed = false;
1125 OnUIASelectionChanged ();
1128 EventHandler eh = (EventHandler)(Events [MouseLeaveEvent]);
1133 protected virtual void OnMouseMove (MouseEventArgs mea)
1136 MouseEventHandler eh = (MouseEventHandler)(Events [MouseMoveEvent]);
1142 protected virtual void OnMouseUp (MouseEventArgs e)
1145 this.is_pressed = false;
1148 if (this.IsOnDropDown)
1149 if (!(this is ToolStripDropDownItem) || !(this as ToolStripDropDownItem).HasDropDownItems || (this as ToolStripDropDownItem).DropDown.Visible == false) {
1150 if ((this.Parent as ToolStripDropDown).OwnerItem != null)
1151 ((this.Parent as ToolStripDropDown).OwnerItem as ToolStripDropDownItem).HideDropDown ();
1153 (this.Parent as ToolStripDropDown).Hide ();
1157 MouseEventHandler eh = (MouseEventHandler)(Events [MouseUpEvent]);
1163 protected virtual void OnOwnerChanged (EventArgs e)
1165 EventHandler eh = (EventHandler)(Events [OwnerChangedEvent]);
1170 [EditorBrowsable (EditorBrowsableState.Advanced)]
1171 protected internal virtual void OnOwnerFontChanged (EventArgs e)
1173 this.CalculateAutoSize ();
1176 protected virtual void OnPaint (PaintEventArgs e)
1178 if (this.parent != null)
1179 this.parent.Renderer.DrawItemBackground (new ToolStripItemRenderEventArgs (e.Graphics, this));
1181 PaintEventHandler eh = (PaintEventHandler)(Events [PaintEvent]);
1186 // This is never called.
1187 [EditorBrowsable (EditorBrowsableState.Advanced)]
1188 protected virtual void OnParentBackColorChanged (EventArgs e)
1192 protected virtual void OnParentChanged (ToolStrip oldParent, ToolStrip newParent)
1194 this.text_size = TextRenderer.MeasureText (this.Text == null ? string.Empty : this.text, this.Font, Size.Empty, TextFormatFlags.HidePrefix);
1196 if (oldParent != null)
1197 oldParent.PerformLayout ();
1199 if (newParent != null)
1200 newParent.PerformLayout ();
1203 protected internal virtual void OnParentEnabledChanged (EventArgs e)
1205 this.OnEnabledChanged (e);
1208 // This is never called.
1209 [EditorBrowsable (EditorBrowsableState.Advanced)]
1210 protected virtual void OnParentForeColorChanged (EventArgs e)
1214 [EditorBrowsable (EditorBrowsableState.Advanced)]
1215 protected internal virtual void OnParentRightToLeftChanged (EventArgs e)
1217 this.OnRightToLeftChanged (e);
1220 [EditorBrowsable (EditorBrowsableState.Advanced)]
1221 protected virtual void OnQueryContinueDrag (QueryContinueDragEventArgs queryContinueDragEvent)
1223 QueryContinueDragEventHandler eh = (QueryContinueDragEventHandler)(Events[QueryContinueDragEvent]);
1225 eh (this, queryContinueDragEvent);
1228 protected virtual void OnRightToLeftChanged (EventArgs e)
1230 EventHandler eh = (EventHandler)(Events[RightToLeftChangedEvent]);
1235 [EditorBrowsable (EditorBrowsableState.Advanced)]
1236 protected virtual void OnTextChanged (EventArgs e)
1238 EventHandler eh = (EventHandler)(Events [TextChangedEvent]);
1243 protected virtual void OnVisibleChanged (EventArgs e)
1245 EventHandler eh = (EventHandler)(Events [VisibleChangedEvent]);
1250 protected internal virtual bool ProcessCmdKey (ref Message m, Keys keyData)
1255 protected internal virtual bool ProcessDialogKey (Keys keyData)
1257 if (this.Selected && keyData == Keys.Enter) {
1258 this.FireEvent (EventArgs.Empty, ToolStripItemEventType.Click);
1265 // ProcessMnemonic will only be called if we are supposed to handle
1266 // it. None of that fancy "thinking" needed!
1267 protected internal virtual bool ProcessMnemonic (char charCode)
1269 ToolStripManager.SetActiveToolStrip (this.Parent, true);
1270 this.PerformClick ();
1274 protected internal virtual void SetBounds (Rectangle bounds)
1276 if (this.bounds != bounds) {
1277 this.bounds = bounds;
1282 protected virtual void SetVisibleCore (bool visible)
1284 this.visible = visible;
1285 this.OnVisibleChanged (EventArgs.Empty);
1295 #region Public Events
1296 static object AvailableChangedEvent = new object ();
1297 static object BackColorChangedEvent = new object ();
1298 static object ClickEvent = new object ();
1299 static object DisplayStyleChangedEvent = new object ();
1300 static object DoubleClickEvent = new object ();
1301 static object DragDropEvent = new object ();
1302 static object DragEnterEvent = new object ();
1303 static object DragLeaveEvent = new object ();
1304 static object DragOverEvent = new object ();
1305 static object EnabledChangedEvent = new object ();
1306 static object ForeColorChangedEvent = new object ();
1307 static object GiveFeedbackEvent = new object ();
1308 static object LocationChangedEvent = new object ();
1309 static object MouseDownEvent = new object ();
1310 static object MouseEnterEvent = new object ();
1311 static object MouseHoverEvent = new object ();
1312 static object MouseLeaveEvent = new object ();
1313 static object MouseMoveEvent = new object ();
1314 static object MouseUpEvent = new object ();
1315 static object OwnerChangedEvent = new object ();
1316 static object PaintEvent = new object ();
1317 static object QueryAccessibilityHelpEvent = new object ();
1318 static object QueryContinueDragEvent = new object ();
1319 static object RightToLeftChangedEvent = new object ();
1320 static object TextChangedEvent = new object ();
1321 static object VisibleChangedEvent = new object ();
1324 public event EventHandler AvailableChanged {
1325 add { Events.AddHandler (AvailableChangedEvent, value); }
1326 remove {Events.RemoveHandler (AvailableChangedEvent, value); }
1329 public event EventHandler BackColorChanged {
1330 add { Events.AddHandler (BackColorChangedEvent, value); }
1331 remove {Events.RemoveHandler (BackColorChangedEvent, value); }
1334 public event EventHandler Click {
1335 add { Events.AddHandler (ClickEvent, value); }
1336 remove {Events.RemoveHandler (ClickEvent, value); }
1339 public event EventHandler DisplayStyleChanged {
1340 add { Events.AddHandler (DisplayStyleChangedEvent, value); }
1341 remove {Events.RemoveHandler (DisplayStyleChangedEvent, value); }
1344 public event EventHandler DoubleClick {
1345 add { Events.AddHandler (DoubleClickEvent, value); }
1346 remove {Events.RemoveHandler (DoubleClickEvent, value); }
1349 [MonoTODO ("Not raised")]
1351 [EditorBrowsable (EditorBrowsableState.Advanced)]
1352 public event DragEventHandler DragDrop {
1353 add { Events.AddHandler (DragDropEvent, value); }
1354 remove { Events.RemoveHandler (DragDropEvent, value); }
1357 [MonoTODO ("Not raised")]
1359 [EditorBrowsable (EditorBrowsableState.Advanced)]
1360 public event DragEventHandler DragEnter {
1361 add { Events.AddHandler (DragEnterEvent, value); }
1362 remove { Events.RemoveHandler (DragEnterEvent, value); }
1365 [MonoTODO ("Not raised")]
1367 [EditorBrowsable (EditorBrowsableState.Advanced)]
1368 public event EventHandler DragLeave {
1369 add { Events.AddHandler (DragLeaveEvent, value); }
1370 remove { Events.RemoveHandler (DragLeaveEvent, value); }
1373 [MonoTODO ("Not raised")]
1375 [EditorBrowsable (EditorBrowsableState.Advanced)]
1376 public event DragEventHandler DragOver {
1377 add { Events.AddHandler (DragOverEvent, value); }
1378 remove { Events.RemoveHandler (DragOverEvent, value); }
1381 public event EventHandler EnabledChanged {
1382 add { Events.AddHandler (EnabledChangedEvent, value); }
1383 remove {Events.RemoveHandler (EnabledChangedEvent, value); }
1386 public event EventHandler ForeColorChanged {
1387 add { Events.AddHandler (ForeColorChangedEvent, value); }
1388 remove {Events.RemoveHandler (ForeColorChangedEvent, value); }
1391 [MonoTODO ("Not raised")]
1393 [EditorBrowsable (EditorBrowsableState.Advanced)]
1394 public event GiveFeedbackEventHandler GiveFeedback {
1395 add { Events.AddHandler (GiveFeedbackEvent, value); }
1396 remove { Events.RemoveHandler (GiveFeedbackEvent, value); }
1399 public event EventHandler LocationChanged {
1400 add { Events.AddHandler (LocationChangedEvent, value); }
1401 remove {Events.RemoveHandler (LocationChangedEvent, value); }
1404 public event MouseEventHandler MouseDown {
1405 add { Events.AddHandler (MouseDownEvent, value); }
1406 remove {Events.RemoveHandler (MouseDownEvent, value); }
1409 public event EventHandler MouseEnter {
1410 add { Events.AddHandler (MouseEnterEvent, value); }
1411 remove {Events.RemoveHandler (MouseEnterEvent, value); }
1414 public event EventHandler MouseHover {
1415 add { Events.AddHandler (MouseHoverEvent, value); }
1416 remove {Events.RemoveHandler (MouseHoverEvent, value); }
1419 public event EventHandler MouseLeave {
1420 add { Events.AddHandler (MouseLeaveEvent, value); }
1421 remove {Events.RemoveHandler (MouseLeaveEvent, value); }
1424 public event MouseEventHandler MouseMove {
1425 add { Events.AddHandler (MouseMoveEvent, value); }
1426 remove {Events.RemoveHandler (MouseMoveEvent, value); }
1429 public event MouseEventHandler MouseUp {
1430 add { Events.AddHandler (MouseUpEvent, value); }
1431 remove {Events.RemoveHandler (MouseUpEvent, value); }
1434 public event EventHandler OwnerChanged {
1435 add { Events.AddHandler (OwnerChangedEvent, value); }
1436 remove {Events.RemoveHandler (OwnerChangedEvent, value); }
1439 public event PaintEventHandler Paint {
1440 add { Events.AddHandler (PaintEvent, value); }
1441 remove {Events.RemoveHandler (PaintEvent, value); }
1444 [MonoTODO ("Not raised")]
1445 public event QueryAccessibilityHelpEventHandler QueryAccessibilityHelp {
1446 add { Events.AddHandler (QueryAccessibilityHelpEvent, value); }
1447 remove { Events.RemoveHandler (QueryAccessibilityHelpEvent, value); }
1450 [MonoTODO ("Not raised")]
1452 [EditorBrowsable (EditorBrowsableState.Advanced)]
1453 public event QueryContinueDragEventHandler QueryContinueDrag {
1454 add { Events.AddHandler (QueryContinueDragEvent, value); }
1455 remove { Events.RemoveHandler (QueryContinueDragEvent, value); }
1458 public event EventHandler RightToLeftChanged {
1459 add { Events.AddHandler (RightToLeftChangedEvent, value); }
1460 remove { Events.RemoveHandler (RightToLeftChangedEvent, value); }
1463 public event EventHandler TextChanged {
1464 add { Events.AddHandler (TextChangedEvent, value); }
1465 remove {Events.RemoveHandler (TextChangedEvent, value); }
1468 public event EventHandler VisibleChanged {
1469 add { Events.AddHandler (VisibleChangedEvent, value); }
1470 remove {Events.RemoveHandler (VisibleChangedEvent, value); }
1474 #region Internal Methods
1475 internal Rectangle AlignInRectangle (Rectangle outer, Size inner, ContentAlignment align)
1480 if (align == ContentAlignment.BottomLeft || align == ContentAlignment.MiddleLeft || align == ContentAlignment.TopLeft)
1482 else if (align == ContentAlignment.BottomCenter || align == ContentAlignment.MiddleCenter || align == ContentAlignment.TopCenter)
1483 x = Math.Max (outer.X + ((outer.Width - inner.Width) / 2), outer.Left);
1484 else if (align == ContentAlignment.BottomRight || align == ContentAlignment.MiddleRight || align == ContentAlignment.TopRight)
1485 x = outer.Right - inner.Width;
1486 if (align == ContentAlignment.TopCenter || align == ContentAlignment.TopLeft || align == ContentAlignment.TopRight)
1488 else if (align == ContentAlignment.MiddleCenter || align == ContentAlignment.MiddleLeft || align == ContentAlignment.MiddleRight)
1489 y = outer.Y + (outer.Height - inner.Height) / 2;
1490 else if (align == ContentAlignment.BottomCenter || align == ContentAlignment.BottomRight || align == ContentAlignment.BottomLeft)
1491 y = outer.Bottom - inner.Height;
1493 return new Rectangle (x, y, Math.Min (inner.Width, outer.Width), Math.Min (inner.Height, outer.Height));
1496 internal void CalculateAutoSize ()
1498 this.text_size = TextRenderer.MeasureText (this.Text == null ? string.Empty: this.text, this.Font, Size.Empty, TextFormatFlags.HidePrefix);
1500 // If our text is rotated, flip the width and height
1501 ToolStripTextDirection direction = this.TextDirection;
1503 if (direction == ToolStripTextDirection.Vertical270 || direction == ToolStripTextDirection.Vertical90)
1504 this.text_size = new Size (this.text_size.Height, this.text_size.Width);
1506 if (!this.auto_size || this is ToolStripControlHost)
1508 //this.text_size.Width += 6;
1510 Size final_size = this.CalculatePreferredSize (Size.Empty);
1512 if (final_size != this.Size) {
1513 this.bounds.Width = final_size.Width;
1514 if (this.parent != null)
1515 this.parent.PerformLayout ();
1519 internal virtual Size CalculatePreferredSize (Size constrainingSize)
1521 if (!this.auto_size)
1522 return this.explicit_size;
1524 Size preferred_size = this.DefaultSize;
1526 switch (this.display_style) {
1527 case ToolStripItemDisplayStyle.Text:
1528 int width = text_size.Width + this.padding.Horizontal;
1529 int height = text_size.Height + this.padding.Vertical;
1530 preferred_size = new Size (width, height);
1532 case ToolStripItemDisplayStyle.Image:
1533 if (this.GetImageSize () == Size.Empty)
1534 preferred_size = this.DefaultSize;
1536 switch (this.image_scaling) {
1537 case ToolStripItemImageScaling.None:
1538 preferred_size = this.GetImageSize ();
1540 case ToolStripItemImageScaling.SizeToFit:
1541 if (this.parent == null)
1542 preferred_size = this.GetImageSize ();
1544 preferred_size = this.parent.ImageScalingSize;
1549 case ToolStripItemDisplayStyle.ImageAndText:
1550 int width2 = text_size.Width + this.padding.Horizontal;
1551 int height2 = text_size.Height + this.padding.Vertical;
1553 if (this.GetImageSize () != Size.Empty) {
1554 Size image_size = this.GetImageSize ();
1556 if (this.image_scaling == ToolStripItemImageScaling.SizeToFit && this.parent != null)
1557 image_size = this.parent.ImageScalingSize;
1559 switch (this.text_image_relation) {
1560 case TextImageRelation.Overlay:
1561 width2 = Math.Max (width2, image_size.Width);
1562 height2 = Math.Max (height2, image_size.Height);
1564 case TextImageRelation.ImageAboveText:
1565 case TextImageRelation.TextAboveImage:
1566 width2 = Math.Max (width2, image_size.Width);
1567 height2 += image_size.Height;
1569 case TextImageRelation.ImageBeforeText:
1570 case TextImageRelation.TextBeforeImage:
1571 height2 = Math.Max (height2, image_size.Height);
1572 width2 += image_size.Width;
1577 preferred_size = new Size (width2, height2);
1581 if (!(this is ToolStripLabel)) { // Everything but labels have a border
1582 preferred_size.Height += 4;
1583 preferred_size.Width += 4;
1586 // Account for ToolStripDropDownButton's drop down arrow
1587 if (this is ToolStripDropDownButton && (this as ToolStripDropDownButton).ShowDropDownArrow)
1588 preferred_size.Width += 9;
1590 return preferred_size;
1593 internal void CalculateTextAndImageRectangles (out Rectangle text_rect, out Rectangle image_rect)
1595 this.CalculateTextAndImageRectangles (this.ContentRectangle, out text_rect, out image_rect);
1598 internal void CalculateTextAndImageRectangles (Rectangle contentRectangle, out Rectangle text_rect, out Rectangle image_rect)
1600 text_rect = Rectangle.Empty;
1601 image_rect = Rectangle.Empty;
1603 switch (this.display_style) {
1604 case ToolStripItemDisplayStyle.None:
1606 case ToolStripItemDisplayStyle.Text:
1607 if (this.text != string.Empty)
1608 text_rect = AlignInRectangle (contentRectangle, this.text_size, this.text_align);
1610 case ToolStripItemDisplayStyle.Image:
1611 if (this.Image != null && this.UseImageMargin)
1612 image_rect = AlignInRectangle (contentRectangle, GetImageSize (), this.image_align);
1614 case ToolStripItemDisplayStyle.ImageAndText:
1615 if (this.text != string.Empty && (this.Image == null || !this.UseImageMargin))
1616 text_rect = AlignInRectangle (contentRectangle, this.text_size, this.text_align);
1617 else if (this.text == string.Empty && (this.Image == null || !this.UseImageMargin))
1619 else if (this.text == string.Empty && this.Image != null)
1620 image_rect = AlignInRectangle (contentRectangle, GetImageSize (), this.image_align);
1622 Rectangle text_area;
1623 Rectangle image_area;
1625 switch (this.text_image_relation) {
1626 case TextImageRelation.Overlay:
1627 text_rect = AlignInRectangle (contentRectangle, this.text_size, this.text_align);
1628 image_rect = AlignInRectangle (contentRectangle, GetImageSize (), this.image_align);
1630 case TextImageRelation.ImageAboveText:
1631 text_area = new Rectangle (contentRectangle.Left, contentRectangle.Bottom - (text_size.Height - 4), contentRectangle.Width, text_size.Height - 4);
1632 image_area = new Rectangle (contentRectangle.Left, contentRectangle.Top, contentRectangle.Width, contentRectangle.Height - text_area.Height);
1634 text_rect = AlignInRectangle (text_area, this.text_size, this.text_align);
1635 image_rect = AlignInRectangle (image_area, GetImageSize (), this.image_align);
1637 case TextImageRelation.TextAboveImage:
1638 text_area = new Rectangle (contentRectangle.Left, contentRectangle.Top, contentRectangle.Width, text_size.Height - 4);
1639 image_area = new Rectangle (contentRectangle.Left, text_area.Bottom, contentRectangle.Width, contentRectangle.Height - text_area.Height);
1641 text_rect = AlignInRectangle (text_area, this.text_size, this.text_align);
1642 image_rect = AlignInRectangle (image_area, GetImageSize (), this.image_align);
1644 case TextImageRelation.ImageBeforeText:
1645 LayoutTextBeforeOrAfterImage (contentRectangle, false, text_size, GetImageSize (), text_align, image_align, out text_rect, out image_rect);
1647 case TextImageRelation.TextBeforeImage:
1648 LayoutTextBeforeOrAfterImage (contentRectangle, true, text_size, GetImageSize (), text_align, image_align, out text_rect, out image_rect);
1656 private static Font DefaultFont { get { return new Font ("Tahoma", 8.25f); } }
1658 internal virtual ToolStripTextDirection DefaultTextDirection { get { return ToolStripTextDirection.Inherit; } }
1660 internal virtual void Dismiss (ToolStripDropDownCloseReason reason)
1663 this.is_selected = false;
1665 OnUIASelectionChanged ();
1669 internal virtual ToolStrip GetTopLevelToolStrip ()
1671 if (this.Parent != null)
1672 return this.Parent.GetTopLevelToolStrip ();
1677 private void LayoutTextBeforeOrAfterImage (Rectangle totalArea, bool textFirst, Size textSize, Size imageSize, ContentAlignment textAlign, ContentAlignment imageAlign, out Rectangle textRect, out Rectangle imageRect)
1679 int element_spacing = 0; // Spacing between the Text and the Image
1680 int total_width = textSize.Width + element_spacing + imageSize.Width;
1681 int excess_width = totalArea.Width - total_width;
1684 Rectangle final_text_rect;
1685 Rectangle final_image_rect;
1687 HorizontalAlignment h_text = GetHorizontalAlignment (textAlign);
1688 HorizontalAlignment h_image = GetHorizontalAlignment (imageAlign);
1690 if (h_image == HorizontalAlignment.Left)
1692 else if (h_image == HorizontalAlignment.Right && h_text == HorizontalAlignment.Right)
1693 offset = excess_width;
1694 else if (h_image == HorizontalAlignment.Center && (h_text == HorizontalAlignment.Left || h_text == HorizontalAlignment.Center))
1695 offset += (int)(excess_width / 3);
1697 offset += (int)(2 * (excess_width / 3));
1700 final_text_rect = new Rectangle (totalArea.Left + offset, AlignInRectangle (totalArea, textSize, textAlign).Top, textSize.Width, textSize.Height);
1701 final_image_rect = new Rectangle (final_text_rect.Right + element_spacing, AlignInRectangle (totalArea, imageSize, imageAlign).Top, imageSize.Width, imageSize.Height);
1703 final_image_rect = new Rectangle (totalArea.Left + offset, AlignInRectangle (totalArea, imageSize, imageAlign).Top, imageSize.Width, imageSize.Height);
1704 final_text_rect = new Rectangle (final_image_rect.Right + element_spacing, AlignInRectangle (totalArea, textSize, textAlign).Top, textSize.Width, textSize.Height);
1707 textRect = final_text_rect;
1708 imageRect = final_image_rect;
1711 private HorizontalAlignment GetHorizontalAlignment (ContentAlignment align)
1714 case ContentAlignment.BottomLeft:
1715 case ContentAlignment.MiddleLeft:
1716 case ContentAlignment.TopLeft:
1717 return HorizontalAlignment.Left;
1718 case ContentAlignment.BottomCenter:
1719 case ContentAlignment.MiddleCenter:
1720 case ContentAlignment.TopCenter:
1721 return HorizontalAlignment.Center;
1722 case ContentAlignment.BottomRight:
1723 case ContentAlignment.MiddleRight:
1724 case ContentAlignment.TopRight:
1725 return HorizontalAlignment.Right;
1728 return HorizontalAlignment.Left;
1731 internal Size GetImageSize ()
1733 // Get the actual size of our internal image -or-
1734 // Get the ImageList.ImageSize if we are using ImageLists
1735 if (this.image_scaling == ToolStripItemImageScaling.None) {
1736 if (this.image != null)
1739 if (this.image_index >= 0 || !string.IsNullOrEmpty (this.image_key))
1740 if (this.owner != null && this.owner.ImageList != null)
1741 return this.owner.ImageList.ImageSize;
1743 // If we have an image and a parent, return ImageScalingSize
1744 if (this.Parent == null)
1747 if (this.image != null)
1748 return this.Parent.ImageScalingSize;
1750 if (this.image_index >= 0 || !string.IsNullOrEmpty (this.image_key))
1751 if (this.owner != null && this.owner.ImageList != null)
1752 return this.Parent.ImageScalingSize;
1758 internal string GetToolTip ()
1760 if (this.auto_tool_tip && string.IsNullOrEmpty (this.tool_tip_text))
1763 return this.tool_tip_text;
1766 internal void FireEvent (EventArgs e, ToolStripItemEventType met)
1768 // If we're disabled, don't fire any of these events, except Paint
1769 if (!this.Enabled && met != ToolStripItemEventType.Paint)
1773 case ToolStripItemEventType.MouseUp:
1774 this.HandleClick (e);
1775 this.OnMouseUp ((MouseEventArgs)e);
1777 case ToolStripItemEventType.MouseDown:
1778 this.OnMouseDown ((MouseEventArgs)e);
1780 case ToolStripItemEventType.MouseEnter:
1781 this.OnMouseEnter (e);
1783 case ToolStripItemEventType.MouseHover:
1784 this.OnMouseHover (e);
1786 case ToolStripItemEventType.MouseLeave:
1787 this.OnMouseLeave (e);
1789 case ToolStripItemEventType.MouseMove:
1790 this.OnMouseMove ((MouseEventArgs)e);
1792 case ToolStripItemEventType.Paint:
1793 this.OnPaint ((PaintEventArgs)e);
1795 case ToolStripItemEventType.Click:
1796 this.HandleClick (e);
1801 internal virtual void HandleClick (EventArgs e)
1803 this.Parent.HandleItemClick (this);
1807 internal virtual void SetPlacement (ToolStripItemPlacement placement)
1809 this.placement = placement;
1812 private void BeginAnimation ()
1814 if (image != null && ImageAnimator.CanAnimate (image)) {
1815 frame_handler = new EventHandler (OnAnimateImage);
1816 ImageAnimator.Animate (image, frame_handler);
1820 private void OnAnimateImage (object sender, EventArgs e)
1822 // This is called from a worker thread,BeginInvoke is used
1823 // so the control is updated from the correct thread
1825 // Check if we have a handle again, since it may have gotten
1826 // destroyed since the last time we checked.
1827 if (Parent == null || !Parent.IsHandleCreated)
1830 Parent.BeginInvoke (new EventHandler (UpdateAnimatedImage), new object[] { this, e });
1833 private void StopAnimation ()
1835 if (frame_handler == null)
1838 ImageAnimator.StopAnimate (image, frame_handler);
1839 frame_handler = null;
1842 private void UpdateAnimatedImage (object sender, EventArgs e)
1844 // Check if we have a handle again, since it may have gotten
1845 // destroyed since the last time we checked.
1846 if (Parent == null || !Parent.IsHandleCreated)
1849 ImageAnimator.UpdateFrames (image);
1853 internal bool ShowMargin {
1855 if (!this.IsOnDropDown)
1858 if (!(this.Owner is ToolStripDropDownMenu))
1861 ToolStripDropDownMenu tsddm = (ToolStripDropDownMenu)this.Owner;
1863 return tsddm.ShowCheckMargin || tsddm.ShowImageMargin;
1867 internal bool UseImageMargin {
1869 if (!this.IsOnDropDown)
1872 if (!(this.Owner is ToolStripDropDownMenu))
1875 ToolStripDropDownMenu tsddm = (ToolStripDropDownMenu)this.Owner;
1877 return tsddm.ShowImageMargin || tsddm.ShowCheckMargin;
1881 internal virtual bool InternalVisible {
1882 get { return this.visible; }
1883 set { this.visible = value; Invalidate (); }
1886 internal ToolStrip InternalOwner {
1888 if (this.owner != value) {
1890 this.CalculateAutoSize ();
1891 OnOwnerChanged (EventArgs.Empty);
1896 internal Point Location {
1897 get { return this.bounds.Location; }
1899 if (this.bounds.Location != value) {
1900 this.bounds.Location = value;
1901 this.OnLocationChanged (EventArgs.Empty);
1907 get { return this.bounds.Y; }
1909 if (this.bounds.Y != value) {
1910 this.bounds.Y = value;
1911 this.OnLocationChanged (EventArgs.Empty);
1917 get { return this.bounds.X; }
1919 if (this.bounds.X != value) {
1920 this.bounds.X = value;
1921 this.OnLocationChanged (EventArgs.Empty);
1926 internal int Right { get { return this.bounds.Right; } }
1927 internal int Bottom { get { return this.bounds.Bottom; } }
1930 #region IDropTarget Members
1931 void IDropTarget.OnDragDrop (DragEventArgs dragEvent)
1933 OnDragDrop (dragEvent);
1936 void IDropTarget.OnDragEnter (DragEventArgs dragEvent)
1938 OnDragEnter (dragEvent);
1941 void IDropTarget.OnDragLeave (EventArgs e)
1946 void IDropTarget.OnDragOver (DragEventArgs dragEvent)
1948 OnDragOver (dragEvent);
1952 #region UIA Framework: Methods, Properties and Events
1954 static object UIASelectionChangedEvent = new object ();
1956 internal event EventHandler UIASelectionChanged {
1957 add { Events.AddHandler (UIASelectionChangedEvent, value); }
1958 remove { Events.RemoveHandler (UIASelectionChangedEvent, value); }
1961 internal void OnUIASelectionChanged ()
1963 EventHandler eh = (EventHandler)(Events [UIASelectionChangedEvent]);
1965 eh (this, EventArgs.Empty);
1971 public class ToolStripItemAccessibleObject : AccessibleObject
1973 internal ToolStripItem owner_item;
1975 public ToolStripItemAccessibleObject (ToolStripItem ownerItem)
1977 if (ownerItem == null)
1978 throw new ArgumentNullException ("ownerItem");
1980 this.owner_item = ownerItem;
1981 base.default_action = string.Empty;
1982 base.keyboard_shortcut = string.Empty;
1983 base.name = string.Empty;
1984 base.value = string.Empty;
1987 #region Public Properties
1988 public override Rectangle Bounds {
1990 return owner_item.Visible ? owner_item.Bounds : Rectangle.Empty;
1994 public override string DefaultAction {
1995 get { return base.DefaultAction; }
1998 public override string Description {
1999 get { return base.Description; }
2002 public override string Help {
2003 get { return base.Help; }
2006 public override string KeyboardShortcut {
2007 get { return base.KeyboardShortcut; }
2010 public override string Name {
2012 if (base.name == string.Empty)
2013 return owner_item.Text;
2017 set { base.Name = value; }
2020 public override AccessibleObject Parent {
2021 get { return base.Parent; }
2024 public override AccessibleRole Role {
2025 get { return base.Role; }
2028 public override AccessibleStates State {
2029 get { return base.State; }
2033 #region Public Methods
2034 public void AddState (AccessibleStates state)
2039 public override void DoDefaultAction ()
2041 base.DoDefaultAction ();
2044 public override int GetHelpTopic (out string fileName)
2046 return base.GetHelpTopic (out fileName);
2049 public override AccessibleObject Navigate (AccessibleNavigation navigationDirection)
2051 return base.Navigate (navigationDirection);
2054 public override string ToString ()
2056 return string.Format ("ToolStripItemAccessibleObject: Owner = {0}", owner_item.ToString());
2062 internal class NoneExcludedImageIndexConverter : ImageIndexConverter