Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 36 Next »

Unknown macro: {div}

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

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Unknown macro: {div}


Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Return Types

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

ALIGNMENT

Unknown macro: {span}

ANCHOR

Unknown macro: {span}

BEVELTYPE

Unknown macro: {span}

CURSOR

Unknown macro: {span}

DEFAULTS

Unknown macro: {span}

FONTSTYLE

Unknown macro: {span}

JSBean

Unknown macro: {span}

JSButton

Unknown macro: {span}

JSCalculation

Unknown macro: {span}

JSComponent

Unknown macro: {span}

JSDataSourceNode

Unknown macro: {span}

JSField

Unknown macro: {span}

JSForm

Unknown macro: {span}

JSLabel

Unknown macro: {span}

JSMedia

Unknown macro: {span}

JSMethod

Unknown macro: {span}

JSPart

Unknown macro: {span}

JSPortal

Unknown macro: {span}

JSRelation

Unknown macro: {span}

JSRelationItem

Unknown macro: {span}

JSStyle

Unknown macro: {span}

JSTab

Unknown macro: {span}

JSTabPanel

Unknown macro: {span}

JSValueList

Unknown macro: {span}

JSVariable

Unknown macro: {span}

MEDIAOPTION

Unknown macro: {span}

PAGEORIENTATION

Unknown macro: {span}

PRINTSLIDING

Unknown macro: {span}

SCROLLBAR

Unknown macro: {span}

TITLEJUSTIFICATION

Unknown macro: {span}

TITLEPOSITION

Unknown macro: {span}

UNITS


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSComponent

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSComponent

Unknown macro: {td}

cloneComponent(newName, component, newParentForm)
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.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {td}

cloneForm(newName, jsForm)
Makes an exact copy of the given form and gives it the new name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createBevelBorder(bevel_type, highlight_outer_color, highlight_inner_color, shadow_outer_color, shadow_inner_color)
Create a bevel border string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createEmptyBorder(top_width, right_width, bottom_width, left_width)
Create an empty border string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createEtchedBorder(bevel_type, highlight_color, shadow_color)
Create an etched border string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createFont(name, style, size)
Create a font string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createLineBorder(thick, color)
Create a line border string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createMatteBorder(top_width, right_width, bottom_width, left_width, color)
Create a matte border string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin)
Create a page format string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation)
Create a page format string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation, units)
Create a page format string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createRoundedBorder(top_width, right_width, bottom_width, left_width, top_color, right_color, bottom_color, left_color, rounding_radius, border_style)
Create a special matte border string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createSpecialMatteBorder(top_width, right_width, bottom_width, left_width, top_color, right_color, bottom_color, left_color, rounding_radius, dash_pattern)
Create a special matte border string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

createTitledBorder(title_text, font, color, title_justification, title_position)
Create a titled border string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSDataSourceNode

Unknown macro: {td}

getDataSourceNode(dataSource)
Gets the specified data source node and returns information about the form (see JSDataSourceNode node).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm[]

Unknown macro: {td}

getForms()
Get an array of all forms.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm[]

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm[]

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMethod

Unknown macro: {td}

getGlobalMethod(scopeName, name)
Gets an existing global method by the specified name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMethod[]

Unknown macro: {td}

getGlobalMethods()
The list of all global methods.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMethod[]

Unknown macro: {td}

getGlobalMethods(scopeName)
The list of all global methods.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSVariable

Unknown macro: {td}

getGlobalVariable(scopeName, name)
Gets an existing global variable by the specified name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSVariable[]

Unknown macro: {td}

getGlobalVariables()
Gets an array of all global variables.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSVariable[]

Unknown macro: {td}

getGlobalVariables(scopeName)
Gets an array of all global variables.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMedia

Unknown macro: {td}

getMedia(name)
Gets the specified media object; can be assigned to a button/label.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMedia[]

Unknown macro: {td}

getMediaList()
Gets the list of all media objects.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSRelation

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSRelation[]

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSRelation[]

Unknown macro: {td}

getRelations(servername, tablename)
Gets an array of all relations; or an array of all global relations if the specified table is NULL.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String[]

Unknown macro: {td}

getScopeNames()
Gets an array of all scope names used.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSStyle

Unknown macro: {td}

getStyle(name)
Gets the style specified by the given name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSValueList

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSValueList[]

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {td}

newForm(name, superForm)
Creates a new form with the given JSForm as its super form.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {td}

newForm(name, dataSource, styleName, show_in_menu, width, height)
Creates a new JSForm Object.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {td}

newForm(name, serverName, tableName, styleName, show_in_menu, width, height)
Creates a new JSForm Object.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMethod

Unknown macro: {td}

newGlobalMethod(scopeName, code)
Creates a new global method with the specified code in a scope.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSVariable

Unknown macro: {td}

newGlobalVariable(scopeName, name, type)
Creates a new global variable with the specified name and number type.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMedia

Unknown macro: {td}

newMedia(name, bytes)
Creates a new media object that can be assigned to a label or a button.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSRelation

Unknown macro: {td}

newRelation(name, primaryDataSource, foreignDataSource, joinType)
Creates a new JSRelation Object with a specified name; includes the primary datasource, foreign datasource and the type of join for the new relation.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSStyle

Unknown macro: {td}

newStyle(name, content)
Creates a new style with the given css content string under the given name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSValueList

Unknown macro: {td}

newValueList(name, type)
Creates a new valuelist with the specified name and number type.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeForm(name)
Removes the specified form during the persistent connected client session.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeGlobalMethod(scopeName, name)
Removes the specified global method.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeGlobalVariable(scopeName, name)
Removes the specified global variable.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeMedia(name)
Removes the media item specified by name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeRelation(name)
Removes the relation specified by name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeStyle(name)
Removes the specified style.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeValueList(name)
Removes the specified valuelist.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {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.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMethod

Unknown macro: {td}

wrapMethodWithArguments(method, args)
Get a JSMethod instance with arguments to be assigned to an event.


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
cloneComponent
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSComponent

Unknown macro: {span}

cloneComponent

Unknown macro: {span}

(newName, component)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} newName – the new name of the cloned component
{JSComponent} component – the component to clone

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSComponent – the exact copy of the given component

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// get an existing field to clone.
var field = solutionModel.getForm("formWithField").getField("fieldName");
// make a clone/copy of the field
var clone = solutionModel.cloneComponent("clonedField",field);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
cloneComponent
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSComponent

Unknown macro: {span}

cloneComponent

Unknown macro: {span}

(newName, component, newParentForm)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} newName – the new name of the cloned component
{JSComponent} component – the component to clone
{JSForm} newParentForm – the new parent form

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSComponent – the exact copy of the given component

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
cloneForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm

Unknown macro: {span}

cloneForm

Unknown macro: {span}

(newName, jsForm)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} newName – the new name for the form clone
{JSForm} jsForm – the form to be cloned

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a JSForm

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createBevelBorder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createBevelBorder

Unknown macro: {span}

(bevel_type, highlight_outer_color, highlight_inner_color, shadow_outer_color, shadow_inner_color)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} bevel_type – bevel border type (SM_BEVELTYPE.RAISED or SM_BEVELTYPE.LOWERED)
{String} highlight_outer_color – bevel border highlight outer color
{String} highlight_inner_color – bevel border highlight inner color
{String} shadow_outer_color – bevel border shadow outer color
{String} shadow_inner_color – bevel border shadow outer color

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createBevelBorder(SM_BEVELTYPE.RAISED,'#ff0000','#00ff00','#ff0000','#00ff00');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createEmptyBorder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createEmptyBorder

Unknown macro: {span}

(top_width, right_width, bottom_width, left_width)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} top_width – top width of empty border in pixels
{Number} right_width – right width of empty border in pixels
{Number} bottom_width – bottom width of empty border in pixels
{Number} left_width – left width of empty border in pixels

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createEmptyBorder(1,1,1,1);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createEtchedBorder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createEtchedBorder

Unknown macro: {span}

(bevel_type, highlight_color, shadow_color)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} bevel_type – bevel border type
{String} highlight_color – bevel border highlight color
{String} shadow_color – bevel border shadow color

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createEtchedBorder(SM_BEVELTYPE.RAISED,'#ff0000','#00ff00');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createFont
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createFont

Unknown macro: {span}

(name, style, size)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the name of the font
{Number} style – the style of the font (PLAIN, BOLD, ITALIC or BOLD+ITALIC)
{Number} size – the font size

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
var component = form.getComponent("someComponent")
component.fontType = solutionModel.createFont('Arial',SM_FONTSTYLE.BOLD,14);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createLineBorder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createLineBorder

Unknown macro: {span}

(thick, color)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} thick – border thickness in pixels
{String} color – color of the line border

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createLineBorder(1,'#ff0000');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createMatteBorder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createMatteBorder

Unknown macro: {span}

(top_width, right_width, bottom_width, left_width, color)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} top_width – top width of matte border in pixels
{Number} right_width – right width of matte border in pixels
{Number} bottom_width – bottom width of matte border in pixels
{Number} left_width – left width of matte border in pixels
{String} color – border color

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createMatteBorder(1,1,1,1,"#00ff00");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createPageFormat
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createPageFormat

Unknown macro: {span}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} width – the specified width of the page to be printed.
{Number} height – the specified height of the page to be printed.
{Number} leftmargin – the specified left margin of the page to be printed.
{Number} rightmargin – the specified right margin of the page to be printed.
{Number} topmargin – the specified top margin of the page to be printed.
{Number} bottommargin – the specified bottom margin of the page to be printed.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createPageFormat
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createPageFormat

Unknown macro: {span}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} width – the specified width of the page to be printed.
{Number} height – the specified height of the page to be printed.
{Number} leftmargin – the specified left margin of the page to be printed.
{Number} rightmargin – the specified right margin of the page to be printed.
{Number} topmargin – the specified top margin of the page to be printed.
{Number} bottommargin – the specified bottom margin of the page to be printed.
{Number} orientation – the specified orientation of the page to be printed; the default is Portrait mode

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createPageFormat
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createPageFormat

Unknown macro: {span}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} width – the specified width of the page to be printed.
{Number} height – the specified height of the page to be printed.
{Number} leftmargin – the specified left margin of the page to be printed.
{Number} rightmargin – the specified right margin of the page to be printed.
{Number} topmargin – the specified top margin of the page to be printed.
{Number} bottommargin – the specified bottom margin of the page to be printed.
{Number} orientation – the specified orientation of the page to be printed; the default is Portrait mode
{Number} units – the specified units for the width and height of the page to be printed; the default is pixels

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createRoundedBorder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createRoundedBorder

Unknown macro: {span}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} top_width – top width of matte border in pixels
{Number} right_width – right width of matte border in pixels
{Number} bottom_width – bottom width of matte border in pixels
{Number} left_width – left width of matte border in pixels
{String} top_color – top border color
{String} right_color – right border color
{String} bottom_color – bottom border color
{String} left_color – left border color
{Number[]} rounding_radius – array with width/height of the arc to round the corners
{String[]} border_style – the border styles for the four margins(top/left/bottom/left)

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

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

String

Unknown macro: {span}

createSpecialMatteBorder

Unknown macro: {span}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} top_width – top width of matte border in pixels
{Number} right_width – right width of matte border in pixels
{Number} bottom_width – bottom width of matte border in pixels
{Number} left_width – left width of matte border in pixels
{String} top_color – top border color
{String} right_color – right border color
{String} bottom_color – bottom border color
{String} left_color – left border color
{Number} rounding_radius – width of the arc to round the corners
{Number[]} dash_pattern – the dash pattern of border stroke

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
// create a rectangle border (no rounded corners) and continous line
form.borderType = solutionModel.createSpecialMatteBorder(1,1,1,1,"#00ff00","#00ff00","#00ff00","#00ff00",0,null);
// create a border with rounded corners and dashed line (25 pixels drawn, then 25 pixels skipped)
// form.borderType = solutionModel.createSpecialMatteBorder(1,1,1,1,"#00ff00","#00ff00","#00ff00","#00ff00",10,new Array(25,25));
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
createTitledBorder
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

createTitledBorder

Unknown macro: {span}

(title_text, font, color, title_justification, title_position)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} title_text – the text from border
{String} font – title text font string
{String} color – border color
{Number} title_justification – title text justification
{Number} title_position – bevel title text position

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var form = solutionModel.getForm("someForm");
form.borderType = solutionModel.createTitledBorder('Test',solutionModel.createFont('Arial',SM_FONTSTYLE.PLAIN,10),'#ff0000',SM_TITLEJUSTIFICATION.CENTER,SM_TITLEPOSITION.TOP);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getDataSourceNode
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSDataSourceNode

Unknown macro: {span}

getDataSourceNode

Unknown macro: {span}

(dataSource)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} dataSource – table data source

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSDataSourceNode – a JSDataSourceNode

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var dsnode = solutionModel.getDataSourceNode('db:/example_data/customers');
var c = dsnode.getCalculation("myCalculation");
application.output("Name: " + c.getName() + ", Stored: " + c.isStored());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm

Unknown macro: {span}

getForm

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the form

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a JSForm

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var myForm = solutionModel.getForm('existingFormName');
//get the style of the form (for all other properties see JSForm node)
var styleName = myForm.styleName;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getForms
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm[]

Unknown macro: {span}

getForms

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm[] – an array of JSForm type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var forms = solutionModel.getForms()
for (var i in forms)
	application.output(forms[i].name)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getForms
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm[]

Unknown macro: {span}

getForms

Unknown macro: {span}

(datasource)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} datasource – the datasource or servername

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm[] – an array of JSForm type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var forms = solutionModel.getForms(datasource)
for (var i in forms)
	application.output(forms[i].name)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getForms
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm[]

Unknown macro: {span}

getForms

Unknown macro: {span}

(server, tablename)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} server – the datasource or servername
{String} tablename – the tablename

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm[] – an array of JSForm type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var forms = solutionModel.getForms(datasource,tablename)
for (var i in forms)
	application.output(forms[i].name)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalMethod
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod

Unknown macro: {span}

getGlobalMethod

Unknown macro: {span}

(scopeName, name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} scopeName – the scope in which the method is searched
{String} name – the name of the specified global method

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMethod – a JSMethod

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var method = solutionModel.getGlobalMethod('globals', 'nameOfGlobalMethod'); 
if (method != null) application.output(method.code);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalMethods
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod[]

Unknown macro: {span}

getGlobalMethods

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMethod[] – an array of JSMethod type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var methods = solutionModel.getGlobalMethods('globals'); 
for (var x in methods) 
	application.output(methods[x].getName());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalMethods
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod[]

Unknown macro: {span}

getGlobalMethods

Unknown macro: {span}

(scopeName)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} scopeName – limit to global methods of specified scope name

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMethod[] – an array of JSMethod type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var methods = solutionModel.getGlobalMethods('globals'); 
for (var x in methods) 
	application.output(methods[x].getName());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalVariable
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable

Unknown macro: {span}

getGlobalVariable

Unknown macro: {span}

(scopeName, name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} scopeName – the scope in which the variable is searched
{String} name – the specified name of the global variable

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSVariable – a JSVariable

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var globalVariable = solutionModel.getGlobalVariable('globals', 'globalVariableName');
application.output(globalVariable.name + " has the default value of " + globalVariable.defaultValue);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalVariables
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable[]

Unknown macro: {span}

getGlobalVariables

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSVariable[] – an array of JSVariable type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var globalVariables = solutionModel.getGlobalVariables('globals');
for (var i in globalVariables)
	application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalVariables
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable[]

Unknown macro: {span}

getGlobalVariables

Unknown macro: {span}

(scopeName)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} scopeName – limit to global vars of specified scope name

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSVariable[] – an array of JSVariable type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var globalVariables = solutionModel.getGlobalVariables('globals');
for (var i in globalVariables)
	application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getMedia
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMedia

Unknown macro: {span}

getMedia

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the media object

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMedia – a JSMedia element

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var myMedia = solutionModel.getMedia('button01.gif')
//now set the imageMedia property of your label or button
//myButton.imageMedia = myMedia
// OR
//myLabel.imageMedia = myMedia
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getMediaList
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMedia[]

Unknown macro: {span}

getMediaList

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMedia[] – a list with all the media objects.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var mediaList = solutionModel.getMediaList();
if (mediaList.length != 0 && mediaList != null) {
	for (var x in mediaList) {
		application.output(mediaList[x]);
	}
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRelation
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSRelation

Unknown macro: {span}

getRelation

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the relation

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSRelation – a JSRelation

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRelations
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSRelation[]

Unknown macro: {span}

getRelations

Unknown macro: {span}

(datasource)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} datasource – the specified name of the datasource for the specified table

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSRelation[] – an array of all relations (all elements in the array are of type JSRelation)

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var relations = solutionModel.getRelations('server_name','table_name');
if (relations.length != 0)
	for (var i in relations)
		application.output(relations[i].name);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRelations
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSRelation[]

Unknown macro: {span}

getRelations

Unknown macro: {span}

(servername, tablename)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} servername – the specified name of the server for the specified table
{String} tablename – the specified name of the table

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSRelation[] – an array of all relations (all elements in the array are of type JSRelation)

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var relations = solutionModel.getRelations('server_name','table_name');
if (relations.length != 0)
	for (var i in relations)
		application.output(relations[i].name);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getScopeNames
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String[]

Unknown macro: {span}

getScopeNames

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String[] – an array of String scope names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var scopeNames = solutionModel.getScopeNames();
for (var name in scopeNames)
	application.output(name);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getStyle
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSStyle

Unknown macro: {span}

getStyle

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the style

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSStyle – a JSStyle

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var style = solutionModel.getStyle('my_existing_style')
style.content = 'combobox { color: #0000ff;font: italic 10pt "Verdana";}'
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getValueList
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSValueList

Unknown macro: {span}

getValueList

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the valuelist

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSValueList – a JSValueList object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var myValueList = solutionModel.getValueList('myValueListHere')
//now set the valueList property of your field
//myField.valuelist = myValueList
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getValueLists
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSValueList[]

Unknown macro: {span}

getValueLists

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSValueList[] – an array of JSValueList objects

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var valueLists = solutionModel.getValueLists();
if (valueLists != null && valueLists.length != 0)
	for (var i in valueLists)
		application.output(valueLists[i].name);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm

Unknown macro: {span}

newForm

Unknown macro: {span}

(name, superForm)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – The name of the new form
{JSForm} superForm – the super form that will extended from, see JSform.setExtendsForm();

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a new JSForm object

Unknown macro: {tr}
Unknown macro: {td}

Sample

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

JSForm

Unknown macro: {span}

newForm

Unknown macro: {span}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the form
{String} dataSource – the specified name of the datasource for the specified table
{String} styleName – the specified style
{Boolean} show_in_menu – if true show the name of the new form in the menu; or false for not showing
{Number} width – the width of the form in pixels
{Number} height – the height of the form in pixels

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a new JSForm object

Unknown macro: {tr}
Unknown macro: {td}

Sample

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

JSForm

Unknown macro: {span}

newForm

Unknown macro: {span}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the form
{String} serverName – the specified name of the server for the specified table
{String} tableName – the specified name of the table
{String} styleName – the specified style
{Boolean} show_in_menu – if true show the name of the new form in the menu; or false for not showing
{Number} width – the width of the form in pixels
{Number} height – the height of the form in pixels

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a new JSForm object

Unknown macro: {tr}
Unknown macro: {td}

Sample

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

JSMethod

Unknown macro: {span}

newGlobalMethod

Unknown macro: {span}

(scopeName, code)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} scopeName – the scope in which the method is created
{String} code – the specified code for the global method

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMethod – a JSMethod object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var method = solutionModel.newGlobalMethod('globals', 'function myglobalmethod(){foundset.newRecord()}')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newGlobalVariable
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable

Unknown macro: {span}

newGlobalVariable

Unknown macro: {span}

(scopeName, name, type)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} scopeName – the scope in which the variable is created
{String} name – the specified name for the global variable
{Number} type – the specified number type for the global variable

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSVariable – a JSVariable object

Unknown macro: {tr}
Unknown macro: {td}

Sample

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

JSMedia

Unknown macro: {span}

newMedia

Unknown macro: {span}

(name, bytes)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – The name of the new media
{byte[]} bytes – The content

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMedia – a JSMedia object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var myMedia = solutionModel.newMedia('button01.gif',bytes)
//now set the imageMedia property of your label or button
//myButton.imageMedia = myMedia
// OR
//myLabel.imageMedia = myMedia
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newRelation
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSRelation

Unknown macro: {span}

newRelation

Unknown macro: {span}

(name, primaryDataSource, foreignDataSource, joinType)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the new relation
{String} primaryDataSource – the specified name of the primary datasource
{String} foreignDataSource – the specified name of the foreign datasource
{Number} joinType – the type of join for the new relation; JSRelation.INNER_JOIN, JSRelation.LEFT_OUTER_JOIN

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSRelation – a JSRelation object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var rel = solutionModel.newRelation('myRelation', myPrimaryDataSource, myForeignDataSource, JSRelation.INNER_JOIN);
application.output(rel.getRelationItems());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newStyle
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSStyle

Unknown macro: {span}

newStyle

Unknown macro: {span}

(name, content)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the name of the new style
{String} content – the css content of the new style

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSStyle – a JSStyle object

Unknown macro: {tr}
Unknown macro: {td}

Sample

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

JSValueList

Unknown macro: {span}

newValueList

Unknown macro: {span}

(name, type)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name for the valuelist
{Number} type – the specified number type for the valuelist; may be JSValueList.CUSTOM_VALUES, JSValueList.DATABASE_VALUES, JSValueList.EMPTY_VALUE_ALWAYS, JSValueList.EMPTY_VALUE_NEVER

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSValueList – a JSValueList object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var vl1 = solutionModel.newValueList("customText",JSValueList.CUSTOM_VALUES);
vl1.customValues = "customvalue1\ncustomvalue2";
var vl2 = solutionModel.newValueList("customid",JSValueList.CUSTOM_VALUES);
vl2.customValues = "customvalue1|1\ncustomvalue2|2";
var form = solutionModel.newForm("customValueListForm",controller.getDataSource(),null,true,300,300);
var combo1 = form.newComboBox("scopes.globals.text",10,10,120,20);
combo1.valuelist = vl1;
var combo2 = form.newComboBox("scopes.globals.id",10,60,120,20);
combo2.valuelist = vl2;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeForm

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the form to remove

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true is form has been removed, false if form could not be removed

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//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')
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeGlobalMethod
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeGlobalMethod

Unknown macro: {span}

(scopeName, name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} scopeName – the scope in which the method is declared
{String} name – the name of the global method to be removed

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if the removal was successful, false otherwise

Unknown macro: {tr}
Unknown macro: {td}

Sample

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

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

var list = solutionModel.getGlobalMethods('globals');
for (var i = 0; i < list.length; i++) { 
	application.output(list[i].code);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeGlobalVariable
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeGlobalVariable

Unknown macro: {span}

(scopeName, name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} scopeName – the scope in which the variable is declared
{String} name – the name of the global variable to be removed

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if the removal was successful, false otherwise

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var v1 = solutionModel.newGlobalVariable('globals', 'globalVar1', JSVariable.INTEGER);
var v2 = solutionModel.newGlobalVariable('globals', 'globalVar2', JSVariable.TEXT);

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

var list = solutionModel.getGlobalVariables('globals');
for (var i = 0; i < list.length; i++) {
	application.output(list[i].name + '[ ' + list[i].variableType + ']: ' + list[i].variableType);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeMedia
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeMedia

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the name of the media item to be removed

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if the removal was successful, false otherwise

Unknown macro: {tr}
Unknown macro: {td}

Sample

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

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

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

var mediaList = solutionModel.getMediaList();
for (var i = 0; i < mediaList.length; i++) {
	application.output(mediaList[i].getName() + ":" + mediaList[i].mimeType);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeRelation
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeRelation

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the name of the relation to be removed

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if the removal was successful, false otherwise

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var success = solutionModel.removeRelation('myRelation');
if (success) { application.output("Relation has been removed");}
else {application.output("Relation could not be removed");}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeStyle
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeStyle

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the name of the style to be removed

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if the removal was successful, false otherwise

Unknown macro: {tr}
Unknown macro: {td}

Sample

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

Boolean

Unknown macro: {span}

removeValueList

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – name of the valuelist to be removed

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if the removal was successful, false otherwise

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var vlName = "customValueList";
var vl = solutionModel.newValueList(vlName,JSValueList.CUSTOM_VALUES);
vl.customValues = "customvalue1\ncustomvalue2";

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

var vls = solutionModel.getValueLists();
if (vls != null) {
	for (var i = 0; i < vls.length; i++) {
		application.output(vls[i]);
	}
	application.output("");
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
revertForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm

Unknown macro: {span}

revertForm

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the form to revert

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a JSForm object

Unknown macro: {tr}
Unknown macro: {td}

Sample

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

JSMethod

Unknown macro: {span}

wrapMethodWithArguments

Unknown macro: {span}

(method, args)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSMethod} method – JSMethod to be assigned to an event
{Object...} args – positional arguments

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMethod – a JSMethod

Unknown macro: {tr}
Unknown macro: {td}

Sample

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