Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Cache

...

tablecolgroupcolcolspan2width100%colthead2Return Types
index
true
idrefreshclass100dservoy sReturnTypes
showRefresh
true
id
doc
title
Refresh page
showDate
true
retry
Table Row (tr)
style
Enable

servoy sReturnTypes2100%height: 30px;

Table Head (th)
colspan
Table Row (tr)
Table Cell (td)
Span
classsWordList
ALIGNMENT
Span
classsWordList
ANCHOR
Span
classsWordList
BEVELTYPE
Span
classsWordList
CURSOR
Span
classsWordList
DEFAULTS
Span
classsWordList
DISPLAYTYPE
Span
classsWordList
FONTSTYLE
Span
classsWordList
JOINTYPE
Span
classsWordList
MEDIAOPTION
Span
classsWordList
PAGEORIENTATION
Span
classsWordList
PARTS
Span
classsWordList
PRINTSLIDING
Span
classsWordList
SCROLLBAR
Span
classsWordList
TITLEJUSTIFICATION
Span
classsWordList
TITLEPOSITION
Span
classsWordList
UNITS
Span
classsWordList
ValueList
Span
classsWordList
VARIABLETYPE
Span
classsWordList
View
Span
classsWordList
JSForm
Span
classsWordList
JSDataSourceNode
Span
classsWordList
JSBean
Span
classsWordList
JSButton
Span
classsWordList
JSCalculation
Span
classsWordList
JSField
Span
classsWordList
JSLayoutContainer
Span
classsWordList
JSField
Span
classsWordList
JSField
Span
classsWordList
JSField
Span
classsWordList
JSField
Span
classsWordList
JSField
Span
classsWordList
JSField
Span
classsWordList
JSField
Span
classsWordList
JSList
Span
classsWordList
JSInsetList
Span
classsWordList
JSComponent
Span
classsWordList
JSLabel
Span
classsWordList
JSMethod
Span
classsWordList
JSPortal
Span
classsWordList
JSPart
Span
classsWordList
JSRelation
Span
classsWordList
JSRelationItem
Span
classsWordList
JSStyle
Span
classsWordList
JSTabPanel
Span
classsWordList
JSTab
Span
classsWordList
JSMedia
Span
classsWordList
JSValueList
Span
classsWordList
JSVariable
Span
classsWordList
JSPart
Span
classsWordList
JSPart
Span
classsWordList
JSTitle
Span
classsWordList
JSWebComponent

 

 

...

Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Supported Clients
Table Row (tr)
Table Cell (td)

Span
classsWordList
SmartClient
Span
classsWordList
WebClient
Span
classsWordList
NGClient
Span
classsWordList
MobileClient

 

 

HTML Table
id
classservoy sSummary
HTML Table
id
Colgroup Tag
Col
width12%
Col
width30%
Col
width58%
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan3
Methods Summary
Table Row (tr)
Table Cell (td)
JSComponent
Table Cell (td)
cloneComponent(newName, component)
Table Cell (td)sWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCK

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

Table Row (tr)

Table Cell (td)
JSComponent
Table Cell (td)
cloneComponent(newName, component, newParentForm)
Table Cell (td)servoy sSummary12%30%58%height: 30px;3Methods SummaryMakes an exact copy of the given component (JSComponent/JSField/JSLabel) and gives it a new name. Table Row (tr)
Table Cell (td)
JSForm
Table Cell (td)
cloneForm(newName, jsForm)
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)
String
Table Cell (td)
createBevelBorder(bevel_type, highlight_outer_color, highlight_inner_color, shadow_outer_color, shadow_inner_color)
Table Cell (td)Makes an exact copy of the given form and gives it the new name. 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 Row (tr)
Table Cell (td)
String
Table Cell (td)
createEtchedBorder(bevel_type, highlight_color, shadow_color)
Table Cell (td)Create an empty border string. Table Row (tr)
Table Cell (td)
String
Table Cell (td)
createFont(name, style, size)
Table Cell (td)Create an etched border string. Table Row (tr)
Table Cell (td)
String
Table Cell (td)
createLineBorder(thick, color)
Table Cell (td)Create a font string. 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 Row (tr)
Table Cell (td)
String
Table Cell (td)
createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin)
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, orientation)
Table Cell (td)Create a page format string. 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 Row (tr)
Table Cell (td)
String
Table Cell (td)
createTitledBorder(title_text, font, color, title_justification, title_position)
Table Cell (td)Create a special matte border string. Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getAllRelations()
Table Cell (td)Create a titled border string.Gets an array of all relations. Table Row (tr)
Table Cell (td)
JSDataSourceNode
Table Cell (td)
getDataSourceNode(dataSource)
Table Cell (td) Table Row (tr)
Table Cell (td)
JSForm
Table Cell (td)
getForm(name)
Table Cell (td)Gets the specified data source node and returns information about the form (see JSDataSourceNode node). Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getForms()
Table Cell (td)Gets the specified form object and returns information about the form (see JSForm node).Get an array of all forms. Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getForms(datasource)
Table Cell (td) 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. Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
getGlobalMethod(scopeName, name)
Table Cell (td)Get an array of forms, that are all based on datasource/servername and tablename. Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getGlobalMethods()
Table Cell (td)Gets an existing global method by the specified name. Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getGlobalMethods(scopeName)
Table Cell (td)The list of all global methods.The list of all global methods. Table Row (tr)
Table Cell (td)
JSVariable
Table Cell (td)
getGlobalVariable(scopeName, name)
Table Cell (td) Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getGlobalVariables()
Table Cell (td)Gets an existing global variable by the specified name. 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 an array of all global variables. Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getMediaList()
Table Cell (td)Gets the specified media object; can be assigned to a button/label. Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
getObjectByUUID(uuid)
Table Cell (td)Gets the list of all media objects.Retrieves an element by its uuid. Table Row (tr)
Table Cell (td)
JSRelation
Table Cell (td)
getRelation(name)
Table Cell (td) Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getRelations(datasource)
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(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 relations; or an array of all global relations if the specified table is NULL. Table Row (tr)
Table Cell (td)
JSStyle
Table Cell (td)
getStyle(name)
Table Cell (td)Gets an array of all scope names used.Gets the style specified by the given name. Table Row (tr)
Table Cell (td)
JSValueList
Table Cell (td)
getValueList(name)
Table Cell (td) Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getValueLists()
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)
JSForm
Table Cell (td)
newForm(name)
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, isResponsive)
Table Cell (td)Creates a new JSForm Object.Create a responsive form: Table Row (tr)
Table Cell (td)
JSForm
Table Cell (td)
newForm(name, superForm)
Table Cell (td) Table Row (tr)
Table Cell (td)
JSForm
Table Cell (td)
newForm(name, dataSource, isResponsive)
Table Cell (td)Creates a new form with the given JSForm as its super form.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, styleName, show_in_menu, width, height)
Table Cell (td)Create a responsive form: 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)
Creates a new JSForm Object. Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
newGlobalMethod(scopeName, code)
Table Cell (td) Table Row (tr)
Table Cell (td)
JSVariable
Table Cell (td)
newGlobalVariable(scopeName, name, type)
Table Cell (td)Creates a new global method with the specified code in a scope. Table Row (tr)
Table Cell (td)
JSMedia
Table Cell (td)
newMedia(name, bytes)
Table Cell (td)Creates a new global variable with the specified name and number type.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 Table Row (tr)
Table Cell (td)
JSStyle
Table Cell (td)
newStyle(name, content)
Table Cell (td)Creates a new media object for things like a CSS or LESS file that can be set as the clients solution style.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)
JSValueList
Table Cell (td)
newValueList(name, type)
Table Cell (td)Creates a new style with the given css content string under the given name. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeForm(name)
Table Cell (td)Creates a new valuelist with the specified name and number type. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeGlobalMethod(scopeName, name)
Table Cell (td)Removes the specified form during the persistent connected client session. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeGlobalVariable(scopeName, name)
Table Cell (td)Removes the specified global method. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeMedia(name)
Table Cell (td)Removes the specified global variable. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeRelation(name)
Table Cell (td)Removes the media item specified by name. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeStyle(name)
Table Cell (td)Removes the relation specified by name. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeValueList(name)
Table Cell (td)Removes the specified style.Removes the specified valuelist. Table Row (tr)
Table Cell (td)
JSForm
Table Cell (td)
revertForm(name)
Table Cell (td) Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
wrapMethodWithArguments(method, args)
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.Get a JSMethod instance with arguments to be assigned to an event.

 

 

servoy sDetail100%

functionclass
Colgroup Tag
Col
colspan2width
Col
Table Head (thead) Table Row (tr)styleheight:30px Table Head (th)colspan2Methods Details Table Body (tbody)ididcloneComponent Table Row (tr)name

Table Cell (td)id

cloneComponent(newName, component)

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

Table Cell (td)

Table Cell (td)
Object
Table Cell (td)
component
Table Cell (td)

Parameters

HTML Table
classsIndent
Table Row (tr)idsIndentnewNamethe new name of the cloned componentcomponentthe component to cloneret

Table Cell (td) Table Row (tr)

idclients
Table Cell (td)

Returns

Div
classsIndent
JSComponent
sIndent the exact copy of the given componentclients

Supported Clients

DivclasssIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguagejavascript
// 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 Table Body (tbody)idlastDetailRow
Table Cell (td)
 
idcloneComponent Table Row (tr)name

Table Cell (td)id

cloneComponent(newName, component, newParentForm)

Table Row (tr)des Table Cell (td) DivclassidsIndent
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)prs

Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)
JSForm
Table Cell (td)
newParentForm
Table Cell (td) Table Row (tr)idsIndentnewNamethe new name of the cloned componentcomponentthe component to clonenewParentFormthe new parent formret

Table Cell (td) Table Row (tr)

idclients
Table Cell (td)

Returns

Div
classsIndent
JSComponent
sIndent the exact copy of the given componentclients

Supported Clients

DivclasssIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguagejavascript
// 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 Table Body (tbody)idlastDetailRow
Table Cell (td)
 
idcloneForm Table Row (tr)name

Table Cell (td)id

cloneForm(newName, jsForm)

Table Row (tr)des Table Cell (td) DivclassidsIndent
Makes an exact copy of the given form and gives it the new name.
Table Row (tr)prs

Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)
JSForm
Table Cell (td)
jsForm
Table Cell (td) Table Row (tr)idsIndentnewNamethe new name for the form clonejsFormthe form to be clonedret

Table Cell (td)

Returns

DivclasssIndentid a JSForm Table Row (tr)clients

Table Cell (td)

Supported Clients

DivclasssIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguagejavascript
// 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)classidlastDetailRow
Table Cell (td)
 
Table Body (tbody)idcreateBevelBorder Table Row (tr)name

Table Cell (td)id

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

Table Row (tr)classdes Table Cell (td) DividsIndent
Create a bevel border string.
Table Row (tr)prs

Table Cell (td) Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)
String
Table Cell (td)
shadow_inner_color
Table Row (tr)idsIndentbevel_typebevel border type (SM_BEVELTYPE.RAISED or SM_BEVELTYPE.LOWERED)highlight_outer_colorbevel border highlight outer colorhighlight_inner_colorbevel border highlight inner colorshadow_outer_colorbevel border shadow outer colorshadow_inner_colorbevel border shadow outer colorret

Table Cell (td)

Returns

DivclassidsIndentString Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createBevelBorder(SM_BEVELTYPE.RAISED,'#ff0000','#00ff00','#ff0000','#00ff00');
Table Body (tbody)idlastDetailRow
Table Cell (td)
 
idcreateEmptyBorder Table Row (tr)name

Table Cell (td)id

createEmptyBorder(top_width, right_width, bottom_width, left_width)

Table Row (tr)classdes Table Cell (td) DividsIndent
Create an empty border string.
Table Row (tr)prs

Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)
Number
Table Cell (td)
left_width
Table Cell (td) Table Row (tr)idsIndenttop_widthtop width of empty border in pixelsright_widthright width of empty border in pixelsbottom_widthbottom width of empty border in pixelsleft_widthleft width of empty border in pixelsret

Table Cell (td)

Returns

DivclassidsIndentString Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createEmptyBorder(1,1,1,1);
Table Body (tbody)idlastDetailRow
Table Cell (td)
 
idcreateEtchedBorder Table Row (tr)name

Table Cell (td)id

createEtchedBorder(bevel_type, highlight_color, shadow_color)

Table Row (tr)classdes Table Cell (td) DividsIndent
Create an etched border string.
Table Row (tr)prs

Table Cell (td)

Table Cell (td)
String
Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)sIndentbevel_typebevel border typehighlight_colorbevel border highlight colorshadow_color Table Row (tr)idbevel border shadow colorret

Table Cell (td)

Returns

DivclassidsIndentString Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createEtchedBorder(SM_BEVELTYPE.RAISED,'#ff0000','#00ff00');
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idcreateFont Table Row (tr)name

Table Cell (td)id

createFont(name, style, size)

Table Row (tr)classdes Table Cell (td) DividsIndent
Create a font string.
Table Row (tr)prs

Table Cell (td)

Table Row (tr)
idret
Table Cell (td)

Returns

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

Supported Clients

Div
classsIndent

Parameters

HTML Table
classsIndent
Table Cell (td)
Number
Table Cell (td)
size
Table Cell (td)
the font size
sIndentnamethe name of the fontstylethe style of the font (PLAIN, BOLD, ITALIC or BOLD+ITALIC)sizethe font sizeret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var form = solutionModel.getForm("someForm");
var component = form.getComponent("someComponent")
component.fontType = solutionModel.createFont('Arial',SM_FONTSTYLE.BOLD,14);
Table Body (tbody)idlastDetailRow
Table Cell (td)
 
idcreateLineBorder Table Row (tr)name

Table Cell (td)id

createLineBorder(thick, color)

Table Row (tr) Divclassdes Table Cell (td)idsIndent
Create a line border string.
Table Row (tr)prs

Table Cell (td)

Table Cell (td)
String
Table Cell (td)
color
Table Cell (td)

Parameters

HTML Table
classsIndent
Table Row (tr)idsIndentthickborder thickness in pixelscolorcolor of the line borderret

Table Cell (td)

Returns

DivclassidsIndentString Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createLineBorder(1,'#ff0000');
Table Body (tbody)idlastDetailRow
Table Cell (td)
 
idcreateMatteBorder Table Row (tr)name

Table Cell (td)id

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

Table Row (tr) Divclassdes Table Cell (td)idsIndent
Create a matte border string.
Table Row (tr)prs

Table Cell (td)

Table Row (tr)
idret
Table Cell (td)

Returns

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

Supported Clients

Div
classsIndent

Parameters

HTML Table
classsIndent
Table Cell (td)
String
Table Cell (td)
color
Table Cell (td)
border color
sIndenttop_widthtop width of matte border in pixelsright_widthright width of matte border in pixelsbottom_widthbottom width of matte border in pixelsleft_widthleft width of matte border in pixelscolorborder colorret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createMatteBorder(1,1,1,1,"#00ff00");
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idcreatePageFormat Table Row (tr)name

Table Cell (td)id

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

Table Row (tr) Divclassdes Table Cell (td)idsIndent
Create a page format string.

Note: The unit specified for width, height and all margins MUST be the same.
Table Row (tr)prs

Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)
Number
Table Cell (td)
bottommargin
Table Cell (td) Table Row (tr)idsIndentwidththe specified width of the page to be printed.heightthe specified height of the page to be printed.leftmarginthe specified left margin of the page to be printed.rightmarginthe specified right margin of the page to be printed.topmarginthe specified top margin of the page to be printed.bottommarginthe specified bottom margin of the page to be printed.ret

Table Cell (td)

Returns

DivclassidsIndentString Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var form = solutionModel.getForm("someForm");
form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS);
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idcreatePageFormat Table Row (tr)name

Table Cell (td)id

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

Table Row (tr)classdes Table Cell (td) DividsIndent
Create a page format string.

Note: The unit specified for width, height and all margins MUST be the same.
Table Row (tr)prs

Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)
Number
Table Cell (td)
orientation
Table Cell (td) Table Row (tr)idsIndentwidththe specified width of the page to be printed.heightthe specified height of the page to be printed.leftmarginthe specified left margin of the page to be printed.rightmarginthe specified right margin of the page to be printed.topmarginthe specified top margin of the page to be printed.bottommarginthe specified bottom margin of the page to be printed.orientationthe specified orientation of the page to be printed; the default is Portrait moderet

Table Cell (td)

Returns

DivclassidsIndentString Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var form = solutionModel.getForm("someForm");
form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS);
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idcreatePageFormat Table Row (tr)name

Table Cell (td)id

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

Table Row (tr)classdes Table Cell (td) DividsIndent
Create a page format string.

Note: The unit specified for width, height and all margins MUST be the same.
Table Row (tr)prs

Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)
Number
Table Cell (td)
units
Table Cell (td) Table Row (tr)idsIndentwidththe specified width of the page to be printed.heightthe specified height of the page to be printed.leftmarginthe specified left margin of the page to be printed.rightmarginthe specified right margin of the page to be printed.topmarginthe specified top margin of the page to be printed.bottommarginthe specified bottom margin of the page to be printed.orientationthe specified orientation of the page to be printed; the default is Portrait modeunitsthe specified units for the width and height of the page to be printed; the default is pixelsret

Table Cell (td)

Returns

DivclassidsIndentString Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var form = solutionModel.getForm("someForm");
form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS);
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idcreateRoundedBorder Table Row (tr)name

Table Cell (td)id

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

Table Row (tr)classdes Table Cell (td) DividsIndent
Create a special matte border string.
Table Row (tr)prs

Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)
Array
Table Cell (td)
border_style
Table Cell (td) Table Row (tr)idsIndenttop_widthtop width of matte border in pixelsright_widthright width of matte border in pixelsbottom_widthbottom width of matte border in pixelsleft_widthleft width of matte border in pixelstop_colortop border colorright_colorright border colorbottom_colorbottom border colorleft_colorleft border colorrounding_radiusarray with width/height of the arc to round the cornersborder_stylethe border styles for the four margins(top/left/bottom/left)ret

Table Cell (td)

Returns

DivclassidsIndentString Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
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));
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idcreateSpecialMatteBorder Table Row (tr)name

Table Cell (td)id

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

Table Row (tr)classdes Table Cell (td) DividsIndent
Create a special matte border string.
Table Row (tr)prs

Table Cell (td)

Table Cell (td)
Array
Table Cell (td)
dash_pattern
Table Cell (td)

Parameters

HTML Table
classsIndent
Table Row (tr)idsIndenttop_widthtop width of matte border in pixelsright_widthright width of matte border in pixelsbottom_widthbottom width of matte border in pixelsleft_widthleft width of matte border in pixelstop_colortop border colorright_colorright border colorbottom_colorbottom border colorleft_colorleft border colorrounding_radiuswidth of the arc to round the cornersdash_patternthe dash pattern of border strokeret

Table Cell (td)

Returns

DivclassidsIndentString Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
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));
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idcreateTitledBorder Table Row (tr)name

Table Cell (td)id

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

Table Row (tr)classdes Table Cell (td) DividsIndent
Create a titled border string.
Table Row (tr)prs

Table Cell (td)class

Parameters

HTML TablesIndent
Table Cell (td)
Number
Table Cell (td)
title_position
Table Cell (td) Table Row (tr)idtitle_textthe text from borderfonttitle text font stringcolorborder colortitle_justificationtitle text justificationtitle_positionbevel title text positionret

Table Cell (td)

Returns

DivclassidsIndentString Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createTitledBorder('Test',solutionModel.createFont('Arial',SM_FONTSTYLE.PLAIN,10),'#ff0000',SM_TITLEJUSTIFICATION.CENTER,SM_TITLEPOSITION.TOP);
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idgetAllRelations Table Row (tr)name

Table Cell (td)id

getAllRelations()

Table Row (tr)classdes Table Cell (td) DividsIndent
Gets an array of all relations.
Table Row (tr)ret

Table Cell (td)

Returns

Div
classsIndent
Array
Table Row (tr)
idclients
Table Cell (td)

Supported Clients

Div
classsIndent
sIndent an array of all relations (all elements in the array are of type JSRelation)clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var relations = solutionModel.getAllRelations();
if (relations.length != 0)
	for (var i in relations)
		application.output(relations[i].name);
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idgetDataSourceNode Table Row (tr)name

Table Cell (td)id

getDataSourceNode(dataSource)

Table Row (tr)classdes Table Cell (td) DividsIndent
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)prs

Table Cell (td)class

Parameters

HTML Table Table Cell (td)sIndent
Table Cell (td)
String
dataSource Table Cell (td) Table Row (tr)idtable data sourceret

Table Cell (td)

Returns

DivclasssIndentid a JSDataSourceNode Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentSmartClient,WebClient,NGClient Table Row (tr)idsam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var dsnode = solutionModel.getDataSourceNode('db:/example_data/customers');
var c = dsnode.getCalculation("myCalculation");
application.output("Name: " + c.getName() + ", Stored: " + c.isStored());
Table Body (tbody)idlastDetailRow
Table Cell (td)
 
idgetForm Table Row (tr)name

Table Cell (td)id

getForm(name)

Table Row (tr)classdes Table Cell (td) DividsIndent
Gets the specified form object and returns information about the form (see JSForm node).
Table Row (tr)prs

Table Cell (td)class

Parameters

HTML Table Table Cell (td)sIndent
Table Cell (td)
String
name Table Cell (td) Table Row (tr)idthe specified name of the formret

Table Cell (td)

Returns

DivclasssIndentid a JSForm Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentidSmartClient,WebClient,NGClient,MobileClient Table Row (tr)sam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var myForm = solutionModel.getForm('existingFormName');
//get the style of the form (for all other properties see JSForm node)
var styleName = myForm.styleName;
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idgetForms Table Row (tr)name

Table Cell (td)id

getForms()

Table Row (tr)classdes Table Cell (td) DividsIndent
Get an array of all forms.
Table Row (tr)ret

Table Cell (td)

Returns

Div
classsIndent
Array
Table Row (tr)
idclients
Table Cell (td)classsIndent an array of JSForm type elementsclients

Supported Clients

DivsIndentidSmartClient,WebClient,NGClient,MobileClient Table Row (tr)sam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var forms = solutionModel.getForms()
for (var i in forms)
	application.output(forms[i].name)
Table Body (tbody)idlastDetailRow
Table Cell (td)
 
idgetForms Table Row (tr)name

Table Cell (td)id

getForms(datasource)

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

Table Cell (td)class

Parameters

HTML Table Table Cell (td)sIndent
Table Cell (td)
String
datasource Table Cell (td) Table Row (tr)idthe datasource or servernameret

Table Cell (td)

Returns

Div
classsIndent
Array
Table Row (tr)
idclients
Table Cell (td)classsIndent an array of JSForm type elementsclients

Supported Clients

DivsIndentidSmartClient,WebClient,NGClient,MobileClient Table Row (tr)sam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var forms = solutionModel.getForms(datasource)
for (var i in forms)
	application.output(forms[i].name)
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idgetForms Table Row (tr)name

Table Cell (td)id

getForms(server, tablename)

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

Table Cell (td)

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Array
Table Row (tr)
idclients
Table Cell (td)

Supported Clients

Div
classsIndent

Parameters

HTML Table
classsIndent
Table Cell (td)
String
Table Cell (td)
tablename
Table Cell (td)
the tablename
idsIndentserverthe datasource or servernametablenamethe tablenameret

Returns

sIndent an array of JSForm type elements
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
Table Row (tr)sam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var forms = solutionModel.getForms(datasource,tablename)
for (var i in forms)
	application.output(forms[i].name)
Table Body (tbody)idlastDetailRow
Table Cell (td)
 
idgetGlobalMethod Table Row (tr)name

Table Cell (td)id

getGlobalMethod(scopeName, name)

Table Row (tr)classdes Table Cell (td) DividsIndent
Gets an existing global method by the specified name.
Table Row (tr)prs

Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)
String
Table Cell (td)
name
Table Cell (td) Table Row (tr)idsIndentscopeNamethe scope in which the method is searchednamethe name of the specified global methodret

Table Cell (td)

Returns

DivclasssIndentid a JSMethod Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentidSmartClient,WebClient,NGClient,MobileClient Table Row (tr)sam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var method = solutionModel.getGlobalMethod('globals', 'nameOfGlobalMethod');
if (method != null) application.output(method.code);
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idgetGlobalMethods Table Row (tr)name

Table Cell (td)id

getGlobalMethods()

Table Row (tr)classdes Table Cell (td) DividsIndent
The list of all global methods.
Table Row (tr)ret

Table Cell (td)

Returns

Div
classsIndent
Array
Table Row (tr)
idclients
Table Cell (td)classsIndent an array of JSMethod type elementsclients

Supported Clients

DivsIndentidSmartClient,WebClient,NGClient,MobileClient Table Row (tr)sam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var methods = solutionModel.getGlobalMethods('globals');
for (var x in methods)
	application.output(methods[x].getName());
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idgetGlobalMethods Table Row (tr)name

Table Cell (td)id

getGlobalMethods(scopeName)

Table Row (tr)classdes Table Cell (td) DividsIndent
The list of all global methods.
Table Row (tr)prs

Table Cell (td)class

Parameters

HTML Table Table Cell (td)sIndent
Table Cell (td)
String
scopeName Table Cell (td) Table Row (tr)idlimit to global methods of specified scope nameret

Table Cell (td)

Returns

Div
classsIndent
Array
Table Row (tr)
idclients
Table Cell (td)classsIndent an array of JSMethod type elementsclients

Supported Clients

DivsIndentidSmartClient,WebClient,NGClient,MobileClient Table Row (tr)sam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var methods = solutionModel.getGlobalMethods('globals');
for (var x in methods)
	application.output(methods[x].getName());
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idgetGlobalVariable Table Row (tr)name

Table Cell (td)id

getGlobalVariable(scopeName, name)

Table Row (tr)classdes Table Cell (td) DividsIndent
Gets an existing global variable by the specified name.
Table Row (tr)prs

Table Cell (td)

Parameters

HTML Table
classsIndent
Table Cell (td)
String
Table Cell (td)
name
Table Cell (td) Table Row (tr)idsIndentscopeNamethe scope in which the variable is searchednamethe specified name of the global variableret

Table Cell (td)

Returns

DivclasssIndentid a JSVariable Table Row (tr)clients

Table Cell (td)class

Supported Clients

DivsIndentidSmartClient,WebClient,NGClient,MobileClient Table Row (tr)sam

Table Cell (td)class

Sample

DivsIdent Code Blocklanguage Table Row (tr)classjavascript
var globalVariable = solutionModel.getGlobalVariable('globals', 'globalVariableName');
application.output(globalVariable.name + " has the default value of " + globalVariable.defaultValue);
idlastDetailRow
Table Cell (td)
 
Table Body (tbody)idgetGlobalVariables Table Row (tr)name

Table Cell (td)id

getGlobalVariables()

Table Row (tr)classdes Table Cell (td) DividsIndent
Gets an array of all global variables.
Table Row (tr)ret

Table Cell (td)

Returns

Div
classsIndent
Array
Table Row (tr)
idclients
Table Cell (td)classsIndent an array of JSVariable type elementsclients

Supported Clients

DivsIndentidSmartClient,WebClient,NGClient,MobileClient Table Row (tr)sam

Table Cell (td)class

Sample