Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{hidden} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden} {sub-section:description|text=}{sub-section}\\{table:class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types{th}{tr}{tr}{td}{span:class=sWordList}[ALIGNMENT]{span}{span:class=sWordList}[ANCHOR]{span}{span:class=sWordList}[CURSOR]{span}{span:class=sWordList}[DEFAULTS]{span}{span:class=sWordList}[DISPLAYTYPE]{span}{span:class=sWordList}[JOINTYPE]{span}{span:class=sWordList}[JSButton]{span}{span:class=sWordList}[JSComponent]{span}{span:class=sWordList}[JSField]{span}{span:class=sWordList}[JSForm]{span}{span:class=sWordList}[JSLabel]{span}{span:class=sWordList}[JSMedia]{span}{span:class=sWordList}[JSMethod]{span}{span:class=sWordList}[JSPart]{span}{span:class=sWordList}[JSPortal]{span}{span:class=sWordList}[JSRelation]{span}{span:class=sWordList}[JSRelationItem]{span}{span:class=sWordList}[JSStyle]{span}{span:class=sWordList}[JSTab]{span}{span:class=sWordList}[JSTabPanel]{span}{span:class=sWordList}[JSValueList]{span}{span:class=sWordList}[JSVariable]{span}{span:class=sWordList}[MEDIAOPTION]{span}{span:class=sWordList}[PARTS]{span}{span:class=sWordList}[PRINTSLIDING]{span}{span:class=sWordList}[SCROLLBAR]{span}{span:class=sWordList}[VALUELIST]{span}{span:class=sWordList}[VARIABLETYPE]{span}{span:class=sWordList}[VIEW]{span}{td}{tr}{table}\\{table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[JSComponent]{td}{td}[#cloneComponent]\(newName, component, newParentForm) Makes an exact copy of the given component
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Return TypessWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCK

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryMakes an exact copy of the given component (JSComponent/JSField/JSLabel) and gives it a new name.Makes an exact copy of the given component (JSComponent/JSField/JSLabel), gives it a new name and optionally moves it to a new parent form.{td}{tr}{tbody}{tbody}{tr}{td}[JSForm]{td}{td}[#cloneForm]\(newName, jsForm) Makes an exact copy of the given form and gives it the new name.{td}{tr}{tbody}{tbody}{tr}{td}[JSForm]{td}{td}[#getForm]\(name) Gets the specified form object and returns information about the form (see JSForm node).{td}{tr}{tbody}{tbody}{tr}{td}[JSForm]\[]{td}{td}[#getForms]\(server, tablename) Get an array of forms, that are all based on datasource/servername or tablename.{td}{tr}{tbody}{tbody}{tr}{td}[JSMethod]{td}{td}[#getGlobalMethod]\(name) Gets an existing global method by the specified name.{td}{tr}{tbody}{tbody}{tr}{td}[JSMethod]\[]{td}{td}[#getGlobalMethods]\() The list of all global methods.{td}{tr}{tbody}{tbody}{tr}{td}[JSVariable]{td}{td}[#getGlobalVariable]\(name) Gets an existing global variable by the specified name.{td}{tr}{tbody}{tbody}{tr}{td}[JSVariable]\[]{td}{td}[#getGlobalVariables]\() Gets an array of all global variables.{td}{tr}{tbody}{tbody}{tr}{td}[JSMedia]{td}{td}[#getMedia]\(name) Gets the specified media object; can be assigned to a button/label.{td}{tr}{tbody}{tbody}{tr}{td}[JSMedia]\[]{td}{td}[#getMediaList]\() Gets the list of all media objects.{td}{tr}{tbody}{tbody}{tr}{td}[JSRelation]{td}{td}[#getRelation]\(name) Gets an existing relation by the specified name and returns a JSRelation Object.{td}{tr}{tbody}{tbody}{tr}{td}[JSRelation]\[]{td}{td}[#getRelations]\(primary_server_name/primary_data_source, primary_table_name) Gets an array of all relations; or an array of all global relations if the specified table is NULL.{td}{tr}{tbody}{tbody}{tr}{td}[JSStyle]{td}{td}[#getStyle]\(name) Gets the style specified by the given name.{td}{tr}{tbody}{tbody}{tr}{td}[JSValueList]{td}{td}[#getValueList]\(name) Gets an existing valuelist by the specified name and returns a JSValueList Object that can be assigned to a field.{td}{tr}{tbody}{tbody}{tr}{td}[JSValueList]\[]{td}{td}[#getValueLists]\() Gets an array of all valuelists for the currently active solution.{td}{tr}{tbody}{tbody}{tr}{td}[JSForm]{td}{td}[#newForm]\(name, server_name|data_source, table_name, style, show_in_menu, width, height) Creates a new JSForm Object.{td}{tr}{tbody}{tbody}{tr}{td}[JSMethod]{td}{td}[#newGlobalMethod]\(code) Creates a new global method with the specified code.{td}{tr}{tbody}{tbody}{tr}{td}[JSVariable]{td}{td}[#newGlobalVariable]\(name, type) Creates a new global variable with the specified name and number type.{td}{tr}{tbody}{tbody}{tr}{td}[JSMedia]{td}{td}[#newMedia]\(name, bytes) Creates a new media object that can be assigned to a label or a button.{td}{tr}{tbody}{tbody}{tr}{td}[JSRelation]{td}{td}[#newRelation]\(name, primary_server_name|primary_data_source, primary_table_name, foreign_server_name|foreign_data_source, foreign_table_name, join_type) Creates a new JSRelation Object with a specified name; includes the primary datasource, optional table name, foreign datasource, optional foreign table name, and the type of join for the new relation.{td}{tr}{tbody}{tbody}{tr}{td}[JSStyle]{td}{td}[#newStyle]\(name, content) Creates a new style with the given css content string under the given name.{td}{tr}{tbody}{tbody}{tr}{td}[JSValueList]{td}{td}[#newValueList]\(name, type) Creates a new valuelist with the specified name and number type.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#removeForm]\(name) Removes the specified form during the persistent connected client session.{td}{tr}{tbody}{tbody}{tr}{td}[JSForm]{td}{td}[#revertForm]\(name) 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.{td}{tr}{tbody}{table}\\{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=4939DBDC-22DF-4FCA-9CA1-5C74C08558E3}{tr:id=name}{td}h6.cloneComponent{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSComponent]{span}{span:id=iets|style=float: left; font-weight: bold;}cloneComponent{span}{span:id=iets|style=float: left;}\(newName, component, newParentForm){span}{td}{tr}{tr:id=des}{td}{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_des|text=|trigger=button}{sub-section}{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_des|trigger=none|class=sIndent}, specified as a parameter.Makes an exact copy of the given form and gives it the new name.Create a bevel border string.Create an empty border string.Create an etched border string.Create a font string.Create a line border string.Create a matte border string.Create a page format string.Create a page format string.Create a page format string.Create a special matte border string.Create a special matte border string.Create a titled border string.Gets an array of all relations.Gets the specified data source node and returns information about the form (see JSDataSourceNode node).Gets the specified form object and returns information about the form (see JSForm node).Get an array of all forms.Get an array of forms, that are all based on datasource/servername.Get an array of forms, that are all based on datasource/servername and tablename.Gets an existing global method by the specified name.The list of all global methods.The list of all global methods.Gets an existing global variable by the specified name.Gets an array of all global variables.Gets an array of all global variables.Gets the specified media object; can be assigned to a button/label.Gets the list of all media objects.Retrieves an element by its uuid.Gets an existing relation by the specified name and returns a JSRelation Object.Gets an array of all relations; or an array of all global relations if the specified table is NULL.Gets an array of all relations; or an array of all global relations if the specified table is NULL.Gets an array of all scope names used.Gets the style specified by the given name.Gets an existing valuelist by the specified name and returns a JSValueList Object that can be assigned to a field.Gets an array of all valuelists for the currently active solution.Creates a new JSForm Object.Create a responsive form:Creates a new form with the given JSForm as its super form.Creates a new form with the given JSForm as its super form.Create a responsive form:Creates a new JSForm Object.Creates a new JSForm Object.Creates a new global method with the specified code in a scope.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.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.Creates a new style with the given css content string under the given name.Creates a new valuelist with the specified name and number type.Removes the specified form during the persistent connected client session.Removes the specified global method.Removes the specified global variable.Removes the media item specified by name.Removes the relation specified by name.Removes the specified style.Removes the specified valuelist.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.

functionservoy sDetail2100%height:30px2Methods DetailscloneComponentname

cloneComponent(newName, component)

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

Parameters

sIndentnewNamethe new name of the cloned componentcomponentthe component to clone
ret

Returns

sIndent the exact copy of the given component
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowcloneComponentname

cloneComponent(newName, component, newParentForm)

dessIndent
Makes an exact copy of the given component (JSComponent/JSField/JSLabel), gives it a new name and 
optionally
moves it to a new parent form
.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_prs|trigger=none}newName -- the new name of the cloned component component -- the component to clone \[newParentForm\] -- the new parent form {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_ret|text=|trigger=button}{sub-section}{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_ret|trigger=none|class=sIndent}[JSComponent] -- the
, specified as a parameter.
prs

Parameters

sIndentnewNamethe new name of the cloned componentcomponentthe component to clonenewParentFormthe new parent form
ret

Returns

sIndent the exact copy of the given component
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
cloneFormname

cloneForm(newName, jsForm)

dessIndent
Makes an exact copy of the given 
component{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_see|text=|trigger=button}{sub-section}{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_see|text=|trigger=button}{sub-section}{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_sam|text=|trigger=button}{sub-section}{sub-section:4939DBDC-22DF-4FCA-9CA1-5C74C08558E3_sam|class=sIndent|trigger=none}{code: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(); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=93230A82-DB79-4965-9872-765E6C175106}{tr:id=name}{td}h6.cloneForm{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSForm]{span}{span:id=iets|style=float: left; font-weight: bold;}cloneForm{span}{span:id=iets|style=float: left;}\(newName, jsForm){span}{td}{tr}{tr:id=des}{td}{sub-section:93230A82-DB79-4965-9872-765E6C175106_des|text=|trigger=button}{sub-section}{sub-section:93230A82-DB79-4965-9872-765E6C175106_des|trigger=none|class=sIndent}Makes an exact copy of the given form and gives it the new name.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:93230A82-DB79-4965-9872-765E6C175106_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:93230A82-DB79-4965-9872-765E6C175106_prs|trigger=none}newName -- the new name for the form clone jsForm -- the form to be cloned {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:93230A82-DB79-4965-9872-765E6C175106_ret|text=|trigger=button}{sub-section}{sub-section:93230A82-DB79-4965-9872-765E6C175106_ret|trigger=none|class=sIndent}[JSForm] -- a JSForm{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:93230A82-DB79-4965-9872-765E6C175106_see|text=|trigger=button}{sub-section}{sub-section:93230A82-DB79-4965-9872-765E6C175106_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:93230A82-DB79-4965-9872-765E6C175106_see|text=|trigger=button}{sub-section}{sub-section:93230A82-DB79-4965-9872-765E6C175106_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:93230A82-DB79-4965-9872-765E6C175106_sam|text=|trigger=button}{sub-section}{sub-section:93230A82-DB79-4965-9872-765E6C175106_sam|class=sIndent|trigger=none}{code: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(); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=EA81D008-2EEA-4DF7-9A09-B6D507B91FE8}{tr:id=name}{td}h6.getForm{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSForm]{span}{span:id=iets|style=float: left; font-weight: bold;}getForm{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_des|text=|trigger=button}{sub-section}{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_des|trigger=none|class=sIndent}
form and gives it the new name.
prs

Parameters

sIndentnewNamethe new name for the form clonejsFormthe form to be cloned
ret

Returns

sIndent a JSForm
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createBevelBordername

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

dessIndent
Create a bevel border string.
prs

Parameters

sIndentbevel_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 color
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createEmptyBordername

createEmptyBorder(top_width, right_width, bottom_width, left_width)

dessIndent
Create an empty border string.
prs

Parameters

sIndenttop_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 pixels
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createEtchedBordername

createEtchedBorder(bevel_type, highlight_color, shadow_color)

dessIndent
Create an etched border string.
prs

Parameters

sIndentbevel_typebevel border typehighlight_colorbevel border highlight colorshadow_colorbevel border shadow color
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createFontname

createFont(name, style, size)

dessIndent
Create a font string.
prs

Parameters

sIndentnamethe name of the fontstylethe style of the font (PLAIN, BOLD, ITALIC or BOLD+ITALIC)sizethe font size
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createLineBordername

createLineBorder(thick, color)

dessIndent
Create a line border string.
prs

Parameters

sIndentthickborder thickness in pixelscolorcolor of the line border
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createMatteBordername

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

dessIndent
Create a matte border string.
prs

Parameters

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 color
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createPageFormatname

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

dessIndent
Create a page format string.

Note: The unit specified for width, height and all margins MUST be the same.
prs

Parameters

sIndentwidththe 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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createPageFormatname

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

dessIndent
Create a page format string.

Note: The unit specified for width, height and all margins MUST be the same.
prs

Parameters

sIndentwidththe 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 mode
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createPageFormatname

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

dessIndent
Create a page format string.

Note: The unit specified for width, height and all margins MUST be the same.
prs

Parameters

sIndentwidththe 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 pixels
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createRoundedBordername

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

dessIndent
Create a special matte border string.
prs

Parameters

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 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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createSpecialMatteBordername

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

dessIndent
Create a special matte border string.
prs

Parameters

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 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 stroke
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createTitledBordername

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

dessIndent
Create a titled border string.
prs

Parameters

sIndenttitle_textthe text from borderfonttitle text font stringcolorborder colortitle_justificationtitle text justificationtitle_positionbevel title text position
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getAllRelationsname

getAllRelations()

dessIndent
Gets an array of all relations.
ret

Returns

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

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDataSourceNodename

getDataSourceNode(dataSource)

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

Parameters

sIndentdataSourcetable data source
ret

Returns

sIndent a JSDataSourceNode
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormname

getForm(name)

dessIndent
Gets the specified form object and returns information about the form (see JSForm node).
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_prs|trigger=none}name -- the specified name of the form {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_ret|text=|trigger=button}{sub-section}{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_ret|trigger=none|class=sIndent}[JSForm] -- a JSForm{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_see|text=|trigger=button}{sub-section}{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_see|text=|trigger=button}{sub-section}{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_sam|text=|trigger=button}{sub-section}{sub-section:EA81D008-2EEA-4DF7-9A09-B6D507B91FE8_sam|class=sIndent|trigger=none}{code:language=javascript} var myForm = solutionModel.getForm('existingFormName'); //get the style of the form (for all other properties see JSForm node) var styleName = myForm.styleName; {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=E2E828FD-A1DC-4623-9900-A9076F0521BD}{tr:id=name}{td}h6.getForms{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSForm]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getForms{span}{span:id=iets|style=float: left;}\(server, tablename){span}{td}{tr}{tr:id=des}{td}{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_des|text=|trigger=button}{sub-section}{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_des|trigger=none|class=sIndent}
prs

Parameters

sIndentnamethe specified name of the form
ret

Returns

sIndent a JSForm
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowgetFormsname

getForms()

dessIndent
Get an array of all forms.
ret

Returns

sIndent an array of JSForm type elements
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormsname

getForms(datasource)

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

Parameters

sIndentdatasourcethe datasource or servername
ret

Returns

sIndent an array of JSForm type elements
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormsname

getForms(server, tablename)

dessIndent
Get an array of forms, that are all based on datasource/servername 
or
and tablename.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_prs|trigger=none}\[server\] -- the datasource or servername \[tablename\] -- the tablename {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_ret|text=|trigger=button}{sub-section}{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_ret|trigger=none|class=sIndent}[JSForm]\[] -- an array of JSForm type elements{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_see|text=|trigger=button}{sub-section}{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_see|text=|trigger=button}{sub-section}{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_sam|text=|trigger=button}{sub-section}{sub-section:E2E828FD-A1DC-4623-9900-A9076F0521BD_sam|class=sIndent|trigger=none}{code:language=javascript} var forms = solutionModel.getForms(datasource) for (var i in forms) application.output(forms[i].name) {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=34B47141-C642-4374-9679-9A1316859FB3}{tr:id=name}{td}h6.getGlobalMethod{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSMethod]{span}{span:id=iets|style=float: left; font-weight: bold;}getGlobalMethod{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:34B47141-C642-4374-9679-9A1316859FB3_des|text=|trigger=button}{sub-section}{sub-section:34B47141-C642-4374-9679-9A1316859FB3_des|trigger=none|class=sIndent}
prs

Parameters

sIndentserverthe datasource or servernametablenamethe tablename
ret

Returns

sIndent an array of JSForm type elements
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowgetGlobalMethodname

getGlobalMethod(scopeName, name)

dessIndent
Gets an existing global method by the specified name.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:34B47141-C642-4374-9679-9A1316859FB3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:34B47141-C642-4374-9679-9A1316859FB3_prs|trigger=none}name -- the name of the specified global method {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:34B47141-C642-4374-9679-9A1316859FB3_ret|text=|trigger=button}{sub-section}{sub-section:34B47141-C642-4374-9679-9A1316859FB3_ret|trigger=none|class=sIndent}[JSMethod] -- a JSMethod{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:34B47141-C642-4374-9679-9A1316859FB3_see|text=|trigger=button}{sub-section}{sub-section:34B47141-C642-4374-9679-9A1316859FB3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:34B47141-C642-4374-9679-9A1316859FB3_see|text=|trigger=button}{sub-section}{sub-section:34B47141-C642-4374-9679-9A1316859FB3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:34B47141-C642-4374-9679-9A1316859FB3_sam|text=|trigger=button}{sub-section}{sub-section:34B47141-C642-4374-9679-9A1316859FB3_sam|class=sIndent|trigger=none}{code:language=javascript} var method = solutionModel.getGlobalMethod("nameOfGlobalMethod"); if (method != null) application.output(method.code); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=5937D335-5345-4DEE-AF09-7372655624F0}{tr:id=name}{td}h6.getGlobalMethods{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSMethod]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getGlobalMethods{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_des|text=|trigger=button}{sub-section}{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_des|trigger=none|class=sIndent}
prs

Parameters

sIndentscopeNamethe scope in which the method is searchednamethe name of the specified global method
ret

Returns

sIndent a JSMethod
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowgetGlobalMethodsname

getGlobalMethods()

dessIndent
The list of all global methods.
ret

Returns

sIndent an array of JSMethod type elements
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getGlobalMethodsname

getGlobalMethods(scopeName)

dessIndent
The list of all global methods.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_ret|text=|trigger=button}{sub-section}{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_ret|trigger=none|class=sIndent}[JSMethod]\[] -- an array of JSMethod type elements{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_see|text=|trigger=button}{sub-section}{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_see|text=|trigger=button}{sub-section}{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_sam|text=|trigger=button}{sub-section}{sub-section:5937D335-5345-4DEE-AF09-7372655624F0_sam|class=sIndent|trigger=none}{code:language=javascript} var methods = solutionModel.getGlobalMethods(); if (methods != null) for (var x in methods) application.output(methods[x].getName()); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=68DEBFB8-D182-4B41-968F-F8BE81E39B4B}{tr:id=name}{td}h6.getGlobalVariable{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSVariable]{span}{span:id=iets|style=float: left; font-weight: bold;}getGlobalVariable{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_des|text=|trigger=button}{sub-section}{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_des|trigger=none|class=sIndent}
prs

Parameters

sIndentscopeNamelimit to global methods of specified scope name
ret

Returns

sIndent an array of JSMethod type elements
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowgetGlobalVariablename

getGlobalVariable(scopeName, name)

dessIndent
Gets an existing global variable by the specified name.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_prs|trigger=none}name -- the specified name of the global variable {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_ret|text=|trigger=button}{sub-section}{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_ret|trigger=none|class=sIndent}[JSVariable] -- a JSVariable{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_see|text=|trigger=button}{sub-section}{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_see|text=|trigger=button}{sub-section}{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_sam|text=|trigger=button}{sub-section}{sub-section:68DEBFB8-D182-4B41-968F-F8BE81E39B4B_sam|class=sIndent|trigger=none}{code:language=javascript} var globalVariable = solutionModel.getGlobalVariable('globalVariableName'); application.output(globalVariable.name + " has the default value of " + globalVariable.defaultValue); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=164EFA51-B6CB-4177-B861-59CEFD7B2C09}{tr:id=name}{td}h6.getGlobalVariables{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSVariable]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getGlobalVariables{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_des|text=|trigger=button}{sub-section}{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_des|trigger=none|class=sIndent}
prs

Parameters

sIndentscopeNamethe scope in which the variable is searchednamethe specified name of the global variable
ret

Returns

sIndent a JSVariable
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowgetGlobalVariablesname

getGlobalVariables()

dessIndent
Gets an array of all global variables.
ret

Returns

sIndent an array of JSVariable type elements
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getGlobalVariablesname

getGlobalVariables(scopeName)

dessIndent
Gets an array of all global variables.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_ret|text=|trigger=button}{sub-section}{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_ret|trigger=none|class=sIndent}[JSVariable]\[] -- an array of JSVariable type elements{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_see|text=|trigger=button}{sub-section}{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_see|text=|trigger=button}{sub-section}{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_sam|text=|trigger=button}{sub-section}{sub-section:164EFA51-B6CB-4177-B861-59CEFD7B2C09_sam|class=sIndent|trigger=none}{code:language=javascript} var globalVariables = solutionModel.getGlobalVariables(); for (var i in globalVariables) application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=416CCD97-2910-4836-867F-0A030C620177}{tr:id=name}{td}h6.getMedia{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSMedia]{span}{span:id=iets|style=float: left; font-weight: bold;}getMedia{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:416CCD97-2910-4836-867F-0A030C620177_des|text=|trigger=button}{sub-section}{sub-section:416CCD97-2910-4836-867F-0A030C620177_des|trigger=none|class=sIndent}
prs

Parameters

sIndentscopeNamelimit to global vars of specified scope name
ret

Returns

sIndent an array of JSVariable type elements
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowgetMedianame

getMedia(name)

dessIndent
Gets the specified media object; can be assigned to a button/label.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:416CCD97-2910-4836-867F-0A030C620177_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:416CCD97-2910-4836-867F-0A030C620177_prs|trigger=none}name -- the specified name of the media object {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:416CCD97-2910-4836-867F-0A030C620177_ret|text=|trigger=button}{sub-section}{sub-section:416CCD97-2910-4836-867F-0A030C620177_ret|trigger=none|class=sIndent}[JSMedia] -- a JSMedia element{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:416CCD97-2910-4836-867F-0A030C620177_see|text=|trigger=button}{sub-section}{sub-section:416CCD97-2910-4836-867F-0A030C620177_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:416CCD97-2910-4836-867F-0A030C620177_see|text=|trigger=button}{sub-section}{sub-section:416CCD97-2910-4836-867F-0A030C620177_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:416CCD97-2910-4836-867F-0A030C620177_sam|text=|trigger=button}{sub-section}{sub-section:416CCD97-2910-4836-867F-0A030C620177_sam|class=sIndent|trigger=none}{code: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 {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=515F8668-3950-408D-87A1-D0EF62E85D8F}{tr:id=name}{td}h6.getMediaList{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSMedia]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getMediaList{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_des|text=|trigger=button}{sub-section}{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_des|trigger=none|class=sIndent}
prs

Parameters

sIndentnamethe specified name of the media object
ret

Returns

sIndent a JSMedia element
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetMediaListname

getMediaList()

dessIndent
Gets the list of all media objects.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_ret|text=|trigger=button}{sub-section}{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_ret|trigger=none|class=sIndent}[JSMedia]\[] -- a list with all the media objects.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_see|text=|trigger=button}{sub-section}{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_see|text=|trigger=button}{sub-section}{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_sam|text=|trigger=button}{sub-section}{sub-section:515F8668-3950-408D-87A1-D0EF62E85D8F_sam|class=sIndent|trigger=none}{code:language=javascript} var mediaList = solutionModel.getMediaList(); if (mediaList.length != 0 && mediaList != null) { for (var x in mediaList) { application.output(mediaList[x]); } } {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=FD04A17C-E72C-41E3-B8BD-98624D3CCFC1}{tr:id=name}{td}h6.getRelation{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSRelation]{span}{span:id=iets|style=float: left; font-weight: bold;}getRelation{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_des|text=|trigger=button}{sub-section}{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_des|trigger=none|class=sIndent}
ret

Returns

sIndent a list with all the media objects.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetObjectByUUIDname

getObjectByUUID(uuid)

dessIndent
Retrieves an element by its uuid.
prs

Parameters

sIndentuuidelement uuid
ret

Returns

sIndent found element
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getRelationname

getRelation(name)

dessIndent
Gets an existing relation by the specified name and returns a JSRelation Object.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_prs|trigger=none}name -- the specified name of the relation {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_ret|text=|trigger=button}{sub-section}{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_ret|trigger=none|class=sIndent}[JSRelation] -- a JSRelation{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_see|text=|trigger=button}{sub-section}{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_see|text=|trigger=button}{sub-section}{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_sam|text=|trigger=button}{sub-section}{sub-section:FD04A17C-E72C-41E3-B8BD-98624D3CCFC1_sam|class=sIndent|trigger=none}{code: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()); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=C3BA785D-988C-4CDA-979E-1A87E85BA698}{tr:id=name}{td}h6.getRelations{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSRelation]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getRelations{span}{span:id=iets|style=float: left;}\(primary_server_name/primary_data_source, primary_table_name){span}{td}{tr}{tr:id=des}{td}{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_des|text=|trigger=button}{sub-section}{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_des|trigger=none|class=sIndent}
prs

Parameters

sIndentnamethe specified name of the relation
ret

Returns

sIndent a JSRelation
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetRelationsname

getRelations(datasource)

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

Parameters

sIndentdatasourcethe specified name of the datasource for the specified table
ret

Returns

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

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getRelationsname

getRelations(servername, tablename)

dessIndent
Gets an array of all relations; or an array of all global relations if the specified table is NULL.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_prs|trigger=none}\[primary_server_name/primary_data_source\] -- the specified name of the server or datasource for the specified table \[primary_table_name\] -- the specified name of the table {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_ret|text=|trigger=button}{sub-section}{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_ret|trigger=none|class=sIndent}[JSRelation]\[] -- an array of all relations (all elements in the array are of type JSRelation){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_see|text=|trigger=button}{sub-section}{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_see|text=|trigger=button}{sub-section}{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_sam|text=|trigger=button}{sub-section}{sub-section:C3BA785D-988C-4CDA-979E-1A87E85BA698_sam|class=sIndent|trigger=none}{code:language=javascript} var relations = solutionModel.getRelations('server_name','table_name'); if (relations.length != 0) for (var i in relations) application.output(relations[i].name); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=8E5DC228-63A9-4CC7-BF97-236716FFA584}{tr:id=name}{td}h6.getStyle{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSStyle]{span}{span:id=iets|style=float: left; font-weight: bold;}getStyle{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_des|text=|trigger=button}{sub-section}{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_des|trigger=none|class=sIndent}
prs

Parameters

sIndentservernamethe specified name of the server for the specified tabletablenamethe specified name of the table
ret

Returns

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

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetScopeNamesname

getScopeNames()

dessIndent
Gets an array of all scope names used.
ret

Returns

sIndent an array of String scope names
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getStylename

getStyle(name)

dessIndent
Gets the style specified by the given name.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_prs|trigger=none}name -- the specified name of the style {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_ret|text=|trigger=button}{sub-section}{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_ret|trigger=none|class=sIndent}[JSStyle] -- a JSStyle{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_see|text=|trigger=button}{sub-section}{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_see|text=|trigger=button}{sub-section}{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_sam|text=|trigger=button}{sub-section}{sub-section:8E5DC228-63A9-4CC7-BF97-236716FFA584_sam|class=sIndent|trigger=none}{code:language=javascript} var style = solutionModel.getStyle('my_existing_style') style.content = 'combobox { color: #0000ff;font: italic 10pt "Verdana";}' {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D}{tr:id=name}{td}h6.getValueList{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSValueList]{span}{span:id=iets|style=float: left; font-weight: bold;}getValueList{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_des|text=|trigger=button}{sub-section}{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_des|trigger=none|class=sIndent}
prs

Parameters

sIndentnamethe specified name of the style
ret

Returns

sIndent a JSStyle
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetValueListname

getValueList(name)

dessIndent
Gets an existing valuelist by the specified name and returns a JSValueList Object that can be assigned to a field.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_prs|trigger=none}name -- the specified name of the valuelist {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_ret|text=|trigger=button}{sub-section}{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_ret|trigger=none|class=sIndent}[JSValueList] -- a JSValueList object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_see|text=|trigger=button}{sub-section}{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_see|text=|trigger=button}{sub-section}{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_sam|text=|trigger=button}{sub-section}{sub-section:A62CCDD5-B67B-4AAA-95B6-FE7FBDB71C8D_sam|class=sIndent|trigger=none}{code:language=javascript} var myValueList = solutionModel.getValueList('myValueListHere') //now set the valueList property of your field //myField.valuelist = myValueList {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=276FF889-4EA8-40B9-99A0-A309B24450DA}{tr:id=name}{td}h6.getValueLists{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSValueList]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getValueLists{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_des|text=|trigger=button}{sub-section}{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_des|trigger=none|class=sIndent}Gets an array of all valuelists for the currently active solution.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_ret|text=|trigger=button}{sub-section}{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_ret|trigger=none|class=sIndent}[JSValueList]\[] -- an array of JSValueList objects{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_see|text=|trigger=button}{sub-section}{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_see|text=|trigger=button}{sub-section}{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_sam|text=|trigger=button}{sub-section}{sub-section:276FF889-4EA8-40B9-99A0-A309B24450DA_sam|class=sIndent|trigger=none}{code:language=javascript} var valueLists = solutionModel.getValueLists(); if (valueLists != null && valueLists.length != 0) for (var i in valueLists) application.output(valueLists[i].name); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=214D0763-FD0B-4239-BF8D-4B3777154A0B}{tr:id=name}{td}h6.newForm{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSForm]{span}{span:id=iets|style=float: left; font-weight: bold;}newForm{span}{span:id=iets|style=float: left;}\(name, server_name|data_source, table_name, style, show_in_menu, width, height){span}{td}{tr}{tr:id=des}{td}{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_des|text=|trigger=button}{sub-section}{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_des|trigger=none|class=sIndent}


NOTE: Changes to valuelist should be done before showing any form that has component using the valuelist.
prs

Parameters

sIndentnamethe specified name of the valuelist
ret

Returns

sIndent a JSValueList object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getValueListsname

getValueLists()

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

NOTE: Changes to valuelist should be done before showing any form that has component using the valuelist.
ret

Returns

sIndent an array of JSValueList objects
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
newFormname

newForm(name)

dessIndent
Creates a new JSForm Object.
prs

Parameters

sIndentnamethe specified name of the form
ret

Returns

sIndent a new JSForm object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newFormname

newForm(name, isResponsive)

dessIndent
Create a responsive form:
prs

Parameters

sIndentnameThe name of the new formisResponsiveif true will create an responsive form, otherwise an absolute layout form
ret

Returns

sIndent a new JSForm object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newFormname

newForm(name, superForm)

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

Parameters

sIndentnameThe name of the new formsuperFormthe super form that will extended from, see JSform.setExtendsForm();
ret

Returns

sIndent a new JSForm object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newFormname

newForm(name, superForm, isResponsive)

dessIndent
Creates a new form with the given JSForm as its super form.
Use this function in the case when the super form is a logical form (no parts/UI).
prs

Parameters

sIndentnameThe name of the new formsuperFormthe super form that will extended from, see JSform.setExtendsForm();isResponsive ;
ret

Returns

sIndent a new JSForm object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newFormname

newForm(name, dataSource, isResponsive)

dessIndent
Create a responsive form:
prs

Parameters

sIndentnameThe name of the new formdataSourcethe form datasourceisResponsiveif true will create an responsive form, otherwise an absolute layout form
ret

Returns

sIndent a new JSForm object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newFormname

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

dessIndent
Creates a new JSForm Object.

NOTE: See the JSForm node for more information about form objects that can be added to the new form.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_prs|trigger=none}name -- the specified name of the form server_name|data_source -- the specified name of the server or datasource for the specified table \[table_name\] -- the specified name of the table style -- the specified style show_in_menu -- if true show the name of the new form in the menu; or false for not showing width -- the width of the form in pixels height -- the height of the form in pixels {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_ret|text=|trigger=button}{sub-section}{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_ret|trigger=none|class=sIndent}[JSForm] -- a new JSForm object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_see|text=|trigger=button}{sub-section}{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_see|text=|trigger=button}{sub-section}{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_sam|text=|trigger=button}{sub-section}{sub-section:214D0763-FD0B-4239-BF8D-4B3777154A0B_sam|class=sIndent|trigger=none}{code:language=javascript} var myForm = solutionModel.newForm('newForm', 'myServer', 'myTable', '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) {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=3786ADD4-078B-4AB3-81C7-8DA6C02746F6}{tr:id=name}{td}h6.newGlobalMethod{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSMethod]{span}{span:id=iets|style=float: left; font-weight: bold;}newGlobalMethod{span}{span:id=iets|style=float: left;}\(code){span}{td}{tr}{tr:id=des}{td}{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_des|text=|trigger=button}{sub-section}{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_des|trigger=none|class=sIndent}
prs

Parameters

sIndentnamethe specified name of the formdataSourcethe specified name of the datasource for the specified tablestyleNamethe specified styleshow_in_menuif true show the name of the new form in the menu; or false for not showingwidththe width of the form in pixelsheightthe height of the form in pixels
ret

Returns

sIndent a new JSForm object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRownewFormname

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

dessIndent
Creates a new JSForm Object.

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

Parameters

sIndentnamethe specified name of the formserverNamethe specified name of the server for the specified tabletableNamethe specified name of the tablestyleNamethe specified styleshow_in_menuif true show the name of the new form in the menu; or false for not showingwidththe width of the form in pixelsheightthe height of the form in pixels
ret

Returns

sIndent a new JSForm object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newGlobalMethodname

newGlobalMethod(scopeName, code)

dessIndent
Creates a new global method with the specified code
.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_prs|trigger=none}code -- the specified code for the global method {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_ret|text=|trigger=button}{sub-section}{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_ret|trigger=none|class=sIndent}[JSMethod] -- a JSMethod object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_see|text=|trigger=button}{sub-section}{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_see|text=|trigger=button}{sub-section}{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_sam|text=|trigger=button}{sub-section}{sub-section:3786ADD4-078B-4AB3-81C7-8DA6C02746F6_sam|class=sIndent|trigger=none}{code:language=javascript} var method = solutionModel.newGlobalMethod('function myglobalmethod(){currentcontroller.newRecord()}') {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=5E2C2D43-E31A-4254-8E55-75AAD91339D1}{tr:id=name}{td}h6.newGlobalVariable{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSVariable]{span}{span:id=iets|style=float: left; font-weight: bold;}newGlobalVariable{span}{span:id=iets|style=float: left;}\(name, type){span}{td}{tr}{tr:id=des}{td}{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_des|text=|trigger=button}{sub-section}{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_des|trigger=none|class=sIndent}
 in a scope.
prs

Parameters

sIndentscopeNamethe scope in which the method is createdcodethe specified code for the global method
ret

Returns

sIndent a JSMethod object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
newGlobalVariablename

newGlobalVariable(scopeName, name, type)

dessIndent
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.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_prs|trigger=none}name -- the specified name for the global variable type -- the specified number type for the global variable {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_ret|text=|trigger=button}{sub-section}{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_ret|trigger=none|class=sIndent}[JSVariable] -- a JSVariable object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_see|text=|trigger=button}{sub-section}{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_see|text=|trigger=button}{sub-section}{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_sam|text=|trigger=button}{sub-section}{sub-section:5E2C2D43-E31A-4254-8E55-75AAD91339D1_sam|class=sIndent|trigger=none}{code:language=javascript} var myGlobalVariable = solutionModel.newGlobalVariable('newGlobalVariable',JSVariable.INTEGER); myGlobalVariable.defaultValue = 12; {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=C946FCA0-3FAA-4DBA-8623-C97997CC2792}{tr:id=name}{td}h6.newMedia{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSMedia]{span}{span:id=iets|style=float: left; font-weight: bold;}newMedia{span}{span:id=iets|style=float: left;}\(name, bytes){span}{td}{tr}{tr:id=des}{td}{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_des|text=|trigger=button}{sub-section}{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_des|trigger=none|class=sIndent}
prs

Parameters

sIndentscopeNamethe scope in which the variable is creatednamethe specified name for the global variabletypethe specified number type for the global variable
ret

Returns

sIndent a JSVariable object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRownewMedianame

newMedia(name, bytes)

dessIndent
Creates a new media object that can be assigned to a label or a button.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_prs|trigger=none}name -- The name of the new media bytes -- The content {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_ret|text=|trigger=button}{sub-section}{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_ret|trigger=none|class=sIndent}[JSMedia] -- a JSMedia object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_see|text=|trigger=button}{sub-section}{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_see|text=|trigger=button}{sub-section}{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_sam|text=|trigger=button}{sub-section}{sub-section:C946FCA0-3FAA-4DBA-8623-C97997CC2792_sam|class=sIndent|trigger=none}{code: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 {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA}{tr:id=name}{td}h6.newRelation{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSRelation]{span}{span:id=iets|style=float: left; font-weight: bold;}newRelation{span}{span:id=iets|style=float: left;}\(name, primary_server_name|primary_data_source, primary_table_name, foreign_server_name|foreign_data_source, foreign_table_name, join_type){span}{td}{tr}{tr:id=des}{td}{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_des|text=|trigger=button}{sub-section}{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_des|trigger=none|class=sIndent}
prs

Parameters

sIndentnameThe name of the new mediabytesThe content
ret

Returns

sIndent a JSMedia object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRownewMedianame

newMedia(name, bytes)

dessIndent
Creates a new media object for things like a CSS or LESS file that can be set as the clients solution style.
The stringContents is converted to bytes through the UTF-8 charset.
prs

Parameters

sIndentnameThe name of the new mediabytesThe content
ret

Returns

sIndent a JSMedia object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newRelationname

newRelation(name, primaryDataSource, foreignDataSource, joinType)

dessIndent
Creates a new JSRelation Object with a specified name; includes the primary datasource, 
optional table name,
foreign datasource
,
 
optional foreign table name,
and the type of join for the new relation.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_prs|trigger=none}name -- the specified name of the new relation primary_server_name|primary_data_source -- the specified name of the primary server or datasource \[primary_table_name\] -- the specified name of the primary table foreign_server_name|foreign_data_source -- the specified name of the foreign server or datasource \[foreign_table_name\] -- the specified name of the foreign table join_type -- the type of join for the new relation;
prs

Parameters

sIndentnamethe specified name of the new relationprimaryDataSourcethe specified name of the primary datasourceforeignDataSourcethe specified name of the foreign datasourcejoinTypethe type of join for the new relation; JSRelation.INNER_JOIN,
JSRelation.LEFT_OUTER_JOIN {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_ret|text=|trigger=button}{sub-section}{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_ret|trigger=none|class=sIndent}[JSRelation] -- a JSRelation object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_see|text=|trigger=button}{sub-section}{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_see|text=|trigger=button}{sub-section}{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_sam|text=|trigger=button}{sub-section}{sub-section:FBB61C1E-11DA-4FC9-A41B-D9D2BFB7C1FA_sam|class=sIndent|trigger=none}{code:language=javascript} var rel = solutionModel.newRelation('myRelation','myPrimaryServerName','myPrimaryTableName','myForeignServerName','myForeignTableName',JSRelation.INNER_JOIN); application.output(rel.getRelationItems()); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=B0F1FFB7-4CCF-4A15-AE33-40863A42CC62}{tr:id=name}{td}h6.newStyle{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSStyle]{span}{span:id=iets|style=float: left; font-weight: bold;}newStyle{span}{span:id=iets|style=float: left;}\(name, content){span}{td}{tr}{tr:id=des}{td}{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_des|text=|trigger=button}{sub-section}{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_des|trigger=none|class=sIndent}ret

Returns

sIndent a JSRelation object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newStylename

newStyle(name, content)

dessIndent
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.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_prs|trigger=none}name -- the name of the new style content -- the css content of the new style {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_ret|text=|trigger=button}{sub-section}{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_ret|trigger=none|class=sIndent}[JSStyle] -- a JSStyle object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_see|text=|trigger=button}{sub-section}{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_see|text=|trigger=button}{sub-section}{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_sam|text=|trigger=button}{sub-section}{sub-section:B0F1FFB7-4CCF-4A15-AE33-40863A42CC62_sam|class=sIndent|trigger=none}{code:language=javascript} var form = solutionModel.newForm('myForm','myServer','myTable',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(); {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=D70B62C9-BB7B-4C64-8EAD-4C664EB61691}{tr:id=name}{td}h6.newValueList{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSValueList]{span}{span:id=iets|style=float: left; font-weight: bold;}newValueList{span}{span:id=iets|style=float: left;}\(name, type){span}{td}{tr}{tr:id=des}{td}{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_des|text=|trigger=button}{sub-section}{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_des|trigger=none|class=sIndent}
prs

Parameters

sIndentnamethe name of the new stylecontentthe css content of the new style
ret

Returns

sIndent a JSStyle object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRownewValueListname

newValueList(name, type)

dessIndent
Creates a new valuelist with the specified name and number type.
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_prs|trigger=none}name -- the specified name for the valuelist type -- the specified number type for the valuelist; may be
prs

Parameters

sIndentnamethe specified name for the valuelisttypethe specified number type for the valuelist; may be JSValueList.CUSTOM_VALUES,
JSValueList.DATABASE_VALUES, JSValueList.EMPTY_VALUE_ALWAYS, JSValueList.EMPTY_VALUE_NEVER {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_ret|text=|trigger=button}{sub-section}{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_ret|trigger=none|class=sIndent}[JSValueList] -- a JSValueList object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_see|text=|trigger=button}{sub-section}{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_see|text=|trigger=button}{sub-section}{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_sam|text=|trigger=button}{sub-section}{sub-section:D70B62C9-BB7B-4C64-8EAD-4C664EB61691_sam|class=sIndent|trigger=none}{code: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("globals.text",10,10,120,20); combo1.valuelist = vl1; var combo2 = form.newComboBox("globals.id",10,60,120,20); combo2.valuelist = vl2; {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=C08E9966-B2E4-43AB-8932-C3C975651A95}{tr:id=name}{td}h6.removeForm{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}removeForm{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_des|text=|trigger=button}{sub-section}{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_des|trigger=none|class=sIndent}ret

Returns

sIndent a JSValueList object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
removeFormname

removeForm(name)

dessIndent
Removes the specified form during the persistent connected client session.

NOTE: Make sure you call history.remove first in your Servoy method (script).
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_prs|trigger=none}name -- the specified name of the form to remove {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_ret|text=|trigger=button}{sub-section}{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_ret|trigger=none|class=sIndent}[Boolean] -- true is form has been removed, false if form could not be removed{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_see|text=|trigger=button}{sub-section}{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_see|text=|trigger=button}{sub-section}{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_sam|text=|trigger=button}{sub-section}{sub-section:C08E9966-B2E4-43AB-8932-C3C975651A95_sam|class=sIndent|trigger=none}{code: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') } {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=8DE65790-54F9-4BDF-81C1-B6AEB67388DF}{tr:id=name}{td}h6.revertForm{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSForm]{span}{span:id=iets|style=float: left; font-weight: bold;}revertForm{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_des|text=|trigger=button}{sub-section}{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_des|trigger=none|class=sIndent}
prs

Parameters

sIndentnamethe specified name of the form to remove
ret

Returns

sIndent true is form has been removed, false if form could not be removed
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowremoveGlobalMethodname

removeGlobalMethod(scopeName, name)

dessIndent
Removes the specified global method.
prs

Parameters

sIndentscopeNamethe scope in which the method is declarednamethe name of the global method to be removed
ret

Returns

sIndent true if the removal was successful, false otherwise
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
removeGlobalVariablename

removeGlobalVariable(scopeName, name)

dessIndent
Removes the specified global variable.
prs

Parameters

sIndentscopeNamethe scope in which the variable is declarednamethe name of the global variable to be removed
ret

Returns

sIndent true if the removal was successful, false otherwise
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
removeMedianame

removeMedia(name)

dessIndent
Removes the media item specified by name.
prs

Parameters

sIndentnamethe name of the media item to be removed
ret

Returns

sIndent true if the removal was successful, false otherwise
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeRelationname

removeRelation(name)

dessIndent
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.
prs

Parameters

sIndentnamethe name of the relation to be removed
ret

Returns

sIndent true if the removal was successful, false otherwise
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeStylename

removeStyle(name)

dessIndent
Removes the specified style.
prs

Parameters

sIndentnamethe name of the style to be removed
ret

Returns

sIndent true if the removal was successful, false otherwise
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeValueListname

removeValueList(name)

dessIndent
Removes the specified valuelist.
prs

Parameters

sIndentnamename of the valuelist to be removed
ret

Returns

sIndent true if the removal was successful, false otherwise
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
revertFormname

revertForm(name)

dessIndent
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)
.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_prs|trigger=none}name -- the specified name of the form to revert {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_ret|text=|trigger=button}{sub-section}{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_ret|trigger=none|class=sIndent}[JSForm] -- a JSForm object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_see|text=|trigger=button}{sub-section}{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_see|text=|trigger=button}{sub-section}{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_sam|text=|trigger=button}{sub-section}{sub-section:8DE65790-54F9-4BDF-81C1-B6AEB67388DF_sam|class=sIndent|trigger=none}{code:language=javascript} //first remove it from the current history, to destroy any active form instance var success = history.removeForm('myForm') if(success) { //reverts the named form to the original solution design form, will throw an exception if the form is not an original, please make sure you called history.remove() first var revertedForm = solutionModel.revertForm('myForm') } {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
 or call form.controller.recreateUI() before the script ends.
prs

Parameters

sIndentnamethe specified name of the form to revert
ret

Returns

sIndent a JSForm object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
wrapMethodWithArgumentsname

wrapMethodWithArguments(method, args)

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

Parameters

sIndentmethodJSMethod to be assigned to an eventargspositional arguments
ret

Returns

sIndent a JSMethod
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow