Methods of the ACCORDION MENU Object

ADD_CTX_MENU_OPT

Adds an option to a context-sensitive menu.

Syntax

CALL_METHOD AccordionMenuObjectName ADD_CTX_MENU_OPT MenuId MenuOptionId Position Text ImageId Style NewMenuOptionId ReturnCode

Parameters

NUM_BIN_4 MenuId

Parent context-sensitive menu ID (input parameter).

NUM_BIN_4 MenuId

Parent menu option ID or _ACC_ROOT (input parameter).

NUM_BIN_2 Position

New element position (input parameter).

Possible values:

_ACC_POS_BEFORE	ParentId will be a sibling element (it cannot be set to _ACC_ROOT). The element created will be added before ParentId.
_ACC_POS_AFTER	ParentId will be a sibling element (it cannot be set to _ACC_ROOT). The element created will be added after ParentId.
_ACC_POS_FIRST	ParentId will be a parent element. The element created will be added at the head of the ParentId child elements.
_ACC_POSS_LAST	ParentId will be a parent element. The element created will be added to the end of the ParentId child elements.

ALPHA(250) Text

Option text (input parameter).

NUM_BIN_4 IdPicture

ID of the image to associate with the element or _ACC_NONE if there is no image (input parameter).

NUM_BIN_4 Style

Style to apply (input parameter)

Possible values:

_ACC_SIMPLE	Simple text menu option
_ACC_SEPARATOR	Separation menu option.

NUM_BIN_4 NewMenuOptionId

Created menu option ID (output parameter).

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-4	The Text parameter value is incorrect.
-3	The Position parameter value is incorrect.
-2	The MenuOptionId parameter value is incorrect.
-1	The MenuId parameter value is incorrect.
1	Operation completed successfully.

Conditions for use

None

ADD_ELEMENT

Adds an element to the tree view.

Syntax

CALL_METHOD AccordionMenuObjectName ADD_ELEMENT ParentId Position Text ElementId ReturnCode

Parameters

NUM_BIN_4 ParentId

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

Possible values:

_ACC_ROOT	Root of the tree,
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:

_ACC_POS_BEFORE	ParentId will be a sibling element (it cannot be set to _TRV_ROOT). The element created will be added before ParentId,
_ACC_POS_AFTER	ParentId will be a sibling element (it cannot be set to _TRV_ROOT). The element created will be added after ParentId,
_ACC_POS_FIRST	ParentId will be a parent element. The element created will be added at the head of the ParentId child elements,
_ACC_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 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:

-4	Error creating the element,
-3	Incorrect Text parameter value,
-2	Incorrect Position parameter value,
-1	Incorrect ParentId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

ADD_IMAGE

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

Syntax

CALL_METHOD AccordionMenuObjectName 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_IMAGE_FROM_URL

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

Syntax
CALL_METHOD AccordionMenuObjectName ADD_IMAGE_FROM_URL UrlAddress ImageId ReturnCode
Parameters
ALPHA (500) UrlAddress	URL address specifying the Image file. Input parameter. The following image file extensions are supported: bmp, cut, emf, eps, ico, gif, iff, jpg, jp2, mng, pbm, pcx, pgm, png, ppm, psp, tif, tga, wmf.
NUM_BIN_4 ImageId	The ID of the added image (output parameter).
NUM_BIN_4 ReturnCode	Return code for the operation (output parameter). Possible values: 1: Operation completed successfully.

ASSOCIATE_CTX_MENU

Associates a context-sensitive menu with a tree view element.

Syntax

CALL_METHOD AccordionMenuObjectName ASSOCIATE_CTX_MENU MenuId ElementId ReturnCode

Parameters

NUM_BIN_4 MenuId

Context-sensitive menu ID (input parameter)

NUM_BIN_4 ElementId

ID of the element where the menu needs to be added (input parameter).

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-4	The tree to be copied is empty.
-3	The ElementId parameter value is incorrect
-2	The ElementId parameter value is incorrect
-1	The MenuId parameter value is incorrect.
1	Operation completed successfully.

Conditions for use

None

BROWSE

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

Syntax

CALL_METHOD AccordionMenuObjectName BROWSE ElementId BrowseType ElementIdArray ReturnCode

Parameters

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:

_ACC_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),
_ACC_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),
_ACC_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:

-2	Incorrect ElementIdArray array size,
-1	Incorrect ElementId 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.

Syntax

CALL_METHOD AccordionMenuObjectName COPY ElementId ReturnCode

Parameters

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:

-2	The tree to be copied is empty,
-1	Incorrect ElementId 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 AccordionMenuObjectName CREATE_CTX_MENU MenuId ReturnCode

Parameters

NUM_BIN_4 MenuId

Created menu ID (output 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.

Syntax

CALL_METHOD AccordionMenuObjectName CUT ElementId ReturnCode

Parameters

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:

-2	The tree to be cut is empty,
-1	Incorrect ElementId 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 AccordionMenuObjectName DELETE_CTX_MENU MenuId ReturnCode

Parameters

NUM_BIN_ MenuId

ID of the menu to delete (output parameter).

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-1	The MenuId parameter value is incorrect.
1	Operation completed successfully.

Conditions for use

None

DELETE_CTX_MENU_OPT

Deletes an option from a context-sensitive menu.

Syntax

CALL_METHOD AccordionMenuObjectName DELETE_CTX_MENU_OPT MenuId MenuOptionId ReturnCode

Parameters

NUM_BIN_4 MenuId

Parent context-sensitive menu ID (input parameter).

NUM_BIN_4 MenuId

Parent context-sensitive menu option ID (input parameter).

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-2	The MenuOptionId parameter value is incorrect.
-1	The MenuId parameter value is incorrect.
1	Operation completed successfully.

Conditions for use

None

DELETE_ELEMENT

Deletes an element.

Syntax

CALL_METHOD AccordionMenuObjectName DELETE_ELEMENT ElementId ReturnCode

Parameters

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:

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

Conditions for use

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

EXPAND

Expands or collapses a given node element.

Syntax

CALL_METHOD AccordionMenuObjectName EXPAND ElementId Expands ReturnCode

Parameters

NUM_BIN_4 ElementId

Element identification code (input parameter),

BOOL Expands

*TRUE for expand, *FALSE for collapse (input parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-2	Error expanding/collapsing the element,
-1	Incorrect ElementId parameter value,
0	Internal error,
1	Operation completed successfully.

Conditions for use

None

GET_CHILD

Returns the child element for a given parent element.

Syntax

CALL_METHOD AccordionMenuObjectName GET_CHILD ElementId First ResultElementId ReturnCode

Parameters

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 _ACC_NONE if the element has no child) (output parameter),

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

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

Conditions for use

None

GET_CTX_MENU_OPT_PROPERTY

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

Syntax

CALL_METHOD AccordionMenuObjectName GET_CTX_MENU_OPT_PROPERTY MenuId MenuOptionId Property Value ReturnCode

Parameters

NUM_BIN_4 MenuId

Context-sensitive menu ID (input parameter).

NUM_BIN_4 MenuId

Context-sensitive menu option ID (input parameter).

NUM_BIN_4 Property

ID of the property to retrieve (input parameter).

Possible values:

ALPHA(n) _ACC_TEXT	Menu option text.
BOOL _ACC_VISIBILITY	Defines if the menu option is visible.
BOOL _ACC_ACTIVITY	Defines if the menu option is active.
BOOL _ACC_GRAYED	Defines if the menu option is grayed out.
BOOL _ACC_CHECKED	Defines if the menu option is checked.
BOOL _ACC_DEFAULT	Defines the default menu option.

Adelia variable: Value

Retrieved value (input parameter).

NUM_BIN_2 ReturnCode

Operation return code (output parameter).

Possible values:

-3	The Property parameter value is incorrect.
-2	The MenuOptionId parameter value is incorrect.
-1	The MenuId parameter value is incorrect.
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.

Syntax

CALL_METHOD AccordionMenuObjectName GET_DEPTH ElementId Depth ReturnCode

Parameters

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:

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

Conditions for use

None

GET_ELEMENT_IMAGE

Returns the image associated with a specific status for a given element.

Syntax

CALL_METHOD AccordionMenuObjectName GET_ELEMENT_IMAGE ElementId Status ImageIdOrImage ReturnCode

Parameters

NUM_BIN_4 ElementId

Element identification code (input parameter)

NUM_BIN_2 Status

Status for the element (input parameter)

Possible values:

_ACC_STATUS_SELECTED	The element has been selected,
_ACC_STATUS_NOT_SELECTED	The element is not selected,
_ACC_STATUS_COLLAPSED	The element is contracted,
_ACC_STATUS_EXPANDED	The element is expanded.
_ACC_STATUS_ALL	Gathers the different statuses previously described.

Variable of Adelia type ImageIdOrImage

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

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter)

Possible values:

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

Conditions for use

None

GET_ELEMENT_PROPERTY

Retrieves a property of an element.

Syntax

CALL_METHOD AccordionMenuObjectName GET_ELEMENT_PROPERTY ElementId Property Value ReturnCode

Parameters

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) _ACC_TEXT	Text associated with the element,
ALPHA(n) _ACC_FONT	Character font associated with the element,
NUM_BIN_4 _ACC_TEXT_COLOR	Color of the text in the element,
NUM_BIN_4 _ACC_BACKGROUND_COLOR	Background color of the element,
BOOL _ACC_DRAG_DROP	Drag and Drop permission for the element,
AssociatedVariable name _ACC_ASSOCIATED_VARIABLE	Associated variable of the element,
NUM_BIN_2 _ACC_DESCRIPTION	Description of the element.

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:

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

Conditions for use

None

GET_NB_CHILDREN

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

Syntax

CALL_METHOD AccordionMenuObjectName GET_NB_CHILDREN ElementId Nb ReturnCode

Parameters

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:

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

Conditions for use

None

GET_NEXT

Returns the sibling element immediately after a given element.

Syntax

CALL_METHOD AccordionMenuObjectName GET_NEXT ElementId ResultElementId ReturnCode

Parameters

NUM_BIN_4 ElementId

Element identification code (input parameter),

NUM_BIN_4 ResultElementId

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

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

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

Conditions for use

None

GET_PARENT

Returns a given element's parent element.

Syntax

CALL_METHOD AcordionMenuObjectName GET_PARENT ElementId ResultElementId ReturnCode

Parameters

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:

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

Conditions for use

None

GET_PREVIOUS

Returns the sibling element that precedes a given element.

Syntax

CALL_METHOD AccordionMenuObjectName GET_PREVIOUS ElementId ResultElementId ReturnCode

Parameters

NUM_BIN_4 ElementId

Element identification code (input parameter),

NUM_BIN_4 ResultElementId

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

NUM_BIN_2 ReturnCode

Return code for the operation (output parameter).

Possible values:

-1	Incorrect ElementId parameter value,
0	Internal error,
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.

Syntax

CALL_METHOD AccordionMenuObjectName PASTE ParentId Position ReturnCode

Parameters

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:

_ACC_POS_BEFORE	ParentId will be a sibling element (it cannot be set to _ACC_ROOT). The element created will be added before ParentId,
_ACC_POS_AFTER	ParentId will be a sibling element (it cannot be set to _ACC_ROOT). The element created will be added after ParentId,
_ACC_POS_FIRST	ParentId will be a parent element. The element created will be added at the head of the ParentId children,
_ACC_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:

-3	Incorrect ParentId parameter value,
-2	Incorrect Position parameter value,
-1	No tree has been copied to the clipboard,
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_OPT_PROPERTY

Sets a property for a context-sensitive menu option.

Syntax

CALL_METHOD AccordionMenuObjectName SET_CTX_MENU_OPT_PROPERTY MenuId MenuOptionId Property Value ReturnCode

Parameters

NUM_BIN_4 MenuId

Context-sensitive menu ID (input parameter).

NUM_BIN_4 MenuId

Context-sensitive menu option ID (input parameter).

NUM_BIN_4 Property

ID of the property to modify (input parameter).

Possible values:

ALPHA(n) _ACC_TEXT	Menu option text.
BOOL _ACC_VISIBILITY	Defines if the menu option is visible.
BOOL _ACC_ACTIVITY	Defines if the menu option is active.
BOOL _ACC_GRAYED	Defines if the menu option is grayed out.
BOOL _ACC_CHECKED	Defines if the menu option is checked.
BOOL _ACC_DEFAULT	Defines the default menu option.

Adelia variable: Value

New property value (input parameter).

NUM_BIN_2 ReturnCode

Operation return code (output parameter).

Possible values:

-4	The Value parameter value is incorrect.
-3	The Property parameter value is incorrect.
-2	The MenuOptionId parameter value is incorrect.
-1	The MenuId parameter value is incorrect.
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 when it is in the specified status.

Syntax

CALL_METHOD AccordionMenuObjectName SET_ELEMENT_IMAGE ElementId ImageId Status Height Width ReturnCode

Parameters

NUM_BIN_4 ElementId

Element identification code (input parameter)

NUM_BIN_4 ImageId

Identification code of the image associated with the element (input parameter)

NUM_BIN_2 Status

Element status (input parameter)

Possible values:

_ACC_STATUS_SELECTED	The element has been selected,
_ACC_STATUS_NOT_SELECTED	The element is not selected,
_ACC_STATUS_COLLAPSED	The element is contracted,
_ACC_STATUS_EXPANDED	The element is expanded,
_ACC_ALL_STATUSES	Gathers all statuses previously described.

The order of priority of the various states (in ascending order) for a given element is:

_ACC_STATUS_NOT_SELECTED, _ACC_STATUS_EXPANDED, _ACC_STATUS_COLLAPSED, _ACC_STATUS_SELECTED.

NUM_BIN_2 Height

Height of the image to display (input parameter)

Possible values:

_ACC_ACTUAL_SIZE	The image is displayed with its actual size, no resizing is applied,
_ACC_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:

_ACC_ACTUAL_SIZE	The image is displayed with its actual size, no resizing is applied,
_ACC_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 Status parameter value,
-2	Incorrect ImageId parameter value,
-1	Incorrect ElementId parameter value,
1	Operation completed successfully.

Conditions for use

If the value of the ElementId parameter is _ACC_NONE, the image currently set for the element is deleted.

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

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

SET_ELEMENT_PROPERTY

Defines a property for an element.

Syntax

CALL_METHOD AccordionMenuObjectName SET_ELEMENT_PROPERTY ElementId Property Value ReturnCode

Parameters

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) _ACC_TEXT	Text associated with the element,
ALPHA(n) _ACC_FONT	Character font associated with the element,
NUM_BIN_4 _ACC_TEXT_COLOR	Color of the text in the element,
NUM_BIN_4 _ACC_BACKGROUND_COLOR	Background color of the element,
BOOL _ACC_DRAG_DROP	Drag and Drop permission for the element,
AssociatedVariable name _ACC_ASSOCIATED_VARIABLE	Associated variable of the element,
NUM_BIN_2 _ACC_DESCRIPTION	Description of the element.

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 ElementId parameter value,
1	Operation completed successfully.

Conditions for use

None

SET_FOCUS

Places the focus on the object.

Syntax
CALL_METHOD AccordionMenuObjectName SET_FOCUS
Conditions for use	None