Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Return TypessWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCK

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 moves it to a new parent form, 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
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 moves it to a new parent form, specified as a parameter.
prs

Parameters

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
cloneFormname

cloneForm(newName, jsForm)

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

Parameters

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

Returns

sIndent
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
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
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).
prs

Parameters

sIndentnamethe specified name of the form
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormsname

getForms()

dessIndent
Get an array of all forms.
ret

Returns

sIndent
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
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 and tablename.
prs

Parameters

sIndentserverthe datasource or servernametablenamethe tablename
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getGlobalMethodname

getGlobalMethod(scopeName, name)

dessIndent
Gets an existing global method by the specified name.
prs

Parameters

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getGlobalMethodsname

getGlobalMethods()

dessIndent
The list of all global methods.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getGlobalMethodsname

getGlobalMethods(scopeName)

dessIndent
The list of all global methods.
prs

Parameters

sIndentscopeNamelimit to global methods of specified scope name
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getGlobalVariablename

getGlobalVariable(scopeName, name)

dessIndent
Gets an existing global variable by the specified name.
prs

Parameters

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getGlobalVariablesname

getGlobalVariables()

dessIndent
Gets an array of all global variables.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getGlobalVariablesname

getGlobalVariables(scopeName)

dessIndent
Gets an array of all global variables.
prs

Parameters

sIndentscopeNamelimit to global vars of specified scope name
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getMedianame

getMedia(name)

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

Parameters

sIndentnamethe specified name of the media object
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getMediaListname

getMediaList()

dessIndent
Gets the list of all media objects.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getObjectByUUIDname

getObjectByUUID(uuid)

dessIndent
Retrieves an element by its uuid.
prs

Parameters

sIndentuuidelement uuid
ret

Returns

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

Parameters

sIndentnamethe specified name of the relation
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getRelationsname

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

Parameters

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getScopeNamesname

getScopeNames()

dessIndent
Gets an array of all scope names used.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getStylename

getStyle(name)

dessIndent
Gets the style specified by the given name.
prs

Parameters

sIndentnamethe specified name of the style
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getValueListname

getValueList(name)

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

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

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newFormname

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
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newGlobalMethodname

newGlobalMethod(scopeName, code)

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

Parameters

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

Returns

sIndent
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.
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
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
newMedianame

newMedia(name, bytes)

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

Parameters

sIndentnameThe name of the new mediabytesThe content
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newMedianame

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
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, foreign datasource and 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
ret

Returns

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

Parameters

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newValueListname

newValueList(name, type)

dessIndent
Creates a new valuelist with the specified name and number type.
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
ret

Returns

sIndent
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).
prs

Parameters

sIndentnamethe specified name of the form to remove
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
removeGlobalMethodname

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
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
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
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
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
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
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) or call form.controller.recreateUI() before the script ends.
prs

Parameters

sIndentnamethe specified name of the form to revert
ret

Returns

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

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow