---
title: "Display (_Display class)"
canonical: "https://docs.cuesystem.com/space/CVCHELP/518881360/Display%20(_Display%20class)"
format: markdown
---
> Macro (toc)

---

# AdaptiveBrightnessEnable

This function enables automatic control of brightness. Function overrides setting in the on-screen menu or web. The setting is global. If the application uses this function, the setting is persistent. 

#### Syntax 

```visualbasic
Function AdaptiveBrightnessEnable()
```

# AdaptiveBrightnessDisable

This function disables automatic control of brightness. Function overrides setting in on-screen menu or web. The setting is global. If the application uses this function, the setting is persistent. 

#### Syntax 

```visualbasic
Function AdaptiveBrightnessDisable()
```

# GetBackLightSaverTimeout

This function returns the backlight saver timeout. 

#### Syntax 

```visualbasic
Function GetBackLightSaverTimeout() As Time
```

#### Return value 

timeout 

<u>[Time](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Time)</u> It is a backlight saver timeout. If the returned timeout is :0 then the backlight saver is disabled.  

# GetBrightness

This function returns actual brightness in percent. 

#### Syntax 

```visualbasic
Function GetBrightness() As Byte
```

#### Return value 

<u>[Byte](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Byte)</u> It is the brightness. 

# GetHeight

This function returns a display height in pixels. 

#### Syntax 

```visualbasic
Function GetHeight() As Long
```

#### Return value 

<u>[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> It is the display height in pixels. 

# GetOrientation

This function returns a display height in pixels.  This function is supported only in units which support landscape and portrait mode of display orientation.

#### Syntax 

```visualbasic
Function GetOrientation() As Long
```

#### Return value 

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> It is the orientation type. 

#### Orientation types

|  |  |  |
| --- | --- | --- |
| Name | Value | Notes |
| Landscape | 0 | supported by touchCUE-5-knob, touchCUE-10-W and signCUE-two. |
| Portrait | 1 | supported by touchCUE-5-knob, touchCUE-10-W and signCUE-two. |
| Landscape flipped | 2 | supported by signCUE-two. |
| Portrait flipped | 3 | supported by signCUE-two. |

# GetOSDTimeout

The function returns the value of the on-screen menu timeout actually set. 

#### Syntax 

```visualbasic
Public Function GetOSDTimeout() As Time
```

#### Return value 

The function returns the value of the timeout actually set. 

# GetPrimaryDisplay

This function returns an address of a primary display. 

Note: GetPrimaryDisplay function is not a member of a _Display class. 

#### Syntax 

```visualbasic
Function GetPrimaryDisplay() As AddressOf _Display
```

#### Return value 

<u>[AddressOf](/wiki/spaces/CVCHELP/pages/522682857/Other+operators#AddressOf)</u> <u>[_Display](/wiki/spaces/CVCHELP/pages/498533122/Terminology#EmbeddedClasses)</u> It is the address of the primary display. 

# GetWidth

This function returns a display width in pixels. 

#### Syntax 

```visualbasic
Function GetWidth() As Long
```

#### Return value* *

<u>[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> It is the display width in pixels. 

# HideOSD

Function hides the on-screen menu immediately. 

#### Syntax 

```visualbasic
Public Function HideOSD() As Boolean
```

#### Return value 

True if the function succeeds, false otherwise. 

# HidePowerOffPage

The function shows the power off page only. This is useful if the programmer will allow the user only to switch off the panel. 

```visualbasic
Public Function HidePowerOffPage () As Boolean
```

#### Return value 

True if the function succeeds, false otherwise. 

# IsAdaptiveBrightnessEnabled

This function returns true if adaptive brightness is enabled. 

#### Syntax 

```visualbasic
Function IsAdaptiveBrightnessEnabled () As Boolean
```

#### Return value 

True … adaptive brightness is enabled. 

False … adaptive brightness is disabled. 

# IsDisplayOn

This function returns true if the display is on. 

#### Syntax 

```visualbasic
Function IsDisplayOn () As Boolean
```

#### Return value 

True - the display is on. 

False - the display is off. 

# Off

This function turns off showing on the display. 

#### Syntax 

```visualbasic
Function Off()
```

# On

This function turns on showing on the display. 

#### Syntax* *

```visualbasic
Function On()
```

# OnDisplayOff

Event OnDisplayOff is invoked when the display is going to the off state. The process can be linked to that event. 

#### Syntax* *

```visualbasic
Process OnDisplayOff ()
```

# OnDisplayOn

Event OnDisplayOn is invoked when the display is going to the on state. The process can be linked to that event. 

#### Syntax 

```visualbasic
Process OnDisplayOn()
```

# SetBackLightSaverTimeout

This function sets the backlight saver timeout. 

#### Syntax 

```visualbasic
Function SetBackLightSaverTimeout(timeout As Time)
```

#### Parameters 

timeout 

<u>[Time](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Time)</u> It is a backlight saver timeout. If the timeout parameter is :0 backlight saver is disabled.  

# SetBrightness

This function sets the brightness of the display. 

#### Syntax 

```visualbasic
Function SetBrightness(brightness As Byte)
```

#### Parameters 

brightness 

<u>[Byte](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Byte)</u> It is the brightness. The value can be from 0 to 100.

# SetOrientation

This function sets a display orientation.  

> ℹ️ This function is supported only in units which support landscape and portrait mode of display orientation.

> ℹ️ Landscape flipped and Portrait flipped orientations are only supported by signCUE-two. Please look at the notes in orientation types table.

> ⚠️ This function only sets the new orientation type. To apply the change it is necessary to restart the unit. You can use function [Reset](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/512983127/General#Reset) for restarting the unit.

#### Syntax 

```visualbasic
Function SetOrientation(orientation As Long) As Boolean
```

#### Return value 

True if the function succeeds, False otherwise. 

#### Orientation types

|  |  |  |
| --- | --- | --- |
| Name | Value | Notes |
| Landscape | 0 | supported by touchCUE-5-knob, touchCUE-10-W and signCUE-two. |
| Portrait | 1 | supported by touchCUE-5-knob, touchCUE-10-W and signCUE-two. |
| Landscape flipped | 2 | supported by signCUE-two. |
| Portrait flipped | 3 | supported by signCUE-two. |

# SetOSDTimeout

This function can be used for setting the on-screen menu automatic hide timeout programmatically. The timeout is the interval of user inactivity after it is the on-screen menu or power off page automatically hidden. This value is valid only in the case of running application. If the application is not running, the timeout is always the system default value (60 seconds). 

#### Syntax* *

```visualbasic
Public Function SetOSDTimeout(timeout As Time) As Boolean
```

#### Parameters 

*Timeout* 

Timeout specifies inactivity time to hide the on-screen menu. Valid is the value greater than :0.0 second. But the value that is too low is not useful. 

#### Return value 

True if the function succeeds, false otherwise. 

# ShowOnScreenMenu

*Warning! This function is deprecated.*

This function can be used for activating the on-screen menu programmatically. 

#### Syntax 

```visualbasic
Function ShowOnScreenMenu()
```

***Note*** 

This function is not supported in newer versions of airCUE and touchCUE panels with OMAP processors starting from the firmware version 4.19. The command is supported only in the firmware version 4.18. In newer versions is replaced by the function ShowOSD.

# ShowOSD

This function can be used for activating the on-screen menu programmatically. The programmer can select the preferred page.

#### Syntax 

```visualbasic
Public Function ShowOSD(
  Optional osdmode As Long:=_OSDMODE_DEFAULT, 
  Optional pagenumber As Long:=1) 
As Boolean
```

The function shows the OnScreen menu in the specified osd mode and activates the specific page.

#### Parameters 

*Osdmode* 

Specifies the mode of activation the on-screen menu. There are three modes at disposal. These modes are specified as long numbers and there are three built-in constants for the mode. 

#### OSD mode constants 

|  |  |  |
| --- | --- | --- |
| _OSDMODE_DEFAULT | 0 | The on-screen menu will be shown in the mode specified on the configuration web page. |
| _OSDMODE_BASIC | 1 | The on-screen menu will be shown in the basic mode. |
| _OSDMODE_ADVANCED | 2 | The on-screen menu will be shown in the advanced mode. |

*Pagenumber* 

Specifies the page to activate. If the parameter *pagenumber* is not valid for the specific device, then the function returns false and nothing happens. Page numbers are the same on all devices, but on some devices, some pages do not exist. For example wifi setting on the lan panels. 

# ShowPowerOffPage

The function shows the power off page only. This is useful if the programmer will allow the user only to switch off the panel. 

```visualbasic
Public Function ShowPowerOffPage() As Boolean
```

#### Return value 

True if the function succeeds, false otherwise.