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

---

# Description

This object can indicate two states - it might simulate light indicator. NonActive and ActiveColor can be set as well as BlinkPeriod and BlinkDutyCycle.

![image](media://f1a399ef-ee5e-4d7c-b6af-dd0e473a90b4)

# Properties

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Behavior |
| BlinkDutyCycle | Double | 0.0 to 100.0 | 50.0 | It is the time spent in an ActiveColor / ActivePicture as a percentage of the total BlinkPeriod time. |
| BlinkPeriod | Time |  | :0 | It is a total time between two   
ActiveColors or ActivePictures. |
| Events | Boolean | True<br>False | False | If True event OnTouch is enabled. If False event OnTouch is disabled. |
| Value | Boolean | True  
False | False | True means ActiveColor / ActivePicture is displayed. |
| Appearance |
| ActiveColor | Long | Any | _COLOR_RED | Color of active state |
| ActivePicture | AddressOf _Picture | Any | Nothing | Picture placed to the object in active state. |
| ConstrainProportion | Boolean | True   
False | True | If True the object preserves the original proportions of pictures placed to the object. |
| NonActiveColor | Long | Any | _COLOR_GREY | Color of non-active state |
| NonActivePicture | AddressOf _Picture | Any | Nothing | Picture placed to the object in non-active state. |

# Functions

## SetActiveColor

This function sets ActiveColor to newactivecolor. Function returns True.

#### Syntax

```visualbasic
Function SetActiveColor(newactivecolor As Long) As Boolean
```

## GetActiveColor

This function returns current ActiveColor.

#### Syntax

```visualbasic
Function GetActiveColor() As Long
```

## SetActivePicture

This function sets ActivePicture to newactivepicture. Function returns True.

#### Syntax

```visualbasic
Function SetActivePicture(newactivepicture As AddressOf _Picture) As Boolean
```

## GetActivePicture

This function returns address of current ActivePicture.

#### Syntax

```visualbasic
Function GetActivePicture() As AddressOf _Picture
```

## SetBlinkDutyCycle

This function sets BlinkDutyCycle to BlinkDutyCycle. Function returns True if newblinkdutycycle >= 0 and newblinkdutycycle <= 100, otherwise it returns False.

#### Syntax

```visualbasic
Function SetBlinkDutyCycle(newblinkdutycycle As Double) As Boolean
```

## GetBlinkDutyCycle

This function returns current BlinkDutyCycle.

#### Syntax

```visualbasic
Function GetBlinkDutyCycle() As Double
```

## SetBlinkPeriod

This function sets BlinkPeriod to newblinkperiod. Function returns True.

#### Syntax

```visualbasic
Function SetBlinkPeriod(newblinkperiod As Time) As Boolean
```

## GetBlinkPeriod

This function returns current BlinkPeriod.

#### Syntax

```visualbasic
Function GetBlinkPeriod() As Time
```

## SetConstrainProportion

This function enables (newconstrainproportion = True) or disables (newconstrainproportion = False) ConstrainProportion. Function returns True.

#### Syntax

```visualbasic
Function SetConstrainProportion(newconstrainproportion As Boolean) As Boolean
```

## GetConstrainProportion

This function returns True (ConstrainProportion enabled) or False (ConstrainProportion disabled).

#### Syntax

```visualbasic
Function GetConstrainProportion() As Boolean
```

## 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
```

## SetNonActiveColor

This function sets NonActiveColor to newnonactivecolor. Function returns True.

#### Syntax

```visualbasic
Function SetNonActiveColor(newnonactivecolor As Long) As Boolean
```

## GetNonActiveColor

This function returns current NonActiveColor.

#### Syntax

```visualbasic
Function GetNonActiveColor() As Long
```

## SetNonActivePicture

This function sets NonActivePicture to newnonactivepicture. Function returns True.

#### Syntax

```visualbasic
Function SetNonActivePicture(newnonactivepicture As AddressOf _Picture) As Boolean
```

## GetNonActivePicture

This function returns address of current NonActivePicture.

#### Syntax

```visualbasic
Function GetNonActivePicture() As AddressOf _Picture
```

## SetValue

This function sets Value to newvalue. Function returns True.

#### Syntax

```visualbasic
Function SetValue(newvalue As Boolean) As Boolean
```

## GetValue

This function returns current Value.

#### Syntax

```visualbasic
Function GetValue() As Boolean
```

## 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()
```