System.Windows.Forms
1.0.5000.0
2.0.0.0
System.Windows.Forms.Control
System.Runtime.InteropServices.ComVisible(true)
System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)
System.ComponentModel.DefaultBindingProperty("Value")
System.ComponentModel.DefaultProperty("Value")
A 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 in a marquee fashion.
The property determines the style of that is displayed. Note that the control can only be oriented horizontally. For an example of how to create a vertically oriented , see the class. The 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 in your application, you alert the user that the application is performing a lengthy task and that the application is still responding.
The and properties define the range of values to represent the progress of a task. The property is typically set to a value of 0, and the 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 property could be set to the total number of files to be copied.
The property represents the progress that the application has made toward completing the operation. The value displayed by the only approximates the current value of the property. Based on the size of the , the 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 other than changing the property directly. You can use the property to specify a specific value to increment the property by, and then call the method to increment the value. To vary the increment value, you can use the method and specify a value with which to increment the property.
and changes for the will not be honored when visual styles are enabled on winxpfamily and above.
Represents a Windows progress bar control.
Constructor
By default, the property is set to 0, the property is set to 100, and the property is set to 10.
Initializes a new instance of the class.
1.0.5000.0
2.0.0.0
Property
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Boolean
To be added.
To be added.
Overrides .
1.0.5000.0
2.0.0.0
Property
System.Runtime.InteropServices.DispId(-501)
System.Drawing.Color
To be added.
To be added.
To be added.
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(State=System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(Browsable=False)
System.EventHandler
To be added.
To be added.
1.0.5000.0
Property
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Drawing.Image
To be added.
Setting the has no effect on the appearance of the .
Gets or sets the background image for the control.
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
Setting the has no effect on the appearance of the .
Occurs when the value of the property changes.
1.0.5000.0
2.0.0.0
Property
2.0.0.0
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Windows.Forms.ImageLayout
To be added.
Setting the property has no effect on the appearance of the control.
Gets or sets the layout of the background image of the progress bar.
Event
2.0.0.0
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
Setting the property has no effect on the appearance of the control.
Occurs when the value of the property changes.
Property
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Boolean
To be added.
To be added.
Gets or sets a value indicating whether the control, when it receives focus, causes validation to be performed on any controls that require validation.
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
To be added.
Occurs when the value of the property changes.
1.0.5000.0
2.0.0.0
Method
System.Void
To be added.
To be added.
1.0.5000.0
2.0.0.0
Property
System.Windows.Forms.CreateParams
To be added.
To be added.
Overrides .
1.0.5000.0
2.0.0.0
Property
System.Windows.Forms.ImeMode
To be added.
To be added.
To be added.
1.0.5000.0
2.0.0.0
Property
System.Drawing.Size
To be added.
To be added.
Gets the default size of the control.
1.0.5000.0
2.0.0.0
Property
2.0.0.0
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.Boolean
To be added.
Setting the property has no effect on the control.
Gets or sets a value indicating whether the control should redraw its surface using a secondary buffer.
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
The control does not raise the event.
Occurs when the user double-clicks the control.
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
This event is not relevant for this class.
The control cannot receive keyboard focus, so it never raises the event.
Occurs when focus enters the control.
1.0.5000.0
2.0.0.0
Property
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Drawing.Font
To be added.
This property is not relevant for this class.
Gets or sets the font of text in the .
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
To be added.
Occurs when the value of the property changes.
1.0.5000.0
2.0.0.0
Property
System.Runtime.InteropServices.DispId(-513)
System.Drawing.Color
To be added.
To be added.
To be added.
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(State=System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(Browsable=False)
System.EventHandler
To be added.
To be added.
1.0.5000.0
Property
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Windows.Forms.ImeMode
To be added.
This property is not relevant for this class.
Gets or sets the input method editor (IME) for the
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
To be added.
Occurs when the value of the property changes.
1.0.5000.0
2.0.0.0
Method
System.Void
The method enables you to increment the value of the progress bar by a specific amount. This method of incrementing the progress bar is similar to using the property with the method. The property specifies the current position of the . If, after calling the method, the property is greater than the value of the property, the property remains at the value of the property. If, after calling the method with a negative value specified in the parameter, the property is less than the value of the property, the property remains at the value of the property.
Because a object whose style is set to displays a continuously scrolling bar instead of its , calling is unnecessary and will raise an .
Advances the current position of the progress bar by the specified amount.
The amount by which to increment the progress bar's current position.
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Windows.Forms.KeyEventHandler
The control cannot receive keyboard focus, so it never raises the event.
Occurs when the user presses a key while the control has focus.
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Windows.Forms.KeyPressEventHandler
The control cannot receive keyboard focus, so it never raises the event.
Occurs when the user presses a key while the control has focus.
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Windows.Forms.KeyEventHandler
The control cannot receive keyboard focus, so it never raises the event.
Occurs when the user releases a key while the control has focus.
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
The control cannot receive keyboard focus, so it never raises the event.
Occurs when focus leaves the control.
1.0.5000.0
2.0.0.0
Property
System.ComponentModel.DefaultValue(100)
System.Int32
To be added.
A marquee-style progress indicator does not display progress; instead it indicates that an operation is occurring by moving the progress block across the progress bar.
Since the marquee animation speed is a time period, setting the value to a higher number results in a slower speed and a lower number results in a faster speed.
Gets or sets the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
2.0.0.0
Property
System.ComponentModel.DefaultValue(100)
System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)
System.Int32
To be added.
This property specifies the upper limit of the property. When the value of the property is changed, the control is redrawn to reflect the new range of the control. When the value of the property is equal to the value of the property, the progress bar is completely filled.
You can use this property to specify a value to which the property must be set (by setting the property or using the or methods) to indicate that an operation is complete. For example, you can set the value of the property to the total number of files in a file copy operation. Each time a file is copied, the property can be increased by 1 until the total number of files is copied. At that point, the progress bar would be completely filled.
Gets or sets the maximum value of the range of the control.
1.0.5000.0
2.0.0.0
Property
System.ComponentModel.DefaultValue(0)
System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.Repaint)
System.Int32
To be added.
This property specifies the lower limit of the property. When the value of the property is changed, the control is redrawn to reflect the new range of the control. When the value of the property is equal to the value of the property, the progress bar is empty. To change the value of the progress bar, use the property with the method, use the method, or set the value of the property directly.
Gets or sets the minimum value of the range of the control.
1.0.5000.0
2.0.0.0
Event
2.0.0.0
System.ComponentModel.Browsable(false)
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.Windows.Forms.MouseEventHandler
The control does not raise the event.
Occurs when the user double-clicks the control.
Method
2.0.0.0
System.Void
Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.
The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Raises the event.
A that contains the event data.
Method
2.0.0.0
System.Void
Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.
The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
changes will not be honored when visual styles are enabled and the operating system supports visual styles.
Raises the event.
An that contains the event data.
Method
System.Void
To be added.
Overrides
A that contains the event data.
1.0.5000.0
2.0.0.0
Method
2.0.0.0
System.Void
Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.
The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Raises the event.
An that contains the event data.
Method
2.0.0.0
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)
System.Void
Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.
The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Raises the event.
A that contains the event data.
Property
2.0.0.0
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
System.Windows.Forms.Padding
To be added.
Setting the property will have no effect on the appearance of the .
Gets or sets the space between the edges of a control and its contents.
Event
2.0.0.0
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
For more information about handling events, see Consuming Events.
Occurs when the value of the property changes.
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Windows.Forms.PaintEventHandler
To be added.
Occurs when the is drawn.
1.0.5000.0
2.0.0.0
Method
System.Void
The method increments the value of the progress bar by the amount specified by the property. You can use the property to specify the amount that each completed task in an operation changes the value of the progress bar. For example, if you are copying a group of files, you might want to set the value of the property to 1 and the value of the property to the total number of files to copy. When each file is copied, you can call the method to increment the progress bar by the value of the property. If you want to have more flexible control of the value of the progress bar, you can use the method or set the value of the property directly.
The property specifies the current position of the . If, after calling the method, the property is greater than the value of the property, the property remains at the value of the property. If, after calling the method with a negative value specified in , the property is less than the value of the property, the property remains at the value of the property.
Because a object whose style is set to displays a continuously scrolling bar instead of its , calling is unnecessary and will raise an .
Advances the current position of the progress bar by the amount of the property.
1.0.5000.0
2.0.0.0
Method
2.0.0.0
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.Void
Calling this method will reset the to unless the method is overridden in a derived class. The method is useful when you create a designer for the control, or you are creating your own control that incorporates the .
Resets the to its default value.
Property
System.ComponentModel.Localizable(true)
System.ComponentModel.AmbientValue(System.Windows.Forms.RightToLeft.Inherit)
System.Windows.Forms.RightToLeft
To be added.
To be added.
To be added.
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(State=System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(Browsable=False)
System.EventHandler
To be added.
To be added.
1.0.5000.0
Property
2.0.0.0
System.ComponentModel.DefaultValue(false)
System.ComponentModel.Localizable(true)
System.Boolean
To be added.
The property is useful when creating an application for use with languages that read from right to left.
Gets or sets a value indicating whether the and any text it contains is displayed from right to left.
Event
2.0.0.0
System.EventHandler
For more information about handling events, see Consuming Events.
Occurs when the property changes.
Property
System.ComponentModel.DefaultValue(10)
System.Int32
To be added.
You can use the property to specify the amount that each completed task in an operation changes the value of the progress bar. For example, if you are copying a group of files, you might want to set the value of the property to 1 and the value of the property to the total number of files to copy. When each file is copied, you can call the method to increment the progress bar by the value of the property. If you want to have more flexible control of the value of the progress bar, you can use the method or set the value of the property directly.
Gets or sets the amount by which a call to the method increases the current position of the progress bar.
1.0.5000.0
2.0.0.0
Property
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Always)
System.ComponentModel.DefaultValue(System.Windows.Forms.ProgressBarStyle.Blocks)
System.ComponentModel.Browsable(true)
System.Windows.Forms.ProgressBarStyle
To be added.
You can use the marquee style when you need to indicate progress is being made, without indicating the quantity of progress. The style is honored only when visual styles are enabled. The style is honored when visual styles are not enabled.
Gets or sets the manner in which progress should be indicated on the progress bar.
2.0.0.0
Property
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.Boolean
To be added.
To be added.
Overrides .
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
To be added.
Occurs when the property changes.
1.0.5000.0
2.0.0.0
Property
System.ComponentModel.Bindable(false)
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.String
To be added.
To be added.
Overrides .
1.0.5000.0
2.0.0.0
Event
System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)
System.ComponentModel.Browsable(false)
System.EventHandler
To be added.
Occurs when the property changes.
1.0.5000.0
2.0.0.0
Method
System.String
The return string includes the type and the values for the , , and properties.
Returns a string that represents the control.
A string that represents the current .
1.0.5000.0
2.0.0.0
Property
System.ComponentModel.DefaultValue(0)
System.ComponentModel.Bindable(true)
System.Int32
To be added.
The minimum and maximum values of the property are specified by the and properties. This property enables you to increment or decrement the value of the progress bar directly. To perform consistent increases in the value of the control you can use the property with the method. To increase the progress bar value by varying amounts, use the method.
Gets or sets the current position of the progress bar.
1.0.5000.0
2.0.0.0