---
title: "MarqueeProgressIndicator (Generic)"
canonical: "https://docs.cuesystem.com/space/CVCGC/418938915/MarqueeProgressIndicator%20(Generic)"
format: markdown
---
> Macro (toc)

---

# Description

This object is used to indicate that a time-consuming operation is in progress but it is unknown how long it may take. The indicator spins while a task is progressing and disappears when the task completes. By default, an indicator is grey and it is possible to set another color. The object uses standard functions ShowObject for start and HideObject for stop.

![image](media://201561c2-c48d-4d3c-8704-7e256afd2a46)

# Properties

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Behavior |
| Events | Boolean | True<br>False | False | If True event OnTouch is enabled. If False event OnTouch is disabled. |
| FrameRate | Double |  | 8 | Number of frames that are displayed per second. |
| Appearance |
| Color | Long | Any | _COLOR_BLACK | Color of object |

# Functions

## SetColor

This function sets indicator Color to newcolor. Function returns True.

#### Syntax

```visualbasic
Function SetColor(newcolor As Long) As Boolean
```

## GetColor

This function returns current indicator Color.

#### Syntax

```visualbasic
Function GetColor() As Long
```

## SetEvents

This function enables (newevents = True) or disables (newevents = False) event OnTouch. Function returns True.

#### Syntax

```visualbasic
Function SetEvents(newevents As Boolean) As Boolean
```

## GetEvents

This function returns True (event OnTouch enabled) or False (event OnTouch disabled).

#### Syntax

```visualbasic
Function GetEvents() As Boolean
```

## SetFrameRate

This function sets FrameRate to newframerate. Function returns True if newframerate > 0 and newframerate <= 100, 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
```

## BringToFrontZOrder

This function temporarily brings the object to the very top position.

#### Syntax

```visualbasic
Function BringToFrontZOrder()
```

## RestoreZOrder

This function restores object’s z-order to value defined in design mode.

#### Syntax

```visualbasic
Function RestoreZOrder()
```

# Events

## OnTouch 

This event is generated when the object is touched and property Events is set to True.Syntax

```visualbasic
Event OnTouch As Process()
```