ToolStripSeparator Class

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ToolStripSeparator.cs

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

public ref class ToolStripSeparator : System::Windows::Forms::ToolStripItem

[System.Windows.Forms.Design.ToolStripItemDesignerAvailability(System.Windows.Forms.Design.ToolStripItemDesignerAvailability.ContextMenuStrip | System.Windows.Forms.Design.ToolStripItemDesignerAvailability.ToolStrip)]
public class ToolStripSeparator : System.Windows.Forms.ToolStripItem

[<System.Windows.Forms.Design.ToolStripItemDesignerAvailability(System.Windows.Forms.Design.ToolStripItemDesignerAvailability.ContextMenuStrip | System.Windows.Forms.Design.ToolStripItemDesignerAvailability.ToolStrip)>]
type ToolStripSeparator = class
    inherit ToolStripItem

Public Class ToolStripSeparator
Inherits ToolStripItem

Inheritance

Object

MarshalByRefObject

Component

BindableComponent

ToolStripItem

ToolStripSeparator

Attributes

ToolStripItemDesignerAvailabilityAttribute

Remarks

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.

Constructors

ToolStripSeparator()

Initializes a new instance of the ToolStripSeparator class.

Properties

AccessibilityObject	Gets the AccessibleObject assigned to the control. (Inherited from ToolStripItem)
AccessibleDefaultActionDescription	Gets or sets the default action description of the control for use by accessibility client applications. (Inherited from ToolStripItem)
AccessibleDescription	Gets or sets the description that will be reported to accessibility client applications. (Inherited from ToolStripItem)
AccessibleName	Gets or sets the name of the control for use by accessibility client applications. (Inherited from ToolStripItem)
AccessibleRole	Gets or sets the accessible role of the control, which specifies the type of user interface element of the control. (Inherited from ToolStripItem)
Alignment	Gets or sets a value indicating whether the item aligns towards the beginning or end of the ToolStrip. (Inherited from ToolStripItem)
AllowDrop	Gets or sets a value indicating whether drag-and-drop and item reordering are handled through events that you implement. (Inherited from ToolStripItem)
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)
AutoSize	Gets or sets a value indicating whether the item is automatically sized. (Inherited from ToolStripItem)
AutoToolTip	This property is not relevant to this class.
Available	Gets or sets a value indicating whether the ToolStripItem should be placed on a ToolStrip. (Inherited from ToolStripItem)
BackColor	Gets or sets the background color for the item. (Inherited from ToolStripItem)
BackgroundImage	This property is not relevant to this class.
BackgroundImageLayout	This property is not relevant to this class.
BindingContext	Gets or sets the collection of currency managers for the IBindableComponent. (Inherited from BindableComponent)
Bounds	Gets the size and location of the item. (Inherited from ToolStripItem)
CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
CanSelect	Gets a value indicating whether the ToolStripSeparator can be selected.
Command	Gets or sets the ICommand whose Execute(Object) method will be called when the ToolStripItem's Click event is invoked. (Inherited from ToolStripItem)
CommandParameter	Gets or sets the parameter that is passed to the ICommand that's assigned to the Command property. (Inherited from ToolStripItem)
Container	Gets the IContainer that contains the Component. (Inherited from Component)
ContentRectangle	Gets the area where content, such as text and icons, can be placed within a ToolStripItem without overwriting background borders. (Inherited from ToolStripItem)
DataBindings	Gets the collection of data-binding objects for this IBindableComponent. (Inherited from BindableComponent)
DefaultAutoToolTip	Gets a value indicating whether to display the ToolTip that is defined as the default. (Inherited from ToolStripItem)
DefaultDisplayStyle	Gets a value indicating what is displayed on the ToolStripItem. (Inherited from ToolStripItem)
DefaultMargin	Gets the spacing between the ToolStripSeparator and an adjacent item.
DefaultPadding	Gets the internal spacing characteristics of the item. (Inherited from ToolStripItem)
DefaultSize	Gets the default size of the ToolStripSeparator.
DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
DismissWhenClicked	Gets a value indicating whether items on a ToolStripDropDown are hidden after they are clicked. (Inherited from ToolStripItem)
DisplayStyle	This property is not relevant to this class.
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)
DoubleClickEnabled	This property is not relevant to this class.
Enabled	This property is not relevant to this class.
Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
Font	This property is not relevant to this class.
ForeColor	Gets or sets the foreground color of the item. (Inherited from ToolStripItem)
Height	Gets or sets the height, in pixels, of a ToolStripItem. (Inherited from ToolStripItem)
Image	This property is not relevant to this class.
ImageAlign	This property is not relevant to this class.
ImageIndex	This property is not relevant to this class.
ImageKey	This property is not relevant to this class.
ImageScaling	This property is not relevant to this class.
ImageTransparentColor	This property is not relevant to this class.
IsDisposed	Gets a value indicating whether the object has been disposed of. (Inherited from ToolStripItem)
IsOnDropDown	Gets a value indicating whether the container of the current Control is a ToolStripDropDown. (Inherited from ToolStripItem)
IsOnOverflow	Gets a value indicating whether the Placement property is set to Overflow. (Inherited from ToolStripItem)
Margin	Gets or sets the space between the item and adjacent items. (Inherited from ToolStripItem)
MergeAction	Gets or sets how child menus are merged with parent menus. (Inherited from ToolStripItem)
MergeIndex	Gets or sets the position of a merged item within the current ToolStrip. (Inherited from ToolStripItem)
Name	Gets or sets the name of the item. (Inherited from ToolStripItem)
Overflow	Gets or sets whether the item is attached to the ToolStrip or ToolStripOverflowButton or can float between the two. (Inherited from ToolStripItem)
Owner	Gets or sets the owner of this item. (Inherited from ToolStripItem)
OwnerItem	Gets the parent ToolStripItem of this ToolStripItem. (Inherited from ToolStripItem)
Padding	Gets or sets the internal spacing, in pixels, between the item's contents and its edges. (Inherited from ToolStripItem)
Parent	Gets or sets the parent container of the ToolStripItem. (Inherited from ToolStripItem)
Placement	Gets the current layout of the item. (Inherited from ToolStripItem)
Pressed	Gets a value indicating whether the state of the item is pressed. (Inherited from ToolStripItem)
Renderer	Returns the parent ToolStrip's renderer. (Inherited from ToolStripItem)
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)
RightToLeftAutoMirrorImage	This property is not relevant to this class.
Selected	Gets a value indicating whether the item is selected. (Inherited from ToolStripItem)
ShowKeyboardCues	Gets a value indicating whether to show or hide shortcut keys. (Inherited from ToolStripItem)
Site	Gets or sets the ISite of the Component. (Inherited from Component)
Size	Gets or sets the size of the item. (Inherited from ToolStripItem)
Tag	Gets or sets the object that contains data about the item. (Inherited from ToolStripItem)
Text	This property is not relevant to this class.
TextAlign	This property is not relevant to this class.
TextDirection	This property is not relevant to this class.
TextImageRelation	This property is not relevant to this class.
ToolTipText	This property is not relevant to this class.
Visible	Gets or sets a value indicating whether the item is displayed. (Inherited from ToolStripItem)
Width	Gets or sets the width in pixels of a ToolStripItem. (Inherited from ToolStripItem)

Methods

CreateAccessibilityInstance()	Creates a new accessibility object for the ToolStripSeparator.
CreateObjRef(Type)	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject)
Dispose()	Releases all resources used by the Component. (Inherited from Component)
Dispose(Boolean)	Releases the unmanaged resources used by the ToolStripItem and optionally releases the managed resources. (Inherited from ToolStripItem)
DoDragDrop(Object, DragDropEffects, Bitmap, Point, Boolean)	Begins a drag operation. (Inherited from ToolStripItem)
DoDragDrop(Object, DragDropEffects)	Begins a drag-and-drop operation. (Inherited from ToolStripItem)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetCurrentParent()	Retrieves the ToolStrip that is the container of the current ToolStripItem. (Inherited from ToolStripItem)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetPreferredSize(Size)	Retrieves the size of a rectangular area into which a ToolStripSeparator can be fitted.
GetService(Type)	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
GetType()	Gets the Type of the current instance. (Inherited from Object)
InitializeLifetimeService()	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
Invalidate()	Invalidates the entire surface of the ToolStripItem and causes it to be redrawn. (Inherited from ToolStripItem)
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)
IsInputChar(Char)	Determines whether a character is an input character that the item recognizes. (Inherited from ToolStripItem)
IsInputKey(Keys)	Determines whether the specified key is a regular input key or a special key that requires preprocessing. (Inherited from ToolStripItem)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
OnAvailableChanged(EventArgs)	Raises the AvailableChanged event. (Inherited from ToolStripItem)
OnBackColorChanged(EventArgs)	Raises the BackColorChanged event. (Inherited from ToolStripItem)
OnBindingContextChanged(EventArgs)	Raises the BindingContextChanged event. (Inherited from BindableComponent)
OnBoundsChanged()	Occurs when the Bounds property changes. (Inherited from ToolStripItem)
OnClick(EventArgs)	Raises the Click event. (Inherited from ToolStripItem)
OnCommandCanExecuteChanged(EventArgs)	Raises the CommandCanExecuteChanged event. (Inherited from ToolStripItem)
OnCommandChanged(EventArgs)	Raises the CommandChanged event. (Inherited from ToolStripItem)
OnCommandParameterChanged(EventArgs)	Raises the CommandParameterChanged event. (Inherited from ToolStripItem)
OnDisplayStyleChanged(EventArgs)	Raises the DisplayStyleChanged event. (Inherited from ToolStripItem)
OnDoubleClick(EventArgs)	Raises the DoubleClick event. (Inherited from ToolStripItem)
OnDragDrop(DragEventArgs)	Raises the DragDrop event. (Inherited from ToolStripItem)
OnDragEnter(DragEventArgs)	Raises the DragEnter event. (Inherited from ToolStripItem)
OnDragLeave(EventArgs)	Raises the DragLeave event. (Inherited from ToolStripItem)
OnDragOver(DragEventArgs)	Raises the DragOver event. (Inherited from ToolStripItem)
OnEnabledChanged(EventArgs)	Raises the EnabledChanged event. (Inherited from ToolStripItem)
OnFontChanged(EventArgs)	This method is not relevant to this class.
OnForeColorChanged(EventArgs)	Raises the ForeColorChanged event. (Inherited from ToolStripItem)
OnGiveFeedback(GiveFeedbackEventArgs)	Raises the GiveFeedback event. (Inherited from ToolStripItem)
OnLayout(LayoutEventArgs)	Raises the Layout event. (Inherited from ToolStripItem)
OnLocationChanged(EventArgs)	Raises the LocationChanged event. (Inherited from ToolStripItem)
OnMouseDown(MouseEventArgs)	Raises the MouseDown event. (Inherited from ToolStripItem)
OnMouseEnter(EventArgs)	Raises the MouseEnter event. (Inherited from ToolStripItem)
OnMouseHover(EventArgs)	Raises the MouseHover event. (Inherited from ToolStripItem)
OnMouseLeave(EventArgs)	Raises the MouseLeave event. (Inherited from ToolStripItem)
OnMouseMove(MouseEventArgs)	Raises the MouseMove event. (Inherited from ToolStripItem)
OnMouseUp(MouseEventArgs)	Raises the MouseUp event. (Inherited from ToolStripItem)
OnOwnerChanged(EventArgs)	Raises the OwnerChanged event. (Inherited from ToolStripItem)
OnOwnerFontChanged(EventArgs)	Raises the FontChanged event when the Font property has changed on the parent of the ToolStripItem. (Inherited from ToolStripItem)
OnPaint(PaintEventArgs)	Raises the Paint event.
OnParentBackColorChanged(EventArgs)	Raises the BackColorChanged event. (Inherited from ToolStripItem)
OnParentChanged(ToolStrip, ToolStrip)	Raises the ParentChanged event. (Inherited from ToolStripItem)
OnParentEnabledChanged(EventArgs)	Raises the EnabledChanged event when the Enabled property value of the item's container changes. (Inherited from ToolStripItem)
OnParentForeColorChanged(EventArgs)	Raises the ForeColorChanged event. (Inherited from ToolStripItem)
OnParentRightToLeftChanged(EventArgs)	Raises the RightToLeftChanged event. (Inherited from ToolStripItem)
OnQueryContinueDrag(QueryContinueDragEventArgs)	Raises the QueryContinueDrag event. (Inherited from ToolStripItem)
OnRequestCommandExecute(EventArgs)	Called in the context of OnClick(EventArgs) to invoke Execute(Object) if the context allows. (Inherited from ToolStripItem)
OnRightToLeftChanged(EventArgs)	Raises the RightToLeftChanged event. (Inherited from ToolStripItem)
OnSelectedChanged(EventArgs)	Raises the SelectedChanged event. (Inherited from ToolStripItem)
OnTextChanged(EventArgs)	Raises the TextChanged event. (Inherited from ToolStripItem)
OnVisibleChanged(EventArgs)	Raises the VisibleChanged event. (Inherited from ToolStripItem)
PerformClick()	Generates a Click event for a ToolStripItem. (Inherited from ToolStripItem)
ProcessCmdKey(Message, Keys)	Processes a command key. (Inherited from ToolStripItem)
ProcessDialogKey(Keys)	Processes a dialog key. (Inherited from ToolStripItem)
ProcessMnemonic(Char)	Processes a mnemonic character. (Inherited from ToolStripItem)
ResetBackColor()	This method is not relevant to this class. (Inherited from ToolStripItem)
ResetDisplayStyle()	This method is not relevant to this class. (Inherited from ToolStripItem)
ResetFont()	This method is not relevant to this class. (Inherited from ToolStripItem)
ResetForeColor()	This method is not relevant to this class. (Inherited from ToolStripItem)
ResetImage()	This method is not relevant to this class. (Inherited from ToolStripItem)
ResetMargin()	This method is not relevant to this class. (Inherited from ToolStripItem)
ResetPadding()	This method is not relevant to this class. (Inherited from ToolStripItem)
ResetRightToLeft()	This method is not relevant to this class. (Inherited from ToolStripItem)
ResetTextDirection()	This method is not relevant to this class. (Inherited from ToolStripItem)
Select()	Selects the item. (Inherited from ToolStripItem)
SetBounds(Rectangle)	Sets the size and location of the ToolStripSeparator.
SetVisibleCore(Boolean)	Sets the ToolStripItem to the specified visible state. (Inherited from ToolStripItem)
ToString()	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from ToolStripItem)

Events

AvailableChanged	Occurs when the value of the Available property changes. (Inherited from ToolStripItem)
BackColorChanged	Occurs when the value of the BackColor property changes. (Inherited from ToolStripItem)
BindingContextChanged	Occurs when the binding context has changed. (Inherited from BindableComponent)
Click	Occurs when the ToolStripItem is clicked. (Inherited from ToolStripItem)
CommandCanExecuteChanged	Occurs when the CanExecute(Object) status of the ICommand that's assigned to the Command property has changed. (Inherited from ToolStripItem)
CommandChanged	Occurs when the assigned ICommand of the Command property has changed. (Inherited from ToolStripItem)
CommandParameterChanged	Occurs when the value of the CommandParameter property has changed. (Inherited from ToolStripItem)
DisplayStyleChanged	This event is not relevant to this class.
Disposed	Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component)
DoubleClick	Occurs when the item is double-clicked with the mouse. (Inherited from ToolStripItem)
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)
DragEnter	Occurs when the user drags an item into the client area of this item. (Inherited from ToolStripItem)
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)
DragOver	Occurs when the user drags an item over the client area of this item. (Inherited from ToolStripItem)
EnabledChanged	This event is not relevant to this class.
ForeColorChanged	Occurs when the ForeColor property value changes. (Inherited from ToolStripItem)
GiveFeedback	Occurs during a drag operation. (Inherited from ToolStripItem)
LocationChanged	Occurs when the location of a ToolStripItem is updated. (Inherited from ToolStripItem)
MouseDown	Occurs when the mouse pointer is over the item and a mouse button is pressed. (Inherited from ToolStripItem)
MouseEnter	Occurs when the mouse pointer enters the item. (Inherited from ToolStripItem)
MouseHover	Occurs when the mouse pointer hovers over the item. (Inherited from ToolStripItem)
MouseLeave	Occurs when the mouse pointer leaves the item. (Inherited from ToolStripItem)
MouseMove	Occurs when the mouse pointer is moved over the item. (Inherited from ToolStripItem)
MouseUp	Occurs when the mouse pointer is over the item and a mouse button is released. (Inherited from ToolStripItem)
OwnerChanged	Occurs when the Owner property changes. (Inherited from ToolStripItem)
Paint	Occurs when the item is redrawn. (Inherited from ToolStripItem)
QueryAccessibilityHelp	Occurs when an accessibility client application invokes help for the ToolStripItem. (Inherited from ToolStripItem)
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)
RightToLeftChanged	Occurs when the RightToLeft property value changes. (Inherited from ToolStripItem)
SelectedChanged	Occurs when the value of the Selected property changes. (Inherited from ToolStripItem)
TextChanged	This event is not relevant to this class.
VisibleChanged	Occurs when the value of the Visible property changes. (Inherited from ToolStripItem)

Explicit Interface Implementations

IDropTarget.OnDragDrop(DragEventArgs)	Raises the DragDrop event. (Inherited from ToolStripItem)
IDropTarget.OnDragEnter(DragEventArgs)	Raises the DragEnter event. (Inherited from ToolStripItem)
IDropTarget.OnDragLeave(EventArgs)	Raises the DragLeave event. (Inherited from ToolStripItem)
IDropTarget.OnDragOver(DragEventArgs)	Raises the DragOver event. (Inherited from ToolStripItem)

See also

• ToolStrip Control (Windows Forms)
• MenuStrip Control (Windows Forms)
• How to: Add Enhancements to ToolStripMenuItems