Child pages
  • Function

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{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:id=|class=servoy sSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[Function]{td}{td}[#constructor] Specifies the function that creates an object's prototype.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#length] Specifies the number of arguments expected by the function.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}void{td}{td}[#apply]\() Applies the method of another object in the context of a different object (the calling object); arguments can be passed as an Array object.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#bind]\() Creates a new function which, when called, itself calls this function in the context of the provided value, with a given sequence of arguments preceding any provided when the new function was called.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#call]\() Calls (executes) a method of another object in the context of a different object (the calling object); arguments can be passed as they are.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#toString]\() Returns a string representing the source code of the function.{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=constructor|class=node}{tr:id=name}{td}h6.constructor{td}{tr}{tr:id=des}{td}{sub-section:constructor_des|text=|trigger=button}{sub-section}{sub-section:constructor_des|trigger=none|class=sIndent}
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Property SummarySpecifies the function that creates an object's prototype.Specifies the number of arguments expected by the function.

servoy sSummary12%30%58%height: 30px;3Methods SummaryvoidApplies the method of another object in the context of a different object (the calling object); arguments can be passed as an Array object.voidCreates a new function which, when called, itself calls this function in the context of the provided value, with a given sequence of arguments preceding any provided when the new function was called.voidCalls (executes) a method of another object in the context of a different object (the calling object); arguments can be passed as they are.Returns a string representing the source code of the function.

propertyservoy sDetail2100%height:30px2Property Detailsconstructorname

constructor

dessIndent
Specifies the function that creates an object's prototype.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:constructor_snc|text=|trigger=button}{sub-section}{sub-section:constructor_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:constructor_prs|text=|trigger=button}{sub-section}{sub-section:constructor_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:constructor_ret|text=|trigger=button}{sub-section}{sub-section:constructor_ret|trigger=none|class=sIndent}[Function]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:constructor_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:constructor_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:constructor_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:constructor_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:constructor_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:constructor_sam|trigger=none}{code:language=javascript} function Tree(name) { this.name = name; } theTree = new Tree("Redwood"); console.log("theTree.constructor is " + theTree.constructor); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=length|class=node}{tr:id=name}{td}h6.length{td}{tr}{tr:id=des}{td}{sub-section:length_des|text=|trigger=button}{sub-section}{sub-section:length_des|trigger=none|class=sIndent}
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowlengthname

length

dessIndent
Specifies the number of arguments expected by the function.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:length_snc|text=|trigger=button}{sub-section}{sub-section:length_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:length_prs|text=|trigger=button}{sub-section}{sub-section:length_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:length_ret|text=|trigger=button}{sub-section}{sub-section:length_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:length_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:length_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:length_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:length_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:length_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:length_sam|trigger=none}{code:language=javascript} function addNumbers(x, y){ if (addNumbers.length == 2) { return (x + y); } else return 0; } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=apply|class=node}{tr:id=name}{td}h6.apply{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}apply{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:apply_des|text=|trigger=button}{sub-section}{sub-section:apply_des|trigger=none|class=sIndent}
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods Detailsapplyname

apply()

dessIndent
Applies the method of another object in the context of a different object (the calling object); arguments can be passed as an Array object.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:apply_snc|text=|trigger=button}{sub-section}{sub-section:apply_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:apply_prs|text=|trigger=button}{sub-section}{sub-section:apply_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:apply_ret|text=|trigger=button}{sub-section}{sub-section:apply_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:apply_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:apply_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:apply_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:apply_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:apply_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:apply_sam|trigger=none}{code:language=javascript} function book(name, author) { this.name = name; this.author = author; } function book_with_topic(name, author, topic) { this.topic = topic; book.apply(this, arguments); } book_with_topic.prototype = new book(); var aBook = new book_with_topic("name","author","topic"); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=bind|class=node}{tr:id=name}{td}h6.bind{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}bind{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:bind_des|text=|trigger=button}{sub-section}{sub-section:bind_des|trigger=none|class=sIndent}
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowbindname

bind()

dessIndent
Creates a new function which, when called, itself calls this function in the context of the provided value, with a given sequence of arguments preceding any provided when the new function was called.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:bind_snc|text=|trigger=button}{sub-section}{sub-section:bind_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:bind_prs|text=|trigger=button}{sub-section}{sub-section:bind_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:bind_ret|text=|trigger=button}{sub-section}{sub-section:bind_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:bind_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:bind_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:bind_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:bind_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:bind_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:bind_sam|trigger=none}{code:language=javascript} var x = 9, module = { getX: function() { return this.x; }, x: 81 }; // "module.getX()" called, "module" is "this", "module.x" is returned module.getX(); // > 81 // "getX()" called, "this" is global, "x" is returned getX(); // > 9 // store a reference with "module" bound as "this" var boundGetX = getX.bind(module); // "boundGetX()" called, "module" is "this" again, "module.x" is returned boundGetX(); // > 81 {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=call|class=node}{tr:id=name}{td}h6.call{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}call{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:call_des|text=|trigger=button}{sub-section}{sub-section:call_des|trigger=none|class=sIndent}
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowcallname

call()

dessIndent
Calls (executes) a method of another object in the context of a different object (the calling object); arguments can be passed as they are.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:call_snc|text=|trigger=button}{sub-section}{sub-section:call_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:call_prs|text=|trigger=button}{sub-section}{sub-section:call_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:call_ret|text=|trigger=button}{sub-section}{sub-section:call_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:call_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:call_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:call_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:call_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:call_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:call_sam|trigger=none}{code:language=javascript} function book(name) { this.name = name; } function book_with_author(name, author) { this.author = author; book.call(this, name); } book_with_author.prototype = new book(); var aBook = new book_with_author("name","author"); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=toString|class=node}{tr:id=name}{td}h6.toString{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}toString{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:toString_des|text=|trigger=button}{sub-section}{sub-section:toString_des|trigger=none|class=sIndent}
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowtoStringname

toString()

dessIndent
Returns a string representing the source code of the function. Overrides the Object.toString method.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:toString_snc|text=|trigger=button}{sub-section}{sub-section:toString_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:toString_prs|text=|trigger=button}{sub-section}{sub-section:toString_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:toString_ret|text=|trigger=button}{sub-section}{sub-section:toString_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:toString_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:toString_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:toString_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:toString_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:toString_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:toString_sam|trigger=none}{code:language=javascript} function printHello() { return "Hello"; } application.output(printHello.toString()); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow