TGraphic.Progress procedure

Member of TGraphicprotectedIn unit Graphics

Monitor the Progress of the drawing.

Declaration

pascal

procedure Progress(Sender: TObject; Stage: TProgressStage; 
 PercentDone: Byte; RedrawNow: Boolean; 
 const R: TRect; const Msg: string; 
 var DoContinue: Boolean); virtual
procedure Progress(Sender: TObject; Stage: TProgressStage; 
 PercentDone: Byte; RedrawNow: Boolean; 
 const R: TRect; const Msg: string); virtual

Arguments

`Sender`	Object for the notification.
`Stage`	Indicates whether an operation is starting, running, or ending.
`PercentDone`	Completion percentage for the progress step.
`RedrawNow`	Indicates if the application should redraw the image.
`R`	Rectangle with the coordinates affected by the progress step.
`Msg`	Message for the progress notification.
`DoContinue`	Indicates if the caller should continue the current operation.

Description

Progress is an overloaded procedure used to perform actions needed for progress notifications for the class instance. Arguments passed to the method identify the class instance, the progress step, the completion amount, and display options for the notification.

Progress signals the OnProgress event handler (when assigned) using the parameter values as arguments. Applications must implement an OnProgress event handler to respond to the progress notification.

Progress is a virtual method, and can be overridden in a descendent class to preform any actions needed when reading or writing image data for a specific image format.

Please note the data type used for the PercentDone argument. It is declared as a Byte type, and will accept a value that exceeds 100.

TGraphic.Progress procedure

Declaration

Arguments

Description

See also