Start page
Start page

Start page / Template development / Template syntax / System objects / #nav

#navAvailable from FirstSpirit Version 4.0

The system object #nav is available in the following functions:

#nav can be used to access special values of the relevant navigation functions.

A list of the functions and their possible uses are given in the following table:

Methods within the MenuGroup function

Invocation

Meaning

Return data type

#nav.label

Contains the value of the "Menuname" field

String
(character string)

#nav.media

Contains the value of the "Normal" field

StoreElement

#nav.pos

Contains the position of the menu in the menu group.

Integer

#nav.ref

Contains the reference to the startpage of the relevant menu item.

Element of the menu group

#nav.mediaHighlight

Contains the value of the "with mouse pointer" field of the menu level.

Media

#nav.mediaSelected

Contains the value of the "Selected" field of the menu level.

Media

#nav.mediaHighlightSelected

Contains the value of the "Selected with mouse" field of the menu level.

Media

   

Methods within the Navigation function

Invocation

Meaning

Return data type

#nav.comment

Comment on the target node entered in the structure tree.

String
(character string)

#nav.data ("IDENTIFIER")

Value of the variables given with the identifier.

Variable value, e.g. String
(character string)

#nav.hasSubFolders

Determines whether the current navigation item has got children (sub-ordinated menu levels / folders)

Boolean
(Boolean value)

#nav.id

Unique, server-wide valid identification number of the target node.

Long

#nav.isFirst

Returns whether the element is the first of the current menu level.

Boolean
(Boolean value)

#nav.isLast

Returns whether the element is the last of the current menu level.

Boolean
(Boolean value)

#nav.label

Name of the corresponding target node.

String
(character string)

#nav.level

Number of the navigation level. The counting begins with 0.

Integer

#nav.levelPos

Position of the current folder in the current level. The counting begins with 0.

Integer

#nav.media

Picture for the target node referenced in the structure tree under "Normal".

Media

#nav.media.height

Height of the picture in pixels.

Integer

#nav.media.width

Width of the picture in pixels.

Integer

#nav.mediaHighlight

Picture for the target node referenced in the structure tree under "with mouse pointer".

Media

#nav.mediaHighlight.height

Height of the picture in pixels.

Integer

#nav.mediaHighlight.width

Width of the picture in pixels.

Integer

#nav.mediaHighlightSelected

Picture for the target node referenced in the structure tree under "Selected with mouse".

Media

#nav.mediaHighlightSelected.height

Height of the picture in pixels.

Integer

#nav.mediaHighlightSelected.width

Width of the picture in pixels.

Integer

#nav.mediaSelected

Picture for the target node referenced in the structure tree under "Selected".

Media

#nav.mediaSelected.height

Height of the picture in pixels.

Integer

#nav.mediaSelected.width

Width of the picture in pixels.

Integer

#nav.positions[INTEGER]

Position of the corresponding folder in the level given with an integer.
#nav.positions is a list. It is therefore necessary to ensure that the number given is less than the number of elements in the list (#nav.positions.size).

Integer

#nav.ref

Reference to the target node or the corresponding start node.

PageRef

#nav.ref.page.id

Unique, server-wide valid identification number of the corresponding page.

Long

#nav.selected

Determines whether the element is selected or not.

Boolean
(Boolean value)

   

Methods within the PageGroup function

Invocation

Meaning

Return data type

#nav.label

Returns the name of the corresponding page. This is either set in the Site Store (test for sitemap) or it is the name of the page from the Page Store.

String
(character string)

#nav.media

Returns the picture entered in the Site Store for the sitemap.

StoreElement

#nav.pos

Gives the position of the page in the page group.

Integer

#nav.ref

Returns a link to the corresponding page.

Element of the page group

   

© 2005 - 2015 e-Spirit AG | All rights reserved. | Last change: 2013-12-09