TTaskDialogProgressBar.State property

Declaration

property State: TProgressBarState read FState write SetState default pbsNormal;

Description

State is a TProgressBarState property which indicates the drawing style used to render the progress bar. The default value for the property is pbsNormal. Values in the property affect the drawing style used for the completion indicator on the progress bar as follows:

pbsNormal

Causes the default drawing style for the platform to be applied to the completion indicator.

pbsError

Causes the completion bar to be drawn with a red fill color to indicate an error condition.

pbsPaused

Causes the completion bar to be drawn with an amber fill color to indicate that the progress bar has been paused.

Changing the value for the property causes the TDM_SET_PROGRESS_BAR_STATE message to be sent to the task dialog instance. This allows the task dialog and its widget to be updated with the mew state for the progress bar. This action is not performed if tfShowProgressBar has not been included in the flags for the task dialog or its Handle has not been assigned.

Added in LCL version 4.0.