Page History

HTML Table

id
class	servoy sReturnTypes

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

ALIGNMENT

Span

class	sWordList

ANCHOR

Span

class	sWordList

BEVELTYPE

Span

class	sWordList

CURSOR

Span

class	sWordList

DEFAULTS

Span

class	sWordList

DISPLAYTYPE

Span

class	sWordList

FONTSTYLE

Span

class	sWordList

JOINTYPE

Span

class	sWordList

MEDIAOPTION

Span

class	sWordList

PAGEORIENTATION

Span

class	sWordList

PARTS

Span

class	sWordList

PRINTSLIDING

Span

class	sWordList

SCROLLBAR

Span

class	sWordList

TITLEJUSTIFICATION

Span

class	sWordList

TITLEPOSITION

Span

class	sWordList

UNITS

Span

class	sWordList

ValueList

Span

class	sWordList

VARIABLETYPE

Span

class	sWordList

View

Span

class	sWordList

JSForm

Span

class	sWordList

JSDataSourceNode

Span

class	sWordList

JSBean

Span

class	sWordList

JSButton

Span

class	sWordList

JSCalculation

Span

class	sWordList

JSField

Span

class	sWordList

JSLayoutContainer

Span

class	sWordList

JSField

Span

class	sWordList

JSField

Span

class	sWordList

JSField

Span

class	sWordList

JSField

Span

class	sWordList

JSField

Span

class	sWordList

JSField

Span

class	sWordList

JSField

Span

class	sWordList

JSList

Span

class	sWordList

JSInsetList

Span

class	sWordList

JSComponent

Span

class	sWordList

JSLabel

Span

class	sWordList

JSMethod

Span

class	sWordList

JSPortal

Span

class	sWordList

JSPart

Span

class	sWordList

JSRelation

Span

class	sWordList

JSRelationItem

Span

class	sWordList

JSStyle

Span

class	sWordList

JSTabPanel

Span

class	sWordList

JSTab

Span

class	sWordList

JSMedia

Span

class	sWordList

JSValueList

Span

class	sWordList

JSVariable

Span

class	sWordList

JSPart

Span

class	sWordList

JSPart

Span

class	sWordList

JSTitle

Span

class	sWordList

JSWebComponent

HTML Table

id
class	servoy sReturnTypes

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Supported Clients

Table Row (tr)

Table Cell (td)

Span

class	sWordList

SmartClient

Span

class	sWordList

WebClient

Span

class	sWordList

NGClient

Span

class	sWordList

MobileClient

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	12%

Col

width	30%

Col

width	58%

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	3

Methods Summary

Table Row (tr)

Table Cell (td)
JSComponent

Table Cell (td)
cloneComponent(newName, component)

Table Cell (td)
Makes an exact copy of the given component (JSComponent/JSField/JSLabel) and gives it a new name.

Table Row (tr)

Table Cell (td)
JSComponent

Table Cell (td)
cloneComponent(newName, component, newParentForm)

Table Cell (td)
Makes an exact copy of the given component (JSComponent/JSField/JSLabel), gives it a new name and moves it to a new parent form, specified as a parameter.

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
cloneForm(newName, jsForm)

Table Cell (td)
Makes an exact copy of the given form and gives it the new name.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createBevelBorder(bevel_type, highlight_outer_color, highlight_inner_color, shadow_outer_color, shadow_inner_color)

Table Cell (td)
Create a bevel border string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createEmptyBorder(top_width, right_width, bottom_width, left_width)

Table Cell (td)
Create an empty border string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createEtchedBorder(bevel_type, highlight_color, shadow_color)

Table Cell (td)
Create an etched border string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createFont(name, style, size)

Table Cell (td)
Create a font string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createLineBorder(thick, color)

Table Cell (td)
Create a line border string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createMatteBorder(top_width, right_width, bottom_width, left_width, color)

Table Cell (td)
Create a matte border string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin)

Table Cell (td)
Create a page format string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation)

Table Cell (td)
Create a page format string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation, units)

Table Cell (td)
Create a page format string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createRoundedBorder(top_width, right_width, bottom_width, left_width, top_color, right_color, bottom_color, left_color, rounding_radius, border_style)

Table Cell (td)
Create a special matte border string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createSpecialMatteBorder(top_width, right_width, bottom_width, left_width, top_color, right_color, bottom_color, left_color, rounding_radius, dash_pattern)

Table Cell (td)
Create a special matte border string.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createTitledBorder(title_text, font, color, title_justification, title_position)

Table Cell (td)
Create a titled border string.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getAllRelations()

Table Cell (td)
Gets an array of all relations.

Table Row (tr)

Table Cell (td)
JSDataSourceNode

Table Cell (td)
getDataSourceNode(dataSource)

Table Cell (td)
Gets the specified data source node and returns information about the form (see JSDataSourceNode node).

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
getForm(name)

Table Cell (td)
Gets the specified form object and returns information about the form (see JSForm node).

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getForms()

Table Cell (td)
Get an array of all forms.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getForms(datasource)

Table Cell (td)
Get an array of forms, that are all based on datasource/servername.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getForms(server, tablename)

Table Cell (td)
Get an array of forms, that are all based on datasource/servername and tablename.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
getGlobalMethod(scopeName, name)

Table Cell (td)
Gets an existing global method by the specified name.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getGlobalMethods()

Table Cell (td)
The list of all global methods.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getGlobalMethods(scopeName)

Table Cell (td)
The list of all global methods.

Table Row (tr)

Table Cell (td)
JSVariable

Table Cell (td)
getGlobalVariable(scopeName, name)

Table Cell (td)
Gets an existing global variable by the specified name.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getGlobalVariables()

Table Cell (td)
Gets an array of all global variables.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getGlobalVariables(scopeName)

Table Cell (td)
Gets an array of all global variables.

Table Row (tr)

Table Cell (td)
JSMedia

Table Cell (td)
getMedia(name)

Table Cell (td)
Gets the specified media object; can be assigned to a button/label.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getMediaList()

Table Cell (td)
Gets the list of all media objects.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
getObjectByUUID(uuid)

Table Cell (td)
Retrieves an element by its uuid.

Table Row (tr)

Table Cell (td)
JSRelation

Table Cell (td)
getRelation(name)

Table Cell (td)
Gets an existing relation by the specified name and returns a JSRelation Object.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getRelations(datasource)

Table Cell (td)
Gets an array of all relations; or an array of all global relations if the specified table is NULL.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getRelations(servername, tablename)

Table Cell (td)
Gets an array of all relations; or an array of all global relations if the specified table is NULL.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getScopeNames()

Table Cell (td)
Gets an array of all scope names used.

Table Row (tr)

Table Cell (td)
JSStyle

Table Cell (td)
getStyle(name)

Table Cell (td)
Gets the style specified by the given name.

Table Row (tr)

Table Cell (td)
JSValueList

Table Cell (td)
getValueList(name)

Table Cell (td)
Gets an existing valuelist by the specified name and returns a JSValueList Object that can be assigned to a field.

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
getValueLists()

Table Cell (td)
Gets an array of all valuelists for the currently active solution.

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
newForm(name)

Table Cell (td)
Creates a new JSForm Object.

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
newForm(name, isResponsive)

Table Cell (td)
Create a responsive form:

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
newForm(name, superForm)

Table Cell (td)
Creates a new form with the given JSForm as its super form.

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
newForm(name, dataSource, isResponsive)

Table Cell (td)
Create a responsive form:

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
newForm(name, dataSource, styleName, show_in_menu, width, height)

Table Cell (td)
Creates a new JSForm Object.

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
newForm(name, serverName, tableName, styleName, show_in_menu, width, height)

Table Cell (td)
Creates a new JSForm Object.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
newGlobalMethod(scopeName, code)

Table Cell (td)
Creates a new global method with the specified code in a scope.

Table Row (tr)

Table Cell (td)
JSVariable

Table Cell (td)
newGlobalVariable(scopeName, name, type)

Table Cell (td)
Creates a new global variable with the specified name and number type.

Table Row (tr)

Table Cell (td)
JSMedia

Table Cell (td)
newMedia(name, bytes)

Table Cell (td)
Creates a new media object that can be assigned to a label or a button.

Table Row (tr)

Table Cell (td)
JSRelation

Table Cell (td)
newRelation(name, primaryDataSource, foreignDataSource, joinType)

Table Cell (td)
Creates a new JSRelation Object with a specified name; includes the primary datasource, foreign datasource and the type of join for the new relation.

Table Row (tr)

Table Cell (td)
JSStyle

Table Cell (td)
newStyle(name, content)

Table Cell (td)
Creates a new style with the given css content string under the given name.

Table Row (tr)

Table Cell (td)
JSValueList

Table Cell (td)
newValueList(name, type)

Table Cell (td)
Creates a new valuelist with the specified name and number type.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeForm(name)

Table Cell (td)
Removes the specified form during the persistent connected client session.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeGlobalMethod(scopeName, name)

Table Cell (td)
Removes the specified global method.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeGlobalVariable(scopeName, name)

Table Cell (td)
Removes the specified global variable.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeMedia(name)

Table Cell (td)
Removes the media item specified by name.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeRelation(name)

Table Cell (td)
Removes the relation specified by name.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeStyle(name)

Table Cell (td)
Removes the specified style.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeValueList(name)

Table Cell (td)
Removes the specified valuelist.

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
revertForm(name)

Table Cell (td)
Reverts the specified form to the original (blueprint) version of the form; will result in an exception error if the form is not an original form.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
wrapMethodWithArguments(method, args)

Table Cell (td)
Get a JSMethod instance with arguments to be assigned to an event.

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height:30px

Table Head (th)

colspan	2

Methods Details

Table Body (tbody)

id	cloneComponent

Table Row (tr)

id	name

Table Cell (td)
cloneComponent(newName, component)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Makes an exact copy of the given component (JSComponent/JSField/JSLabel) and gives it a new name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)
Table Cell (td)
Object

Table Cell (td)
component

Table Cell (td)
the component to clone

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSComponent

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

// get an existing field to clone.
var field = solutionModel.getForm("formWithField").getField("fieldName");
// make a clone/copy of the field
var clone = solutionModel.cloneComponent("clonedField",field);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	cloneComponent

Table Row (tr)

id	name

Table Cell (td)
cloneComponent(newName, component, newParentForm)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Makes an exact copy of the given component (JSComponent/JSField/JSLabel), gives it a new name and moves it to a new parent form, specified as a parameter.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)

Table Cell (td)

Table Row (tr)
Table Cell (td)
JSForm

Table Cell (td)
newParentForm

Table Cell (td)
the new parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSComponent

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

// get an existing field to clone.
var field = solutionModel.getForm("formWithField").getField("fieldName");
// get the target form for the copied/cloned field
var form = solutionModel.getForm("targetForm");
// make a clone/copy of the field and re parent it to the target form.
var clone = solutionModel.cloneComponent("clonedField",field,form);
// show it
forms["targetForm"].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	cloneForm

Table Row (tr)

id	name

Table Cell (td)
cloneForm(newName, jsForm)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Makes an exact copy of the given form and gives it the new name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

String JSForm

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)
jsForm

Table Cell (td)
the form to be cloned

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

// get an existing form
var form = solutionModel.getForm("existingForm")
// make a clone/copy from it
var clone = solutionModel.cloneForm("clonedForm", form)
// add a new label to the clone
clone.newLabel("added label",50,50,80,20);
// show it
forms["clonedForm"].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createBevelBorder

Table Row (tr)

id	name

Table Cell (td)
createBevelBorder(bevel_type, highlight_outer_color, highlight_inner_color, shadow_outer_color, shadow_inner_color)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a bevel border string.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)
Table Cell (td)
Number String

Table Cell (td)
shadow_inner_color

Table Cell (td)
bevel border shadow outer color

tdString

Table Row (tr)

id

ret

Table Cell (td)

Returns

td td

Div

class

Table Row (tr)

sIndent

String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createBevelBorder(SM_BEVELTYPE.RAISED,'#ff0000','#00ff00','#ff0000','#00ff00');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createEmptyBorder

Table Row (tr)

id	name

Table Cell (td)
createEmptyBorder(top_width, right_width, bottom_width, left_width)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create an empty border string.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

left_width

Table Cell (td)
left width of empty border in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createEmptyBorder(1,1,1,1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createEtchedBorder

Table Row (tr)

id	name

Table Cell (td)
createEtchedBorder(bevel_type, highlight_color, shadow_color)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create an etched border string.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
Number String

Table Cell (td)
shadow_color

Table Cell (td)
bevel border shadow color

tdString

Table Row (tr)

id

ret

Table Cell (td)

Returns

td

Div

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createEtchedBorder(SM_BEVELTYPE.RAISED,'#ff0000','#00ff00');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createFont

Table Row (tr)

id	name

Table Cell (td)
createFont(name, style, size)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a font string.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

String Number

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)
size

the font size

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
var component = form.getComponent("someComponent")
component.fontType = solutionModel.createFont('Arial',SM_FONTSTYLE.BOLD,14);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createLineBorder

Table Row (tr)

id	name

Table Cell (td)
createLineBorder(thick, color)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a line border string.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

trString

HTML Table

class	sIndent

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)
color

Table Cell (td)
color of the line border

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createLineBorder(1,'#ff0000');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createMatteBorder

Table Row (tr)

id	name

Table Cell (td)
createMatteBorder(top_width, right_width, bottom_width, left_width, color)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a matte border string.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
Number String

Table Cell (td)
color

Table Cell (td)
border color

tdNumber

Table Row (tr)

id

ret

Table Cell (td)

Returns

td tr

Div

class

sIndent

tdString Number

td

Table Row (tr)

id

clients

Table Row (tr)

id

Table Cell (td)

Supported Clients

trtd

Div

class

Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createMatteBorder(1,1,1,1,"#00ff00");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createPageFormat

Table Row (tr)

id	name

Table Cell (td)
createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a page format string. Note: The unit specified for width, height and all margins MUST be the same.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
Number

Table Cell (td)
bottommargin

Table Cell (td)
the specified bottom margin of the page to be printed.

Table Row (tr)

id	ret

Table Cell (td)

Number

Returns

td td

Div

class

sIndent

String

tdNumber

Table Row (tr)

id

clients

Table Cell (td)

Supported Clients

td

Div

Table Cell (td)
Number

Table Cell (td)

class

Table Row (tr)

sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

trtdNumber

Div

class

sIdent

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

td

Code Block

language

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

var

Code Block

language	javascript

javascript

var form = solutionModel.getForm("someForm");
form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createPageFormat

Table Row (tr)

id	name

Table Cell (td)
createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a page format string. Note: The unit specified for width, height and all margins MUST be the same.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
Number

Table Cell (td)
orientation

Table Cell (td)
the specified orientation of the page to be printed; the default is Portrait mode

tdNumber

Table Row (tr)

id

ret

Table Cell (td)

Returns

td tr

Div

class

sIndent

tdString Number

td

Table Row (tr)

id

clients

Table Cell (td)

Supported Clients

trtd

Div

class

Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

SmartClient,

Div

class	sIndent

sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createPageFormat

Table Row (tr)

id	name

Table Cell (td)
createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation, units)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a page format string. Note: The unit specified for width, height and all margins MUST be the same.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
Number

Table Cell (td)
units

Table Cell (td)
the specified units for the width and height of the page to be printed; the default is pixels

tdNumber

Table Row (tr)

id

ret

Table Cell (td)

Returns

td tr

Div

class

sIndent

tdString Number

td

Table Row (tr)

id

clients

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createRoundedBorder

Table Row (tr)

id	name

Table Cell (td)
createRoundedBorder(top_width, right_width, bottom_width, left_width, top_color, right_color, bottom_color, left_color, rounding_radius, border_style)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a special matte border string.

Table Row (tr)

id	prs

border_style

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Array

Table Row (tr)

Table Cell (td)

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)

Table Cell (td)

Table Cell (td)
the border styles for the four margins(top/left/bottom/left)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
// create a rectangle border (no rounded corners) and continous line
form.borderType = solutionModel.createSpecialMatteBorder(1,1,1,1,"#00ff00","#00ff00","#00ff00","#00ff00",0,null);
// create a border with rounded corners and dashed line (25 pixels drawn, then 25 pixels skipped)
// rounding_radius is an array of up to 8 numbers, order is: top-left,top-right,bottom-right,bottom-left (repetead twice - for width and height)
// form.borderType = solutionModel.createSpecialMatteBorder(1,1,1,1,"#00ff00","#00ff00","#00ff00","#00ff00",new Array(10,10,10,10),new Array(25,25));

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createSpecialMatteBorder

Table Row (tr)

id	name

Table Cell (td)
createSpecialMatteBorder(top_width, right_width, bottom_width, left_width, top_color, right_color, bottom_color, left_color, rounding_radius, dash_pattern)

Parameters

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a special matte border string.

Table Row (tr)

id	prs

Table Cell (td)

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

tr

Table Cell (td)

Div

class	sIndent

Create a special matte border string.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Cell (td)
Array

Table Cell (td)
dash_pattern

Table Cell (td)
the dash pattern of border stroke

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
// create a rectangle border (no rounded corners) and continous line
form.borderType = solutionModel.createSpecialMatteBorder(1,1,1,1,"#00ff00","#00ff00","#00ff00","#00ff00",0,null);
// create a border with rounded corners and dashed line (25 pixels drawn, then 25 pixels skipped)
// form.borderType = solutionModel.createSpecialMatteBorder(1,1,1,1,"#00ff00","#00ff00","#00ff00","#00ff00",10,new Array(25,25));

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createTitledBorder

Table Row (tr)

id	name

Table Cell (td)
createTitledBorder(title_text, font, color, title_justification, title_position)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a titled border string.

Number

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)
Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)
title_position

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

bevel title text position

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createTitledBorder('Test',solutionModel.createFont('Arial',SM_FONTSTYLE.PLAIN,10),'#ff0000',SM_TITLEJUSTIFICATION.CENTER,SM_TITLEPOSITION.TOP);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAllRelations

Table Row (tr)

id	name

Table Cell (td)
getAllRelations()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all relations.

Table Row (tr)

prs

id

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var relations = solutionModel.getAllRelations();
if (relations.length != 0)
	for (var i in relations)
		application.output(relations[i].name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDataSourceNode

Table Row (tr)

id	name

Table Cell (td)
getDataSourceNode(dataSource)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the specified data source node and returns information about the form (see JSDataSourceNode node). The JSDataSourceNode holds all calculations and foundset methods.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
dataSource

Table Cell (td)
table data source

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSDataSourceNode

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var dsnode = solutionModel.getDataSourceNode('db:/example_data/customers');
var c = dsnode.getCalculation("myCalculation");
application.output("Name: " + c.getName() + ", Stored: " + c.isStored());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getForm

Table Row (tr)

id	name

Table Cell (td)
getForm(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the specified form object and returns information about the form (see JSForm node).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the specified name of the form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var myForm = solutionModel.getForm('existingFormName');
//get the style of the form (for all other properties see JSForm node)
var styleName = myForm.styleName;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getForms

Table Row (tr)

id	name

Table Cell (td)
getForms()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get an array of all forms.

Parameters

Table Row (tr)

id	prs

Table Cell (td)

HTML Table

class	sIndent

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var forms = solutionModel.getForms()
for (var i in forms)
	application.output(forms[i].name)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getForms

Table Row (tr)

id	name

Table Cell (td)
getForms(datasource)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get an array of forms, that are all based on datasource/servername.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
datasource

Table Cell (td)
the datasource or servername

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var forms = solutionModel.getForms(datasource)
for (var i in forms)
	application.output(forms[i].name)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getForms

Table Row (tr)

id	name

Table Cell (td)
getForms(server, tablename)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get an array of forms, that are all based on datasource/servername and tablename.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)
Table Cell (td)
String

Table Cell (td)
tablename

Table Cell (td)
the tablename

String

Table Row (tr)
Table Cell (td)

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var forms = solutionModel.getForms(datasource,tablename)
for (var i in forms)
	application.output(forms[i].name)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalMethod

Table Row (tr)

id	name

Table Cell (td)
getGlobalMethod(scopeName, name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing global method by the specified name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the name of the specified global method

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var method = solutionModel.getGlobalMethod('globals', 'nameOfGlobalMethod');
if (method != null) application.output(method.code);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalMethods

Table Row (tr)

id	name

Table Cell (td)
getGlobalMethods()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The list of all global methods.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

sIndent

HTML Table
class

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var methods = solutionModel.getGlobalMethods('globals');
for (var x in methods)
	application.output(methods[x].getName());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalMethods

Table Row (tr)

id	name

Table Cell (td)
getGlobalMethods(scopeName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The list of all global methods.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)
Table Cell (td)
String

Table Cell (td)
scopeName

Table Cell (td)
limit to global methods of specified scope name

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var methods = solutionModel.getGlobalMethods('globals');
for (var x in methods)
	application.output(methods[x].getName());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalVariable

Table Row (tr)

id	name

Table Cell (td)
getGlobalVariable(scopeName, name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing global variable by the specified name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

sIndent

HTML Table
class

tdString

Table Row (tr)

id

prs

Table Cell (td)

Parameters

td tr

HTML Table

class

sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the specified name of the global variable

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var globalVariable = solutionModel.getGlobalVariable('globals', 'globalVariableName');
application.output(globalVariable.name + " has the default value of " + globalVariable.defaultValue);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalVariables

Table Row (tr)

id	name

Table Cell (td)
getGlobalVariables()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all global variables.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

table

class	sIndent

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var globalVariables = solutionModel.getGlobalVariables('globals');
for (var i in globalVariables)
	application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalVariables

Table Row (tr)

id	name

Table Cell (td)
getGlobalVariables(scopeName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all global variables.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
scopeName

Table Cell (td)
limit to global vars of specified scope name

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var globalVariables = solutionModel.getGlobalVariables('globals');
for (var i in globalVariables)
	application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMedia

Table Row (tr)

id	name

Table Cell (td)
getMedia(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the specified media object; can be assigned to a button/label.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the specified name of the media object

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMedia

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var myMedia = solutionModel.getMedia('button01.gif')
//now set the imageMedia property of your label or button
//myButton.imageMedia = myMedia
// OR
//myLabel.imageMedia = myMedia

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMediaList

Table Row (tr)

id	name

Table Cell (td)
getMediaList()

tr

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the list of all media objects.

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var mediaList = solutionModel.getMediaList();
if (mediaList.length != 0 && mediaList != null) {
	for (var x in mediaList) {
		application.output(mediaList[x]);
	}
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getObjectByUUID

Table Row (tr)

id	name

Table Cell (td)
getObjectByUUID(uuid)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves an element by its uuid.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)
Table Cell (td)
Object

Table Cell (td)
uuid

Table Cell (td)
element uuid

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

solutionModel.getObjectByUUID(uuid)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRelation

Table Row (tr)

id	name

Table Cell (td)
getRelation(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing relation by the specified name and returns a JSRelation Object.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the specified name of the relation

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSRelation

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var relation = solutionModel.getRelation('name');
application.output("The primary server name is " + relation.primaryServerName);
application.output("The primary table name is " + relation.primaryTableName);
application.output("The foreign table name is " + relation.foreignTableName);
application.output("The relation items are " + relation.getRelationItems());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRelations

Table Row (tr)

id	name

Table Cell (td)
getRelations(datasource)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all relations; or an array of all global relations if the specified table is NULL.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)
Table Cell (td)
String

Table Cell (td)
datasource

Table Cell (td)
the specified name of the datasource for the specified table

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var relations = solutionModel.getRelations('server_name','table_name');
if (relations.length != 0)
	for (var i in relations)
		application.output(relations[i].name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRelations

Table Row (tr)

id	name

Table Cell (td)
getRelations(servername, tablename)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all relations; or an array of all global relations if the specified table is NULL.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

tr

Table Cell (td)
String

Table Cell (td)
tablename

Table Cell (td)
the specified name of the table

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var relations = solutionModel.getRelations('server_name','table_name');
if (relations.length != 0)
	for (var i in relations)
		application.output(relations[i].name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getScopeNames

Table Row (tr)

id	name

Table Cell (td)
getScopeNames()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all scope names used.

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

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var scopeNames = solutionModel.getScopeNames();
for (var name in scopeNames)
	application.output(name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getStyle

Table Row (tr)

id	name

Table Cell (td)
getStyle(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the style specified by the given name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the specified name of the style

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSStyle

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var style = solutionModel.getStyle('my_existing_style')
style.content = 'combobox { color: #0000ff;font: italic 10pt "Verdana";}'

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getValueList

Table Row (tr)

id	name

Table Cell (td)
getValueList(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing valuelist by the specified name and returns a JSValueList Object that can be assigned to a field.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)
Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the specified name of the valuelist

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSValueList

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var myValueList = solutionModel.getValueList('myValueListHere')
//now set the valueList property of your field
//myField.valuelist = myValueList

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getValueLists

Table Row (tr)

id	name

Table Cell (td)
getValueLists()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all valuelists for the currently active solution.

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

Array

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var valueLists = solutionModel.getValueLists();
if (valueLists != null && valueLists.length != 0)
	for (var i in valueLists)
		application.output(valueLists[i].name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newForm

Table Row (tr)

id	name

Table Cell (td)
newForm(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSForm Object.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)
Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the specified name of the form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var myForm = solutionModel.newForm('newForm')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newForm

Table Row (tr)

id	name

Table Cell (td)
newForm(name, isResponsive)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a responsive form:

Table Row (tr)

id	prs

Table Cell (td)

Parameters

trBoolean

HTML Table

class	sIndent

String

Table Cell (td)

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)
isResponsive

Table Cell (td)
if true will create an responsive form, otherwise an absolute layout form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var frm = solutionModel.newForm('test', true);
var c = frm.newLayoutContainer(1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newForm

Table Row (tr)

id	name

Table Cell (td)
newForm(name, superForm)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new form with the given JSForm as its super form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String JSForm

Table Cell (td)
superForm

Table Cell (td)

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)

Table Cell (td)

the super form that will extended from, see JSform.setExtendsForm();

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

//creates 2 forms with elements on them; shows the parent form, waits 2 seconds and shows the child form
var mySuperForm = solutionModel.newForm('mySuperForm', 'db:/my_server/my_table', null, false, 800, 600);
var label1 = mySuperForm.newLabel('LabelName', 20, 20, 120, 30);
label1.text = 'DataProvider';
label1.background = 'red';
mySuperForm.newTextField('myDataProvider', 140, 20, 140,20);
forms['mySuperForm'].controller.show();
application.sleep(2000);
var mySubForm = solutionModel.newForm('mySubForm', mySuperForm);
var label2 = mySuperForm.newLabel('SubForm Label', 20, 120, 120, 30);
label2.background = 'green';
forms['mySuperForm'].controller.recreateUI();
forms['mySubForm'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newForm

Table Row (tr)

id	name

Table Cell (td)
newForm(name, dataSource, isResponsive)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a responsive form:

Table Row (tr)

id	prs

String Boolean

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)
isResponsive

Table Cell (td)
if true will create an responsive form, otherwise an absolute layout form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var frm = solutionModel.newForm('test','db:/my_server/my_table', true);
var c = frm.newLayoutContainer(1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Number

Table Body (tbody)

id	newForm

Table Row (tr)

id	name

Table Cell (td)
newForm(name, dataSource, styleName, show_in_menu, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSForm Object. NOTE: See the JSForm node for more information about form objects that can be added to the new form.

Parameters

Table Row (tr)

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

id	prs

Table Cell (td)

	prs

Table Cell (td)

Parameters

td tr

HTML Table

class

sIndent

Table Cell (td)
Number

Table Cell (td)
height

Table Cell (td)
the height of the form in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var myForm = solutionModel.newForm('newForm', 'db:/my_server/my_table', 'myStyleName', false, 800, 600)
//now you can add stuff to the form (under JSForm node)
//add a label
myForm.newLabel('Name', 20, 20, 120, 30)
//add a "normal" text entry field
myForm.newTextField('dataProviderNameHere', 140, 20, 140,20)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newForm

Table Row (tr)

id	name

Table Cell (td)
newForm(name, serverName, tableName, styleName, show_in_menu, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSForm Object. NOTE: See the JSForm node for more information about form objects that can be added to the new form.

Table Row (tr)

id	prs

String

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)

Table Cell (td)

Number

Table Row (tr)

Table Cell (td)

Table Cell (td)
height

Table Cell (td)
the height of the form in pixels

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var myForm = solutionModel.newForm('newForm', 'my_server', 'my_table', 'myStyleName', false, 800, 600)
//With only a datasource:
//var myForm = solutionModel.newForm('newForm', datasource, 'myStyleName', false, 800, 600)
//now you can add stuff to the form (under JSForm node)
//add a label
myForm.newLabel('Name', 20, 20, 120, 30)
//add a "normal" text entry field
myForm.newTextField('dataProviderNameHere', 140, 20, 140,20)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newGlobalMethod

Table Row (tr)

id	name

Table Cell (td)
newGlobalMethod(scopeName, code)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new global method with the specified code in a scope.

Parameters

String

Table Row (tr)

id	prs

Table Cell (td)

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)

	prs

Table Cell (td)

Parameters

td tr

HTML Table

class

sIndent

Table Cell (td)
String

Table Cell (td)
code

Table Cell (td)
the specified code for the global method

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var method = solutionModel.newGlobalMethod('globals', 'function myglobalmethod(){foundset.newRecord()}')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newGlobalVariable

Table Row (tr)

id	name

Table Cell (td)
newGlobalVariable(scopeName, name, type)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new global variable with the specified name and number type. NOTE: The global variable number type is based on the value assigned from the SolutionModel-JSVariable node; for example: JSVariable.INTEGER.

Table Row (tr)

id	prs

Number

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)
Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)
type

Table Cell (td)
the specified number type for the global variable

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var myGlobalVariable = solutionModel.newGlobalVariable('globals', 'newGlobalVariable', JSVariable.INTEGER);
myGlobalVariable.defaultValue = 12;
//myGlobalVariable.defaultValue = "{a:'First letter',b:'Second letter'}" // an js object, type must be media.
//myGlobalVariable.defaultValue = '"some text"'; // Use two pairs of quotes if you want to assign a String as default value.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newMedia

Table Row (tr)

id	name

Table Cell (td)
newMedia(name, bytes)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new media object that can be assigned to a label or a button.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

String Array

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)
bytes

Table Cell (td)
The content

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMedia

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var myMedia = solutionModel.newMedia('button01.gif',bytes)
//now set the imageMedia property of your label or button
//myButton.imageMedia = myMedia
// OR
//myLabel.imageMedia = myMedia

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newRelation

Table Row (tr)

id	name

Table Cell (td)
newRelation(name, primaryDataSource, foreignDataSource, joinType)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSRelation Object with a specified name; includes the primary datasource, foreign datasource and the type of join for the new relation.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)
Table Cell (td)
String Number

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

Table Cell (td)

joinType

Table Cell (td)
the type of join for the new relation; JSRelation.INNER_JOIN, JSRelation.LEFT_OUTER_JOIN

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSRelation

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var rel = solutionModel.newRelation('myRelation', myPrimaryDataSource, myForeignDataSource, JSRelation.INNER_JOIN);
application.output(rel.getRelationItems());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newStyle

Table Row (tr)

id	name

Table Cell (td)
newStyle(name, content)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new style with the given css content string under the given name. NOTE: Will throw an exception if a style with that name already exists.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
content

Table Cell (td)
the css content of the new style

td

Table Row (tr)

String

Table Cell (td)

Table Cell (td)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSStyle

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var form = solutionModel.newForm('myForm','db:/my_server/my_table',null,true,1000,800);
if (form.transparent == false)
{
	var style = solutionModel.newStyle('myStyle','form { background-color: yellow; }');
	style.text = style.text + 'field { background-color: blue; }';
	form.styleName = 'myStyle';
}
var field = form.newField('columnTextDataProvider',JSField.TEXT_FIELD,100,100,100,50);
forms['myForm'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newValueList

Table Row (tr)

id	name

Table Cell (td)
newValueList(name, type)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new valuelist with the specified name and number type.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

trNumber

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)
type

Table Cell (td)
the specified number type for the valuelist; may be JSValueList.CUSTOM_VALUES, JSValueList.DATABASE_VALUES, JSValueList.EMPTY_VALUE_ALWAYS, JSValueList.EMPTY_VALUE_NEVER

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSValueList

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var vl1 = solutionModel.newValueList("customText",JSValueList.CUSTOM_VALUES);
vl1.customValues = "customvalue1\ncustomvalue2";
var vl2 = solutionModel.newValueList("customid",JSValueList.CUSTOM_VALUES);
vl2.customValues = "customvalue1|1\ncustomvalue2|2";
var form = solutionModel.newForm("customValueListForm",controller.getDataSource(),null,true,300,300);
var combo1 = form.newComboBox("scopes.globals.text",10,10,120,20);
combo1.valuelist = vl1;
var combo2 = form.newComboBox("scopes.globals.id",10,60,120,20);
combo2.valuelist = vl2;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeForm

Table Row (tr)

id	name

Table Cell (td)
removeForm(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the specified form during the persistent connected client session. NOTE: Make sure you call history.remove first in your Servoy method (script).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)
Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the specified name of the form to remove

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

//first remove it from the current history, to destroy any active form instance
var success = history.removeForm('myForm')
//removes the named form from this session, please make sure you called history.remove() first
if(success)
{
	solutionModel.removeForm('myForm')
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeGlobalMethod

Table Row (tr)

id	name

Table Cell (td)
removeGlobalMethod(scopeName, name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the specified global method.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

HTML Table

class	sIndent

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the name of the global method to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var m1 = solutionModel.newGlobalMethod('globals', 'function myglobalmethod1(){application.output("Global Method 1");}');
var m2 = solutionModel.newGlobalMethod('globals', 'function myglobalmethod2(){application.output("Global Method 2");}');

var success = solutionModel.removeGlobalMethod('globals', 'myglobalmethod1');
if (success == false) application.output('!!! myglobalmethod1 could not be removed !!!');

var list = solutionModel.getGlobalMethods('globals');
for (var i = 0; i < list.length; i++) {
	application.output(list[i].code);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeGlobalVariable

Table Row (tr)

id	name

Table Cell (td)
removeGlobalVariable(scopeName, name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the specified global variable.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Table Cell (td)

the name of the global variable to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var v1 = solutionModel.newGlobalVariable('globals', 'globalVar1', JSVariable.INTEGER);
var v2 = solutionModel.newGlobalVariable('globals', 'globalVar2', JSVariable.TEXT);

var success = solutionModel.removeGlobalVariable('globals', 'globalVar1');
if (success == false) application.output('!!! globalVar1 could not be removed !!!');

var list = solutionModel.getGlobalVariables('globals');
for (var i = 0; i < list.length; i++) {
	application.output(list[i].name + '[ ' + list[i].variableType + ']: ' + list[i].variableType);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeMedia

Table Row (tr)

id	name

Table Cell (td)
removeMedia(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the media item specified by name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the name of the media item to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var bytes1 = plugins.file.readFile('D:/Imgs/image1.png');
var image1 = solutionModel.newMedia('image1.png', bytes1);
var bytes2 = plugins.file.readFile('D:/Imgs/image2.jpg');
var image2 = solutionModel.newMedia('image2.jpg',bytes2);
var bytes3 = plugins.file.readFile('D:/Imgs/image3.jpg');
var image3 = solutionModel.newMedia('image3.jpg',bytes3);

var f = solutionModel.newForm("newForm",databaseManager.getDataSource('example_data', 'orders'),null,false,500,350);
var l = f.newLabel('', 20, 70, 300, 200);
l.imageMedia = image1;
l.borderType =  solutionModel.createLineBorder(4,'#ff0000');
forms["newForm"].controller.show();

var status = solutionModel.removeMedia('image1.jpg');
if (status) application.output("image1.png has been removed");
else application.output("image1.png has not been removed");

var mediaList = solutionModel.getMediaList();
for (var i = 0; i < mediaList.length; i++) {
	application.output(mediaList[i].getName() + ":" + mediaList[i].mimeType);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeRelation

Table Row (tr)

id	name

Table Cell (td)
removeRelation(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the relation specified by name. You cannot remove the relation if it is touched within the application. So even if you remove all the ui elements using it, like tabs, it still can't be removed, because of underlying created and cached data.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the name of the relation to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var success = solutionModel.removeRelation('myRelation');
if (success) { application.output("Relation has been removed");}
else {application.output("Relation could not be removed");}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeStyle

Table Row (tr)

id	name

Table Cell (td)
removeStyle(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the specified style.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the name of the style to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var s = solutionModel.newStyle("smStyle1",'form { background-color: yellow; }');
var status = solutionModel.removeStyle("smStyle1");
if (status == false) application.output("Could not remove style.");
else application.output("Style removed.");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeValueList

Table Row (tr)

id	name

Table Cell (td)
removeValueList(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the specified valuelist.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
name of the valuelist to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var vlName = "customValueList";
var vl = solutionModel.newValueList(vlName,JSValueList.CUSTOM_VALUES);
vl.customValues = "customvalue1\ncustomvalue2";

var status = solutionModel.removeValueList(vlName);
if (status) application.output("Removal has been done.");
else application.output("ValueList not removed.");

var vls = solutionModel.getValueLists();
if (vls != null) {
	for (var i = 0; i < vls.length; i++) {
		application.output(vls[i]);
	}
	application.output("");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	revertForm

Table Row (tr)

id	name

Table Cell (td)
revertForm(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Reverts the specified form to the original (blueprint) version of the form; will result in an exception error if the form is not an original form. NOTE: Make sure you call history.remove first in your Servoy method (script) or call form.controller.recreateUI() before the script ends.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

tr

HTML Table

class	sIndent

Table Cell (td)
String

Table Cell (td)
name

Table Cell (td)
the specified name of the form to revert

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

// revert the form to the original solution form, removing any changes done to it through the solution model.
var revertedForm = solutionModel.revertForm('myForm')
// add a label on a random place.
revertedForm.newLabel("MyLabel",Math.random()*100,Math.random()*100,80,20);
// make sure that the ui is up to date.
forms.myForm.controller.recreateUI();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	wrapMethodWithArguments

Table Row (tr)

id	name

Table Cell (td)
wrapMethodWithArguments(method, args)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get a JSMethod instance with arguments to be assigned to an event.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

trArray

HTML Table

class	sIndent

JSMethod

Table Cell (td)

Table Cell (td)

Table Cell (td)

Table Row (tr)

Table Cell (td)

Table Cell (td)
args

Table Cell (td)
positional arguments

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	clients

Table Cell (td)

Supported Clients

Div

class	sIndent

SmartClient,WebClient,NGClient

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIdent

Code Block

language	javascript

var str = "John's Bookstore"
var form = solutionModel.getForm('orders')
var button = form.getButton('abutton')
var method = form.getFormMethod('doit') // has 4 arguments: event (fixed), boolean, number and string
// string arguments have to be quoted, they are interpreted before the method is called
var quotedString = "'"+utils.stringReplace(str, "'", "\\'")+"'"
// list all arguments the method has, use nulls for fixed arguments (like event)
button.onAction = solutionModel.wrapMethodWithArguments(method, [null, true, 42, quotedString])

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Page History

Versions Compared

Old Version 45

New Version 46

Key

cloneComponent(newName, component)

cloneComponent(newName, component, newParentForm)

cloneForm(newName, jsForm)

createBevelBorder(bevel_type, highlight_outer_color, highlight_inner_color, shadow_outer_color, shadow_inner_color)

createEmptyBorder(top_width, right_width, bottom_width, left_width)

createEtchedBorder(bevel_type, highlight_color, shadow_color)

createFont(name, style, size)

createLineBorder(thick, color)

createMatteBorder(top_width, right_width, bottom_width, left_width, color)

createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin)

createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation)

createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation, units)

createRoundedBorder(top_width, right_width, bottom_width, left_width, top_color, right_color, bottom_color, left_color, rounding_radius, border_style)

createSpecialMatteBorder(top_width, right_width, bottom_width, left_width, top_color, right_color, bottom_color, left_color, rounding_radius, dash_pattern)

createTitledBorder(title_text, font, color, title_justification, title_position)

getAllRelations()

getDataSourceNode(dataSource)

getForm(name)

getForms()

getForms(datasource)

getForms(server, tablename)

getGlobalMethod(scopeName, name)

getGlobalMethods()

getGlobalMethods(scopeName)

getGlobalVariable(scopeName, name)

getGlobalVariables()

getGlobalVariables(scopeName)

getMedia(name)

getMediaList()

getObjectByUUID(uuid)

getRelation(name)

getRelations(datasource)

getRelations(servername, tablename)

getScopeNames()

getStyle(name)

getValueList(name)

getValueLists()

newForm(name)

newForm(name, isResponsive)

newForm(name, superForm)

newForm(name, dataSource, isResponsive)

newForm(name, dataSource, styleName, show_in_menu, width, height)

newForm(name, serverName, tableName, styleName, show_in_menu, width, height)

newGlobalMethod(scopeName, code)

newGlobalVariable(scopeName, name, type)

newMedia(name, bytes)

newRelation(name, primaryDataSource, foreignDataSource, joinType)

newStyle(name, content)

newValueList(name, type)

removeForm(name)

removeGlobalMethod(scopeName, name)

removeGlobalVariable(scopeName, name)

removeMedia(name)

removeRelation(name)

removeStyle(name)

removeValueList(name)

revertForm(name)

wrapMethodWithArguments(method, args)