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

---

# Description

This object displays text. Text can be set from external sources as well using function SetText.

![image](media://71d529d4-b5b1-487a-8fdf-2d7e08e71862)

# Properties

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Behavior |
| Events | Boolean | True  
False | False | If True event OnTouch is enabled. If False event OnTouch is disabled. |
| Content |
| Align | 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 content text. |
| Color | Long | Any | _COLOR_BLACK | Color of content Text |
| Font | AddressOf _Font | Any | fntDefault16 | Content text font. fntDefault16 is Verdana 16 pixels high. |
| LineSpacing | Double | Any non-negative | 1.2 | Vertical distance between two lines of multiline content Text. The value is multiple of the font height. |
| Text | AddressOf Text | Any | “Text“ | Text shown as content. |
| TextOffsetX | Long | Any | 0 | Horizontal offset of Text in pixels. |
| TextOffsetY | Long | Any | 0 | Vertical offset of Text in pixels. |

# Functions

## SetAlign

This function sets Align of content 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.

#### Syntax

```visualbasic
Function SetAlign(newalign As Long) As Boolean
```

## GetAlign

This function returns current Align of content Text.

#### Syntax

```visualbasic
Function GetAlign() As Long
```

## SetColor

This function sets content text Color to newcolor. Function returns True.

#### Syntax

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

## GetColor

This function returns current content text 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 if event OnTouch is enabled or False if event OnTouch disabled.

#### Syntax

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

## SetFont

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

#### Syntax

```visualbasic
Function SetFont(newfont As AddressOf _Font) As Boolean
```

## GetFont

This function returns address of content text font.

#### Syntax

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

## SetLineSpacing

This function sets LineSpacing to newlinespacing. Function returns True if newlinespacing >= 0, otherwise it returns False.

#### Syntax

```visualbasic
Function SetLineSpacing(newlinespacing As Double) As Boolean
```

## GetLineSpacing

This function returns current LineSpacing.

#### Syntax

```visualbasic
Function GetLineSpacing() As Double
```

## SetText

This function sets content Text to newtext. Function returns True.

#### Syntax

```visualbasic
Function SetText(newtext As Text) As Boolean
```

## GetText

This function returns address of current content text.

#### Syntax

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

## SetTextOffsetX

This function sets TextOffsetX to newtextoffsetx. Function returns True.

#### Syntax

```visualbasic
Function SetTextOffsetX(newtextoffsetx As Long) As Boolean
```

## GetTextOffsetX

This function returns current TextOffsetX.

#### Syntax

```visualbasic
Function GetTextOffsetX() As Long
```

## SetTextOffsetY

This function sets TextOffsetY to newtextoffsety. Function returns True.

#### Syntax

```visualbasic
Function SetTextOffsetY(newtextoffsety As Long) As Boolean
```

## GetTextOffsetY

This function returns current TextOffsetY.

#### Syntax

```visualbasic
Function GetTextOffsetY() As Long
```

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