Returns Supported Clients Sample Supported Clients Sample Supported Clients Sample Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample
Nov 25, 2023 22:48
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.
history.buttonsEnabled = true;
var status = history.buttonsEnabled;
Methods Details
back()
Navigates back in the history stack; shows the previous form (if present).
history.back();
clear()
Clear the entire history stack.
history.clear();
forward()
Navigates forward in the history stack; shows the next form (if present).
history.forward();
getCurrentIndex()
Get the current absolute index in the history stack.
var abs_index = history.getCurrentIndex();
getFormName(i)
Get the form name based on the specified absolute index in the history stack location.
Number
i
the absolute index
var name = history.getFormName(history.getCurrentIndex());
go(i)
Navigates to the relative index based on current position in the history.
Number
i
the relative index
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)
String
formName
the name of the form to remove.
var done = history.removeForm('mypreviousform');
removeIndex(index)
Removes an absolute index based history stack form item.
Number
index
the index of the form to remove.
var done = history.removeIndex(history.getCurrentIndex()+1);
size()
Returns the total size of the history stack.
var size = history.size();