---
title: "FullScreenWindow (Basic)"
canonical: "https://docs.cuesystem.com/space/CVCGC/401899564/FullScreenWindow%20(Basic)"
format: markdown
---
> Macro (toc)

---

# Description

The FullscreenWindow is a basic object used as a container for other objects. FullscreenWindow dimensions are automatically resized to fit the screen. That is why this object does not have functions for settings size and position. The background of the FullscreenWindow can be selected from three predefined themes or any solid color.

# Properties

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Behavior |
| NavigationBarButtonID | Long | 0 to maximum number of buttons in joined Navigation Bar | 0 | Value for joining Navigation Bars with FullScreenWindow. |
| Appearance |
| BackgroundColor | Long | Any | Gray | Solid color of object |
| BackgroundPicture | AddressOf _Picture | Any | Nothing | Picture placed on the object |
| BackgroungPictureAlign | Long | <> Maximum | Center-Middle | All nine combinations of horizontal and vertical align |

> 📝 #### Note
> 📝 
> 📝 NavigationBarButtonID is a property used for joining FullScreenWindow with the navigation bar. If the navigation bar has the same join as this FullScreenWindow and button with corresponding NavigationBarButtonID is pressed on navigation bar, this FullScreenWindow will open. If another button on navigation bar is pressed, this FullScreenWindow will close. If navigation bar has a different join, visibility of this FullScreenWindow is not managed by the navigation bar.

# Functions

## SetBackgroundColor

This function sets background color of FullScreenWindow. See CVC / Commands / Graphics help for details, how to create long number representing required color. Function returns True.

#### Syntax

```visualbasic
Function SetBackgroundColor(newbackgroundcolor As Long) As Boolean
```

## GetBackgroundColor

This function returns current background color of FullScreenWindow.

#### Syntax

```visualbasic
Function GetBackgroundColor() As Long
```

## SetBackgroundPicture

This function sets FullScreenWindow background picture to the newbackgroundpicture. Function returns True.

#### Syntax

```visualbasic
Function SetBackgroundPicture(newbackgroundpicture As AddressOf _Picture) As Boolean
```

## GetBackgroundPicture

This function returns AddressOf current background picture.

#### Syntax

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

## SetBackgroundPictureAlign

This function sets new picture align. You can use meaningful BitOr combinations of predefined constants for align. For example, if instance of FullScreenWindow is named FS1, you can use as parameter (FS1.PICTURE_ ALIGNLEFT BitOr FS1.PICTURE_ALIGNTOP) for left top align. The function returns True on success or False if an error occurs (parameter has wrong value).

#### Syntax

```visualbasic
Function SetBackgroundPictureAlign(newbackgroundpicturealign As Long) As Boolean
```

## GetBackgroundPictureAlign

This function returns current align of picture.

#### Syntax

```visualbasic
Function GetBackgroundPictureAlign() As Long
```

# Events

## OnHideObject

This event is raised whenever FullScreenWindow has been closed.

#### Syntax

```visualbasic
Event OnHideObject As Function()
```

## OnPush

This event is raised whenever FullScreenWindow has been pushed.

#### Syntax

```visualbasic
Event OnPush As Process()
```

## OnShowObject

This event is raised whenever FullScreenWindow has been opened.

#### Syntax

```visualbasic
Event OnShowObject As Function()
```