Supported Clients | |
---|---|
SmartClient WebClient NGClient MobileClient |
Property Summary | ||
---|---|---|
Boolean | buttonsEnabled | Set/Get the history buttons enabled. |
Methods Summary | ||
---|---|---|
void | back() | Navigates back in the history stack; shows the previous form (if present). |
void | clear() | Clear the entire history stack. |
void | forward() | Navigates forward in the history stack; shows the next form (if present). |
Number | getCurrentIndex() | Get the current absolute index in the history stack. |
String | getFormName(i) | Get the form name based on the specified absolute index in the history stack location. |
void | go(i) | Navigates to the relative index based on current position in the history. |
Boolean | removeForm(formName) | Removes the named form item from the history stack (and from memory) if not currently shown. |
Boolean | removeIndex(index) | Removes an absolute index based history stack form item. |
Number | size() | Returns the total size of the history stack. |
Property Details | |
---|---|
buttonsEnabled |
|
Set/Get the history buttons enabled.
|
|
Returns |
|
Supported Clients SmartClient,WebClient,NGClient
|
|
Sample history.buttonsEnabled = true; var status = history.buttonsEnabled; |
|
|
Methods Details | |||
---|---|---|---|
back() |
|||
Navigates back in the history stack; shows the previous form (if present).
|
|||
Parameters |
|||
Returns |
|||
Supported Clients SmartClient,WebClient,MobileClient
|
|||
Sample history.back(); |
|||
| |||
clear() |
|||
Clear the entire history stack.
|
|||
Parameters |
|||
Returns |
|||
Supported Clients SmartClient,WebClient,MobileClient
|
|||
Sample history.clear(); |
|||
| |||
forward() |
|||
Navigates forward in the history stack; shows the next form (if present).
|
|||
Parameters |
|||
Returns |
|||
Supported Clients SmartClient,WebClient,MobileClient
|
|||
Sample history.forward(); |
|||
| |||
getCurrentIndex() |
|||
Get the current absolute index in the history stack.
|
|||
Parameters |
|||
Returns |
|||
Supported Clients SmartClient,WebClient,MobileClient
|
|||
Sample var abs_index = history.getCurrentIndex(); |
|||
| |||
getFormName(i) |
|||
Get the form name based on the specified absolute index in the history stack location.
|
|||
Parameters
|
|||
Returns |
|||
Supported Clients SmartClient,WebClient,MobileClient
|
|||
Sample var name = history.getFormName(history.getCurrentIndex()); |
|||
| |||
go(i) |
|||
Navigates to the relative index based on current position in the history.
|
|||
Parameters
|
|||
Returns |
|||
Supported Clients SmartClient,WebClient,MobileClient
|
|||
Sample history.go(-3); |
|||
| |||
removeForm(formName) |
|||
Removes the named form item from the history stack (and from memory) if not currently shown. Will return false when the form can't be removed, this can happen in certain situations: 1> The form is visible, 2> The form is executing a function (is actively used), 3> There are references to this form by a global variable/array, 4> If the form has a separate foundset with edited records that can't be saved (for example autosave is false)
|
|||
Parameters
|
|||
Returns |
|||
Supported Clients SmartClient,WebClient,NGClient,MobileClient
|
|||
Sample var done = history.removeForm('mypreviousform'); |
|||
| |||
removeIndex(index) |
|||
Removes an absolute index based history stack form item.
|
|||
Parameters
|
|||
Returns |
|||
Supported Clients SmartClient,WebClient,MobileClient
|
|||
Sample var done = history.removeIndex(history.getCurrentIndex()+1); |
|||
| |||
size() |
|||
Returns the total size of the history stack.
|
|||
Parameters |
|||
Returns |
|||
Supported Clients SmartClient,WebClient,MobileClient
|
|||
Sample var size = history.size(); |
|||
|
Overview
Content Tools
Activity