---
title: "NavigationBar"
canonical: "https://docs.cuesystem.com/space/CVCGC/476512325/NavigationBar"
format: markdown
---
> Macro (toc)
---
# Description
NavigationBar is a window mainly used for navigation between different Windows or MessageBoxes. NavigationBar contains ScrollListBox. The ScrollListBox enables you to display a list of items to the user that the user can select by click. By scrolling, you can reach other items in the list. VisibleLines are displayed in the bar. You can assign an icon to each item. Icons for each line are inserted by animation. Each item of animation is assigned to the item in ScrollListBox. NavigationBar contains two types of graphic windows: HorizontalNavigationBar and VerticalNavigationBar.
Navigation Bar should be joined (by the Join property) to Windows. If any button on Navigation Bar is pushed, Window with the same join and corresponding NavigationBarButtonID will open, while windows with different NavigationBarButtonID will close. Windows with different Join will not be affected.
> 📝 Don’t forget to place the command ShowObject to Autoexec. Window joined with DefaultButton property of NavigationBar will open automatically.
# 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 |
| Behavior |
| OpenMode | Long | Modal Modeless
Topmost | Topmost | It is the method of the window activation. |
| NavigationBarButtonID | Long | 0 to Maximum number of used buttons in NavigationBar | 0 | Value for joining Navigation Bars with object. |
| Appearance |
| DefaultSelectedItem | Long | Any of maximal item | 1 | Selected item of Navigation Bar. |
| BackgroundColor | Long | Any | &H00000000 | Color of background. |
| SelectedItemColor | Long | Any | &H33000000 | Color of selected item. |
| KeepSelected | Boolean | Yes
No | Yes | Yes - always show selected item. |
| VisibleItems | Long | Any positive | 5 | 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.
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 |
| Texts | AddressOf
Text | Any | Nothing | Defines items of rotary picker. Every item must be on separate line. |
| Font | AddressOf
_Font | Any | fntSegoeUI23 | Font of Texts |
| FontColor | Long | Any | _COLOR_BLACK | Color of Texts |
| HorizontalTextShift | Long | Any | 0 | Horizontal shift of texts in pixels |
| VerticalTextShift | Long | Any | 0 | Vertical shift of texts in pixels |
| Icon |
| Icons | AddressOf
_Animation | Any | Nothing | Every item animation is on separate line. |
| HorizontalIconShift | Long | Any | 0 | Horizontal shift of icons in pixels |
| VerticalIconShift | Long | Any | 0 | Vertical shift of icons in pixels |
| Line |
| LineColor | Long | Any | _COLOR_WHITE | Color of Line |
| LineWeight | Long | Any positive | 0 | Weight of Line |
# Functions
## SetOpenMode
This function sets OpenMode to newopenmode. You can use following constants as parameter
- _OW_MODAL for Modal open mode
- _OW_TOPMOST for Topmost open mode
- 0 for Modeless open mode
Function returns True on success or False if an error occurs (parameter has wrong value).
#### Syntax
```visualbasic
Function SetOpenMode(newopenmode As Long) As Boolean
```
## GetOpenMode
This function returns current OpenMode of the window.
#### Syntax
```visualbasic
Function GetOpenMode() As Long
```
## SetBackgroundColor
This function sets a newbackgroundcolor to BackgroundColor. Function returns True.
#### Syntax
```visualbasic
Function SetBackgroundColor(newbackgroundcolor As Long) As Boolean
```
## GetBackgroundColor
This function 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
```
## SetColorBreath
This function sets a newcolorbreath to ColorBreath. The function returns True.
#### Syntax
```visualbasic
Function SetColorBreath(newcolorbreath As Boolean)As Boolean
```
## GetColorBreath
This function returns ColorBreath.
#### Syntax
```visualbasic
Function GetColorBreath() As Long
```
## SetTexts
This function sets a newtexts to Texts. Function returns True.
#### Syntax
```visualbasic
Function SetTexts(newtexts As AddressOf Text) As Boolean
```
## GetTexts
This function returns Texts.
#### Syntax
```visualbasic
Function GetTexts()As AddressOf Text
```
## GetItemTexts
This function returns text of item.
#### Syntax
```visualbasic
Function GetItemTexts(item AsLong)As AddressOf Text
```
## 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 a 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
```
## SetIcons
This function sets a newicons to Icons. The function returns True on success or False if an error occurs.
#### Syntax
```visualbasic
Function SetIcons(newicons As AddressOf _Animation) As Boolean
```
## GetIcons
This function returns the Icons.
#### Syntax
```visualbasic
Function GetIcons() As AddressOf _Animation
```
## 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
```
## 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 a 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
```
# Events
## OnHideObject
This event is raised whenever NavigationBar has been closed.
#### Syntax
```visualbasic
Event OnHideObject As Function()
```
## OnShowObject
This event is raised whenever NavigationBar has been opened.
#### Syntax
```visualbasic
Event OnShowObject As Function()
```
## OnSelect
Selected value is delivered in parameter This event is generated, if a line on NavigationBar is pressed. Selected value is set as parameter in newselitem.
#### Syntax
```visualbasic
Event OnSelect() As Process(newselecteditem As Long)
```
# Example
How insert items to NavigationBar:
At first, insert animation to MyProjectResources/MyCommon/Animations and text to MyProjectResources/ MyCommon/Texts.
- Using properties:
Insert text and animation into properties. Each item of animation is assigned to the item in NavigationBar. Each line of text is assigned to the item in NavigationBar.
- Using functions:
Use function SetIcons() and SetTexts(). Each item of animation is assigned to the item in NavigationBar. Each line of text is assigned to the item in NavigationBar.
```visualbasic
Function SetNavigationBar()
HorizontalNavigationBar1.SetIcons(aniNavigationBar)
HorizontalNavigationBar1.SetTexts(txtNavigationBar)
End Function
```