Page History

HTML Table

id
class	servoy sReturnTypes

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Supported Clients

Table Row (tr)

Table Cell (td)

Span

class	sWordList

SmartClient

Span

class	sWordList

WebClient

Span

class	sWordList

NGClient

Span

class	sWordList

MobileClient

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	12%

Col

width	30%

Col

width	58%

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	3

Property Summary

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
buttonsEnabled

Table Cell (td)
Set/Get the history buttons enabled.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	12%

Col

width	30%

Col

width	58%

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	3

Methods Summary

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
back()

Table Cell (td)
Navigates back in the history stack; shows the previous form (if present).

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
clear()

Table Cell (td)
Clear the entire history stack.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
forward()

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

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getCurrentIndex()

Table Cell (td)
Get the current absolute index in the history stack.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getFormName(i)

Table Cell (td)
Get the form name based on the specified absolute index in the history stack location.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
go(i)

Table Cell (td)
Navigates to the relative index based on current position in the history.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeForm(formName)

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeIndex(index)

Table Cell (td)
Removes an absolute index based history stack form item.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
size()

Table Cell (td)
Returns the total size of the history stack.

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height:30px

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	buttonsEnabled

Table Row (tr)

id	name

Table Cell (td)
buttonsEnabled

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set/Get the history buttons enabled.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

history.buttonsEnabled = true;
var status = history.buttonsEnabled;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height:30px

Table Head (th)

colspan	2

Methods Details

Table Body (tbody)

id	back

Table Row (tr)

id	name

Table Cell (td)
back()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Navigates back in the history stack; shows the previous form (if present).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

history.back();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	clear

Table Row (tr)

id	name

Table Cell (td)
clear()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Clear the entire history stack.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

history.clear();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	forward

Table Row (tr)

id	name

Table Cell (td)
forward()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

history.forward();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentIndex

Table Row (tr)

id	name

Table Cell (td)
getCurrentIndex()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the current absolute index in the history stack.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var abs_index = history.getCurrentIndex();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFormName

Table Row (tr)

id	name

Table Cell (td)
getFormName(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the form name based on the specified absolute index in the history stack location.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Cell (td)
Number

Table Cell (td)
i

Table Cell (td)
the absolute index

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	go

Table Row (tr)

id	name

Table Cell (td)
go(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Cell (td)
Number

Table Cell (td)
i

Table Cell (td)
the relative index

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

history.go(-3);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeForm

Table Row (tr)

id	name

Table Cell (td)
removeForm(formName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
formName

Table Cell (td)
the name of the form to remove.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeIndex

Table Row (tr)

id	name

Table Cell (td)
removeIndex(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes an absolute index based history stack form item.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Cell (td)
Number

Table Cell (td)
index

Table Cell (td)
the index of the form to remove.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	size

Table Row (tr)

id	name

Table Cell (td)
size()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the total size of the history stack.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var size = history.size();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 36

New Version 37

Key

buttonsEnabled

back()

clear()

forward()

getCurrentIndex()

getFormName(i)

go(i)

removeForm(formName)

removeIndex(index)

size()