Skip to main content

TcxCustomProgressBarProperties.OverloadValue Property

Specifies the starting position of the overload bar.

Declaration

property OverloadValue: Double read; write;

Property Value

Type
Double

Remarks

The progress bar control displays the overload bar if its ShowOverload property is set to True. The bar fills the range specified by the OverloadValue and Position properties. Note that the OverloadValue property cannot be set to a value less than the Min property or greater than the Position property.

The table below shows how changing the OverloadValue property affects the appearance of the control. Assume that the Min, Max and Position properties are set to 0, 100 and 75 respectively.

Value Sample
25
50

The overload bar is used when you need to illustrate two values using the same progress bar control. For instance, if the application compresses files you can illustrate the number of bytes currently processed and the current size of the compressed file. The size of the compressed file will correspond to the OverloadValue property value in this case. The total number of bytes processed will correspond to the Position property.

Note

The overload bar cannot be displayed when the control is painted using the native style. Use the Style.LookAndFeel.NativeStyle property to control whether native painting is used.

The default value of the OverloadValue property is 80.

See Also