| Next revision | Previous revision |
| scripting:dialogs:button [2015/03/25 21:44] – created admin | scripting:dialogs:button [2018/01/10 20:41] (current) – external edit 127.0.0.1 |
|---|
| | **id** | empty | id (name) of the button control | | | **id** | empty | id (name) of the button control | |
| | **title** | empty | title of the control. | | | **title** | empty | title of the control. | |
| | **admin** | false | [[wp>UAC]] icon to indicate actions requiring Administrator rights. | | | **admin** | false | [[wp>User_Account_Control|UAC]] icon to indicate actions requiring Administrator rights. | |
| | **default** | false | [Indicates default button - button that is automatically executed, if user press Enter. There shall be only one //default// button on dialog for correct processing. | | | **default** | false | [Indicates default button - button that is automatically executed, if user press Enter. There shall be only one //default// button on dialog for correct processing. | |
| | **align** | stretched | [[scripting:dialogs:align|Alignment]] of the control | | | **align** | stretched | [[scripting:dialogs:align|Alignment]] of the control | |
| | **positive** | false | Indicates //positive// buttons that shall be disabled if all required fields on dialog are not filled | | | **positive** | false | Indicates //positive// buttons that shall be disabled if all required fields on dialog are not filled | |
| | **returnval** | empty | Dialog return value. There are some predefined return values as "ok" or "cancel" that lead to closing of the dialog. | | | **returnval** | empty | Dialog return value. If there is no //onclick// event is bound, dialog will be automatically closed, after button click and //returnval// is returned by [[scripting:api:application:dialog|Application.dialog(...)]].| |
| |
| ===== Events ===== | ===== Events ===== |
| ^ Event ^ Description ^ | ^ Event ^ Description ^ |
| | **[[scripting:dialogs:events:onclick|onclick]]** | event handler (function name) to be called, if button is clicked| | | **[[scripting:dialogs:events:onclick|onclick]]** | event handler (function name) to be called, if button is clicked| |
| | |
| | ===== Predefined Return Values ===== |
| | |
| | ^ ID ^ Positive ^ |
| | | //none// | false| |
| | | //cancel// | false| |
| | | //ok// | true| |
| | | //yes// | true| |
| | | //no// | false| |
| | | //abort// | false| |
| | | //retry// | true| |
| | | //continue// | true| |
| | | //close// | false| |
| | | //help// | false| |
| | | //other// | false| |
| |
| ===== Example ===== | ===== Example ===== |