Export (0) Print
Expand All

ProgressBar Class

Represents a Windows progress bar control.

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

[DefaultBindingPropertyAttribute("Value")]
[ComVisibleAttribute(true)]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
public class ProgressBar : Control

The ProgressBar type exposes the following members.

  NameDescription
Public methodProgressBarInitializes a new instance of the ProgressBar class.
Top

  NameDescription
Public propertyAccessibilityObjectGets the AccessibleObject assigned to the control. (Inherited from Control.)
Public propertyAccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. (Inherited from Control.)
Public propertyAccessibleDescriptionGets or sets the description of the control used by accessibility client applications. (Inherited from Control.)
Public propertyAccessibleNameGets or sets the name of the control used by accessibility client applications. (Inherited from Control.)
Public propertyAccessibleRoleGets or sets the accessible role of the control (Inherited from Control.)
Public propertyAllowDropInfrastructure. Overrides Control.AllowDrop. (Overrides Control.AllowDrop.)
Public propertyAnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. (Inherited from Control.)
Public propertyAutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView. (Inherited from Control.)
Public propertyAutoSizeInfrastructure. This property is not relevant for this class. (Inherited from Control.)
Public propertyBackColorGets or sets the background color for the control. (Inherited from Control.)
Public propertyBackgroundImageInfrastructure. Gets or sets the background image for the ProgressBar control. (Overrides Control.BackgroundImage.)
Public propertyBackgroundImageLayoutInfrastructure. Gets or sets the layout of the background image of the progress bar. (Overrides Control.BackgroundImageLayout.)
Public propertyBindingContextGets or sets the BindingContext for the control. (Inherited from Control.)
Public propertyBottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area. (Inherited from Control.)
Public propertyBoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. (Inherited from Control.)
Protected propertyCanEnableImeGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. (Inherited from Control.)
Public propertyCanFocusGets a value indicating whether the control can receive focus. (Inherited from Control.)
Protected propertyCanRaiseEventsDetermines if events can be raised on the control. (Inherited from Control.)
Public propertyCanSelectGets a value indicating whether the control can be selected. (Inherited from Control.)
Public propertyCaptureGets or sets a value indicating whether the control has captured the mouse. (Inherited from Control.)
Public propertyCausesValidationInfrastructure. Gets or sets a value indicating whether the control, when it receives focus, causes validation to be performed on any controls that require validation.
Public propertyClientRectangleGets the rectangle that represents the client area of the control. (Inherited from Control.)
Public propertyClientSizeGets or sets the height and width of the client area of the control. (Inherited from Control.)
Public propertyCompanyNameGets the name of the company or creator of the application containing the control. (Inherited from Control.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. (Inherited from Control.)
Public propertyContextMenuGets or sets the shortcut menu associated with the control. (Inherited from Control.)
Public propertyContextMenuStripGets or sets the ContextMenuStrip associated with this control. (Inherited from Control.)
Public propertyControlsGets the collection of controls contained within the control. (Inherited from Control.)
Public propertyCreatedGets a value indicating whether the control has been created. (Inherited from Control.)
Protected propertyCreateParamsInfrastructure. Overrides Control.CreateParams. (Overrides Control.CreateParams.)
Public propertyCursorGets or sets the cursor that is displayed when the mouse pointer is over the control. (Inherited from Control.)
Public propertyDataBindingsGets the data bindings for the control. (Inherited from Control.)
Protected propertyDefaultCursorGets or sets the default cursor for the control. (Inherited from Control.)
Protected propertyDefaultImeModeGets the default Input Method Editor (IME) mode supported by the control. (Overrides Control.DefaultImeMode.)
Protected propertyDefaultMarginGets the space, in pixels, that is specified by default between controls. (Inherited from Control.)
Protected propertyDefaultMaximumSizeGets the length and height, in pixels, that is specified as the default maximum size of a control. (Inherited from Control.)
Protected propertyDefaultMinimumSizeGets the length and height, in pixels, that is specified as the default minimum size of a control. (Inherited from Control.)
Protected propertyDefaultPaddingGets the internal spacing, in pixels, of the contents of a control. (Inherited from Control.)
Protected propertyDefaultSizeGets the default size of the control. (Overrides Control.DefaultSize.)
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public propertyDisplayRectangleGets the rectangle that represents the display area of the control. (Inherited from Control.)
Public propertyDisposingGets a value indicating whether the base Control class is in the process of disposing. (Inherited from Control.)
Public propertyDockGets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. (Inherited from Control.)
Protected propertyDoubleBufferedGets or sets a value indicating whether the control should redraw its surface using a secondary buffer. (Overrides Control.DoubleBuffered.)
Public propertyEnabledGets or sets a value indicating whether the control can respond to user interaction. (Inherited from Control.)
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyFocusedGets a value indicating whether the control has input focus. (Inherited from Control.)
Public propertyFontInfrastructure. Gets or sets the font of text in the ProgressBar. (Overrides Control.Font.)
Protected propertyFontHeightGets or sets the height of the font of the control. (Inherited from Control.)
Public propertyForeColorGets or sets the foreground color of the control. (Inherited from Control.)
Public propertyHandleGets the window handle that the control is bound to. (Inherited from Control.)
Public propertyHasChildrenGets a value indicating whether the control contains one or more child controls. (Inherited from Control.)
Public propertyHeightGets or sets the height of the control. (Inherited from Control.)
Public propertyImeModeInfrastructure. Gets or sets the input method editor (IME) for the ProgressBar
Protected propertyImeModeBaseGets or sets the IME mode of a control. (Inherited from Control.)
Public propertyInvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. (Inherited from Control.)
Public propertyIsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. (Inherited from Control.)
Public propertyIsDisposedGets a value indicating whether the control has been disposed of. (Inherited from Control.)
Public propertyIsHandleCreatedGets a value indicating whether the control has a handle associated with it. (Inherited from Control.)
Public propertyIsMirroredGets a value indicating whether the control is mirrored. (Inherited from Control.)
Public propertyLayoutEngineGets a cached instance of the control's layout engine. (Inherited from Control.)
Public propertyLeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area. (Inherited from Control.)
Public propertyLocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. (Inherited from Control.)
Public propertyMarginGets or sets the space between controls. (Inherited from Control.)
Public propertyMarqueeAnimationSpeedGets or sets the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
Public propertyMaximumGets or sets the maximum value of the range of the control.
Public propertyMaximumSizeGets or sets the size that is the upper limit that GetPreferredSize can specify. (Inherited from Control.)
Public propertyMinimumGets or sets the minimum value of the range of the control.
Public propertyMinimumSizeGets or sets the size that is the lower limit that GetPreferredSize can specify. (Inherited from Control.)
Public propertyNameGets or sets the name of the control. (Inherited from Control.)
Public propertyPaddingInfrastructure. Gets or sets the space between the edges of a ProgressBar control and its contents.
Public propertyParentGets or sets the parent container of the control. (Inherited from Control.)
Public propertyPreferredSizeGets the size of a rectangular area into which the control can fit. (Inherited from Control.)
Public propertyProductNameGets the product name of the assembly containing the control. (Inherited from Control.)
Public propertyProductVersionGets the version of the assembly containing the control. (Inherited from Control.)
Public propertyRecreatingHandleGets a value indicating whether the control is currently re-creating its handle. (Inherited from Control.)
Public propertyRegionGets or sets the window region associated with the control. (Inherited from Control.)
Protected propertyRenderRightToLeft Obsolete. This property is now obsolete. (Inherited from Control.)
Protected propertyResizeRedrawGets or sets a value indicating whether the control redraws itself when resized. (Inherited from Control.)
Public propertyRightGets the distance, in pixels, between the right edge of the control and the left edge of its container's client area. (Inherited from Control.)
Public propertyRightToLeftGets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts. (Inherited from Control.)
Public propertyRightToLeftLayoutGets or sets a value indicating whether the ProgressBar and any text it contains is displayed from right to left.
Protected propertyScaleChildrenGets a value that determines the scaling of child controls. (Inherited from Control.)
Protected propertyShowFocusCuesGets a value indicating whether the control should display focus rectangles. (Inherited from Control.)
Protected propertyShowKeyboardCuesGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. (Inherited from Control.)
Public propertySiteGets or sets the site of the control. (Inherited from Control.)
Public propertySizeGets or sets the height and width of the control. (Inherited from Control.)
Public propertyStepGets or sets the amount by which a call to the PerformStep method increases the current position of the progress bar.
Public propertyStyleGets or sets the manner in which progress should be indicated on the progress bar.
Public propertyTabIndexGets or sets the tab order of the control within its container. (Inherited from Control.)
Public propertyTabStopInfrastructure. Overrides TabStop.
Public propertyTagGets or sets the object that contains data about the control. (Inherited from Control.)
Public propertyTextInfrastructure. Overrides Text. (Overrides Control.Text.)
Public propertyTopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area. (Inherited from Control.)
Public propertyTopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. (Inherited from Control.)
Public propertyUseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. (Inherited from Control.)
Public propertyValueGets or sets the current position of the progress bar.
Public propertyVisibleGets or sets a value indicating whether the control and all its child controls are displayed. (Inherited from Control.)
Public propertyWidthGets or sets the width of the control. (Inherited from Control.)
Public propertyWindowTargetInfrastructure. This property is not relevant for this class. (Inherited from Control.)
Top

  NameDescription
Protected methodAccessibilityNotifyClients(AccessibleEvents, Int32)Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control. (Inherited from Control.)
Protected methodAccessibilityNotifyClients(AccessibleEvents, Int32, Int32)Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control . (Inherited from Control.)
Public methodBeginInvoke(Delegate)Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on. (Inherited from Control.)
Public methodBeginInvoke(Delegate, Object[])Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on. (Inherited from Control.)
Public methodBringToFrontBrings the control to the front of the z-order. (Inherited from Control.)
Public methodContainsRetrieves a value indicating whether the specified control is a child of the control. (Inherited from Control.)
Protected methodCreateAccessibilityInstanceCreates a new accessibility object for the control. (Inherited from Control.)
Public methodCreateControlForces the creation of the visible control, including the creation of the handle and any visible child controls. (Inherited from Control.)
Protected methodCreateControlsInstanceCreates a new instance of the control collection for the control. (Inherited from Control.)
Public methodCreateGraphicsCreates the Graphics for the control. (Inherited from Control.)
Protected methodCreateHandleCreates a handle for the control. (Overrides Control.CreateHandle().)
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.)
Protected methodDefWndProcSends the specified message to the default window procedure. (Inherited from Control.)
Protected methodDestroyHandleDestroys the handle associated with the control. (Inherited from Control.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the Control and its child controls and optionally releases the managed resources. (Inherited from Control.)
Public methodDoDragDropBegins a drag-and-drop operation. (Inherited from Control.)
Public methodDrawToBitmapSupports rendering to the specified bitmap. (Inherited from Control.)
Public methodEndInvokeRetrieves the return value of the asynchronous operation represented by the IAsyncResult passed. (Inherited from Control.)
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 methodFindFormRetrieves the form that the control is on. (Inherited from Control.)
Public methodFocusSets input focus to the control. (Inherited from Control.)
Protected methodGetAccessibilityObjectByIdRetrieves the specified AccessibleObject. (Inherited from Control.)
Protected methodGetAutoSizeModeRetrieves a value indicating how a control will behave when its AutoSize property is enabled. (Inherited from Control.)
Public methodGetChildAtPoint(Point)Retrieves the child control that is located at the specified coordinates. (Inherited from Control.)
Public methodGetChildAtPoint(Point, GetChildAtPointSkip)Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type. (Inherited from Control.)
Public methodGetContainerControlReturns the next ContainerControl up the control's chain of parent controls. (Inherited from Control.)
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 methodGetNextControlRetrieves the next control forward or back in the tab order of child controls. (Inherited from Control.)
Public methodGetPreferredSizeRetrieves the size of a rectangular area into which a control can be fitted. (Inherited from Control.)
Protected methodGetScaledBoundsRetrieves the bounds within which the control is scaled. (Inherited from Control.)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Protected methodGetStyleRetrieves the value of the specified control style bit for the control. (Inherited from Control.)
Protected methodGetTopLevelDetermines if the control is a top-level control. (Inherited from Control.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHideConceals the control from the user. (Inherited from Control.)
Public methodIncrementAdvances the current position of the progress bar by the specified amount.
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodInitLayoutCalled after the control has been added to another container. (Inherited from Control.)
Public methodInvalidate()Invalidates the entire surface of the control and causes the control to be redrawn. (Inherited from Control.)
Public methodInvalidate(Boolean)Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. (Inherited from Control.)
Public methodInvalidate(Rectangle)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. (Inherited from Control.)
Public methodInvalidate(Region)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. (Inherited from Control.)
Public methodInvalidate(Rectangle, Boolean)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. (Inherited from Control.)
Public methodInvalidate(Region, Boolean)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. (Inherited from Control.)
Public methodInvoke(Delegate)Executes the specified delegate on the thread that owns the control's underlying window handle. (Inherited from Control.)
Public methodInvoke(Delegate, Object[])Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments. (Inherited from Control.)
Protected methodInvokeGotFocusRaises the GotFocus event for the specified control. (Inherited from Control.)
Protected methodInvokeLostFocusRaises the LostFocus event for the specified control. (Inherited from Control.)
Protected methodInvokeOnClickRaises the Click event for the specified control. (Inherited from Control.)
Protected methodInvokePaintRaises the Paint event for the specified control. (Inherited from Control.)
Protected methodInvokePaintBackgroundRaises the PaintBackground event for the specified control. (Inherited from Control.)
Protected methodIsInputCharDetermines if a character is an input character that the control recognizes. (Inherited from Control.)
Protected methodIsInputKeyDetermines whether the specified key is a regular input key or a special key that requires preprocessing. (Inherited from Control.)
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 methodNotifyInvalidateInfrastructure. Raises the Invalidated event with a specified region of the control to invalidate. (Inherited from Control.)
Protected methodOnAutoSizeChangedRaises the AutoSizeChanged event. (Inherited from Control.)
Protected methodOnBackColorChangedRaises the BackColorChanged event. (Overrides Control.OnBackColorChanged(EventArgs).)
Protected methodOnBackgroundImageChangedRaises the BackgroundImageChanged event. (Inherited from Control.)
Protected methodOnBackgroundImageLayoutChangedRaises the BackgroundImageLayoutChanged event. (Inherited from Control.)
Protected methodOnBindingContextChangedRaises the BindingContextChanged event. (Inherited from Control.)
Protected methodOnCausesValidationChangedRaises the CausesValidationChanged event. (Inherited from Control.)
Protected methodOnChangeUICuesRaises the ChangeUICues event. (Inherited from Control.)
Protected methodOnClickRaises the Click event. (Inherited from Control.)
Protected methodOnClientSizeChangedRaises the ClientSizeChanged event. (Inherited from Control.)
Protected methodOnContextMenuChangedRaises the ContextMenuChanged event. (Inherited from Control.)
Protected methodOnContextMenuStripChangedRaises the ContextMenuStripChanged event. (Inherited from Control.)
Protected methodOnControlAddedRaises the ControlAdded event. (Inherited from Control.)
Protected methodOnControlRemovedRaises the ControlRemoved event. (Inherited from Control.)
Protected methodOnCreateControlRaises the CreateControl method. (Inherited from Control.)
Protected methodOnCursorChangedRaises the CursorChanged event. (Inherited from Control.)
Protected methodOnDockChangedRaises the DockChanged event. (Inherited from Control.)
Protected methodOnDoubleClickRaises the DoubleClick event. (Inherited from Control.)
Protected methodOnDragDropRaises the DragDrop event. (Inherited from Control.)
Protected methodOnDragEnterRaises the DragEnter event. (Inherited from Control.)
Protected methodOnDragLeaveRaises the DragLeave event. (Inherited from Control.)
Protected methodOnDragOverRaises the DragOver event. (Inherited from Control.)
Protected methodOnEnabledChangedRaises the EnabledChanged event. (Inherited from Control.)
Protected methodOnEnterRaises the Enter event. (Inherited from Control.)
Protected methodOnFontChangedRaises the FontChanged event. (Inherited from Control.)
Protected methodOnForeColorChangedRaises the ForeColorChanged event. (Overrides Control.OnForeColorChanged(EventArgs).)
Protected methodOnGiveFeedbackRaises the GiveFeedback event. (Inherited from Control.)
Protected methodOnGotFocusRaises the GotFocus event. (Inherited from Control.)
Protected methodOnHandleCreatedInfrastructure. Overrides OnHandleCreated (Overrides Control.OnHandleCreated(EventArgs).)
Protected methodOnHandleDestroyedRaises the HandleDestroyed event. (Overrides Control.OnHandleDestroyed(EventArgs).)
Protected methodOnHelpRequestedRaises the HelpRequested event. (Inherited from Control.)
Protected methodOnImeModeChangedRaises the ImeModeChanged event. (Inherited from Control.)
Protected methodOnInvalidatedRaises the Invalidated event. (Inherited from Control.)
Protected methodOnKeyDownRaises the KeyDown event. (Inherited from Control.)
Protected methodOnKeyPressRaises the KeyPress event. (Inherited from Control.)
Protected methodOnKeyUpRaises the KeyUp event. (Inherited from Control.)
Protected methodOnLayoutRaises the Layout event. (Inherited from Control.)
Protected methodOnLeaveRaises the Leave event. (Inherited from Control.)
Protected methodOnLocationChangedRaises the LocationChanged event. (Inherited from Control.)
Protected methodOnLostFocusRaises the LostFocus event. (Inherited from Control.)
Protected methodOnMarginChangedRaises the MarginChanged event. (Inherited from Control.)
Protected methodOnMouseCaptureChangedRaises the MouseCaptureChanged event. (Inherited from Control.)
Protected methodOnMouseClickRaises the MouseClick event. (Inherited from Control.)
Protected methodOnMouseDoubleClickRaises the MouseDoubleClick event. (Inherited from Control.)
Protected methodOnMouseDownRaises the MouseDown event. (Inherited from Control.)
Protected methodOnMouseEnterRaises the MouseEnter event. (Inherited from Control.)
Protected methodOnMouseHoverRaises the MouseHover event. (Inherited from Control.)
Protected methodOnMouseLeaveRaises the MouseLeave event. (Inherited from Control.)
Protected methodOnMouseMoveRaises the MouseMove event. (Inherited from Control.)
Protected methodOnMouseUpRaises the MouseUp event. (Inherited from Control.)
Protected methodOnMouseWheelRaises the MouseWheel event. (Inherited from Control.)
Protected methodOnMoveRaises the Move event. (Inherited from Control.)
Protected methodOnNotifyMessageNotifies the control of Windows messages. (Inherited from Control.)
Protected methodOnPaddingChangedRaises the PaddingChanged event. (Inherited from Control.)
Protected methodOnPaintRaises the Paint event. (Inherited from Control.)
Protected methodOnPaintBackgroundPaints the background of the control. (Inherited from Control.)
Protected methodOnParentBackColorChangedRaises the BackColorChanged event when the BackColor property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentBackgroundImageChangedRaises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentBindingContextChangedRaises the BindingContextChanged event when the BindingContext property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentChangedRaises the ParentChanged event. (Inherited from Control.)
Protected methodOnParentCursorChangedRaises the CursorChanged event. (Inherited from Control.)
Protected methodOnParentEnabledChangedRaises the EnabledChanged event when the Enabled property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentFontChangedRaises the FontChanged event when the Font property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentForeColorChangedRaises the ForeColorChanged event when the ForeColor property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentRightToLeftChangedRaises the RightToLeftChanged event when the RightToLeft property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentVisibleChangedRaises the VisibleChanged event when the Visible property value of the control's container changes. (Inherited from Control.)
Protected methodOnPreviewKeyDownRaises the PreviewKeyDown event. (Inherited from Control.)
Protected methodOnPrintRaises the Paint event. (Inherited from Control.)
Protected methodOnQueryContinueDragRaises the QueryContinueDrag event. (Inherited from Control.)
Protected methodOnRegionChangedRaises the RegionChanged event. (Inherited from Control.)
Protected methodOnResizeRaises the Resize event. (Inherited from Control.)
Protected methodOnRightToLeftChangedRaises the RightToLeftChanged event. (Inherited from Control.)
Protected methodOnRightToLeftLayoutChangedRaises the RightToLeftLayout event.
Protected methodOnSizeChangedRaises the SizeChanged event. (Inherited from Control.)
Protected methodOnStyleChangedRaises the StyleChanged event. (Inherited from Control.)
Protected methodOnSystemColorsChangedRaises the SystemColorsChanged event. (Inherited from Control.)
Protected methodOnTabIndexChangedRaises the TabIndexChanged event. (Inherited from Control.)
Protected methodOnTabStopChangedRaises the TabStopChanged event. (Inherited from Control.)
Protected methodOnTextChangedRaises the TextChanged event. (Inherited from Control.)
Protected methodOnValidatedRaises the Validated event. (Inherited from Control.)
Protected methodOnValidatingRaises the Validating event. (Inherited from Control.)
Protected methodOnVisibleChangedRaises the VisibleChanged event. (Inherited from Control.)
Public methodPerformLayout()Forces the control to apply layout logic to all its child controls. (Inherited from Control.)
Public methodPerformLayout(Control, String)Forces the control to apply layout logic to all its child controls. (Inherited from Control.)
Public methodPerformStepAdvances the current position of the progress bar by the amount of the Step property.
Public methodPointToClientComputes the location of the specified screen point into client coordinates. (Inherited from Control.)
Public methodPointToScreenComputes the location of the specified client point into screen coordinates. (Inherited from Control.)
Public methodPreProcessControlMessagePreprocesses keyboard or input messages within the message loop before they are dispatched. (Inherited from Control.)
Public methodPreProcessMessagePreprocesses keyboard or input messages within the message loop before they are dispatched. (Inherited from Control.)
Protected methodProcessCmdKeyProcesses a command key. (Inherited from Control.)
Protected methodProcessDialogCharProcesses a dialog character. (Inherited from Control.)
Protected methodProcessDialogKeyProcesses a dialog key. (Inherited from Control.)
Protected methodProcessKeyEventArgsProcesses a key message and generates the appropriate control events. (Inherited from Control.)
Protected methodProcessKeyMessageProcesses a keyboard message. (Inherited from Control.)
Protected methodProcessKeyPreviewPreviews a keyboard message. (Inherited from Control.)
Protected methodProcessMnemonicProcesses a mnemonic character. (Inherited from Control.)
Protected methodRaiseDragEventInfrastructure. Raises the appropriate drag event. (Inherited from Control.)
Protected methodRaiseKeyEventInfrastructure. Raises the appropriate key event. (Inherited from Control.)
Protected methodRaiseMouseEventInfrastructure. Raises the appropriate mouse event. (Inherited from Control.)
Protected methodRaisePaintEventInfrastructure. Raises the appropriate paint event. (Inherited from Control.)
Protected methodRecreateHandleForces the re-creation of the handle for the control. (Inherited from Control.)
Public methodRectangleToClientComputes the size and location of the specified screen rectangle in client coordinates. (Inherited from Control.)
Public methodRectangleToScreenComputes the size and location of the specified client rectangle in screen coordinates. (Inherited from Control.)
Public methodRefreshForces the control to invalidate its client area and immediately redraw itself and any child controls. (Inherited from Control.)
Public methodResetBackColorResets the BackColor property to its default value. (Inherited from Control.)
Public methodResetBindingsCauses a control bound to the BindingSource to reread all the items in the list and refresh their displayed values. (Inherited from Control.)
Public methodResetCursorResets the Cursor property to its default value. (Inherited from Control.)
Public methodResetFontResets the Font property to its default value. (Inherited from Control.)
Public methodResetForeColorInfrastructure. Resets the ForeColor to its default value. (Overrides Control.ResetForeColor().)
Public methodResetImeModeResets the ImeMode property to its default value. (Inherited from Control.)
Protected methodResetMouseEventArgsInfrastructure. Resets the control to handle the MouseLeave event. (Inherited from Control.)
Public methodResetRightToLeftResets the RightToLeft property to its default value. (Inherited from Control.)
Public methodResetTextResets the Text property to its default value. (Inherited from Control.)
Public methodResumeLayout()Resumes usual layout logic. (Inherited from Control.)
Public methodResumeLayout(Boolean)Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. (Inherited from Control.)
Protected methodRtlTranslateAlignment(ContentAlignment)Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. (Inherited from Control.)
Protected methodRtlTranslateAlignment(HorizontalAlignment)Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. (Inherited from Control.)
Protected methodRtlTranslateAlignment(LeftRightAlignment)Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. (Inherited from Control.)
Protected methodRtlTranslateContentConverts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. (Inherited from Control.)
Protected methodRtlTranslateHorizontalConverts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. (Inherited from Control.)
Protected methodRtlTranslateLeftRightConverts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. (Inherited from Control.)
Public methodScale(Single) Obsolete. Scales the control and any child controls. (Inherited from Control.)
Public methodScale(SizeF)Scales the control and all child controls by the specified scaling factor. (Inherited from Control.)
Public methodScale(Single, Single) Obsolete. Scales the entire control and any child controls. (Inherited from Control.)
Protected methodScaleControlScales a control's location, size, padding and margin. (Inherited from Control.)
Protected methodScaleCoreInfrastructure. This method is not relevant for this class. (Inherited from Control.)
Public methodSelect()Activates the control. (Inherited from Control.)
Protected methodSelect(Boolean, Boolean)Activates a child control. Optionally specifies the direction in the tab order to select the control from. (Inherited from Control.)
Public methodSelectNextControlActivates the next control. (Inherited from Control.)
Public methodSendToBackSends the control to the back of the z-order. (Inherited from Control.)
Protected methodSetAutoSizeModeSets a value indicating how a control will behave when its AutoSize property is enabled. (Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32)Sets the bounds of the control to the specified location and size. (Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)Sets the specified bounds of the control to the specified location and size. (Inherited from Control.)
Protected methodSetBoundsCorePerforms the work of setting the specified bounds of this control. (Inherited from Control.)
Protected methodSetClientSizeCoreSets the size of the client area of the control. (Inherited from Control.)
Protected methodSetStyleSets a specified ControlStyles flag to either true or false. (Inherited from Control.)
Protected methodSetTopLevelSets the control as the top-level control. (Inherited from Control.)
Protected methodSetVisibleCoreSets the control to the specified visible state. (Inherited from Control.)
Public methodShowDisplays the control to the user. (Inherited from Control.)
Protected methodSizeFromClientSizeDetermines the size of the entire control from the height and width of its client area. (Inherited from Control.)
Public methodSuspendLayoutTemporarily suspends the layout logic for the control. (Inherited from Control.)
Public methodToStringInfrastructure. Returns a string that represents the ProgressBar control. (Overrides Component.ToString().)
Public methodUpdateCauses the control to redraw the invalidated regions within its client area. (Inherited from Control.)
Protected methodUpdateBounds()Updates the bounds of the control with the current size and location. (Inherited from Control.)
Protected methodUpdateBounds(Int32, Int32, Int32, Int32)Updates the bounds of the control with the specified size and location. (Inherited from Control.)
Protected methodUpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32)Updates the bounds of the control with the specified size, location, and client size. (Inherited from Control.)
Protected methodUpdateStylesForces the assigned styles to be reapplied to the control. (Inherited from Control.)
Protected methodUpdateZOrderUpdates the control in its parent's z-order. (Inherited from Control.)
Protected methodWndProcProcesses Windows messages. (Inherited from Control.)
Top

  NameDescription
Public eventAutoSizeChangedInfrastructure. This event is not relevant for this class. (Inherited from Control.)
Public eventBackColorChangedOccurs when the value of the BackColor property changes. (Inherited from Control.)
Public eventBackgroundImageChangedInfrastructure. Occurs when the value of the BackgroundImage property changes.
Public eventBackgroundImageLayoutChangedInfrastructure. Occurs when the value of the BackgroundImageLayout property changes.
Public eventBindingContextChangedOccurs when the value of the BindingContext property changes. (Inherited from Control.)
Public eventCausesValidationChangedInfrastructure. Occurs when the value of the CausesValidation property changes.
Public eventChangeUICuesOccurs when the focus or keyboard user interface (UI) cues change. (Inherited from Control.)
Public eventClickOccurs when the control is clicked. (Inherited from Control.)
Public eventClientSizeChangedOccurs when the value of the ClientSize property changes. (Inherited from Control.)
Public eventContextMenuChangedOccurs when the value of the ContextMenu property changes. (Inherited from Control.)
Public eventContextMenuStripChangedOccurs when the value of the ContextMenuStrip property changes. (Inherited from Control.)
Public eventControlAddedOccurs when a new control is added to the Control.ControlCollection. (Inherited from Control.)
Public eventControlRemovedOccurs when a control is removed from the Control.ControlCollection. (Inherited from Control.)
Public eventCursorChangedOccurs when the value of the Cursor property changes. (Inherited from Control.)
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public eventDockChangedOccurs when the value of the Dock property changes. (Inherited from Control.)
Public eventDoubleClickInfrastructure. Occurs when the user double-clicks the control.
Public eventDragDropOccurs when a drag-and-drop operation is completed. (Inherited from Control.)
Public eventDragEnterOccurs when an object is dragged into the control's bounds. (Inherited from Control.)
Public eventDragLeaveOccurs when an object is dragged out of the control's bounds. (Inherited from Control.)
Public eventDragOverOccurs when an object is dragged over the control's bounds. (Inherited from Control.)
Public eventEnabledChangedOccurs when the Enabled property value has changed. (Inherited from Control.)
Public eventEnterInfrastructure. Occurs when focus enters the ProgressBar control.
Public eventFontChangedInfrastructure. Occurs when the value of the Font property changes.
Public eventForeColorChangedOccurs when the ForeColor property value changes. (Inherited from Control.)
Public eventGiveFeedbackOccurs during a drag operation. (Inherited from Control.)
Public eventGotFocusOccurs when the control receives focus. (Inherited from Control.)
Public eventHandleCreatedOccurs when a handle is created for the control. (Inherited from Control.)
Public eventHandleDestroyedOccurs when the control's handle is in the process of being destroyed. (Inherited from Control.)
Public eventHelpRequestedOccurs when the user requests help for a control. (Inherited from Control.)
Public eventImeModeChangedInfrastructure. Occurs when the value of the ImeMode property changes.
Public eventInvalidatedOccurs when a control's display requires redrawing. (Inherited from Control.)
Public eventKeyDownInfrastructure. Occurs when the user presses a key while the control has focus.
Public eventKeyPressInfrastructure. Occurs when the user presses a key while the control has focus.
Public eventKeyUpInfrastructure. Occurs when the user releases a key while the control has focus.
Public eventLayoutOccurs when a control should reposition its child controls. (Inherited from Control.)
Public eventLeaveInfrastructure. Occurs when focus leaves the ProgressBar control.
Public eventLocationChangedOccurs when the Location property value has changed. (Inherited from Control.)
Public eventLostFocusOccurs when the control loses focus. (Inherited from Control.)
Public eventMarginChangedOccurs when the control's margin changes. (Inherited from Control.)
Public eventMouseCaptureChangedOccurs when the control loses mouse capture. (Inherited from Control.)
Public eventMouseClickOccurs when the control is clicked by the mouse. (Inherited from Control.)
Public eventMouseDoubleClickInfrastructure. Occurs when the user double-clicks the control.
Public eventMouseDownOccurs when the mouse pointer is over the control and a mouse button is pressed. (Inherited from Control.)
Public eventMouseEnterOccurs when the mouse pointer enters the control. (Inherited from Control.)
Public eventMouseHoverOccurs when the mouse pointer rests on the control. (Inherited from Control.)
Public eventMouseLeaveOccurs when the mouse pointer leaves the control. (Inherited from Control.)
Public eventMouseMoveOccurs when the mouse pointer is moved over the control. (Inherited from Control.)
Public eventMouseUpOccurs when the mouse pointer is over the control and a mouse button is released. (Inherited from Control.)
Public eventMouseWheelOccurs when the mouse wheel moves while the control has focus. (Inherited from Control.)
Public eventMoveOccurs when the control is moved. (Inherited from Control.)
Public eventPaddingChangedOccurs when the value of the Padding property changes.
Public eventPaintInfrastructure. Occurs when the ProgressBar is drawn.
Public eventParentChangedOccurs when the Parent property value changes. (Inherited from Control.)
Public eventPreviewKeyDownOccurs before the KeyDown event when a key is pressed while focus is on this control. (Inherited from Control.)
Public eventQueryAccessibilityHelpOccurs when AccessibleObject is providing help to accessibility applications. (Inherited from Control.)
Public eventQueryContinueDragOccurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. (Inherited from Control.)
Public eventRegionChangedOccurs when the value of the Region property changes. (Inherited from Control.)
Public eventResizeOccurs when the control is resized. (Inherited from Control.)
Public eventRightToLeftChangedOccurs when the RightToLeft property value changes. (Inherited from Control.)
Public eventRightToLeftLayoutChangedOccurs when the RightToLeftLayout property changes.
Public eventSizeChangedOccurs when the Size property value changes. (Inherited from Control.)
Public eventStyleChangedOccurs when the control style changes. (Inherited from Control.)
Public eventSystemColorsChangedOccurs when the system colors change. (Inherited from Control.)
Public eventTabIndexChangedOccurs when the TabIndex property value changes. (Inherited from Control.)
Public eventTabStopChangedInfrastructure. Occurs when the TabStop property changes.
Public eventTextChangedInfrastructure. Occurs when the Text property changes.
Public eventValidatedOccurs when the control is finished validating. (Inherited from Control.)
Public eventValidatingOccurs when the control is validating. (Inherited from Control.)
Public eventVisibleChangedOccurs when the Visible property value changes. (Inherited from Control.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIDropTarget.OnDragDropInfrastructure. Raises the DragDrop event. (Inherited from Control.)
Explicit interface implemetationPrivate methodIDropTarget.OnDragEnterInfrastructure. Raises the DragEnter event. (Inherited from Control.)
Explicit interface implemetationPrivate methodIDropTarget.OnDragLeaveInfrastructure. Raises the DragLeave event. (Inherited from Control.)
Explicit interface implemetationPrivate methodIDropTarget.OnDragOverInfrastructure. Raises the DragOver event. (Inherited from Control.)
Top

A ProgressBar control visually indicates the progress of a lengthy operation in one of three styles:

  • Segmented blocks that increase in steps from left to right.

  • A continuous bar that fills in from left to right.

  • A block that scrolls across a ProgressBar in a marquee fashion.

The Style property determines the style of ProgressBar that is displayed. Note that the ProgressBar control can only be oriented horizontally. For an example of how to create a vertically oriented ProgressBar, see the ProgressBarRenderer class. The ProgressBar 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. By using the ProgressBar in your application, you alert 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 0, and the Maximum property is typically set to a value indicating the completion of a task. For example, to properly display the progress 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. The value displayed by the ProgressBar only approximates the current value of the Value property. Based on the size of the ProgressBar, the Value property determines when to display the next block or increase the size of the bar.

There are a number of ways to modify the value displayed by the ProgressBar 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 with which to increment the Value property.

NoteNote

ForeColor and BackColor changes for the ProgressBar will not be honored when visual styles are enabled on Windows XP Home Edition, Windows XP Professional, Windows Server 2003 and above.

The following code example uses a ProgressBar control to display the progress of a file copy operation. The example uses the Minimum and Maximum properties to specify a range for the ProgressBar that is equivalent to the number of files to copy. The code also uses the Step property with the PerformStep method to increment the value of the ProgressBar as a file is copied. This example requires that you have a ProgressBar control created called pBar1 that is created within a Form and that there is a method created called CopyFile (that returns a Boolean value indicating the file copy operation was completed successfully) that performs the file copy operation. The code also requires that an array of strings containing the files to copy is created and passed to the CopyWithProgress method defined in the example and that the method is called from another method or event in the Form.

		private void CopyWithProgress(string[] filenames)
		{
			// Display the ProgressBar control.
			pBar1.Visible = true;
			// Set Minimum to 1 to represent the first file being copied.
			pBar1.Minimum = 1;
			// Set Maximum to the total number of files to copy.
			pBar1.Maximum = filenames.Length;
			// Set the initial value of the ProgressBar.
			pBar1.Value = 1;
			// Set the Step property to a value of 1 to represent each file being copied.
			pBar1.Step = 1;
			
			// Loop through all files to copy. 
			for (int x = 1; x <= filenames.Length; x++)
			{
				// Copy the file and increment the ProgressBar if successful. 
				if(CopyFile(filenames[x-1]) == true)
				{
					// Perform the increment on the ProgressBar.
					pBar1.PerformStep();
				}
			}
		}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.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