Page History

...

Cache

...

tablecolgroupcolcolspan2width100%coltheadclass

2

Supported Clients

sWordList

SmartClient

sWordList

WebClient

sWordList

NGClient

sWordList

MobileClient

servoy sSummary

class

30%

58%

height: 30px;

3

Property Summary

index

showRefresh
true
idrefreshclass	100dservoy sReturnTypes

true

id

doc

title

Refresh page

showDate

true

retry

Table Row (tr)

style

Enable

id

servoy sReturnTypes2100%height: 30px;

Table Head (th)

colspan

Table Row (tr)

Table Cell (td)

Span

class

Span

class

Span

class

Span

class

HTML Table

Colgroup Tag

Col

width

id

12%

Col

width

Col

width

Table Head (thead)

Table Row (tr)

style

Table Head (th)

colspan

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
buttonsEnabled

Table Cell (td)

Set/Get the history buttons enabled.

HTML Table

Colgroup Tag Colwidthservoy sSummaryid12% Colwidth Colwidth30%58% Table Head (thead) Table Row (tr)styleheight: 30px; Table Head (th)colspan3Methods Summary Table Row (tr) Table Cell (td) Table Cell (td)void

Table Cell (td)
back()

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

Table Row (tr) Table Cell (td) Table Cell (td)

void

Table Cell (td)
clear()

Clear the entire history stack.

Table Row (tr) Table Cell (td) Table Cell (td)

void

Table Cell (td)
forward()

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)

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

Table Row (tr) Table Cell (td) 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)

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

Returns the total size of the history stack.

HTML Table

propertyclass Colgroup Tag Colcolspanservoy sDetailid2width100%

Col

Table Head (thead) Table Row (tr)style

height:30px

Table Head (th)colspan

2

Property Details

Table Body (tbody)idid

buttonsEnabled

Table Row (tr)

name

Table Cell (td)

buttonsEnabled

tr

id

des

Table Cell (td) Divclass

sIndent

Set/Get the history buttons enabled.

Table Row (tr)id

ret Table Cell (td)class
Returns Div Table Row (tr)idsIndentBooleantdclientsSupported Clients DivclasssIndentSmartClient,WebClient,NGClient Table Row (tr)idsam
 Table Cell (td)class
Sample DivsIdent Code Blocklanguage Table Row (tr)classjavascripthistory.buttonsEnabled = true;
var status = history.buttonsEnabled;
lastDetailRowtd&nbsp; HTML Table
functionclass Colgroup Tag Colcolspanservoy sDetail2width100%
 Col
 Table Head (thead) Table Row (tr)styleheight:30px Table Head (th)colspan2Methods Details Table Body (tbody)ididback Table Row (tr)name Table Cell (td)idback() Table Row (tr)des Table Cell (td) DivclasssIndentNavigates back in the history stack; shows the previous form (if present).tr Table Row (tr)idid prs
 Table Cell (td)
Parameters
 HTML Table
class sIndent
 
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
void
tdclientsSupported ClientsdivclasssIndentSmartClient,WebClient,NGClient,MobileClient Table Row (tr)idtdsam
Sample DivclasssIdent Code Blocklanguageclassjavascript
history.back();
 Table Row (tr)idlastDetailRow Table Cell (td)
&nbsp;
 Table Body (tbody) Table Row (tr)idclearname Table Cell (td)clear() Table Row (tr)id Table Cell (td) DivclassdessIndentClear the entire history stack. Table Row (tr)id Table Row (tr)idprs Table Cell (td)
Parameters
 HTML Table
class sIndent
 
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
void
tdclientsSupported Clients DivclasssIndentSmartClient,WebClient,NGClient,MobileClient Table Row (tr)idtdsamSampledivclass Code BlocklanguagesIdent
history.clear();
 Table Row (tr)classjavascriptidlastDetailRow Table Cell (td)
&nbsp;
 Table Body (tbody) Table Row (tr)idforwardname Table Cell (td)forward() Table Row (tr)id Divclassdes Table Cell (td)sIndentNavigates 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)idtdclientsSupported Clients DivclasssIndentSmartClient,WebClient,NGClient,MobileClient Table Row (tr)idtdsamSample Divclass Code BlocklanguagesIdent
history.forward();
 Table Row (tr)classjavascriptidlastDetailRow Table Cell (td)
&nbsp;
 Table Body (tbody) Table Row (tr)idgetCurrentIndexname Table Cell (td)idgetCurrentIndex() Table Row (tr) Table Cell (td) Divclassdes Table Row (tr)idsIndentGet the current absolute index in the history stack. Table Row (tr)
id prs
 Table Cell (td)
Parameters
 HTML Table
class sIndent
 
tdrettdReturns Div
class sIndent
Number
 Table Row (tr)id clients
sIndent the current absolute indexclientsSupported Clients DivclasssIndentSmartClient,WebClient,NGClient,MobileClient Table Row (tr)idsam
 Table Cell (td)class
Sample DivlanguagesIdent Code Block Table Row (tr)classjavascriptvar abs_index = history.getCurrentIndex();
idlastDetailRow Table Cell (td)
&nbsp;
 Table Body (tbody) Table Row (tr)idgetFormNametdnamegetFormName(i)tridclassdes Table Cell (td) DivsIndentGet the form name based on the specified absolute index in the history stack location.tridprs Table Cell (td)
Parameters HTML Tableclass Table Cell (td)
Number
 Table Cell (td)sIndent Table Cell (td)iidthe absolute index Table Row (tr)tdrettd
Returns Div
class sIndent
String
 Table Row (tr)id clients
sIndent the formNameclientsSupported Clients DivclasssIndentSmartClient,WebClient,NGClient,MobileClient Table Row (tr)idsam
 Table Cell (td)
Sample DivclasslanguagesIdent Code Block Table Row (tr)classjavascript
var name = history.getFormName(history.getCurrentIndex());
idlastDetailRow Table Cell (td)
&nbsp;
 Table Body (tbody) Table Row (tr)idgoname Table Cell (td)idgo(i) Table Row (tr)classdes Table Cell (td) DividsIndentNavigates to the relative index based on current position in the history. Table Row (tr)tdprsParameterstableclass
 Table Cell (td)
Number
 Table Cell (td)sIndent Table Cell (td)i Table Row (tr)idthe relative index Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
void
tdclientsSupported Clients DivclasssIndentSmartClient,WebClient,NGClient,MobileClient Table Row (tr)idsam
 Table Cell (td)class
Sample DivlanguagesIdent Code Block Table Row (tr)classjavascripthistory.go(-3);
idlastDetailRow Table Cell (td)
&nbsp;
 Table Body (tbody) Table Row (tr)idremoveFormtdnameidremoveForm(formName) Table Row (tr)classdes Table Cell (td) DivsIndentRemoves 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)idtdprsParameters HTML Tableclass Table Cell (td)sIndent
 Table Cell (td)
String
 Table Cell (td)formNamethe name of the form to remove. Table Row (tr)idtdretReturns DivclassidsIndentBoolean Table Row (tr) true if successfulclients
 Table Cell (td)
Supported Clients DivclasssIndentSmartClient,WebClient,NGClient,MobileClient Table Row (tr)idtdsam
Sample DivclasslanguagesIdent Code Block Table Row (tr)classjavascript
var done = history.removeForm('mypreviousform');
idlastDetailRow Table Cell (td)
&nbsp;
 Table Body (tbody) Table Row (tr)idremoveIndextdnameremoveIndex(index) Table Row (tr)idclassdes Table Cell (td) DividsIndentRemoves an absolute index based history stack form item. Table Row (tr)tdprsParameters HTML Tableclass Table Cell (td)sIndent
 Table Cell (td)
Number
 Table Cell (td)indexthe index of the form to remove. Table Row (tr)idret Table Cell (td)
Returns DivclassidsIndentBoolean Table Row (tr) true if successfulclients
 Table Cell (td)
Supported Clients DivclasssIndentSmartClient,WebClient,NGClient,MobileClient Table Row (tr)idtdsamSample DivclasslanguagesIdent Code Block Table Row (tr)classjavascript
var done = history.removeIndex(history.getCurrentIndex()+1);
idlastDetailRow Table Cell (td)
&nbsp;
 Table Body (tbody) Table Row (tr)idsizetdnamesize() Table Row (tr)idclassdes Table Cell (td) DivsIndentReturns the total size of the history stack. Table Row (tr)id prs
 Table Cell (td)Parameters
 HTML TableclassidsIndent  Table Row (tr)ret Table Cell (td)
Returns Div
class sIndent
Number
 Table Row (tr)id clients
tdsIndent the sizeclientsSupported Clients DivclasssIndentSmartClient,WebClient,NGClient,MobileClient Table Row (tr)idtdsamSample DivclasslanguagesIdent Code Block Table Row (tr)classjavascript
var size = history.size();
lastDetailRow Table Cell (td)&nbsp;

Child pages

Versions Compared

Old Version 35

New Version Current

Key

buttonsEnabled

back()

clear()

forward()

getCurrentIndex()

getFormName(i)

go(i)

removeForm(formName)

removeIndex(index)

size()