{hidden}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
{sub-section:description|text=}{sub-section}\\{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#buttonsEnabled]
Set/Get the history buttons enabled.{td}{tr}{tbody}{table}\\{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}void{td}{td}[#back]\()
Navigates back in the history stack; shows the previous form (if present).{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#clear]\()
Clear the entire history stack.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#forward]\()
Navigates forward in the history stack; shows the next form (if present).{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getCurrentIndex]\()
Get the current absolute index in the history stack.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getFormName]\(i)
Get the form name based on the specified absolute index in the history stack location.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#go]\(i)
Navigates to the relative index based on current position in the history.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#removeForm]\(formName)
Removes the named form item from the history stack (and from memory) if not currently shown.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#removeIndex]\(index)
Removes an absolute index based history stack form item.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#size]\()
Returns the total size of the history stack.{td}{tr}{tbody}{table}\\{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=EF73A297-A5A6-41BC-95B7-A2A65FEF26C0}{tr:id=name}{td}h6.buttonsEnabled{td}{tr}{tr:id=des}{td}{sub-section:EF73A297-A5A6-41BC-95B7-A2A65FEF26C0_des|text=|trigger=button}{sub-section}{sub-section:EF73A297-A5A6-41BC-95B7-A2A65FEF26C0_des|trigger=none|class=sIndent}
Cache
index
true
refresh
100d
showRefresh
true
id
doc
title
Refresh page
showDate
true
retry
Enable
servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClientservoy 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
Get the form name based on the specified absolute index in the history stack location.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:9DDD17EA-B76C-4E66-815C-07785BF7B4F1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9DDD17EA-B76C-4E66-815C-07785BF7B4F1_prs|trigger=none}i -- the absolute index
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9DDD17EA-B76C-4E66-815C-07785BF7B4F1_ret|text=|trigger=button}{sub-section}{sub-section:9DDD17EA-B76C-4E66-815C-07785BF7B4F1_ret|trigger=none|class=sIndent}[String] -- the formName{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9DDD17EA-B76C-4E66-815C-07785BF7B4F1_see|text=|trigger=button}{sub-section}{sub-section:9DDD17EA-B76C-4E66-815C-07785BF7B4F1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9DDD17EA-B76C-4E66-815C-07785BF7B4F1_see|text=|trigger=button}{sub-section}{sub-section:9DDD17EA-B76C-4E66-815C-07785BF7B4F1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9DDD17EA-B76C-4E66-815C-07785BF7B4F1_sam|text=|trigger=button}{sub-section}{sub-section:9DDD17EA-B76C-4E66-815C-07785BF7B4F1_sam|class=sIndent|trigger=none}{code:language=javascript}
var name = history.getFormName(history.getCurrentIndex());
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=71F6FB94-0124-46C1-9677-165258AE3894}{tr:id=name}{td}h6.go{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}go{span}{span:id=iets|style=float: left;}\(i){span}{td}{tr}{tr:id=des}{td}{sub-section:71F6FB94-0124-46C1-9677-165258AE3894_des|text=|trigger=button}{sub-section}{sub-section:71F6FB94-0124-46C1-9677-165258AE3894_des|trigger=none|class=sIndent}prs
Removes the named form item from the history stack (and from memory) if not currently shown.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:8B4C1AB6-64AF-45C9-A3F7-361364C2098C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8B4C1AB6-64AF-45C9-A3F7-361364C2098C_prs|trigger=none}formName -- the name of
Will return false when the form
to remove.
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:8B4C1AB6-64AF-45C9-A3F7-361364C2098C_ret|text=|trigger=button}{sub-section}{sub-section:8B4C1AB6-64AF-45C9-A3F7-361364C2098C_ret|trigger=none|class=sIndent}[Boolean] -- true if successful{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8B4C1AB6-64AF-45C9-A3F7-361364C2098C_see|text=|trigger=button}{sub-section}{sub-section:8B4C1AB6-64AF-45C9-A3F7-361364C2098C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8B4C1AB6-64AF-45C9-A3F7-361364C2098C_see|text=|trigger=button}{sub-section}{sub-section:8B4C1AB6-64AF-45C9-A3F7-361364C2098C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8B4C1AB6-64AF-45C9-A3F7-361364C2098C_sam|text=|trigger=button}{sub-section}{sub-section:8B4C1AB6-64AF-45C9-A3F7-361364C2098C_sam|class=sIndent|trigger=none}{code:language=javascript}
var done = history.removeForm('mypreviousform');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=9534EA8F-5960-4ABB-83A7-929F59FB9BC7}{tr:id=name}{td}h6.removeIndex{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}removeIndex{span}{span:id=iets|style=float: left;}\(index){span}{td}{tr}{tr:id=des}{td}{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_des|text=|trigger=button}{sub-section}{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_des|trigger=none|class=sIndent}
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)
Removes an absolute index based history stack form item.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_prs|trigger=none}index -- the index of the form to remove.
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_ret|text=|trigger=button}{sub-section}{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_ret|trigger=none|class=sIndent}[Boolean] -- true if successful{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_see|text=|trigger=button}{sub-section}{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_see|text=|trigger=button}{sub-section}{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_sam|text=|trigger=button}{sub-section}{sub-section:9534EA8F-5960-4ABB-83A7-929F59FB9BC7_sam|class=sIndent|trigger=none}{code:language=javascript}
var done = history.removeIndex(history.getCurrentIndex()+1);
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=A5E58D44-E2BF-4AE0-8F6B-20155DCD22BC}{tr:id=name}{td}h6.size{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}size{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:A5E58D44-E2BF-4AE0-8F6B-20155DCD22BC_des|text=|trigger=button}{sub-section}{sub-section:A5E58D44-E2BF-4AE0-8F6B-20155DCD22BC_des|trigger=none|class=sIndent}prs