ISModalProcessDisplay.Caption

Description

The caption for the progress indicator.

Syntax

object.Caption

Part	Attribute	Type	Description
`object`	Required	ISModalProcessDisplay	The `object` always implements the ISModalProcessDisplay interface

Return Value

string

Example

Display the progress indicator dialog and simulate the long-time data processing with its progress indicator.

Dim aIterationsCount
Dim aModalProcessDisplay
Dim i

aIterationsCount = 100

Set aModalProcessDisplay = Profile.CreateModalProcessDisplay(False)
aModalProcessDisplay.Caption = "Data Processing Progress"
aModalProcessDisplay.ProcessName = "Data Processing"
aModalProcessDisplay.MaxValue = aIterationsCount
aModalProcessDisplay.AllowCancel = True
aModalProcessDisplay.CancelKind = 1 'sckStop 


for i = 1 to aIterationsCount
  Sleep(100) 'Imitation of the long operation
  aModalProcessDisplay.StepIt
next

Note:

Version information

Added in v7.8.0