0 out of 1 rated this helpful - Rate this topic

ToolStripSeparator Class

Represents a line used to group items of a ToolStrip or the drop-down items of a MenuStrip or ContextMenuStrip or other ToolStripDropDown control.

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.ToolStripItem
        System.Windows.Forms.ToolStripSeparator

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
[ToolStripItemDesignerAvailabilityAttribute(ToolStripItemDesignerAvailability.None|ToolStripItemDesignerAvailability.ToolStrip|ToolStripItemDesignerAvailability.ContextMenuStrip)]
public class ToolStripSeparator : ToolStripItem

The ToolStripSeparator type exposes the following members.

  Name Description
Public method ToolStripSeparator Initializes a new instance of the ToolStripSeparator class.
Top
  Name Description
Public property AccessibilityObject Gets the AccessibleObject assigned to the control. (Inherited from ToolStripItem.)
Public property AccessibleDefaultActionDescription Gets or sets the default action description of the control for use by accessibility client applications. (Inherited from ToolStripItem.)
Public property AccessibleDescription Gets or sets the description that will be reported to accessibility client applications. (Inherited from ToolStripItem.)
Public property AccessibleName Gets or sets the name of the control for use by accessibility client applications. (Inherited from ToolStripItem.)
Public property AccessibleRole Gets or sets the accessible role of the control, which specifies the type of user interface element of the control. (Inherited from ToolStripItem.)
Public property Alignment Gets or sets a value indicating whether the item aligns towards the beginning or end of the ToolStrip. (Inherited from ToolStripItem.)
Public property AllowDrop Gets or sets a value indicating whether drag-and-drop and item reordering are handled through events that you implement. (Inherited from ToolStripItem.)
Public property Anchor Gets or sets the edges of the container to which a ToolStripItem is bound and determines how a ToolStripItem is resized with its parent. (Inherited from ToolStripItem.)
Public property AutoSize Gets or sets a value indicating whether the item is automatically sized. (Inherited from ToolStripItem.)
Public property AutoToolTip Infrastructure. This property is not relevant to this class.
Public property Available Gets or sets a value indicating whether the ToolStripItem should be placed on a ToolStrip. (Inherited from ToolStripItem.)
Public property BackColor Gets or sets the background color for the item. (Inherited from ToolStripItem.)
Public property BackgroundImage Infrastructure. This property is not relevant to this class. (Overrides ToolStripItem.BackgroundImage.)
Public property BackgroundImageLayout Infrastructure. This property is not relevant to this class. (Overrides ToolStripItem.BackgroundImageLayout.)
Public property Bounds Gets the size and location of the item. (Inherited from ToolStripItem.)
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property CanSelect Gets a value indicating whether the ToolStripSeparator can be selected. (Overrides ToolStripItem.CanSelect.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Public property ContentRectangle Gets the area where content, such as text and icons, can be placed within a ToolStripItem without overwriting background borders. (Inherited from ToolStripItem.)
Protected property DefaultAutoToolTip Gets a value indicating whether to display the ToolTip that is defined as the default. (Inherited from ToolStripItem.)
Protected property DefaultDisplayStyle Gets a value indicating what is displayed on the ToolStripItem. (Inherited from ToolStripItem.)
Protected property DefaultMargin Gets the default margin of an item. (Overrides ToolStripItem.DefaultMargin.)
Protected property DefaultPadding Gets the internal spacing characteristics of the item. (Inherited from ToolStripItem.)
Protected property DefaultSize Gets the default size of the item. (Overrides ToolStripItem.DefaultSize.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected property DismissWhenClicked Gets a value indicating whether items on a ToolStripDropDown are hidden after they are clicked. (Inherited from ToolStripItem.)
Public property DisplayStyle Infrastructure. This property is not relevant to this class.
Public property Dock Gets or sets which ToolStripItem borders are docked to its parent control and determines how a ToolStripItem is resized with its parent. (Inherited from ToolStripItem.)
Public property DoubleClickEnabled Infrastructure. This property is not relevant to this class.
Public property Enabled Infrastructure. This property is not relevant to this class. (Overrides ToolStripItem.Enabled.)
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property Font Infrastructure. This property is not relevant to this class. (Overrides ToolStripItem.Font.)
Public property ForeColor Gets or sets the foreground color of the item. (Inherited from ToolStripItem.)
Public property Height Gets or sets the height, in pixels, of a ToolStripItem. (Inherited from ToolStripItem.)
Public property Image Infrastructure. This property is not relevant to this class. (Overrides ToolStripItem.Image.)
Public property ImageAlign Infrastructure. This property is not relevant to this class.
Public property ImageIndex Infrastructure. This property is not relevant to this class.
Public property ImageKey Infrastructure. This property is not relevant to this class.
Public property ImageScaling Infrastructure. This property is not relevant to this class.
Public property ImageTransparentColor Infrastructure. This property is not relevant to this class.
Public property IsDisposed Gets a value indicating whether the object has been disposed of. (Inherited from ToolStripItem.)
Public property IsOnDropDown Gets a value indicating whether the container of the current Control is a ToolStripDropDown. (Inherited from ToolStripItem.)
Public property IsOnOverflow Gets a value indicating whether the Placement property is set to Overflow. (Inherited from ToolStripItem.)
Public property Margin Gets or sets the space between the item and adjacent items. (Inherited from ToolStripItem.)
Public property MergeAction Gets or sets how child menus are merged with parent menus. (Inherited from ToolStripItem.)
Public property MergeIndex Gets or sets the position of a merged item within the current ToolStrip. (Inherited from ToolStripItem.)
Public property Name Gets or sets the name of the item. (Inherited from ToolStripItem.)
Public property Overflow Gets or sets whether the item is attached to the ToolStrip or ToolStripOverflowButton or can float between the two. (Inherited from ToolStripItem.)
Public property Owner Gets or sets the owner of this item. (Inherited from ToolStripItem.)
Public property OwnerItem Gets the parent ToolStripItem of this ToolStripItem. (Inherited from ToolStripItem.)
Public property Padding Gets or sets the internal spacing, in pixels, between the item's contents and its edges. (Inherited from ToolStripItem.)
Protected property Parent Gets or sets the parent container of the ToolStripItem. (Inherited from ToolStripItem.)
Public property Placement Gets the current layout of the item. (Inherited from ToolStripItem.)
Public property Pressed Gets a value indicating whether the state of the item is pressed. (Inherited from ToolStripItem.)
Public property RightToLeft Gets or sets a value indicating whether items are to be placed from right to left and text is to be written from right to left. (Inherited from ToolStripItem.)
Public property RightToLeftAutoMirrorImage Infrastructure. This property is not relevant to this class.
Public property Selected Gets a value indicating whether the item is selected. (Inherited from ToolStripItem.)
Protected property ShowKeyboardCues Gets a value indicating whether to show or hide shortcut keys. (Inherited from ToolStripItem.)
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Public property Size Gets or sets the size of the item. (Inherited from ToolStripItem.)
Public property Tag Gets or sets the object that contains data about the item. (Inherited from ToolStripItem.)
Public property Text Infrastructure. This property is not relevant to this class. (Overrides ToolStripItem.Text.)
Public property TextAlign Infrastructure. This property is not relevant to this class.
Public property TextDirection Infrastructure. This property is not relevant to this class. (Overrides ToolStripItem.TextDirection.)
Public property TextImageRelation Infrastructure. This property is not relevant to this class.
Public property ToolTipText Infrastructure. This property is not relevant to this class.
Public property Visible Gets or sets a value indicating whether the item is displayed. (Inherited from ToolStripItem.)
Public property Width Gets or sets the width in pixels of a ToolStripItem. (Inherited from ToolStripItem.)
Top
  Name Description
Protected method CreateAccessibilityInstance Creates a new accessibility object for the ToolStripItem. (Overrides ToolStripItem.CreateAccessibilityInstance().)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the Component. (Inherited from Component.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the ToolStripItem and optionally releases the managed resources. (Inherited from ToolStripItem.)
Public method DoDragDrop Begins a drag-and-drop operation. (Inherited from ToolStripItem.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetCurrentParent Retrieves the ToolStrip that is the container of the current ToolStripItem. (Inherited from ToolStripItem.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetPreferredSize Retrieves the size of a rectangular area into which a ToolStripSeparator can be fitted. (Overrides ToolStripItem.GetPreferredSize(Size).)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method Invalidate() Invalidates the entire surface of the ToolStripItem and causes it to be redrawn. (Inherited from ToolStripItem.)
Public method Invalidate(Rectangle) Invalidates the specified region of the ToolStripItem by adding it to the update region of the ToolStripItem, which is the area that will be repainted at the next paint operation, and causes a paint message to be sent to the ToolStripItem. (Inherited from ToolStripItem.)
Protected method IsInputChar Determines whether a character is an input character that the item recognizes. (Inherited from ToolStripItem.)
Protected method IsInputKey Determines whether the specified key is a regular input key or a special key that requires preprocessing. (Inherited from ToolStripItem.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method OnAvailableChanged Raises the AvailableChanged event. (Inherited from ToolStripItem.)
Protected method OnBackColorChanged Raises the BackColorChanged event. (Inherited from ToolStripItem.)
Protected method OnBoundsChanged Occurs when the Bounds property changes. (Inherited from ToolStripItem.)
Protected method OnClick Raises the Click event. (Inherited from ToolStripItem.)
Protected method OnDisplayStyleChanged Raises the DisplayStyleChanged event. (Inherited from ToolStripItem.)
Protected method OnDoubleClick Raises the DoubleClick event. (Inherited from ToolStripItem.)
Protected method OnDragDrop Raises the DragDrop event. (Inherited from ToolStripItem.)
Protected method OnDragEnter Raises the DragEnter event. (Inherited from ToolStripItem.)
Protected method OnDragLeave Raises the DragLeave event. (Inherited from ToolStripItem.)
Protected method OnDragOver Raises the DragOver event. (Inherited from ToolStripItem.)
Protected method OnEnabledChanged Raises the EnabledChanged event. (Inherited from ToolStripItem.)
Protected method OnFontChanged Infrastructure. This method is not relevant to this class. (Overrides ToolStripItem.OnFontChanged(EventArgs).)
Protected method OnForeColorChanged Raises the ForeColorChanged event. (Inherited from ToolStripItem.)
Protected method OnGiveFeedback Raises the GiveFeedback event. (Inherited from ToolStripItem.)
Protected method OnLayout Raises the Layout event. (Inherited from ToolStripItem.)
Protected method OnLocationChanged Raises the LocationChanged event. (Inherited from ToolStripItem.)
Protected method OnMouseDown Raises the MouseDown event. (Inherited from ToolStripItem.)
Protected method OnMouseEnter Raises the MouseEnter event. (Inherited from ToolStripItem.)
Protected method OnMouseHover Raises the MouseHover event. (Inherited from ToolStripItem.)
Protected method OnMouseLeave Raises the MouseLeave event. (Inherited from ToolStripItem.)
Protected method OnMouseMove Raises the MouseMove event. (Inherited from ToolStripItem.)
Protected method OnMouseUp Raises the MouseUp event. (Inherited from ToolStripItem.)
Protected method OnOwnerChanged Raises the OwnerChanged event. (Inherited from ToolStripItem.)
Protected method OnOwnerFontChanged Raises the FontChanged event when the Font property has changed on the parent of the ToolStripItem. (Inherited from ToolStripItem.)
Protected method OnPaint Raises the Paint event. (Overrides ToolStripItem.OnPaint(PaintEventArgs).)
Protected method OnParentBackColorChanged Raises the BackColorChanged event. (Inherited from ToolStripItem.)
Protected method OnParentChanged Raises the ParentChanged event. (Inherited from ToolStripItem.)
Protected method OnParentEnabledChanged Raises the EnabledChanged event when the Enabled property value of the item's container changes. (Inherited from ToolStripItem.)
Protected method OnParentForeColorChanged Raises the ForeColorChanged event. (Inherited from ToolStripItem.)
Protected method OnParentRightToLeftChanged Raises the RightToLeftChanged event. (Inherited from ToolStripItem.)
Protected method OnQueryContinueDrag Raises the QueryContinueDrag event. (Inherited from ToolStripItem.)
Protected method OnRightToLeftChanged Raises the RightToLeftChanged event. (Inherited from ToolStripItem.)
Protected method OnTextChanged Raises the TextChanged event. (Inherited from ToolStripItem.)
Protected method OnVisibleChanged Raises the VisibleChanged event. (Inherited from ToolStripItem.)
Public method PerformClick Activates the ToolStripItem when it is clicked with the mouse. (Inherited from ToolStripItem.)
Protected method ProcessCmdKey Processes a command key. (Inherited from ToolStripItem.)
Protected method ProcessDialogKey Processes a dialog key. (Inherited from ToolStripItem.)
Protected method ProcessMnemonic Processes a mnemonic character. (Inherited from ToolStripItem.)
Public method ResetBackColor Infrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public method ResetDisplayStyle Infrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public method ResetFont Infrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public method ResetForeColor Infrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public method ResetImage Infrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public method ResetMargin Infrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public method ResetPadding Infrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public method ResetRightToLeft Infrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public method ResetTextDirection Infrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public method Select Selects the item. (Inherited from ToolStripItem.)
Protected method SetBounds Sets the size and location of the ToolStripSeparator. (Overrides ToolStripItem.SetBounds(Rectangle).)
Protected method SetVisibleCore Sets the ToolStripItem to the specified visible state. (Inherited from ToolStripItem.)
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from ToolStripItem.)
Top
  Name Description
Public event AvailableChanged Occurs when the value of the Available property changes. (Inherited from ToolStripItem.)
Public event BackColorChanged Occurs when the value of the BackColor property changes. (Inherited from ToolStripItem.)
Public event Click Occurs when the ToolStripItem is clicked. (Inherited from ToolStripItem.)
Public event DisplayStyleChanged Infrastructure. This event is not relevant to this class.
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public event DoubleClick Occurs when the item is double-clicked with the mouse. (Inherited from ToolStripItem.)
Public event DragDrop Occurs when the user drags an item and the user releases the mouse button, indicating that the item should be dropped into this item. (Inherited from ToolStripItem.)
Public event DragEnter Occurs when the user drags an item into the client area of this item. (Inherited from ToolStripItem.)
Public event DragLeave Occurs when the user drags an item and the mouse pointer is no longer over the client area of this item. (Inherited from ToolStripItem.)
Public event DragOver Occurs when the user drags an item over the client area of this item. (Inherited from ToolStripItem.)
Public event EnabledChanged Infrastructure. This event is not relevant to this class.
Public event ForeColorChanged Occurs when the ForeColor property value changes. (Inherited from ToolStripItem.)
Public event GiveFeedback Occurs during a drag operation. (Inherited from ToolStripItem.)
Public event LocationChanged Occurs when the location of a ToolStripItem is updated. (Inherited from ToolStripItem.)
Public event MouseDown Occurs when the mouse pointer is over the item and a mouse button is pressed. (Inherited from ToolStripItem.)
Public event MouseEnter Occurs when the mouse pointer enters the item. (Inherited from ToolStripItem.)
Public event MouseHover Occurs when the mouse pointer hovers over the item. (Inherited from ToolStripItem.)
Public event MouseLeave Occurs when the mouse pointer leaves the item. (Inherited from ToolStripItem.)
Public event MouseMove Occurs when the mouse pointer is moved over the item. (Inherited from ToolStripItem.)
Public event MouseUp Occurs when the mouse pointer is over the item and a mouse button is released. (Inherited from ToolStripItem.)
Public event OwnerChanged Occurs when the Owner property changes. (Inherited from ToolStripItem.)
Public event Paint Occurs when the item is redrawn. (Inherited from ToolStripItem.)
Public event QueryAccessibilityHelp Occurs when an accessibility client application invokes help for the ToolStripItem. (Inherited from ToolStripItem.)
Public event QueryContinueDrag Occurs during a drag-and-drop operation and allows the drag source to determine whether the drag-and-drop operation should be canceled. (Inherited from ToolStripItem.)
Public event RightToLeftChanged Occurs when the RightToLeft property value changes. (Inherited from ToolStripItem.)
Public event TextChanged Infrastructure. This event is not relevant to this class.
Public event VisibleChanged Occurs when the value of the Visible property changes. (Inherited from ToolStripItem.)
Top
  Name Description
Explicit interface implemetation Private method IDropTarget.OnDragDrop Raises the DragDrop event. (Inherited from ToolStripItem.)
Explicit interface implemetation Private method IDropTarget.OnDragEnter Raises the DragEnter event. (Inherited from ToolStripItem.)
Explicit interface implemetation Private method IDropTarget.OnDragLeave Raises the DragLeave event. (Inherited from ToolStripItem.)
Explicit interface implemetation Private method IDropTarget.OnDragOver Raises the DragOver event. (Inherited from ToolStripItem.)
Top

Use a ToolStripSeparator to group related items on a menu or ToolStrip. The ToolStripSeparator is automatically spaced and oriented horizontally or vertically to accord with its container.

You can add a ToolStripSeparator at design time by choosing it from a drop-down list. However, you can also automatically create a ToolStripSeparator by typing a hyphen (-) in either the designer template node or in the Add method.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ