I_BUTTON

I_BUTTON creates a button on the current page. Buttons can be used to move from page to page or to open a website.

Syntax

I_BUTTON type, text, x, y, width, height [, id [, file [, appl, [wait [, url [, enable]]]]]] [I_TOOLTIP tooltiptext]

Parameters

type: defines the type of the button:

I_PREV: displays the previous page. Disabled if the previous page does not exist. If pushed, the curr_page parameter is set to the index of the page to show (if a parameter with this name exists).

I_NEXT: displays the next page. Disabled if the next page does not exist. If pushed, the curr_page parameter is set to the index of the page to show (if a parameter with this name exists).

I_FUNCTION: sets the global variable GLOB_UI_BUTTON_ID to the value specified in id

I_LINK: opens the web site which is defined in url in the default web browser

I_EXCHANGE: if button is pressed, the parameters are exported to xml, and the file is opened in application.

I_EXEC: if button is pressed, the file is opened in application.

I_FUNCTION: if pressed, the global variable GLOB_UI_BUTTON_ID is set to the ID of the button specified in the parameter id.

text (string): defines the text on the button

x, y (integer): defines the position of the button (in pixel). Negative values can be used to make the button invisible.

width, height (integer, ≥ 0): defines width and height of the button in pixels.

id (integer, ≥ 0): unique identifier

file (string): file to open or to export

appl (string): the application with which file should be opened

wait (boolean):

0: application is started

1: the global variable GLOB_UI_BUTTON_ID is set after saving the file with the application (for handling in scripts)

2: the dialog is blocked until the application is closed.

url (string): a URL in double quotes (only if type = I_LINK)

enable (boolean):

0: button is disabled

1: button is enabled

I_TOOLTIP: defines a tooltip for the interface element (optional), for description see I_TOOLTIP.

Remarks

Each button has to be defined for every single page. The pages itself have to be defined by I_PAGE.

Example

Usable since script version 1.1 (Allplan 2012-1).