History
(history)
Properties Summarized
Type | Name | Summary |
---|---|---|
Set/Get the history buttons enabled. |
Methods Summarized
Type | Name | Summary |
---|---|---|
void | Navigates back in the history stack; shows the previous form (if present). | |
void | Clear the entire history stack. | |
void | Navigates forward in the history stack; shows the next form (if present). | |
Get the current absolute index in the history stack. | ||
Get the form name based on the specified absolute index in the history stack location. | ||
void | Navigates to the relative index based on current position in the history. | |
Removes the named form item from the history stack (and from memory) if not currently shown. | ||
Removes an absolute index based history stack form item. | ||
Returns the total size of the history stack. |
Properties Detailed
buttonsEnabled
Set/Get the history buttons enabled.
Type Boolean
Sample
Methods Detailed
back()
Navigates back in the history stack; shows the previous form (if present).
Returns: void
Sample
clear()
Clear the entire history stack.
Returns: void
Sample
forward()
Navigates forward in the history stack; shows the next form (if present).
Returns: void
Sample
getCurrentIndex()
Get the current absolute index in the history stack.
Returns: Number the current absolute index
Sample
getFormName(i)
Get the form name based on the specified absolute index in the history stack location.
Parameters
Number i the absolute index
Returns: String the formName
Sample
go(i)
Navigates to the relative index based on current position in the history.
Parameters
Number i the relative index
Returns: void
Sample
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
String formName the name of the form to remove.
Returns: Boolean true if successful
Sample
removeIndex(index)
Removes an absolute index based history stack form item.
Parameters
Number index the index of the form to remove.
Returns: Boolean true if successful
Sample
size()
Returns the total size of the history stack.
Returns: Number the size
Sample
Last updated