Export (0) Print
Expand All

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.

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.

  NameDescription
Public methodToolStripSeparatorInitializes a new instance of the ToolStripSeparator class.
Top

  NameDescription
Public propertyAccessibilityObjectGets the AccessibleObject assigned to the control. (Inherited from ToolStripItem.)
Public propertyAccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. (Inherited from ToolStripItem.)
Public propertyAccessibleDescriptionGets or sets the description that will be reported to accessibility client applications. (Inherited from ToolStripItem.)
Public propertyAccessibleNameGets or sets the name of the control for use by accessibility client applications. (Inherited from ToolStripItem.)
Public propertyAccessibleRoleGets or sets the accessible role of the control, which specifies the type of user interface element of the control. (Inherited from ToolStripItem.)
Public propertyAlignmentGets or sets a value indicating whether the item aligns towards the beginning or end of the ToolStrip. (Inherited from ToolStripItem.)
Public propertyAllowDropGets or sets a value indicating whether drag-and-drop and item reordering are handled through events that you implement. (Inherited from ToolStripItem.)
Public propertyAnchorGets 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 propertyAutoSizeGets or sets a value indicating whether the item is automatically sized. (Inherited from ToolStripItem.)
Public propertyAutoToolTipInfrastructure. This property is not relevant to this class.
Public propertyAvailableGets or sets a value indicating whether the ToolStripItem should be placed on a ToolStrip. (Inherited from ToolStripItem.)
Public propertyBackColorGets or sets the background color for the item. (Inherited from ToolStripItem.)
Public propertyBackgroundImageInfrastructure. This property is not relevant to this class. (Overrides ToolStripItem.BackgroundImage.)
Public propertyBackgroundImageLayoutInfrastructure. This property is not relevant to this class. (Overrides ToolStripItem.BackgroundImageLayout.)
Public propertyBoundsGets the size and location of the item. (Inherited from ToolStripItem.)
Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event. (Inherited from Component.)
Public propertyCanSelectGets a value indicating whether the ToolStripSeparator can be selected. (Overrides ToolStripItem.CanSelect.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyContentRectangleGets the area where content, such as text and icons, can be placed within a ToolStripItem without overwriting background borders. (Inherited from ToolStripItem.)
Protected propertyDefaultAutoToolTipGets a value indicating whether to display the ToolTip that is defined as the default. (Inherited from ToolStripItem.)
Protected propertyDefaultDisplayStyleGets a value indicating what is displayed on the ToolStripItem. (Inherited from ToolStripItem.)
Protected propertyDefaultMarginGets the spacing between the ToolStripSeparator and an adjacent item. (Overrides ToolStripItem.DefaultMargin.)
Protected propertyDefaultPaddingGets the internal spacing characteristics of the item. (Inherited from ToolStripItem.)
Protected propertyDefaultSizeGets the default size of the ToolStripSeparator. (Overrides ToolStripItem.DefaultSize.)
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected propertyDismissWhenClickedGets a value indicating whether items on a ToolStripDropDown are hidden after they are clicked. (Inherited from ToolStripItem.)
Public propertyDisplayStyleInfrastructure. This property is not relevant to this class.
Public propertyDockGets 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 propertyDoubleClickEnabledInfrastructure. This property is not relevant to this class.
Public propertyEnabledInfrastructure. This property is not relevant to this class. (Overrides ToolStripItem.Enabled.)
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyFontInfrastructure. This property is not relevant to this class. (Overrides ToolStripItem.Font.)
Public propertyForeColorGets or sets the foreground color of the item. (Inherited from ToolStripItem.)
Public propertyHeightGets or sets the height, in pixels, of a ToolStripItem. (Inherited from ToolStripItem.)
Public propertyImageInfrastructure. This property is not relevant to this class. (Overrides ToolStripItem.Image.)
Public propertyImageAlignInfrastructure. This property is not relevant to this class.
Public propertyImageIndexInfrastructure. This property is not relevant to this class.
Public propertyImageKeyInfrastructure. This property is not relevant to this class.
Public propertyImageScalingInfrastructure. This property is not relevant to this class.
Public propertyImageTransparentColorInfrastructure. This property is not relevant to this class.
Public propertyIsDisposedGets a value indicating whether the object has been disposed of. (Inherited from ToolStripItem.)
Public propertyIsOnDropDownGets a value indicating whether the container of the current Control is a ToolStripDropDown. (Inherited from ToolStripItem.)
Public propertyIsOnOverflowGets a value indicating whether the Placement property is set to Overflow. (Inherited from ToolStripItem.)
Public propertyMarginGets or sets the space between the item and adjacent items. (Inherited from ToolStripItem.)
Public propertyMergeActionGets or sets how child menus are merged with parent menus. (Inherited from ToolStripItem.)
Public propertyMergeIndexGets or sets the position of a merged item within the current ToolStrip. (Inherited from ToolStripItem.)
Public propertyNameGets or sets the name of the item. (Inherited from ToolStripItem.)
Public propertyOverflowGets or sets whether the item is attached to the ToolStrip or ToolStripOverflowButton or can float between the two. (Inherited from ToolStripItem.)
Public propertyOwnerGets or sets the owner of this item. (Inherited from ToolStripItem.)
Public propertyOwnerItemGets the parent ToolStripItem of this ToolStripItem. (Inherited from ToolStripItem.)
Public propertyPaddingGets or sets the internal spacing, in pixels, between the item's contents and its edges. (Inherited from ToolStripItem.)
Protected propertyParentGets or sets the parent container of the ToolStripItem. (Inherited from ToolStripItem.)
Public propertyPlacementGets the current layout of the item. (Inherited from ToolStripItem.)
Public propertyPressedGets a value indicating whether the state of the item is pressed. (Inherited from ToolStripItem.)
Public propertyRightToLeftGets 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 propertyRightToLeftAutoMirrorImageInfrastructure. This property is not relevant to this class.
Public propertySelectedGets a value indicating whether the item is selected. (Inherited from ToolStripItem.)
Protected propertyShowKeyboardCuesGets a value indicating whether to show or hide shortcut keys. (Inherited from ToolStripItem.)
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Public propertySizeGets or sets the size of the item. (Inherited from ToolStripItem.)
Public propertyTagGets or sets the object that contains data about the item. (Inherited from ToolStripItem.)
Public propertyTextInfrastructure. This property is not relevant to this class. (Overrides ToolStripItem.Text.)
Public propertyTextAlignInfrastructure. This property is not relevant to this class.
Public propertyTextDirectionInfrastructure. This property is not relevant to this class. (Overrides ToolStripItem.TextDirection.)
Public propertyTextImageRelationInfrastructure. This property is not relevant to this class.
Public propertyToolTipTextInfrastructure. This property is not relevant to this class.
Public propertyVisibleGets or sets a value indicating whether the item is displayed. (Inherited from ToolStripItem.)
Public propertyWidthGets or sets the width in pixels of a ToolStripItem. (Inherited from ToolStripItem.)
Top

  NameDescription
Protected methodCreateAccessibilityInstanceCreates a new accessibility object for the ToolStripSeparator. (Overrides ToolStripItem.CreateAccessibilityInstance().)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the ToolStripItem and optionally releases the managed resources. (Inherited from ToolStripItem.)
Public methodDoDragDropBegins a drag-and-drop operation. (Inherited from ToolStripItem.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodGetCurrentParentRetrieves the ToolStrip that is the container of the current ToolStripItem. (Inherited from ToolStripItem.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetPreferredSizeRetrieves the size of a rectangular area into which a ToolStripSeparator can be fitted. (Overrides ToolStripItem.GetPreferredSize(Size).)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodInvalidate()Invalidates the entire surface of the ToolStripItem and causes it to be redrawn. (Inherited from ToolStripItem.)
Public methodInvalidate(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 methodIsInputCharDetermines whether a character is an input character that the item recognizes. (Inherited from ToolStripItem.)
Protected methodIsInputKeyDetermines whether the specified key is a regular input key or a special key that requires preprocessing. (Inherited from ToolStripItem.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected methodOnAvailableChangedRaises the AvailableChanged event. (Inherited from ToolStripItem.)
Protected methodOnBackColorChangedRaises the BackColorChanged event. (Inherited from ToolStripItem.)
Protected methodOnBoundsChangedOccurs when the Bounds property changes. (Inherited from ToolStripItem.)
Protected methodOnClickRaises the Click event. (Inherited from ToolStripItem.)
Protected methodOnDisplayStyleChangedRaises the DisplayStyleChanged event. (Inherited from ToolStripItem.)
Protected methodOnDoubleClickRaises the DoubleClick event. (Inherited from ToolStripItem.)
Protected methodOnDragDropRaises the DragDrop event. (Inherited from ToolStripItem.)
Protected methodOnDragEnterRaises the DragEnter event. (Inherited from ToolStripItem.)
Protected methodOnDragLeaveRaises the DragLeave event. (Inherited from ToolStripItem.)
Protected methodOnDragOverRaises the DragOver event. (Inherited from ToolStripItem.)
Protected methodOnEnabledChangedRaises the EnabledChanged event. (Inherited from ToolStripItem.)
Protected methodOnFontChangedInfrastructure. This method is not relevant to this class. (Overrides ToolStripItem.OnFontChanged(EventArgs).)
Protected methodOnForeColorChangedRaises the ForeColorChanged event. (Inherited from ToolStripItem.)
Protected methodOnGiveFeedbackRaises the GiveFeedback event. (Inherited from ToolStripItem.)
Protected methodOnLayoutRaises the Layout event. (Inherited from ToolStripItem.)
Protected methodOnLocationChangedRaises the LocationChanged event. (Inherited from ToolStripItem.)
Protected methodOnMouseDownRaises the MouseDown event. (Inherited from ToolStripItem.)
Protected methodOnMouseEnterRaises the MouseEnter event. (Inherited from ToolStripItem.)
Protected methodOnMouseHoverRaises the MouseHover event. (Inherited from ToolStripItem.)
Protected methodOnMouseLeaveRaises the MouseLeave event. (Inherited from ToolStripItem.)
Protected methodOnMouseMoveRaises the MouseMove event. (Inherited from ToolStripItem.)
Protected methodOnMouseUpRaises the MouseUp event. (Inherited from ToolStripItem.)
Protected methodOnOwnerChangedRaises the OwnerChanged event. (Inherited from ToolStripItem.)
Protected methodOnOwnerFontChangedRaises the FontChanged event when the Font property has changed on the parent of the ToolStripItem. (Inherited from ToolStripItem.)
Protected methodOnPaintRaises the Paint event. (Overrides ToolStripItem.OnPaint(PaintEventArgs).)
Protected methodOnParentBackColorChangedRaises the BackColorChanged event. (Inherited from ToolStripItem.)
Protected methodOnParentChangedRaises the ParentChanged event. (Inherited from ToolStripItem.)
Protected methodOnParentEnabledChangedRaises the EnabledChanged event when the Enabled property value of the item's container changes. (Inherited from ToolStripItem.)
Protected methodOnParentForeColorChangedRaises the ForeColorChanged event. (Inherited from ToolStripItem.)
Protected methodOnParentRightToLeftChangedRaises the RightToLeftChanged event. (Inherited from ToolStripItem.)
Protected methodOnQueryContinueDragRaises the QueryContinueDrag event. (Inherited from ToolStripItem.)
Protected methodOnRightToLeftChangedRaises the RightToLeftChanged event. (Inherited from ToolStripItem.)
Protected methodOnTextChangedRaises the TextChanged event. (Inherited from ToolStripItem.)
Protected methodOnVisibleChangedRaises the VisibleChanged event. (Inherited from ToolStripItem.)
Public methodPerformClickActivates the ToolStripItem when it is clicked with the mouse. (Inherited from ToolStripItem.)
Protected methodProcessCmdKeyProcesses a command key. (Inherited from ToolStripItem.)
Protected methodProcessDialogKeyProcesses a dialog key. (Inherited from ToolStripItem.)
Protected methodProcessMnemonicProcesses a mnemonic character. (Inherited from ToolStripItem.)
Public methodResetBackColorInfrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public methodResetDisplayStyleInfrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public methodResetFontInfrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public methodResetForeColorInfrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public methodResetImageInfrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public methodResetMarginInfrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public methodResetPaddingInfrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public methodResetRightToLeftInfrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public methodResetTextDirectionInfrastructure. This method is not relevant to this class. (Inherited from ToolStripItem.)
Public methodSelectSelects the item. (Inherited from ToolStripItem.)
Protected methodSetBoundsSets the size and location of the ToolStripSeparator. (Overrides ToolStripItem.SetBounds(Rectangle).)
Protected methodSetVisibleCoreSets the ToolStripItem to the specified visible state. (Inherited from ToolStripItem.)
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from ToolStripItem.)
Top

  NameDescription
Public eventAvailableChangedOccurs when the value of the Available property changes. (Inherited from ToolStripItem.)
Public eventBackColorChangedOccurs when the value of the BackColor property changes. (Inherited from ToolStripItem.)
Public eventClickOccurs when the ToolStripItem is clicked. (Inherited from ToolStripItem.)
Public eventDisplayStyleChangedInfrastructure. This event is not relevant to this class.
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public eventDoubleClickOccurs when the item is double-clicked with the mouse. (Inherited from ToolStripItem.)
Public eventDragDropOccurs 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 eventDragEnterOccurs when the user drags an item into the client area of this item. (Inherited from ToolStripItem.)
Public eventDragLeaveOccurs when the user drags an item and the mouse pointer is no longer over the client area of this item. (Inherited from ToolStripItem.)
Public eventDragOverOccurs when the user drags an item over the client area of this item. (Inherited from ToolStripItem.)
Public eventEnabledChangedInfrastructure. This event is not relevant to this class.
Public eventForeColorChangedOccurs when the ForeColor property value changes. (Inherited from ToolStripItem.)
Public eventGiveFeedbackOccurs during a drag operation. (Inherited from ToolStripItem.)
Public eventLocationChangedOccurs when the location of a ToolStripItem is updated. (Inherited from ToolStripItem.)
Public eventMouseDownOccurs when the mouse pointer is over the item and a mouse button is pressed. (Inherited from ToolStripItem.)
Public eventMouseEnterOccurs when the mouse pointer enters the item. (Inherited from ToolStripItem.)
Public eventMouseHoverOccurs when the mouse pointer hovers over the item. (Inherited from ToolStripItem.)
Public eventMouseLeaveOccurs when the mouse pointer leaves the item. (Inherited from ToolStripItem.)
Public eventMouseMoveOccurs when the mouse pointer is moved over the item. (Inherited from ToolStripItem.)
Public eventMouseUpOccurs when the mouse pointer is over the item and a mouse button is released. (Inherited from ToolStripItem.)
Public eventOwnerChangedOccurs when the Owner property changes. (Inherited from ToolStripItem.)
Public eventPaintOccurs when the item is redrawn. (Inherited from ToolStripItem.)
Public eventQueryAccessibilityHelpOccurs when an accessibility client application invokes help for the ToolStripItem. (Inherited from ToolStripItem.)
Public eventQueryContinueDragOccurs 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 eventRightToLeftChangedOccurs when the RightToLeft property value changes. (Inherited from ToolStripItem.)
Public eventTextChangedInfrastructure. This event is not relevant to this class.
Public eventVisibleChangedOccurs when the value of the Visible property changes. (Inherited from ToolStripItem.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIDropTarget.OnDragDropRaises the DragDrop event. (Inherited from ToolStripItem.)
Explicit interface implemetationPrivate methodIDropTarget.OnDragEnterRaises the DragEnter event. (Inherited from ToolStripItem.)
Explicit interface implemetationPrivate methodIDropTarget.OnDragLeaveRaises the DragLeave event. (Inherited from ToolStripItem.)
Explicit interface implemetationPrivate methodIDropTarget.OnDragOverRaises 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.6, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft