[Overview][Constants][Types][Classes][Procedures and functions][Index] | Reference for unit 'ComCtrls' (#lcl)

# TCustomProgressBar

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Implements the base class for progress bar controls.

## Declaration

Source position: comctrls.pp line 1815

`type TCustomProgressBar = class(TWinControl)`
`protected`
`class procedure WSRegisterClass; override;` |  | Registers this component class with the current WidgetSet.
`procedure ApplyChanges;` |  | ApplyChanges - apply any changes that have occurred.
`procedure InitializeWnd; override;` |  | Applies property values to the widgetset class when the Handle is (re-)created.
`procedure Loaded; override;` |  | Applies property values to the widgetset class when component streaming is completed.
`class function GetControlClassDefaultSize; override;` |  | Gets the default size for new instances of the class.
`public`
`constructor Create(); override;` |  | Constructor for the class instance.
`procedure StepIt;` |  | Increments the Position for the progress bar by the value in Step.
`procedure StepBy();` |  | Applies an arbitrary increment value to the Position for the progress bar.
`property Max: Integer; [rw]` |  | Specifies the maximum value for the Position in the progress bar.
`property Min: Integer; [rw]` |  | Specifies the minimum value for the Position in the progress bar.
`property Orientation: TProgressBarOrientation; [rw]` |  | Specifies the orientation and direction for the progress bar.
`property Position: Integer; [rw]` |  | The current position for the progress bar.
`property Smooth: Boolean; [rw]` |  | Indicates if the progress bar indicator is drawn as a smooth solid bar, as opposed to individual bar segments.
`property Step: Integer; [rw]` |  | Increment applied to the value in Position in the StepIt method.
`property Style: TProgressBarStyle; [rw]` |  | Drawing style for the progress bar.
`property BarShowText: Boolean; [rw]` |  | Indicates if status or progress text is draw over the progress bar.
`end;`

## Inheritance

`TCustomProgressBar` |  | Implements the base class for progress bar controls.
`TWinControl` |  | Implements a windowed control which can contain other child controls.
`TControl` |  | The base class for visible controls.
`TLCLComponent` |  | The base class for LCL components which have an associated widget.
`TComponent`
?
`TObject`

## Description

TCustomProgressBar is a TWinControl descendant which implements a progress bar control.

A progress bar is used to indicate the progress for a lengthy operation. It contains an indicator bar that is updated with the completion percentage for the task. A progress bar can use either horizontal or vertical orientations. The visual appearance of the control can be configured using drawing styles, themes, and other property settings.

TCustomProgressBar is the ancestor for TProgressBar.

## See also

TProgressBar |  | TProgress Bar - a bar that depicts what proportion of a process has been completed.
TWinControl |  | Implements a windowed control which can contain other child controls.