---
title: "ScrollListBox"
canonical: "https://docs.cuesystem.com/space/CVCGC/476577805/ScrollListBox"
format: markdown
---
> Macro (toc)

---

# Description

The SclollListBox enables you to display a list of items to the user that the user can select by clicking. By scrolling, you can reach other items in the list. VisibleLines are displayed in the bar. You can assign an icon to each item. The ScrollListBox contains two types of graphic objects: VerticalScrollListBox and  HorizontalScrollListBox.

![image](media://b46db08a-a193-4396-81ab-aa9931525622)


![image](media://dbfdbdc7-da96-4c63-9f63-73ba159a8c39)

# Properties

See manual [https://cue.atlassian.net/wiki/spaces/CVCGC/pages/407535672/Common+Section+of+Generic+object+collection#Properties](https://cue.atlassian.net/wiki/spaces/CVCGC/pages/407535672/Common+Section+of+Generic+object+collection#Properties) . In addition, this object uses the following properties.

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Appearance |
| BackgroundColor | Long | Any | &H00000000 | Color of background. |
| SelectedItemColor | Long | Any | &H33000000 | Color of the selected item. |
| KeepSelected | Boolean | Yes  
No | Yes | Yes - always show the selected item. |
| VisibleItems | Long | Any positive | 5 | A number of visible lines. |
| EnsureVisibleSelectedTimeout | Time | Time | 0:0 | After the last contact and expiration timeout object executes EnsureVisible - moves the selected item and, if possible, it centers.<br>If KeepSelected is not set to “yes”, timeout is not active. If timeout is 0 or TIME_INFINITE, nothing is exercised, the object remains in the last position. |
| ColorBreath | Boolean | Yes  
No | Yes | Yes - Breath selected item |
| Text |
| Font | AddressOf<br>_Font | Any | fntSegoeUI23 | Font of Texts |
| FontColor | Long | Any | _COLOR_BLACK | Color of Texts |
| VerticalTextShift | Long | Any | 0 | Vertical shift of texts in pixels |
| HorizontalTextShift | Long | Any | 0 | Horizontal shift of texts in pixels |
| Icon |
| VerticalIconShift | Long | Any | 0 | Vertical shift of icons in pixels |
| HorizontalIconShift | Long | Any | 0 | Horizontal shift of icons in pixels |
| Line |
| LineColor | Long | Any | _COLOR_WHITE | Color of Line |
| LineWeight | Long | Any positive | 0 | Weight of Line |

# Functions

See manual [https://cue.atlassian.net/wiki/spaces/CVCGC/pages/407535672/Common+Section+of+Generic+object+collection#Functions](https://cue.atlassian.net/wiki/spaces/CVCGC/pages/407535672/Common+Section+of+Generic+object+collection#Functions) . In addition, this object uses the following functions.

## AddItem

This function adds a new item to the list and sets text and icon index. Function returns True on success or False if next item index is more than 1000 items or iconindex is more than 50.

#### Syntax

```visualbasic
Function AddItem(itemtext As Text, iconindex As Long)As Boolean
```

## RemoveAllItems

This function remove all item of the list.

#### Syntax

```visualbasic
Function RemoveAllItems()
```

## SetItemText

This function sets text of itemindex. Function returns True on success or False if sets on existing item index of the list.

#### Syntax

```visualbasic
Function SetItemText(itemindex As Long, newitemtext As Text)As Boolean
```

## GetItemText

This function returns text corresponding to the item index.

#### Syntax

```visualbasic
Function GetItemText(itemindex As Long)As AddressOf Text
```

## SetItemIcon

This function sets iconindex of itemindex. Function returns True on success or False if sets on existing item index of the list.

#### Syntax

```visualbasic
Function SetItemIcon(itemindex As Long, newitemicon As Long)As Boolean
```

## GetItemIcon

This function returns iconindex corresponding to the item index.

#### Syntax

```visualbasic
Function GetItemIcon(itemindex As Long)As Long
```

## SetIconPicture

This function sets picture of iconindex.

#### Syntax

```visualbasic
Function SetIconPicture(newpicture As AddressOf _Picture, iconindex As Long)As Boolean
```

## GetIconPicture

This function returns picture of iconindex.

#### Syntax

```visualbasic
Function GetIconPicture(iconindex As Long)As AddressOf _Picture
```

## SetBackgroundColor 

This function sets a newbackgroundcolor to BackgroundColor. Function returns True.

#### Syntax

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

## GetBackgroundColor

Functions returns BackgroundColor.

#### Syntax

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

## SetKeepSelected 

This function sets a newkeepselected to KeepSelected. Function returns True.

#### Syntax

```visualbasic
Function SetKeepSelected(newkeepselected As Boolean)As Boolean
```

## GetKeepSelected

This function returns KeepSelected.

#### Syntax

```visualbasic
Function GetKeepSelected()As Boolean
```

## SetEnsureVisibleSelectedTimeout

This function sets a newensurevisibleselectedtimeout to EnsureVisibleSelectedTimeout. Function returns True. After the last contact and expiration timeout object executes EnsureVisible - moves the selected item and, if possible, it centers. If KeepSelected is not set to “yes”, timeout is not active. If timeout is 0 or TIME_INFINITE, nothing is exercised, the object remains in the last position.

#### Syntax

```visualbasic
Function SetEnsureVisibleSelectedTimeout(newensurevisibleselectedtimeout As Time)As Boolean
```

## GetEnsureVisibleSelectedTimeout

This function returns EnsureVisibleSelectedTimeout.

#### Syntax

```visualbasic
Function GetEnsureVisibleSelectedTimeout()As Time
```

## EnsureVisible

This function moves the selected item and, if possible, it centers.

#### Syntax

```visualbasic
Function EnsureVisible()
```

## SetVisibleItems

This function sets a newvisibleitems to VisibleItems. The function returns True on success or False if an error occurs.

#### Syntax

```visualbasic
Function SetVisibleItems(newvisibleitems As Long)As Boolean
```

## GetVisibleItems

This function returns VisibleItems.

#### Syntax

```visualbasic
Function GetVisibleItems() As Long
```

## SetFont

This function sets a newfont to Font. The function returns True on success or False if an error occurs.

#### Syntax

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

## GetFont

This function returns the Font.

#### Syntax

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

## SetFontColor

This function sets newfontcolor to FontColor. The function returns True on success or False if an error occurs.

#### Syntax

```visualbasic
Function SetFontColor(newfontcolor As Long) As Boolean
```

## GetFontColor

This function returns the FontColor.

#### Syntax

```visualbasic
Function GetFontColor() As Long
```

## SetSelectedItem

This function sets a newselecteditem to SelectedItem. The function returns True on success or False if an error occurs.

#### Syntax

```visualbasic
Function SetSelectedItem(newselecteditem As Long) As Boolean
```

## GetSelectedItem

This function returns the SelectedItem.

#### Syntax

```visualbasic
Function GetSelectedItem() As Long
```

## GetMaxItems

This function returns the maximum number of items.

#### Syntax

```visualbasic
Function GetMaxItems() As Long
```

## SetSelectedItemColor

This function sets a newselecteditemcolor to SelectedItemColor. The function returns True on success or False if an error occurs.

#### Syntax

```visualbasic
Function SetSelectedItemColor(newselecteditemcolor As Long) As Boolean
```

## GetSelectedItemColor

This function returns the SelectedItemColor.

#### Syntax

```visualbasic
Function GetSelectedItemColor() As Long
```

## SetLineColor

This function sets newlinecolor to LineColor. The function returns True on success or False if an error occurs.

#### Syntax

```visualbasic
Function SetLineColor(newlinecolor As Long) As Boolean
```

## GetLineColor

This function returns the LineColor.

#### Syntax

```visualbasic
Function GetLineColor() As Long
```

## SetLineWeight

This function sets weight of lines. The function returns True on success or False if an error occurs.

#### Syntax

```visualbasic
Function SetLineWeight(newlineweight As Long) As Boolean
```

## GetLineWeight

This function returns the LineWeight.

#### Syntax

```visualbasic
Function GetLineWeight() As Long
```

## SetHorizontalTextShift

This function sets a newhorizontaltextshift to HorizontalTextShift. This function returns true.

#### Syntax

```visualbasic
Function SetHorizontalTextShift(newhorizontaltextshift As Long) As Boolean
```

## GetHorizontalTextShift

This function returns HorizontalTextShift.

#### Syntax

```visualbasic
Function GetHorizontalTextShift() As Long
```

## SetHorizontalIconShift

This function sets a newhorizontalIconshift to HorizontalIconShift. This function returns true.

#### Syntax

```visualbasic
Function SetHorizontalIconShift(newhorizontalIconshift As Long) As Boolean
```

## GetHorizontalIconShift

This function returns HorizontalIconShift.

#### Syntax

```visualbasic
Function GetHorizontalIconShift() As Long
```

## SetVerticalTextShift

This function sets a newverticaltextshift to VerticalTextShift. This function returns true.

#### Syntax

```visualbasic
Function SetVerticalTextShift(newverticaltextshift As Long) As Boolean
```

## GetVerticalTextShift

This function returns VerticalTextShift.

#### Syntax

```visualbasic
Function GetVerticalTextShift() As Long
```

## SetVerticalIconShift

This function sets a newverticalIconshift to VerticalIconShift. This function returns true.

#### Syntax

```visualbasic
Function SetVerticalIconShift(newverticalIconshift As Long) As Boolean
```

## GetVerticalIconShift

This function returns VerticalIconShift.

#### Syntax

```visualbasic
Function GetVerticalIconShift() As Long
```

## SetColorBreath

This function sets a newcolorbreath to ColorBreath. This function returns true.

#### Syntax

```visualbasic
Function SetColorBreath(newcolorbreath As Boolean) As Boolean
```

## GetColorBreath

This function returns ColorBreath.

#### Syntax

```visualbasic
Function GetColorBreath() As Boolean
```

# Events

## OnSelect

Selected value is delivered in parameter. This event is generated, if a line on ScrollListBox is pressed. Selected value is set as parameter in newselecteditem.

#### Syntax

```visualbasic
Event OnSelect() As Process (newselecteditem As Long)
```

# Example

At first, insert icon pictures to MyProjectResources/MyCommon/Pictures.

If you want to insert items with text and icon to ScrollListBox, first use function SetIconPicture() and insert a icon image and index of icon. Then use the function AddItem().

If you want to change items of ScrollListBox, use function RemoveAllItems() and then you can insert items using function AddItem() again.

```visualbasic
Function SetScrollListBox() 
Page1.VerticalScrollListBox1.SetIconPicture(picBBCAmerica,1) 
Page1.VerticalScrollListBox1.SetIconPicture(picFoxNews,2) 
Page1.VerticalScrollListBox1.SetIconPicture(picCNN,3) 
Page1.VerticalScrollListBox1.SetIconPicture(picNBC,4) 
Page1.VerticalScrollListBox1.SetIconPicture(picCNBCworld,5)

Page1.VerticalScrollListBox1.AddItem("BBC America",1)  
Page1.VerticalScrollListBox1.AddItem("FOX news",2)  
Page1.VerticalScrollListBox1.AddItem("CNN",3)  
Page1.VerticalScrollListBox1.AddItem("NBC",4)  
Page1.VerticalScrollListBox1.AddItem("CNBC world",5)
End Function
```

```visualbasic
Function ChangeScrollListBox() 
Page1.VerticalScrollListBox1.RemoveAllItems() 
Page1.VerticalScrollListBox1.AddItem("CNBC world",5) 
Page1.VerticalScrollListBox1.AddItem("NBC",4) 
Page1.VerticalScrollListBox1.AddItem("CNN",3) 
Page1.VerticalScrollListBox1.AddItem("FOX news",2) 
Page1.VerticalScrollListBox1.AddItem("BBC America",1)
End Function
```