ISModalProcessDisplay.TotalCaption

Description

The caption for the total progress indicator.

Syntax

object.TotalCaption

Part Attribute Type Description
object Required
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 indication.

Dim aIterationsCount
Dim aTotalCount
Dim aModalProcessDisplay
Dim i, j

aIterationsCount = 20
aTotalCount = 12

Set aModalProcessDisplay = Profile.CreateModalProcessDisplay(True)
aModalProcessDisplay.Caption = "Data Processing Progress"
aModalProcessDisplay.TotalCaption = "Operations Progress"
aModalProcessDisplay.ProcessName = "Data Processing"

aModalProcessDisplay.SetTotalMaxValue(aTotalCount)
aModalProcessDisplay.MaxValue = aIterationsCount

aModalProcessDisplay.AllowCancel = True
aModalProcessDisplay.CancelKind = 1 'sckStop 

for j = 1 to aTotalCount

  aModalProcessDisplay.Position = 0 
  for i = 1 to aIterationsCount
    Sleep(50) 'Imitation of the long operation
    aModalProcessDisplay.StepIt
  next 'i
  
  aModalProcessDisplay.SetTotalPosition(j)
next 'j       
Note:

Version information

Added in v7.8.0