Child pages
  • JSMethod

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Divcache
Div
iddescription
HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
String
Table Cell (td)code
styleindexdisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable
id

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

Table Cell (td)
Boolean
Table Cell (td)showInMenu
servoy sSummary12%30%58%height: 30px;3Property SummaryThe full source code of this method (including doc and function declaration). Table Row (tr)Flag that tells if the method appears or not in the "Methods" menu of Servoy Client. HTML Table

classservoy sSummary

Colgroup Tag
Col
width80px
Col
Table Head (thead) Table Row (tr)style Table Row (tr)
Table Cell (td)
Object[]
Table Cell (td)getArguments()
servoy sSummary12%30%58%height: 30px;
Table Head (th)
colspan2
Method Summary
3Methods SummaryGets the argument array for this method if that is set for the specific action this method is taken from. Table Row (tr)
Table Cell (td)
String
Table Cell (td)getName()
The name of the method. Table Row (tr)
Table Cell (td)
String
Table Cell (td)getScopeName()
Table Cell (td)getUUID()
Get scope name Table Row (tr)
Table Cell (td)
UUID
Returns the UUID of the method objecttable

id

propertyclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col
Table Head (thead) Table Row (tr)styleheight:30px; Table Head (th)colspan2Property Details Table Body (tbody)ididcode Table Row (tr)name

Table Cell (td)

code

Table Row (tr)id

des Table Cell (td) DivclasssIndentThe full source code of this method (including doc and function declaration). Table Row (tr)idtdret

Returns

Divclass
Table Row (tr)
idname
Table Cell (td)

showInMenu

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent

sIndentString

Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var method = form.newMethod('function original() { application.output("Original function."); }');
application.output('original method name: ' + method.getName());
application.output('original method code: ' + method.code);
method.code = 'function changed() { application.output("This is another function."); }';
method.showInMenu = false;
var button = form.newButton('Click me!', 10, 10, 100, 30, method);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowInMenu
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow 
showInMenuname

showInMenu

dessIndentFlag that tells if the method appears or not in the "Methods" menu of Servoy Client.
Table Row (tr)idret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
Boolean Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var method = form.newMethod('function original() { application.output("Original function."); }');
application.output('original method name: ' + method.getName());
application.output('original method code: ' + method.code);
method.code = 'function changed() { application.output("This is another function."); }';
method.showInMenu = false;
var button = form.newButton('Click me!', 10, 10, 100, 30, method);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idgetArguments
Table Row (tr)
idname
Table Cell (td)

getArguments

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object[]
Span
stylefont-weight: bold;
getArguments
Span
()
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIdentjavascriptlastDetailRow 

functionservoy sDetail2100%height:30px2Methods DetailsgetArgumentsname

getArguments()

dessIndentGets the argument array for this method if that is set for the specific action this method is taken from.

Will return null by default. This is only for reading, you can't alter the arguments through this array,
Table Row (tr)id for that you need to create a new object through solutionModel.wrapMethodWithArguments(..) and assign it again.ret

Table Cell (td)

Returns

div Table Body (tbody)
idgetName
Table Row (tr)
idname
Table Cell (td)

getName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getName
Span
()
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIndentclients

classsIndent
Object[] - Array of the arguments, null if not specified.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
var button = frm.getButton("button");
// get the arguments from the button.
// NOTE: string arguments will be returned with quotes (comp.onAction.getArguments()[0] == '\'foo\' evals to true)
var arguments = button.onAction.getArguments();
if (arguments && arguments.length > 1 && arguments[1] == 10) {
	// change the value and assign it back to the onAction.
	arguments[1] = 50;
	button.onAction = solutionModel.wrapMethodWithArguments(button.onAction,arguments);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow 
getNamename

getName()

dessIndentThe name of the method.
Table Row (tr)idtdret

Returns

Divclass
Table Body (tbody)
idgetScopeName
Table Row (tr)
idname
Table Cell (td)

getScopeName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getScopeName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get scope name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var methods = solutionModel.getGlobalMethods();
for (var x in methods)
	application.output(methods[x].getName() + ' is defined in scope ' + methods[x].getScopeName());
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetUUID
Table Row (tr)
idname
Table Cell (td)

getUUID

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
UUID
Span
stylefont-weight: bold;
getUUID
Span
()
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent

sIndentString - A String holding the name of this method.

Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var method = form.newMethod('function original() { application.output("Original function."); }');
application.output('original method name: ' + method.getName());
application.output('original method code: ' + method.code);
method.code = 'function changed() { application.output("This is another function."); }';
method.showInMenu = false;
var button = form.newButton('Click me!', 10, 10, 100, 30, method);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow 
getScopeNamename

getScopeName()

dessIndentGet scope nameret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow 
getUUIDname

getUUID()

dessIndentReturns the UUID of the method object
Table Row (tr)idtdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
UUID Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td) SmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var method = form.newMethod('function original() { application.output("Original function."); }');
application.output(method.getUUID().toString());
sIdentjavascriptlastDetailRow