View Source

Supported Clients

SmartClient

WebClient

NGClient

MobileClient

Property Summary

Set/Get the history buttons enabled.

Methods 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).

getCurrentIndex()

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.

removeForm(formName)

Removes the named form item from the history stack (and from memory) if not currently shown.

removeIndex(index)

Removes an absolute index based history stack form item.

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).

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

history.back();

clear()

Clear the entire history stack.

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

history.clear();

forward()

Navigates forward in the history stack; shows the next form (if present).

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

history.forward();

getCurrentIndex()

Get the current absolute index in the history stack.

Returns

the current absolute index

Supported Clients

SmartClient,WebClient,NGClient,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

i

the absolute index

Returns

the formName

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var name = history.getFormName(history.getCurrentIndex());

go(i)

Navigates to the relative index based on current position in the history.

Parameters

i

the relative index

Supported Clients

SmartClient,WebClient,NGClient,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

formName

the name of the form to remove.

Returns

true if successful

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var done = history.removeForm('mypreviousform');

removeIndex(index)

Removes an absolute index based history stack form item.

Parameters

index

the index of the form to remove.

Returns

true if successful

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var done = history.removeIndex(history.getCurrentIndex()+1);

size()

Returns the total size of the history stack.

Returns

the size

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var size = history.size();