maximum() [1/2]

virtual int32 xtd::forms::progress_bar::maximum ( ) const

virtualnoexcept

Gets the maximum value of the range of the control.

Returns

The maximum value of the range. The default is 100.

Remarks

This property specifies the upper limit of the value property. When the value of the maximum property is changed, the progress_bar control is redrawn to reflect the new range of the control. When the value of the value property is equal to the value of the maximum property, the progress bar is completely filled.

You can use this property to specify a value to which the value property must be set (by setting the value property or using the increment or perform_step methods) to indicate that an operation is complete. For example, you can set the value of the maximum property to the total number of files in a file copy operation. Each time a file is copied, the value property can be increased by 1 until the total number of files is copied. At that point, the progress bar would be completely filled.