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

---

# Description

This object serves for visual grouping of other objects only (buttons, bargraphs, ...). That means it can’t be a container for other objects. It has a caption and client area. Whole object and caption border can be independently displayed or not as well as backgrounds.

![image](media://473ab21e-5ab5-4280-96ad-52a2100ef713)

# Properties

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Appearance |
| DisplayBackground | Boolean | Yes  
No | Yes | Specifies whether the background is shown. |
| DisplayBorder | Boolean | Yes  
No | Yes | Specifies whether the borders are shown. |
| Caption |
| CaptionAlign | Long | Left-Top   
Left-Middle   
Left-Bottom   
Center-Top  
Center-Middle Center-Bottom Right-Top   
Right-Middle  
Right-Bottom | Center-Middle | Horizontal and vertical align of caption text. |
| CaptionFont | AddressOf _Font | Any | fntDefault16 | Caption font. fntDefault16 is Verdana 16 pixels high. |
| CaptionText | AddressOf Text | Any | “Caption” | Text shown in Caption. |
| DisplayCaptionBackground | Boolean | Yes  
No | Yes | Specifies whether the caption background is shown. |
| DisplayCaptionBorder | Boolean | Yes  
No | Yes | Specifies whether the caption borders are shown. |

# Functions

## SetCaptionAlign

This function sets align of Caption text. You can use meaningful BitOr combinations of the following constants as parameters

- _TEXT_ALIGNLEFT, _TEXT_ALIGNHCENTER, _TEXT_ALIGNRIGHT
- _TEXT_ALIGNTOP, _TEXT_ALIGNVCENTER, _TEXT_ALIGNBOTTOM

The function returns True on success or False if an error occurs (i.e. parameter has wrong value).

#### Syntax

```visualbasic
Function SetCaptionAlign(newcaptionalign As Long) As Boolean
```

## GetCaptionAlign

This function returns the current align of Caption text.

#### Syntax

```visualbasic
Function GetCaptionAlign() As Long
```

## SetCaptionFont

This function sets the font of Caption text. Function returns True.

#### Syntax

```visualbasic
Function SetCaptionFont(newcaptionfont As AddressOf _Font) As Boolean
```

## GetCaptionFont

This function returns addressof Caption text font.

#### Syntax

```visualbasic
Function GetCaptionFont() As AddressOf _Font
```

## SetCaptionText 

This function sets the current CaptionText to newcaptiontext. As newcaptiontext you can use the direct value of text (SetCaptionText (“Hello”)). In this case you will lose the possibility of changing the language of this caption. You can also use addressof text (SetCaptionText (txtHello)) as parameter (txtHello must be declared in MyCommon/Text resources). In this case it is possible to change the language of the caption. Function returns True.

#### Syntax

```visualbasic
Function SetCaptionText(newcaptiontext As Text) As Boolean
```

## GetCaptionText

This function returns addressof the current CaptionText.

#### Syntax

```visualbasic
Function GetCaptionText() As AddressOf Text
```

## SetDisplayBackground

This function sets whether background is visible or not.

#### Syntax

```visualbasic
Function SetDisplayBackground(newdisplaybackground As Boolean) As Boolean
```

## GetDisplayBackground

This function returns whether background is visible or not.

#### Syntax

```visualbasic
Function GetDisplayBackground() As Boolean
```

## SetDisplayBorder

This function sets whether borders are visible or not.

#### Syntax

```visualbasic
Function SetDisplayBorder(newdisplayborder As Boolean) As Boolean
```

## GetDisplayBorder

This function returns whether borders are visible or not.

#### Syntax

```visualbasic
Function GetDisplayBorder() As Boolean
```

## SetDisplayCaptionBackground

This function sets whether caption background is visible or not.

#### Syntax

```visualbasic
Function SetDisplayCaptionBackground(newdisplaycaptionbackground As Boolean) As Boolean
```

## GetDisplayCaptionBackground

This function returns whether caption background is visible or not.

#### Syntax

```visualbasic
Function GetDisplayCaptionBackground() As Boolean
```

## SetDisplayCaptionBorder

This function sets whether caption borders are visible or not.

#### Syntax

```visualbasic
Function SetDisplayCaptionBorder(newdisplaycaptionborder As Boolean) As Boolean
```

## GetDisplayCaptionBorder

This function returns whether caption borders are visible or not.

#### Syntax

```visualbasic
Function GetDisplayCaptionBorder() As Boolean
```