Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Property SummarySet/Get the history buttons enabled.

servoy sSummary12%30%58%height: 30px;3Methods SummaryvoidNavigates back in the history stack; shows the previous form (if present).voidClear the entire history stack.voidNavigates 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.voidNavigates 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.

propertyservoy sDetail2100%height:30px2Property DetailsbuttonsEnabledname

buttonsEnabled

dessIndent
Set/Get the history buttons enabled.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods Detailsbackname

back()

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

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowclearname

clear()

dessIndent
Clear the entire history stack.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
forwardname

forward()

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

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getCurrentIndexname

getCurrentIndex()

dessIndent
Get the current absolute index in the history stack.
ret

Returns

sIndent the current absolute index
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormNamename

getFormName(i)

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

Parameters

sIndentithe absolute index
ret

Returns

sIndent the formName
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
goname

go(i)

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

Parameters

sIndentithe relative index
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
removeFormname

removeForm(formName)

dessIndent
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)
prs

Parameters

sIndentformNamethe name of the form to remove.
ret

Returns

sIndent true if successful
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
removeIndexname

removeIndex(index)

dessIndent
Removes an absolute index based history stack form item.
prs

Parameters

sIndentindexthe index of the form to remove.
ret

Returns

sIndent true if successful
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
sizename

size()

dessIndent
Returns the total size of the history stack.
ret

Returns

sIndent the size
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow