You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
History is a stack of form names that were visible on the screen ordered by appearance. The first/oldest item is stored in position/index 1.
Each container (the main application window or dialogs showing forms) has its own history stack. When the History object is accessed from within scripting, the methods of the History object will work with the history stack for the active container.
Only main forms ( currentcontroller) will be stored in History, so not forms displayed in tabpanels or splitpanes.
The history has a maximum size of 10 entries. When the maximum size is reached, the oldest entries are automatically removed to make place for new entries.
Unknown macro: {table}
{column:padding=0px|width=80px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Property Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} buttonsEnabled
Set/Get the history buttons enabled.
Unknown macro: {table}
{column:padding=0px|width=80px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Method Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} back()
Navigates back in the history stack; shows the previous form (if present).
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} clear()
Clear the entire history stack.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} forward()
Navigates forward in the history stack; shows the next form (if present).
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getCurrentIndex()
Get the current absolute index in the history stack.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getFormName(i)
Get the form name based on the specified absolute index in the history stack location.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} go(i)
Navigates to the relative index based on current position in the history.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} removeForm(formName)
Removes the named form item from the history stack (and from memory) if not currently shown.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} removeIndex(index)
Removes an absolute index based history stack form item.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} size()
Returns the total size of the history stack.
Unknown macro: {table}
{column:padding=0px|width=100%}{column}
Unknown macro: {tr} Unknown macro: {th} Property Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} buttonsEnabled
Unknown macro: {tr} Unknown macro: {td} Set/Get the history buttons enabled.
Unknown macro: {tr} Unknown macro: {td} Returns
Boolean
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
history.buttonsEnabled = true;
var status = history.buttonsEnabled;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {table}
{column:padding=0px|width=100%}{column}
Unknown macro: {tr} Unknown macro: {th} Method Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} back
Unknown macro: {tr} Unknown macro: {td} Navigates back in the history stack; shows the previous form (if present).
Unknown macro: {tr} Unknown macro: {td} Returns
void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} clear
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} clear
Unknown macro: {tr} Unknown macro: {td} Clear the entire history stack.
Unknown macro: {tr} Unknown macro: {td} Returns
void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} forward
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} forward
Unknown macro: {tr} Unknown macro: {td} Navigates forward in the history stack; shows the next form (if present).
Unknown macro: {tr} Unknown macro: {td} Returns
void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getCurrentIndex
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getCurrentIndex
Unknown macro: {tr} Unknown macro: {td} Get the current absolute index in the history stack.
Unknown macro: {tr} Unknown macro: {td} Returns
Number – the current absolute index
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var abs_index = history.getCurrentIndex();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getFormName
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getFormName
Unknown macro: {span} (i)
Unknown macro: {tr} Unknown macro: {td} Get the form name based on the specified absolute index in the history stack location.
Unknown macro: {tr} Unknown macro: {td} Parameters
{Number} i – the absolute index
Unknown macro: {tr} Unknown macro: {td} Returns
String – the formName
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var name = history.getFormName(history.getCurrentIndex());
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} (i)
Unknown macro: {tr} Unknown macro: {td} Navigates to the relative index based on current position in the history.
Unknown macro: {tr} Unknown macro: {td} Parameters
{Number} i – the absolute index
Unknown macro: {tr} Unknown macro: {td} Returns
void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} removeForm
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} removeForm
Unknown macro: {span} (formName)
Unknown macro: {tr} Unknown macro: {td} Removes the named form item from the history stack (and from memory) if not currently shown.
Unknown macro: {tr} Unknown macro: {td} Parameters
{String} formName – the name of the form to remove.
Unknown macro: {tr} Unknown macro: {td} Returns
Boolean – true if successful
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var done = history.removeForm('mypreviousform');
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} removeIndex
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} removeIndex
Unknown macro: {span} (index)
Unknown macro: {tr} Unknown macro: {td} Removes an absolute index based history stack form item.
Unknown macro: {tr} Unknown macro: {td} Parameters
{Number} index – the index of the form to remove.
Unknown macro: {tr} Unknown macro: {td} Returns
Boolean – true if successful
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var done = history.removeIndex(history.getCurrentIndex()+1);
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} size
Unknown macro: {tr} Unknown macro: {td} Returns the total size of the history stack.
Unknown macro: {tr} Unknown macro: {td} Returns
Number – the size
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var size = history.size();
Unknown macro: {tr} Unknown macro: {td}