Back to Contents


Template Paths - TopMenu hierarchy


The TopMenu object

Path: application/ui/topmenu or application/ui/window/form/topmenu

Snippet ID: TopMenu

Corresponding AUI Tree element: TopMenu

The TopMenu is a unique sub-object from the UserInterface or Form object that represents the application or window top menu if any.

This object value is rendered thru the TopMenu snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes) Type Description
CID Attribute (string) The corresponding component identifier.
type Attribute (string) Object type.
name Attribute (string) TopMenu identifier.
hidden Attribute (number) Corresponds to the HIDDEN attribute in 4GL.
tag Attribute (string) Corresponds to the attribute TAG value.
items Collection of TopMenuItem objects The list of all items in the top menu.
Used in a repeat instruction to loop on each file in the list.

Back to the top


The TopMenuItem objects

TopMenuItem objects are in fact one of the following type :

Back to the top


The TopMenuCommand object

Path: no absolute path available

Snippet ID: TopMenuCommand

Corresponding AUI Tree element: TopMenuCommand

The TopMenuCommand is an object implementing a TopMenuItem object that represents a TopMenu command.

This object value is rendered thru the TopMenuCommand snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes) Type Description
CID Attribute (string) The corresponding component identifier.
type Attribute (string) Object type.
id Attribute (string) Object identifier.
DID Deprecated ! Attribute (string) Dialog identifier.
This path is deprecated use IDID or XDID instead.
IDID Attribute (string) Dialog identifier with inclusive format.
XDID Attribute (string) Dialog identifier with exclusive format.
name Attribute (string) TopMenu command identifier.
text Attribute (string) Text displayed for this command.
comment Attribute (string) Comment displayed for this command.
image Attribute (string) The associated image.
isActive Attribute (boolean) True if the command is active.
hidden Attribute (number) Corresponds to the HIDDEN attribute in 4GL.
tag Attribute (string) Corresponds to the attribute TAG value.

Back to the top


The TopMenuGroup object

Path: no absolute path available

Snippet ID: TopMenuGroup

Corresponding AUI Tree element: TopMenuGroup

The TopMenuGroup is an object implementing a TopMenuItem object that represents a group of TopMenu items.

This object value is rendered thru the TopMenuGroup snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes) Type Description
CID Attribute (string) The corresponding component identifier.
type Attribute (string) Object type.
name Attribute (string) TopMenu group identifier.
text Attribute (string) Text displayed for the TopMenu group.
comment Attribute (string) Comment displayed fot the TopMenu group.
image Attribute (string) Image associated to the TopMenu group
isActive Attribute (boolean) True of the TopMenu group is active.
hidden Attribute (number) Corresponds to the HIDDEN attribute in 4GL.
tag Attribute (string) Corresponds to the attribute TAG value.
items Collection of TopMenuItem objects The list of all items in the TopMenu group.
Used in a repeat instruction to loop on each file in the list.

Back to the top


The TopMenuSeparator object

Path: no absolute path available

Snippet ID: TopMenuSeparator

Corresponding AUI Tree element: TopMenuSeparator

The TopMenuSeparator is an object implementing a TopMenuItem object that represents a separator.

This object value is rendered thru the TopMenuSeparator snippet when invoked in a gwc:replace or gwc:content instruction.

Fields (Attributes) Type Description
CID Attribute (string) The corresponding component identifier.
type Attribute (string) Object type.

Back to the top