TechNet
Export (0) Print
Expand All

ToolStripProgressBar Class

 

Represents a Windows progress bar control contained in a StatusStrip.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.ToolStripItem
        System.Windows.Forms.ToolStripControlHost
          System.Windows.Forms.ToolStripProgressBar

public class ToolStripProgressBar : ToolStripControlHost

NameDescription
System_CAPS_pubmethodToolStripProgressBar()

Initializes a new instance of the ToolStripProgressBar class.

System_CAPS_pubmethodToolStripProgressBar(String)

Initializes a new instance of the ToolStripProgressBar class with specified name.

NameDescription
System_CAPS_pubpropertyAccessibilityObject

Gets the AccessibleObject assigned to the control.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAccessibleDefaultActionDescription

Gets or sets the default action description of the control for use by accessibility client applications.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAccessibleDescription

Gets or sets the description that will be reported to accessibility client applications.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAccessibleName

Gets or sets the name of the control for use by accessibility client applications.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAccessibleRole

Gets or sets the accessible role of the control, which specifies the type of user interface element of the control.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAlignment

Gets or sets a value indicating whether the item aligns towards the beginning or end of the ToolStrip.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAllowDrop

Gets or sets a value indicating whether drag-and-drop and item reordering are handled through events that you implement.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAnchor

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.)

System_CAPS_pubpropertyAutoSize

Gets or sets a value indicating whether the item is automatically sized.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAutoToolTip

Gets or sets a value indicating whether to use the Text property or the ToolTipText property for the ToolStripItem ToolTip. (Inherited from ToolStripItem.)

System_CAPS_pubpropertyAvailable

Gets or sets a value indicating whether the ToolStripItem should be placed on a ToolStrip.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyBackColor

Gets or sets the background color for the control.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyBackgroundImage

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Overrides ToolStripControlHost.BackgroundImage.)

System_CAPS_pubpropertyBackgroundImageLayout

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Overrides ToolStripControlHost.BackgroundImageLayout.)

System_CAPS_pubpropertyBounds

Gets the size and location of the item.(Inherited from ToolStripItem.)

System_CAPS_protpropertyCanRaiseEvents

Gets a value indicating whether the component can raise an event.(Inherited from Component.)

System_CAPS_pubpropertyCanSelect

Gets a value indicating whether the control can be selected.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyCausesValidation

Gets or sets a value indicating whether the hosted control causes and raises validation events on other controls when the hosted control receives focus.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyContentRectangle

Gets the area where content, such as text and icons, can be placed within a ToolStripItem without overwriting background borders.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyControl

Gets the Control that this ToolStripControlHost is hosting.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyControlAlign

Gets or sets the alignment of the control on the form.(Inherited from ToolStripControlHost.)

System_CAPS_protpropertyDefaultAutoToolTip

Gets a value indicating whether to display the ToolTip that is defined as the default.(Inherited from ToolStripItem.)

System_CAPS_protpropertyDefaultDisplayStyle

Gets a value indicating what is displayed on the ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_protpropertyDefaultMargin

Gets the spacing between the ToolStripProgressBar and adjacent items.(Overrides ToolStripItem.DefaultMargin.)

System_CAPS_protpropertyDefaultPadding

Gets the internal spacing characteristics of the item.(Inherited from ToolStripItem.)

System_CAPS_protpropertyDefaultSize

Gets the height and width of the ToolStripProgressBar in pixels.(Overrides ToolStripControlHost.DefaultSize.)

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component.)

System_CAPS_protpropertyDismissWhenClicked

Gets a value indicating whether items on a ToolStripDropDown are hidden after they are clicked.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyDisplayStyle

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyDock

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.)

System_CAPS_pubpropertyDoubleClickEnabled

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyEnabled

Gets or sets a value indicating whether the parent control of the ToolStripItem is enabled.(Inherited from ToolStripControlHost.)

System_CAPS_protpropertyEvents

Gets the list of event handlers that are attached to this Component.(Inherited from Component.)

System_CAPS_pubpropertyFocused

Gets a value indicating whether the control has input focus.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyFont

Gets or sets the font to be used on the hosted control.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyForeColor

Gets or sets the foreground color of the hosted control.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyHeight

Gets or sets the height, in pixels, of a ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyImage

This API supports the product infrastructure and is not intended to be used directly from your code. The image associated with the object.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyImageAlign

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyImageIndex

Gets or sets the index value of the image that is displayed on the item.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyImageKey

Gets or sets the key accessor for the image in the ImageList that is displayed on a ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyImageScaling

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyImageTransparentColor

This property is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyIsDisposed

Gets a value indicating whether the object has been disposed of.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyIsOnDropDown

Gets a value indicating whether the container of the current Control is a ToolStripDropDown. (Inherited from ToolStripItem.)

System_CAPS_pubpropertyIsOnOverflow

Gets a value indicating whether the Placement property is set to Overflow.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyMargin

Gets or sets the space between the item and adjacent items.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyMarqueeAnimationSpeed

Gets or sets a value representing the delay between each Marquee display update, in milliseconds.

System_CAPS_pubpropertyMaximum

Gets or sets the upper bound of the range that is defined for this ToolStripProgressBar.

System_CAPS_pubpropertyMergeAction

Gets or sets how child menus are merged with parent menus. (Inherited from ToolStripItem.)

System_CAPS_pubpropertyMergeIndex

Gets or sets the position of a merged item within the current ToolStrip.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyMinimum

Gets or sets the lower bound of the range that is defined for this ToolStripProgressBar.

System_CAPS_pubpropertyName

Gets or sets the name of the item.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyOverflow

Gets or sets whether the item is attached to the ToolStrip or ToolStripOverflowButton or can float between the two.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyOwner

Gets or sets the owner of this item.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyOwnerItem

Gets the parent ToolStripItem of this ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyPadding

Gets or sets the internal spacing, in pixels, between the item's contents and its edges.(Inherited from ToolStripItem.)

System_CAPS_protpropertyParent

Gets or sets the parent container of the ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyPlacement

Gets the current layout of the item.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyPressed

Gets a value indicating whether the state of the item is pressed. (Inherited from ToolStripItem.)

System_CAPS_pubpropertyProgressBar

Gets the ProgressBar.

System_CAPS_pubpropertyRightToLeft

Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyRightToLeftAutoMirrorImage

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyRightToLeftLayout

Gets or sets a value indicating whether the ToolStripProgressBar layout is right-to-left or left-to-right when the RightToLeft property is set to Yes.

System_CAPS_pubpropertySelected

Gets a value indicating whether the item is selected.(Inherited from ToolStripControlHost.)

System_CAPS_protpropertyShowKeyboardCues

Gets a value indicating whether to show or hide shortcut keys.(Inherited from ToolStripItem.)

System_CAPS_pubpropertySite

Gets or sets the site of the hosted control.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertySize

Gets or sets the size of the ToolStripItem.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyStep

Gets or sets the amount by which to increment the current value of the ToolStripProgressBar when the PerformStep method is called.

System_CAPS_pubpropertyStyle

Gets or sets the style of the ToolStripProgressBar.

System_CAPS_pubpropertyTag

Gets or sets the object that contains data about the item.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyText

Gets or sets the text displayed on the ToolStripProgressBar.(Overrides ToolStripControlHost.Text.)

System_CAPS_pubpropertyTextAlign

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyTextDirection

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyTextImageRelation

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubpropertyToolTipText

Gets or sets the text that appears as a ToolTip for a control.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyValue

Gets or sets the current value of the ToolStripProgressBar.

System_CAPS_pubpropertyVisible

Gets or sets a value indicating whether the item is displayed.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyWidth

Gets or sets the width in pixels of a ToolStripItem.(Inherited from ToolStripItem.)

NameDescription
System_CAPS_protmethodCreateAccessibilityInstance()

Creates a new accessibility object for the control.(Inherited from ToolStripControlHost.)

System_CAPS_pubmethodCreateObjRef(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.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the ToolStripControlHost and optionally releases the managed resources.(Inherited from ToolStripControlHost.)

System_CAPS_pubmethodDoDragDrop(Object, DragDropEffects)

Begins a drag-and-drop operation.(Inherited from ToolStripItem.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.(Inherited from Component.)

System_CAPS_pubmethodFocus()

Gives the focus to a control.(Inherited from ToolStripControlHost.)

System_CAPS_pubmethodGetCurrentParent()

Retrieves the ToolStrip that is the container of the current ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetPreferredSize(Size)

Retrieves the size of a rectangular area into which a control can be fitted.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodGetService(Type)

Returns an object that represents a service provided by the Component or by its Container.(Inherited from Component.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIncrement(Int32)

Advances the current position of the progress bar by the specified amount.

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodInvalidate()

Invalidates the entire surface of the ToolStripItem and causes it to be redrawn.(Inherited from ToolStripItem.)

System_CAPS_pubmethodInvalidate(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.)

System_CAPS_protmethodIsInputChar(Char)

Determines whether a character is an input character that the item recognizes.(Inherited from ToolStripItem.)

System_CAPS_protmethodIsInputKey(Keys)

Determines whether the specified key is a regular input key or a special key that requires preprocessing.(Inherited from ToolStripItem.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodOnAvailableChanged(EventArgs)

Raises the AvailableChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnBackColorChanged(EventArgs)

Raises the BackColorChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnBoundsChanged()

Occurs when the Bounds property changes.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnClick(EventArgs)

Raises the Click event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDisplayStyleChanged(EventArgs)

Raises the DisplayStyleChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDoubleClick(EventArgs)

Raises the DoubleClick event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDragDrop(DragEventArgs)

Raises the DragDrop event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDragEnter(DragEventArgs)

Raises the DragEnter event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDragLeave(EventArgs)

Raises the DragLeave event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDragOver(DragEventArgs)

Raises the DragOver event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnEnabledChanged(EventArgs)

Raises the EnabledChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnEnter(EventArgs)

Raises the Enter event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnFontChanged(EventArgs)

Raises the FontChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnForeColorChanged(EventArgs)

Raises the ForeColorChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnGiveFeedback(GiveFeedbackEventArgs)

Raises the GiveFeedback event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnGotFocus(EventArgs)

Raises the GotFocus event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnHostedControlResize(EventArgs)

Synchronizes the resizing of the control host with the resizing of the hosted control.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnKeyDown(KeyEventArgs)

Raises the KeyDown event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnKeyPress(KeyPressEventArgs)

Raises the KeyPress event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnKeyUp(KeyEventArgs)

Raises the KeyUp event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnLayout(LayoutEventArgs)

Raises the Layout event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnLeave(EventArgs)

Raises the Leave event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnLocationChanged(EventArgs)

Raises the LocationChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnLostFocus(EventArgs)

Raises the LostFocus event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnMouseDown(MouseEventArgs)

Raises the MouseDown event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnMouseEnter(EventArgs)

Raises the MouseEnter event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnMouseHover(EventArgs)

Raises the MouseHover event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnMouseLeave(EventArgs)

Raises the MouseLeave event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnMouseMove(MouseEventArgs)

Raises the MouseMove event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnMouseUp(MouseEventArgs)

Raises the MouseUp event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnOwnerChanged(EventArgs)

Raises the OwnerChanged event. (Inherited from ToolStripItem.)

System_CAPS_protmethodOnOwnerFontChanged(EventArgs)

Raises the FontChanged event when the Font property has changed on the parent of the ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnPaint(PaintEventArgs)

Raises the Paint event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnParentBackColorChanged(EventArgs)

Raises the BackColorChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnParentChanged(ToolStrip, ToolStrip)

Raises the ParentChanged event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnParentEnabledChanged(EventArgs)

Raises the EnabledChanged event when the Enabled property value of the item's container changes.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnParentForeColorChanged(EventArgs)

Raises the ForeColorChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnParentRightToLeftChanged(EventArgs)

Raises the RightToLeftChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnQueryContinueDrag(QueryContinueDragEventArgs)

Raises the QueryContinueDrag event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnRightToLeftChanged(EventArgs)

Raises the RightToLeftChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnRightToLeftLayoutChanged(EventArgs)

Raises the RightToLeftLayoutChanged event.

System_CAPS_protmethodOnSubscribeControlEvents(Control)

Subscribes events from the hosted control.(Overrides ToolStripControlHost.OnSubscribeControlEvents(Control).)

System_CAPS_protmethodOnTextChanged(EventArgs)

Raises the TextChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnUnsubscribeControlEvents(Control)

Unsubscribes events from the hosted control.(Overrides ToolStripControlHost.OnUnsubscribeControlEvents(Control).)

System_CAPS_protmethodOnValidated(EventArgs)

Raises the Validated event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnValidating(CancelEventArgs)

Raises the Validating event.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodOnVisibleChanged(EventArgs)

Raises the VisibleChanged event.(Inherited from ToolStripItem.)

System_CAPS_pubmethodPerformClick()

Generates a Click event for a ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubmethodPerformStep()

Advances the current position of the progress bar by the amount of the Step property.

System_CAPS_protmethodProcessCmdKey(Message, Keys)

Processes a command key.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodProcessDialogKey(Keys)

Processes a dialog key.(Inherited from ToolStripControlHost.)

System_CAPS_protmethodProcessMnemonic(Char)

Processes a mnemonic character.(Inherited from ToolStripControlHost.)

System_CAPS_pubmethodResetBackColor()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubmethodResetDisplayStyle()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetFont()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetForeColor()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubmethodResetImage()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetMargin()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetPadding()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetRightToLeft()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetTextDirection()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodSelect()

Selects the item.(Inherited from ToolStripItem.)

System_CAPS_protmethodSetBounds(Rectangle)

Sets the size and location of the item.(Inherited from ToolStripItem.)

System_CAPS_protmethodSetVisibleCore(Boolean)

Sets the ToolStripItem to the specified visible state. (Inherited from ToolStripControlHost.)

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from ToolStripItem.)

NameDescription
System_CAPS_pubeventAvailableChanged

Occurs when the value of the Available property changes.(Inherited from ToolStripItem.)

System_CAPS_pubeventBackColorChanged

Occurs when the value of the BackColor property changes.(Inherited from ToolStripItem.)

System_CAPS_pubeventClick

Occurs when the ToolStripItem is clicked.(Inherited from ToolStripItem.)

System_CAPS_pubeventDisplayStyleChanged

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not relevant to this class.(Inherited from ToolStripControlHost.)

System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

System_CAPS_pubeventDoubleClick

Occurs when the item is double-clicked with the mouse.(Inherited from ToolStripItem.)

System_CAPS_pubeventDragDrop

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.)

System_CAPS_pubeventDragEnter

Occurs when the user drags an item into the client area of this item.(Inherited from ToolStripItem.)

System_CAPS_pubeventDragLeave

Occurs when the user drags an item and the mouse pointer is no longer over the client area of this item.(Inherited from ToolStripItem.)

System_CAPS_pubeventDragOver

Occurs when the user drags an item over the client area of this item.(Inherited from ToolStripItem.)

System_CAPS_pubeventEnabledChanged

Occurs when the Enabled property value has changed.(Inherited from ToolStripItem.)

System_CAPS_pubeventEnter

Occurs when the hosted control is entered.(Inherited from ToolStripControlHost.)

System_CAPS_pubeventForeColorChanged

Occurs when the ForeColor property value changes.(Inherited from ToolStripItem.)

System_CAPS_pubeventGiveFeedback

Occurs during a drag operation.(Inherited from ToolStripItem.)

System_CAPS_pubeventGotFocus

Occurs when the hosted control receives focus.(Inherited from ToolStripControlHost.)

System_CAPS_pubeventKeyDown

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not relevant for this class.

System_CAPS_pubeventKeyPress

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not relevant for this class.

System_CAPS_pubeventKeyUp

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not relevant for this class.

System_CAPS_pubeventLeave

Occurs when the input focus leaves the hosted control.(Inherited from ToolStripControlHost.)

System_CAPS_pubeventLocationChanged

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not relevant for this class.

System_CAPS_pubeventLostFocus

Occurs when the hosted control loses focus.(Inherited from ToolStripControlHost.)

System_CAPS_pubeventMouseDown

Occurs when the mouse pointer is over the item and a mouse button is pressed.(Inherited from ToolStripItem.)

System_CAPS_pubeventMouseEnter

Occurs when the mouse pointer enters the item.(Inherited from ToolStripItem.)

System_CAPS_pubeventMouseHover

Occurs when the mouse pointer hovers over the item.(Inherited from ToolStripItem.)

System_CAPS_pubeventMouseLeave

Occurs when the mouse pointer leaves the item.(Inherited from ToolStripItem.)

System_CAPS_pubeventMouseMove

Occurs when the mouse pointer is moved over the item.(Inherited from ToolStripItem.)

System_CAPS_pubeventMouseUp

Occurs when the mouse pointer is over the item and a mouse button is released.(Inherited from ToolStripItem.)

System_CAPS_pubeventOwnerChanged

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not relevant for this class.

System_CAPS_pubeventPaint

Occurs when the item is redrawn.(Inherited from ToolStripItem.)

System_CAPS_pubeventQueryAccessibilityHelp

Occurs when an accessibility client application invokes help for the ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubeventQueryContinueDrag

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.)

System_CAPS_pubeventRightToLeftChanged

Occurs when the RightToLeft property value changes.(Inherited from ToolStripItem.)

System_CAPS_pubeventRightToLeftLayoutChanged

Occurs when the value of the RightToLeftLayout property changes.

System_CAPS_pubeventTextChanged

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not relevant for this class.

System_CAPS_pubeventValidated

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not relevant to this class.

System_CAPS_pubeventValidating

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not relevant to this class.

System_CAPS_pubeventVisibleChanged

Occurs when the value of the Visible property changes.(Inherited from ToolStripItem.)

ToolStripProgressBar is the ProgressBar optimized for hosting in a ToolStrip. A subset of the hosted control's properties and events are exposed at the ToolStripProgressBar level, but the underlying ProgressBar control is fully accessible through the ProgressBar property.

A ToolStripProgressBar control visually indicates the progress of a lengthy operation. The ToolStripProgressBar control displays a bar that fills in from left to right with the system highlight color as an operation progresses.

System_CAPS_noteNote

The ToolStripProgressBar control can only be oriented horizontally.

The ToolStripProgressBar control is typically used when an application performs tasks such as copying files or printing documents. Users of an application might consider an application unresponsive if there is no visual cue. Use the ToolStripProgressBar to notify the user that the application is performing a lengthy task and that the application is still responding.

The Maximum and Minimum properties define the range of values to represent the progress of a task. The Minimum property is typically set to a value of zero, and the Maximum property is typically set to a value indicating the completion of a task. For example, to display the progress properly when copying a group of files, the Maximum property could be set to the total number of files to be copied. The Value property represents the progress that the application has made toward completing the operation. Because the bar displayed in the control is a collection of blocks, the value displayed by the ToolStripProgressBar only approximates the Value property's current value. Based on the size of the ToolStripProgressBar, the Value property determines when to display the next block.

There are a number of ways to modify the value displayed by the ToolStripProgressBar other than changing the Value property directly. You can use the Step property to specify a specific value to increment the Value property by, and then call the PerformStep method to increment the value. To vary the increment value, you can use the Increment method and specify a value by which to increment the Value property.

ToolStripProgressBar replaces the older ProgressBar control, which is nevertheless retained for backward compatibility.

The following code example demonstrates a ToolStripProgressBar that calculates a sequence of Fibonacci numbers.

using System;
using System.Collections.Generic;
using System.Windows.Forms;
using System.ComponentModel;

class FibonacciNumber : Form
{
	[STAThread]
	static void Main()
	{
		Application.EnableVisualStyles();
		Application.Run(new FibonacciNumber());
	}

	private StatusStrip progressStatusStrip;
	private ToolStripProgressBar toolStripProgressBar;
	private NumericUpDown requestedCountControl;
	private Button goButton;
	private TextBox outputTextBox;
	private BackgroundWorker backgroundWorker;
	private ToolStripStatusLabel toolStripStatusLabel;
	private int requestedCount;

	public FibonacciNumber()
	{
		Text = "Fibonacci";

		// Prepare the StatusStrip.
		progressStatusStrip = new StatusStrip();
		toolStripProgressBar = new ToolStripProgressBar();
		toolStripProgressBar.Enabled = false;
		toolStripStatusLabel = new ToolStripStatusLabel();
		progressStatusStrip.Items.Add(toolStripProgressBar);
		progressStatusStrip.Items.Add(toolStripStatusLabel);

		FlowLayoutPanel flp = new FlowLayoutPanel();
		flp.Dock = DockStyle.Top;

		Label beforeLabel = new Label();
		beforeLabel.Text = "Calculate the first ";
		beforeLabel.AutoSize = true;
		flp.Controls.Add(beforeLabel);
		requestedCountControl = new NumericUpDown();
		requestedCountControl.Maximum = 1000;
		requestedCountControl.Minimum = 1;
		requestedCountControl.Value = 100;
		flp.Controls.Add(requestedCountControl);
		Label afterLabel = new Label();
		afterLabel.Text = "Numbers in the Fibonacci sequence.";
		afterLabel.AutoSize = true;
		flp.Controls.Add(afterLabel);

		goButton = new Button();
		goButton.Text = "&Go";
		goButton.Click += new System.EventHandler(button1_Click);
		flp.Controls.Add(goButton);

		outputTextBox = new TextBox();
		outputTextBox.Multiline = true;
		outputTextBox.ReadOnly = true;
		outputTextBox.ScrollBars = ScrollBars.Vertical;
		outputTextBox.Dock = DockStyle.Fill;

		Controls.Add(outputTextBox);
		Controls.Add(progressStatusStrip);
		Controls.Add(flp);

		backgroundWorker = new BackgroundWorker();
		backgroundWorker.WorkerReportsProgress = true;
		backgroundWorker.DoWork += new DoWorkEventHandler(backgroundWorker1_DoWork);
		backgroundWorker.RunWorkerCompleted += new RunWorkerCompletedEventHandler(backgroundWorker1_RunWorkerCompleted);
		backgroundWorker.ProgressChanged += new ProgressChangedEventHandler(backgroundWorker1_ProgressChanged);

	}

	private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
	{
		// This method will run on a thread other than the UI thread.
		// Be sure not to manipulate any Windows Forms controls created
		// on the UI thread from this method.
		backgroundWorker.ReportProgress(0, "Working...");
		Decimal lastlast = 0;
		Decimal last = 1;
		Decimal current;
		if (requestedCount >= 1)
		{ AppendNumber(0); }
		if (requestedCount >= 2)
		{ AppendNumber(1); }
		for (int i = 2; i < requestedCount; ++i)
		{
			// Calculate the number.
			checked { current = lastlast + last; }
			// Introduce some delay to simulate a more complicated calculation.
			System.Threading.Thread.Sleep(100);
			AppendNumber(current);
			backgroundWorker.ReportProgress((100 * i) / requestedCount, "Working...");
			// Get ready for the next iteration.
			lastlast = last;
			last = current;
		}


		backgroundWorker.ReportProgress(100, "Complete!");
	}

	private delegate void AppendNumberDelegate(Decimal number);
	private void AppendNumber(Decimal number)
	{
		if (outputTextBox.InvokeRequired)
		{ outputTextBox.Invoke(new AppendNumberDelegate(AppendNumber), number); }
		else
		{ outputTextBox.AppendText(number.ToString("N0") + Environment.NewLine); }
	}
	private void backgroundWorker1_ProgressChanged(object sender, ProgressChangedEventArgs e)
	{
		toolStripProgressBar.Value = e.ProgressPercentage;
		toolStripStatusLabel.Text = e.UserState as String;
	}

	private void backgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
	{
		if (e.Error is OverflowException)
		{ outputTextBox.AppendText(Environment.NewLine + "**OVERFLOW ERROR, number is too large to be represented by the decimal data type**"); }
		toolStripProgressBar.Enabled = false;
		requestedCountControl.Enabled = true;
		goButton.Enabled = true;

	}

	private void button1_Click(object sender, EventArgs e)
	{
		goButton.Enabled = false;
		toolStripProgressBar.Enabled = true;
		requestedCount = (int)requestedCountControl.Value;
		requestedCountControl.Enabled = false;
		outputTextBox.Clear();
		backgroundWorker.RunWorkerAsync();
	}
}

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft