---
title: "ProgressBar (Basic)"
canonical: "https://docs.cuesystem.com/space/CVCGC/407044128/ProgressBar%20(Basic)"
format: markdown
---
# Description

This object is used to indicate that a time-consuming operation is in progress when it is known how long the task takes. Standard function ShowObject is used for start. After that ProgressBar runs for time defined in ProgressTime property then it generates event OnProgressEnd. Object is not hidden automatically.

![image](media://a0061de9-6333-4d43-b015-b38c1fb55535)

# Properties

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Behavior |
| FrameRate | Double | > 0 and <= 25 | 25 | Number of frames that are displayed per second. |
| ProgressTime | Time | Any positive | :10.0 | Time of progress. It is time between ShowObject and OnProgressEnd Event. |
| Appearance |
| ObjectColor | Long | 1 = Blue  
2 = Green  
3 = Yellow  
4 = Orange  
5 = Purple | 1 | Color of object |

# Functions

## SetFrameRate

This function sets FrameRate to newframerate value. It returns True, if newframerate is in range 1 to 25, otherwise it returns False.

#### Syntax

```visualbasic
Function SetFrameRate(newframerate As Double) As Boolean
```

## GetFrameRate

This function returns current FrameRate.

#### Syntax

```visualbasic
Function GetFrameRate() As Double
```

## SetObjectColor

This function sets color of ProgressBar to newobjectcolor. Possible values are

- 1 = Blue
- 2 = Green
- 3 = Yellow
- 4 = Orange
- 5 = Purple

The function returns True on success or False if an error occurs (parameter is out of limits).

#### Syntax

```visualbasic
Function SetObjectColor(newobjectcolor As Long) As Boolean
```

## GetObjectColor

This function returns current color of ProgressBar. For possible values see command SetObjectColor.

#### Syntax

```visualbasic
Function GetObjectColor() As Long
```

## SetProgressTime

This function sets ProgressTime to newprogresstime value. It returns True, if newprogresstime is > :0.0, otherwise it returns False.

#### Syntax

```visualbasic
Function SetProgressTime(newprogresstime As Time) As Boolean
```

## GetProgressTime

This function returns current ProgressTime.

#### Syntax

```visualbasic
Function GetProgressTime() As Time
```

## GetRemainingTime

This function returns time remaining to progress end when event OnProgressEnd is generated.

#### Syntax

```visualbasic
Function GetRemainingTime() As Time
```

# Events

## OnProgressEnd

This event is generated when ProgressTime expired.

#### Syntax

```visualbasic
Event OnProgressEnd As Process()
```