Methods of the MENU BAR Object

ADD_CTX_MENU_OPT

Adds a context-sensitive menu option.

Syntax

CALL_METHOD MenuBarObjectName ADD_CTX_MENU_OPT MenuId MenuOptionId Position Text Style NewMenuOptionId ReturnCode

Parameters

NUM_BIN_4 MenuId

Identification number of the parent context-sensitive menu (input parameter)

NUM_BIN_4 MenuOptionId

Identification number of the parent menu option or _MBA_ROOT (input parameter)

NUM_BIN_2 Position

Insertion point for the new element (input parameter)

Possible values:

_MBA_POS_BEFORE

ParentId will be a sibling element (it cannot be set to _MBA_ROOT).

The element created will be added before ParentId,

_MBA_POS_FIRST

ParentId will be a parent element.

The element created will be added at the head of the ParentId child elements,

_MBA_POS_LAST

ParentId will be a parent element.

The element created will be added to the end of the ParentId child elements.

ALPHA(250) Text

Text of the option (input parameter)

NUM_BIN_4 Style

Style to be applied (input parameter)

Possible values:

_MBA_SIMPLE	Simple text menu option,
_MBA_SEPARATOR	Menu option of separator type.

NUM_BIN_4 NewMenuOptionId

Identification code of the created menu option (output parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-4	Incorrect Text parameter value,
-3	Incorrect Position parameter value,
-2	Incorrect MenuOptionId parameter value,
-1	Incorrect MenuId parameter value,
1	Operation completed successfully.

Conditions for use

None

ADD_ELEMENT

Adds an element to the tree view.

Syntax

CALL_METHOD MenuBarObjectName ADD_ELEMENT ToolId ParentId Position Text ElementId ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter)

NUM_BIN_4 ParentId

Identification code of the parent element (parent or sibling) (input parameter)

Possible values:

_MBA_ROOT	Root of the tree or of the search elements list.
a NUM_BIN_4 type value	Unique element. This value is given when calls are made for methods or accesses to property values that return a valid element identification code (i.e. the ADD_ELEMENT or GET_PARENT methods, or the ACTION_ELEMENT property).

NUM_BIN_2 Position

Insertion point for the new element (input parameter)

Possible values:

_MBA_POS_BEFORE	ParentId will be a sibling element (it cannot be set to _MBA_ROOT). The element created will be added before ParentId,
_MBA_POS_AFTER	ParentId will be a sibling element (it cannot be set to _MBA_ROOT). The element created will be added after ParentId,
_MBA_POS_FIRST	ParentId will be a parent element. The element created will be added at the head of the ParentId child elements,
_MBA_POS_LAST	ParentId will be a parent element. The element created will be added to the end of the ParentId child elements.

ALPHA(n) Text

Text in the element (input parameter)

NUM_BIN_4 ElementId

Identification code of the new element added (output parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-5	Internal error,
-4	Incorrect Text parameter value,
-3	Incorrect Position parameter value,
-2	Incorrect ParentId parameter value,
-1	Incorrect ToolId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

Important: in Adelia Cloud mode, the text of an element accepts HTML code as an input, making it possible to create enriched text. If it needs to be possible for the user to enter this text, it is the developer's responsibility to check that the input text does not contain javascript code likely to generate a "Cross-Site Scripting" vulnerability. The VaToolBxJavaSanitizeHTML function can be used to validate the input value.

ADD_ELEMENT_EX

Adds an element to a Search tool or Menu tool.

Syntax

CALL_METHOD MenuBarObjectName ADD_ELEMENT_EX ToolId ParentId Position Text Representation ElementId ReturnCode

Parameters

NUM_BIN_4 ToolId

Tool ID (input parameter).

NUM_BIN_4 ParentId

Parent element ID (parent or sibling) (input parameter).

Possible values:

_MBA_ROOT	Root of the menu or list of search elements.
A NUM_BIN_4 value.	Single element. This value is given when methods are called or when property values returning a valid element ID are accessed (for example, the ADD_ELEMENT or GET_PARENT methods or the ACTION_ELEMENT property).

NUM_BIN_2 Position

New element position (input parameter).

Possible values:

_MBA_POS_BEFORE	ParentId will be a sibling element (it cannot be set to _MBA_ROOT). The element created will be added before ParentId.
_MBA_POS_AFTER	ParentId will be a sibling element (it cannot be set to _MBA_ROOT). The element created will be added after ParentId.
_MBA_POS_FIRST	ParentId will be a parent element. The element created will be added at the head of the ParentId child elements.
_MBA_POS_LAST	ParentId will be a parent element. The element created will be added to the end of the ParentId child elements.

ALPHA(n) Text

Element text (input parameter).

NUM_BIN_4 Representation

Element representation (input parameter).

Possible values:

_MBA_MENU_ITEM	The element is a normal menu item (default value in ADD_ELEMENT).
_MBA_SECTION_TITLE	The element is a section title. The title is displayed in bold and cannot be selected in the menu (but it is clickable).
_MBA_SEPARATOR	The element is a separator. It is not clickable.
_MBA_EDITABLE	The element is an edit check used to modify the value of the associated variable. This representation is only available for Menu tool elements.

Note: the menu behaves differently when it contains form elements (_MBA_EDITABLE). In this case, the menus and sub-menus no longer activate immediately when hovered over. The user needs to explicitly click on them to open or close the sub-menus.

NUM_BIN_4 ElementId

Identifier of the new element added (output parameter).

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-5	Internal error,
-4	The Adelia type of the Text parameter is not authorized.
-3	The Position parameter value is incorrect.
-2	The ParentId parameter value is incorrect.
-1	The ToolId parameter value is incorrect.
0	Internal error.
1	Operation completed successfully.

Conditions for use

None

Important: in Adelia Cloud mode, the text of an element accepts HTML code as an input, making it possible to create enriched text. If it needs to be possible for the user to enter this text, it is the developer's responsibility to check that the input text does not contain javascript code likely to generate a "Cross-Site Scripting" vulnerability. The VaToolBxJavaSanitizeHTML function can be used to validate the input value.

ADD_IMAGE

Adds an image to the image list associated with the object.

Syntax

CALL_METHOD MenuBarObjectName ADD_IMAGE FileName ImageId ReturnCode

Parameters

ALPHA(250) FileName

Name and directory of the file containing the image.

The acceptable file formats are: bmp, gif, jpg and png.

NUM_BIN_4 ImageId

Identification code of the image file just added (output parameter).

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-2	Error while reading the image file,
-1	Error while adding the image,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

ADD_TOOL

Adds a tool at the given position.

Syntax

CALL_METHOD MenuBarObjectName ADD_TOOL MenuId Position Type ToolId ReturnCode

Parameters

NUM_BIN_2 Position

Insertion point for the new element (input parameter)

Possible values:

The position is an integer which starts at 1.

If the position is the same as for an existing tool, the new tool will take its place.

If the position is greater than the number of tool, the new tool will be placed at the end.

ALPHA(250) Type

Text of the option (input parameter)

Possible values:

_MBA_SEPARATOR	Tool of separator type.
_MBA_IMAGE	Tool of image type.
_MBA_BUTTON	Tool of button type.
_MBA_SEARCH	Tool of search type.
_MBA_MENU	Tool of menu type.

NUM_BIN_4 ToolId

Identification code of the tool (input parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-2	Incorrect Type parameter value,
-1	Incorrect Position parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

ASSOCIATE_CTX_MENU

Associates a context-sensitive menu with a tool or a menu element.

Syntax

CALL_METHOD MenuBarObjectName ASSOCIATE_CTX_MENU MenuId ToolId ElementId ReturnCode

Parameters

NUM_BIN_4 MenuId

Identification code of the context-sensitive menu (input parameter),

NUM_BIN_4 ToolId

Identification code of the tool for which the menu must be added (input parameter),

NUM_BIN_4 ElementId

Identification code of the element for which the menu must be added. This value can be _MBA_NONE (input parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-4	Tree to be copied is empty,
-3	Incorrect ElementId parameter value,
-2	Incorrect ToolId parameter value,
-1	Incorrect MenuId parameter value,
1	Operation completed successfully.

Conditions for use

None

BROWSE

Browses through all the tree elements that have been assigned a root element.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenuBarObjectName BROWSE ToolId ElementId BrowseType ElementIdArray ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code for the tool (input parameter)

NUM_BIN_4 ElementId

Identification code for the tree's root element (input parameter)

NUM_BIN_2 BrowseType

Type of browsing route taken through the tree (input parameter)

Possible values:

_MBA_BROWSE_INFIX	Elements will be browsed in infix order (the subtree whose root is the first child of ElementId will be browsed first, followed by ElementId, and lastly the subtrees whose roots are the remaining children of ElementId),
_MBA_BROWSE_PREFIX	Elements will be browsed in prefix order (ElementId will be browsed first, followed by all the subtrees whose roots are the children of ElementId),
_MBA_BROWSE_SUFFIX	Elements will be browsed in suffix order (the subtrees whose roots are the children of ElementId will be browsed first, followed by ElementId).

NUM_BIN_4(n) ElementIdArray

Array containing the results of browsing through the tree. This array contains the identification codes of the elements browsed, in the order defined by the BrowseType parameter (the size of the array must match the number of elements in the ElementId root tree) (output parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-3	Incorrect ElementIdArray array size,
-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

COPY

Copies the tree for which the root is a given element.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenuBarObjectName COPY ToolId ElementId ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter),

NUM_BIN_4 ElementId

Identification code of the root element (input parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-3	The tree to be copied is empty,
-2	Incorrect ElementId parameter value,
-1	Incorrect MenuId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

When calling the COPY (or CUT) method, the copy of the tree previously copied (if any) is destroyed.

CREATE_CTX_MENU

Creates a context-sensitive menu.

Syntax

CALL_METHOD MenuBarObjectName CREATE_CTX_MENU MenuId ReturnCode

Parameters

NUM_BIN_4 MenuId

Identification code of the created menu (input parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

0	Internal error,
1	Operation completed successfully.

Conditions for use

None

CUT

Copies the tree for which the root is a given element, then deletes it.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenuBarObjectName CUT ToolId ElementId ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter),

NUM_BIN_4 ElementId

Identification code of the root element (input parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-3	The tree to be copied is empty,
-2	Incorrect ElementId parameter value,
-1	Incorrect MenuId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

When calling the COPY (or CUT) method, the copy of the tree previously copied is destroyed (if any).

DELETE_CTX_MENU

Deletes a context-sensitive menu.

Syntax

CALL_METHOD MenuBarObjectName DELETE_CTX_MENU MenuId ReturnCode

Parameters

NUM_BIN_4 MenuId

Identification code of the context-sensitive menu (input parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-1	Incorrect MenuId parameter value,
1	Operation completed successfully.

Conditions for use

None

DELETE_CTX_MENU_OPT

Deletes an option from a context-sensitive menu.

Syntax

CALL_METHOD MenuBarObjectName DELETE_CTX_MENU_OPT MenuId MenuOptionId ReturnCode

Parameters

NUM_BIN_4 MenuId

Identification number of the parent context-sensitive menu (input parameter),

NUM_BIN_4 MenuOptionId

Identification number of the parent menu option (input parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-2	Incorrect MenuOptionId parameter value,
-1	Incorrect MenuId parameter value,
1	Operation completed successfully.

Conditions for use

None

DELETE_ELEMENT

Deletes an element.

Syntax

CALL_METHOD MenuBarObjectName DELETE_ELEMENT ToolId ElementId ReturnCode

Parameters

NUM_BIN_4 ToolId

Tool identification code (input parameter),

NUM_BIN_4 ElementId

Identification code of the element to be deleted (input parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-3	Error while deleting the element,
-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

If the ElementId parameter is set to _MBA_NONE, all the elements are deleted.

DELETE_TOOL

Deletes a tool.

Syntax

CALL_METHOD MenuBarObjectName DELETE_TOOL ToolId ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

None

GET_CHILD

Returns the child element for a given parent element.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenuBarObjectName GET_CHILD ToolId ElementId First ResultElementId ReturnCode

Parameters

NUM_BIN_4 ToolId

Tool identification code (input parameter),

NUM_BIN_4 ElementId

Element identification code (input parameter),

BOOL First

Position of the child element to be retrieved (*TRUE to retrieve the first child element, *FALSE to retrieve the last child element) (input parameter),

NUM_BIN_4 ResultElementId

Identification code of the result child element (may be set to _MBA_NONE if the element has no child) (output parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

GET_CTX_MENU_ITEM_IMAGE

Gets a context-sensitive menu option image.

Syntax

CALL_METHOD MenuBarObjectName SET_CTX_MENU_ITEM_IMAGE MenuId OptionId ImageOrImageId ReturnCode

Parameters

NUM_BIN_4 MenuId

Context-sensitive menu ID (input parameter).

NUM_BIN_4 OptionId

Menu option ID (input parameter).

Adelia ImageOrImageId variable

ID of the image associated with the menu option (output parameter).

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-3	The ImageId parameter value is incorrect.
-2	The ElementId parameter value is incorrect
-1	The ToolId parameter value is incorrect.
1	Operation completed successfully.

Conditions for use

None

GET_CTX_MENU_OPT_PROPERTY

Retrieves the value of a property of a context-sensitive menu option.

Syntax

CALL_METHOD MenuBarObjectName GET_CTX_OPT_MENU_PROPERTY MenuId MenuOptionId Property Value ReturnCode

Parameters

NUM_BIN_4 Menu Id

Identification of the context-sensitive menu (input parameter)

NUM_BIN_4 MenuOptionId

Identification of the context-sensitive menu option (input parameter)

NUM_BIN_4 Property

Identification of the property to retrieve (input parameter)

Possible values:

ALPHA(n) _ACC_TEXT	Text of the menu option.
BOOL _MBA_VISIBILITY	Defines if the menu option is visible.
BOOL _MBA_ACTIVE	Defines if the menu option is active.
BOOL _MBA_GRAYED_OUT	Defines if the menu option is grayed out.
BOOL _MBA_CHECKED	Defines if the menu option is checked.
BOOL _MBA_DEFAULT	Defines if the default menu option.

Variable of Adelia type: Value

Retrieved value (output parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-3	Incorrect Property parameter value,
-2	Incorrect MenuOptionId parameter value,
-1	Incorrect MenuId parameter value,
1	Operation completed successfully.

Conditions for use

None

GET_DEPTH

Returns the depth of a given node element. The depth of a tree whose root is the element e1 will be the length of its longest path (in terms of the number of elements) leading from e1.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenuBarObjectName GET_DEPTH ToolId ElementId Depth ReturnCode

Parameters

NUM_BIN_4 ToolId

Tool identification code (input parameter),

NUM_BIN_4 ElementId

Element identification code (input parameter),

NUM_BIN_2 Depth

Depth of the tree whose root is ElementId (output parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-3	Error while calculating the depth,
-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

GET_ELEMENT_IMAGE

Returns the image associated with a menu element.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenubarObjectName GET_ELEMENT_IMAGE ToolId ElementId ImageIdOrImage ReturnCode

Parameters

NUM_BIN_4 ToolId

Tool identification code (input parameter),

NUM_BIN_4 ElementId

Element identification code (input parameter),

Variable of Adelia type ImageIdOrImage

Identification code for the image associated with the element or the image (output parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-3	Incorrect ImageId parameter value,
-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

None

GET_ELEMENT_PROPERTY

Retrieves a property of an element.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenuBarObjectName GET_ELEMENT_PROPERTY ToolId ElementId Property Value ReturnCode

Parameters

NUM_BIN_4 ToolId

Tool identification code (input parameter)

NUM_BIN_4 ElementId

Element identification code (input parameter)

NUM_BIN_4 Property

Identification of the property to be retrieved (input parameter)

Possible values:

ALPHA(n) _MBA_TEXT	Text associated with the element,
ALPHA(n) _MBA_FONT	Character font associated with the element,
NUM_BIN_4 _MBA_TEXT_COLOR	Color of the text in the element,
NUM_BIN_4 _MBA_BACKGROUND_COLOR	Background color of the element,
BOOL _MBA_DRAG_DROP	Drag and Drop permission for the element,
AssociatedVariable name _MBA_ASSOCIATED_VARIABLE	Associated variable of the element,
NUM_BIN_2 _MBA_DESCRIPTION	Description of the element.
ALPHA(n) _MBA_NOTIFICATION_TEXT	Notification badge text (available for Button and Image tools).
NUM_BIN_4 _MBA_NOTIFICATION_TEXT_COLOR	Notification badge text color (available for Button and Image tools).
NUM_BIN_4 _MBA_NOTIFICATION_BACKGROUND_COLOR	Notification badge background color (available for Button and Image tools).
BOOL _MBA_BUTTON_MENU	Displays the context-sensitive menu in button form.

Variable of Adelia type: Value

Value of the retrieved property (output parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-3	Incorrect Property parameter value,
-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

None

GET_NB_CHILDREN

Returns the number of child elements for a given node element.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenuBarObjectName GET_NB_CHILDREN ToolId ElementId Nb ReturnCode

Parameters

NUM_BIN_4 ToolId

Tool identification code (input parameter),

NUM_BIN_4 ElementId

Element identification code (input parameter),

NUM_BIN_2 Nb

Number of children for the element (output parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

GET_NEXT

Returns the sibling element immediately after a given element.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenuBarObjectName GET_NEXT ToolId ElementId ResultElementId ReturnCode

Parameters

NUM_BIN_4 ToolId

Tool identification code (input parameter),

NUM_BIN_4 ElementId

Element identification code (input parameter),

NUM_BIN_4 ResultElementId

Identification code of the result sibling element (may be set to _MBA_NONE if there is no following element) (output parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

GET_PARENT

Returns a given element's parent element.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD AcordionMenuObjectName GET_PARENT ToolId ElementId ResultElementId ReturnCode

Parameters

NUM_BIN_4 ToolId

Tool identification code (input parameter),

NUM_BIN_4 ElementId

Element identification code (input parameter),

NUM_BIN_4 ResultElementId

Identification code of the result parent element (output parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-3	Error while retrieving the parent element,
-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

GET_PREVIOUS

Returns the sibling element that precedes a given element.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenuBarObjectName GET_PREVIOUS ToolId ElementId ResultElementId ReturnCode

Parameters

NUM_BIN_4 ToolId

Tool identification code (input parameter),

NUM_BIN_4 ElementId

Element identification code (input parameter),

NUM_BIN_4 ResultElementId

Identification code of the result sibling element (may be set to _MBA_NONE if there is no previous element) (output parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

GET_TOOL_PROPERTY

Retrieves the value of a tool property.

Syntax

CALL_METHOD MenuBarObjectName GET_TOOL_PROPERTY ToolId Property Value ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter)

NUM_BIN_4 Property

Identification of the property to retrieve (input parameter)

Possible values:

NUM_BIN_4 _MBA_WIDTH	Width of the tool (available for all the tools).
Image _MBA_IMAGE	Image of the tool (available for Search, Image and Button tools).
ALPHA(n) _MBA_TEXT	Text of the tool (available for Search and Button tools).
ALPHA(n) _MBA_FONT	Text character font of the tool (available for Search and Button tools).
NUM_BIN_4 _MBA_TEXT_COLOR	Text color of the tool (available for Search and Button tools).
NUM_BIN_4 _MBA_BACKGROUND_COLOR	Background color of the tool (available for Search and Button tools).
BOOL _MBA_VISIBILITY	Visibility of the tool (available for all the tools).
BOOL _MBA_ACTIVE	Activity of the tool (available for all the tools).
ALPHA(n) _MBA_TOOLTIP_TEXT	Tooltip text (available for Button, Image and Menu tools).
ALPHA(n) _MBA_TOOLTIP_FONT	Tooltip character font (available for Button, Image and Menu tools).
NUM_BIN_4 _MBA_TOOLTIP_TEXT_COLOR	Tooltip text color (available for Button, Image and Menu tools).
NUM_BIN_4 _MBA_TOOLTIP_BACKGROUND_COLOR	Tooltip background color (available for Button, Image and Menu tools).
NUM_BIN_4 _MBA_FILTER_MIN_NB_CHARACTERS	Minimum number of characters to activate a filter (available for Search tool).
NUM_BIN_4 _MBA_MAX_HEIGHT	Maximum height of the search list (available for Search tool).
ALPHA(n) _MBA_NOTIFICATION_TEXT	Notification badge text (available for Button and Image tools).
NUM_BIN_4 _MBA_NOTIFICATION_TEXT_COLOR	Notification badge text color (available for Button and Image tools).
NUM_BIN_4 _MBA_NOTIFICATION_BACKGROUND_COLOR	Notification badge background color (available for Button and Image tools).

Variable of Adelia type: Value

Retrieved value (output parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-2	Incorrect Property parameter value,
-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

None

GET_TOOL_STYLES

Retrieves the styles of a tool.

Syntax

CALL_METHOD MenuBarObjectName GET_TOOL_STYLES ToolId Styles ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter)

NUM_BIN_4 Styles

Styles to be retrieved (input parameter)

Possible values:

_MBA_IMAGE_STYLE	Image display (available for the Button tool).
_MBA_TEXT_STYLE	Text display (available for the Button tool).
_MBA_TXT_IMG_OVERLAP_STYLE	Overlaps image with the text (available for the Button tool).
_MBA_TXT_IMG_RIGHT_STYLE	Places the image to the right of the text (available for the Button tool).
_MBA_TXT_IMG_LEFT_STYLE	Places the image to the left of the text (available for the Button tool).
_MBA_PASTE_BTN	Pastes the button to another button if the current button is to the right of the new button (available for the Button tool)
_MBA_AUTO_ADJUST_WIDTH	The width is adjusted to content automatically (available for the Button and Image tool).
_MBA_SEPARATOR_BAR_VISIBLE	Allows to show or hide the separator bar (available for the Separator tool).
_MBA_MAX_WIDTH	The tool takes all the available space (available for the Separator and Menu tools).

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

None

MODIFY_TOOL_STYLES

Modifies the styles of a tool.

Syntax

CALL_METHOD MenuBarObjectName MODIFY_TOOL_STYLES ToolId AddedStyles RemovedStyles ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter)

NUM_BIN_4 AddedStyles

Styles to be added (input parameter)

Possible values:

_MBA_IMAGE_STYLE	Image display (available for the Button tool).
_MBA_TEXT_STYLE	Text display (available for the Button tool).
_MBA_TXT_IMG_OVERLAP_STYLE	Overlaps image with the text (available for the Button tool).
_MBA_TXT_IMG_RIGHT_STYLE	Places the image to the right of the text (available for the Button tool).
_MBA_TXT_IMG_LEFT_STYLE	Places the image to the left of the text (available for the Button tool).
_MBA_PASTE_BTN	Pastes the button to another button if the current button is to the right of the new button (available for the Button tool)
_MBA_AUTO_ADJUST_WIDTH	The width is adjusted to content automatically (available for the Button and Image tool).
_MBA_SEPARATOR_BAR_VISIBLE	Allows to show or hide the separator bar (available for the Separator tool).
_MBA_MAX_WIDTH	The tool takes all the available space (available for the Separator and Menu tools).

NUM_BIN_4 RemovedStyles

Styles to be removed (input parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

None

PASTE

Pastes a tree (previously copied by calling the COPY or CUT method) at a specified position.

This method is available only for Search and Menu tools.

Syntax

CALL_METHOD MenuBarObjectName PASTE ToolId ParentId Position ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of tool (input parameter)

NUM_BIN_4 ParentId

Identification code of the related element (parent or sibling) (input parameter)

NUM_BIN_2 Position

Insertion point for the new element (input parameter)

Possible values:

_MBA_POS_BEFORE	ParentId will be a sibling element (it cannot be set to _MBA_ROOT). The element created will be added before ParentId,
_MBA_POS_AFTER	ParentId will be a sibling element (it cannot be set to _MBA_ROOT). The element created will be added after ParentId,
_MBA_POS_FIRST	ParentId will be a parent element. The element created will be added at the head of the ParentId children,
_MBA_POS_LAST	ParentId will be a parent element. The element created will be added to the end of the ParentId children.

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-4	Incorrect ParentId parameter value,
-3	Incorrect Position parameter value,
-2	No tree has been copied to the clipboard,
-1	Incorrect MenuId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

When calling the COPY (or CUT) method, the copy of the tree previously copied (if any) is destroyed.

SET_CTX_MENU_ITEM_IMAGE

Sets an image for a context-sensitive menu option. The image will appear on the left of the menu option text.

Syntax

CALL_METHOD MenuBarObjectName SET_CTX_MENU_ITEM_IMAGE MenuId OptionId ImageOrImageId Height Width ReturnCode

Parameters

NUM_BIN_4 MenuId

Menu ID (input parameter).

NUM_BIN_4 OptionId

Menu option ID (input parameter).

NUM_BIN_4 PictureId

ID of the image to associate with the menu option or _MBA_NONE to remove the image (input parameter).

NUM_BIN_4 Height

Height of the image to display (input parameter).

Possible values:

_MBA_DEFAULT_SIZE	The default height and width are applied (16 * 16 pixels).
A NUM_BIN_4 value.

NUM_BIN_4 Width

Width of the image to display (input parameter).

Possible values:

_MBA_ACTUAL_SIZE	The image is displayed with its actual size without being resized.
_MBA_DEFAULT_SIZE	The default height and width are applied (16 * 16 pixels).
A NUM_BIN_4 value.

NUM_BIN_2 ReturnCode

Operation return code (output parameter).

Possible values:

-5	The Width parameter value is incorrect.
-4	The Height parameter value is incorrect.
-3	The ImageId parameter value is incorrect.
-2	The ElementId parameter value is incorrect
-1	The ToolId parameter value is incorrect.
1	Operation completed successfully.

Conditions for use

If one of the Height or Width parameters is MBA_DEFAULT_SIZE, the image is displayed with the default size (16 pixels).

SET_CTX_MENU_OPT_PROPERTY

Defines a property for a context-sensitive menu option.

Syntax

CALL_METHOD MenuBarObjectName SET_CTX_OPT_MENU_PROPERTY MenuId MenuOptionId Property Value ReturnCode

Parameters

NUM_BIN_4 Menu Id

Identification of the context-sensitive menu (input parameter)

NUM_BIN_4 MenuOptionId

Identification of the context-sensitive menu option (input parameter)

NUM_BIN_4 Property

Identification of the property to be modified (input parameter)

Possible values:

ALPHA(n) _ACC_TEXT	Text of the menu option.
BOOL _MBA_VISIBILITY	Defines if the menu option is visible.
BOOL _MBA_ACTIVE	Defines if the menu option is active.
BOOL _MBA_GRAYED_OUT	Defines if the menu option is grayed out.
BOOL _MBA_CHECKED	Defines if the menu option is checked.
BOOL _MBA_DEFAULT	Defines if the default menu option.

Variable of Adelia type: Value

New value of the property (input parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-4	Incorrect Value parameter value,
-3	Incorrect Property parameter value,
-2	Incorrect MenuOptionId parameter value,
-1	Incorrect MenuId parameter value,
1	Operation completed successfully.

Conditions for use

None

SET_ELEMENT_IMAGE

Defines an image as being associated with a specific status of a given element. The image will appear to the left of the element's text.

Syntax

CALL_METHOD MenuBarObjectName SET_ELEMENT_IMAGE ToolId ElementId ImageIdOrImage Height Width ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter)

NUM_BIN_4 ElementId

Element identification code (input parameter)

NUM_BIN_4 ImageId

Identification code of the image associated with the element or _MBA_NONE to delete the image (input parameter)

NUM_BIN_2 Height

Height of the image to display (input parameter)

Possible values:

_MBA_ACTUAL_SIZE	The image is displayed with its actual size, no resizing is applied,
_MBA_DEFAULT_SIZE	The default height and width are applied (16 * 16 pixels).
A value of NUM_BIN_4 type

NUM_BIN_2 Width

Width of the image to display (input parameter)

Possible values:

_MBA_ACTUAL_SIZE	The image is displayed with its actual size, no resizing is applied,
_MBA_DEFAULT_SIZE	The default height and width are applied (16 * 16 pixels).
A value of NUM_BIN_4 type

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-5	Incorrect Width parameter value,
-4	Incorrect Height parameter value,
-3	Incorrect ImageId parameter value,
-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

If the value of one of the Height or Width parameters is MBA_ACTUAL_SIZE, the image is displayed with its actual size.

If one of the Height or Width parameters is set to MBA_DEFAULT_SIZE, the image is displayed with the default size (16 pixels).

SET_ELEMENT_PROPERTY

Defines a property for an element.

Syntax

CALL_METHOD MenuBarObjectName SET_ELEMENT_PROPERTY ToolId ElementId Property Value ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter)

NUM_BIN_4 ElementId

Element identification code (input parameter)

NUM_BIN_4 Property

Identification of the property to be modified (input parameter)

Possible values:

ALPHA(n) _MBA_TEXT	Text associated with the element,
ALPHA(n) _MBA_FONT	Character font associated with the element,
NUM_BIN_4 _MBA_TEXT_COLOR	Color of the text in the element,
NUM_BIN_4 _MBA_BACKGROUND_COLOR	Background color of the element,
BOOL _MBA_DRAG_DROP	Drag and Drop permission for the element,
AssociatedVariable name _MBA_ASSOCIATED_VARIABLE	Associated variable of the element,
NUM_BIN_2 _MBA_DESCRIPTION	Description of the element.
ALPHA(n) _MBA_NOTIFICATION_TEXT	Notification badge text (available for Button and Image tools).
NUM_BIN_4 _MBA_NOTIFICATION_TEXT_COLOR	Notification badge text color (available for Button and Image tools).
NUM_BIN_4 _MBA_NOTIFICATION_BACKGROUND_COLOR	Notification badge background color (available for Button and Image tools).
BOOL _MBA_BUTTON_MENU	Displays the context-sensitive menu in button form.

Variable of Adelia type: Value

New value of the property (input parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-4	Incorrect Value parameter value,
-3	Incorrect Property parameter value,
-2	Incorrect ElementId parameter value,
-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

None

SET_FOCUS

Places the focus on the object.

Syntax
CALL_METHOD MenuBarObjectName SET_FOCUS ToolId
Parameters
NUM_BIN_4 ToolId	Identification code of the tool (input parameter),
Conditions for use	None

SET_TOOL_PROPERTY

Defines a property for a tool.

Syntax

CALL_METHOD MenuBarObjectName SET_TOOL_PROPERTY ToolId Property Value ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter)

NUM_BIN_4 Property

Identification of the property to be modified (input parameter)

Possible values:

NUM_BIN_4 _MBA_WIDTH	Width of the tool (available for all the tools).
Image _MBA_IMAGE	Image of the tool (available for Search, Image and Button tools).
ALPHA(n) _MBA_TEXT	Text of the tool (available for Search and Button tools).
ALPHA(n) _MBA_FONT	Text character font of the tool (available for Search and Button tools).
NUM_BIN_4 _MBA_TEXT_COLOR	Text color of the tool (available for Search and Button tools).
NUM_BIN_4 _MBA_BACKGROUND_COLOR	Background color of the tool (available for Search and Button tools).
BOOL _MBA_VISIBILITY	Visibility of the tool (available for all the tools).
BOOL _MBA_ACTIVE	Activity of the tool (available for all the tools).
ALPHA(n) _MBA_TOOLTIP_TEXT	Tooltip text (available for Button, Image and Menu tools).
ALPHA(n) _MBA_TOOLTIP_FONT	Tooltip character font (available for Button, Image and Menu tools).
NUM_BIN_4 _MBA_TOOLTIP_TEXT_COLOR	Tooltip text color (available for Button, Image and Menu tools).
NUM_BIN_4 _MBA_TOOLTIP_BACKGROUND_COLOR	Tooltip background color (available for Button, Image and Menu tools).
NUM_BIN_4 _MBA_FILTER_MIN_NB_CHARACTERS	Minimum number of characters to activate a filter (available for Search tool).
NUM_BIN_4 _MBA_MAX_HEIGHT	Maximum height of the search list (available for Search tool).
ALPHA(n) _MBA_NOTIFICATION_TEXT	Notification badge text (available for Button and Image tools).
NUM_BIN_4 _MBA_NOTIFICATION_TEXT_COLOR	Notification badge text color (available for Button and Image tools).
NUM_BIN_4 _MBA_NOTIFICATION_BACKGROUND_COLOR	Notification badge background color (available for Button and Image tools).

Variable of Adelia type: Value

New value of the property (input parameter)

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-3	Incorrect Value parameter value,
-2	Incorrect Property parameter value,
-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

None

SET_TOOL_STYLES

Defines the styles for a tool.

Syntax

CALL_METHOD MenuBarObjectName SET_TOOL_STYLES ToolId Styles ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter)

NUM_BIN_4 Styles

Styles to be applied (input parameter)

Possible values:

_MBA_IMAGE_STYLE	Image display (available for the Button tool).
_MBA_TEXT_STYLE	Text display (available for the Button tool).
_MBA_TXT_IMG_OVERLAP_STYLE	Overlaps image with the text (available for the Button tool).
_MBA_TXT_IMG_RIGHT_STYLE	Places the image to the right of the text (available for the Button tool).
_MBA_TXT_IMG_LEFT_STYLE	Places the image to the left of the text (available for the Button tool).
_MBA_PASTE_BTN	Pastes the button to another button if the current button is to the right of the new button (available for the Button tool)
_MBA_AUTO_ADJUST_WIDTH	The width is adjusted to content automatically (available for the Button and Image tool).
_MBA_SEPARATOR_BAR_VISIBLE	Allows to show or hide the separator bar (available for the Separator tool).
_MBA_MAX_WIDTH	The tool takes all the available space (available for the Separator and Menu tools).

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

None

TOOL_HAS_STYLES

Tests whether a tool has one or more styles. The method returns the value *TRUE if the tool has all the styles in the specified combination.

Syntax

CALL_METHOD MenuBarObjectName TOOL_HAS_STYLES ToolId Styles Result ReturnCode

Parameters

NUM_BIN_4 ToolId

Identification code of the tool (input parameter)

NUM_BIN_4 Styles

Styles to be applied (input parameter)

Possible values:

_MBA_IMAGE_STYLE	Image display (available for the Button tool).
_MBA_TEXT_STYLE	Text display (available for the Button tool).
_MBA_TXT_IMG_OVERLAP_STYLE	Overlaps image with the text (available for the Button tool).
_MBA_TXT_IMG_RIGHT_STYLE	Places the image to the right of the text (available for the Button tool).
_MBA_TXT_IMG_LEFT_STYLE	Places the image to the left of the text (available for the Button tool).
_MBA_PASTE_BTN	Pastes the button to another button if the current button is to the right of the new button (available for the Button tool)
_MBA_AUTO_ADJUST_WIDTH	The width is adjusted to content automatically (available for the Button and Image tool).
_MBA_SEPARATOR_BAR_VISIBLE	Allows to show or hide the separator bar (available for the Separator tool).
_MBA_MAX_WIDTH	The tool takes all the available space (available for the Separator and Menu tools).

BOOL Result

Result of the test (output parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-1	Incorrect ToolId parameter value,
1	Operation completed successfully.

Conditions for use

None