Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#bgcolor Gets or sets the background color of a field.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#border Gets or sets the border attribute(s) of a specified element.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#enabled Gets or sets the enabled state of a specified field, also known as "grayed".

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#fgcolor Gets or sets the foreground color of a field.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#readOnly Gets or sets the editable/read-only state of a field; true - read-only; false - editable; ! - the editable/read-only state is inverted (the opposite).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#visible Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#deleteRecord() Deletes the currently selected portal row in the foundset of the specified portal.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#duplicateRecord([addOnTop]) Duplicates the currently selected portal row in the foundset of the specified portal.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getAbsoluteFormLocationY() Returns the absolute form (designed) Y location.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
#getClientProperty(key) Gets the specified client property for the element based on a key.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getElementType() Returns the type of a specified element.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getHeight() Returns the height of the current element.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getLocationX() Returns the x location of the current element.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getLocationY() Returns the y location of the current element.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getName() Returns the name of an element.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getScrollX() Returns the x scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getScrollY() Returns the y scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getSelectedIndex() Gets the selected record index in the current cached foundset in the specified portal.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getSortColumns() Returns the sort columns names of the current portal (as comma separated string).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getWidth() Returns the width of the current element.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#newRecord([addOnTop]) Creates a new portal row in the foundset of the specified portal.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#putClientProperty(key, value) Sets the value for the specified element client property key.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setLocation(x, y) Sets the location of an element.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setScroll(x, y) Sets the scroll location of a portal.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setSelectedIndex(index) Sets the selected record index in the current cached foundset in the specified portal.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setSize(width, height) Sets the size of the field.

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

Table Body (tbody)

id	bgcolor
class	node

Table Row (tr)

id	name

Table Cell (td)
bgcolor

Table Row (tr)

id	des

Table Cell (td)
Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//sets the background color of the field
forms.customer.elements.customer_id.bgcolor = "#FFFFFF";
//gets the background color of the field
var c = forms.customer.elements.customer_id.bgcolor;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	border
class	node

Table Row (tr)

id	name

Table Cell (td)
border

Table Row (tr)

id	des

Table Cell (td)

Gets or sets the border attribute(s) of a specified element.

The border attributes:

borderType - EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder.
size - (numeric value) for: bottom, left, right, top.
color - (hexadecimal value) for: bottom, left, right, top.
dash pattern - (numeric value) for selected side(s).
rounding radius - (numeric value) for selected side(s).

NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType".

Table Row (tr)

id	prs

Table Cell (td)
Parameters spec – the border attributes

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//sets the border type to "LineBorder"
//sets a 1 px line width for the bottom and left side of the border
//sets the hexadecimal color of the border to "#ccffcc"
var b = forms.customer.elements.customer_id.setBorder('LineBorder,1,#ccffcc');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	enabled
class	node

Table Row (tr)

id	name

Table Cell (td)
enabled

Table Row (tr)

id	des

Table Cell (td)

Gets or sets the enabled state of a specified field, also known as "grayed".
true - enabled; false - not enabled; ! - the enabled state is inverted (the opposite).

NOTE: A disabled element cannot be selected by clicking the element (or by pressing the TAB key even if this option is supported by the operating system).

NOTE: A label or button element will not disable if the "displayType" design time property for a field is set to HTML_AREA.

NOTE: The disabled "grayed" color is dependent on the LAF set in the Servoy Client Application Preferences. For more information see Preferences: Look And Feel in the Servoy Developer User's Guide.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets the enabled state of the field
var currState = forms.customer.elements.customer_id.enabled;

//sets the enabled state of the field
forms.customer.elements.customer_id.enabled = !currentState;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	fgcolor
class	node

Table Row (tr)

id	name

Table Cell (td)
fgcolor

Table Row (tr)

id	des

Table Cell (td)
Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//sets the foreground color of the field
forms.customer.elements.customer_id.fgcolor = "#000000";

//gets the foreground color of the field
var c = forms.customer.elements.customer_id.fgcolor;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readOnly
class	node

Table Row (tr)

id	name

Table Cell (td)
readOnly

Table Row (tr)

id	des

Table Cell (td)

Gets or sets the editable/read-only state of a field; true - read-only; false - editable; ! - the editable/read-only state is inverted (the opposite).

NOTE: A field set as read-only can be selected by clicking (or pressing the TAB key if this option is supported by the operating system) and the field data can be copied.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets the editable/read-only state of the field
var currentState = forms.customer.elements.customer_id.readOnly;

//sets the editable/read-only state of the field
forms.customer.elements.customer_id.readOnly = !currentState;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	visible
class	node

Table Row (tr)

id	name

Table Cell (td)
visible

Table Row (tr)

id	des

Table Cell (td)

Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).

NOTE: The visibility of an element is not persistent; the state of visibility only applies to the current user in his/her current session.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//sets the element as visible
forms.company.elements.faxBtn.visible = true;

//gets the visibility of the element
var currentState = forms.company.elements.faxBtn.visible;

//sets the element as not visible when the current state is visible
forms.company.elements.faxBtn.visible = !currentState;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	deleteRecord
class	node

Table Row (tr)

id	name

Table Cell (td)
deleteRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

deleteRecord

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Deletes the currently selected portal row in the foundset of the specified portal.

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.deleteRecord();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	duplicateRecord
class	node

Table Row (tr)

id	name

Table Cell (td)
duplicateRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

duplicateRecord

Span

style	float: left;
id	iets

([addOnTop])

Table Row (tr)

id	des

Table Cell (td)
Duplicates the currently selected portal row in the foundset of the specified portal.

Table Row (tr)

id	prs

Table Cell (td)
Parameters [addOnTop] – adds the duplicated record as the topmost record of the foundset, default value is true

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//adds the duplicated record on top
forms.customer.elements.customer_id.duplicateRecord(true);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAbsoluteFormLocationY
class	node

Table Row (tr)

id	name

Table Cell (td)
getAbsoluteFormLocationY

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getAbsoluteFormLocationY

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the absolute form (designed) Y location.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number – The y location of the form in pixels.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getClientProperty
class	node

Table Row (tr)

id	name

Table Cell (td)
getClientProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Object

Span

style	float: left; font-weight: bold;
id	iets

getClientProperty

Span

style	float: left;
id	iets

(key)

Table Row (tr)

id	des

Table Cell (td)

Gets the specified client property for the element based on a key.

NOTE: Depending on the operating system, a user interface property name may be available.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Object} key – user interface key (depends on operating system)

Table Row (tr)

id	ret

Table Cell (td)
Returns Object – The value of the property for specified key.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getElementType
class	node

Table Row (tr)

id	name

Table Cell (td)
getElementType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getElementType

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the type of a specified element.

Table Row (tr)

id	ret

Table Cell (td)
Returns String – The display type of the element as String.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var et = forms.customer.elements.customer_id.getElementType();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getHeight
class	node

Table Row (tr)

id	name

Table Cell (td)
getHeight

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getHeight

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)

Returns the height of the current element.
NOTE: getHeight() can be used with getWidth() to set the size of an element using the setSize function. For example:

//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();

//sets the new size
forms.company.elements.faxBtn.setSize(w,h);

//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);

Table Row (tr)

id	ret

Table Cell (td)
Returns Number – The height of the element in pixels.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var ht = forms.customer.elements.customer_id.getHeight();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLocationX
class	node

Table Row (tr)

id	name

Table Cell (td)
getLocationX

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getLocationX

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)

Returns the x location of the current element.

NOTE: getLocationX() can be used with getLocationY() to set the location of an element using the setLocation function. For Example:

//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();

//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);

Table Row (tr)

id	ret

Table Cell (td)
Returns Number – The x location of the element in pixels.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var x = forms.customer.elements.customer_id.getLocationX();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLocationY
class	node

Table Row (tr)

id	name

Table Cell (td)
getLocationY

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getLocationY

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)

Returns the y location of the current element.

NOTE: getLocationY() can be used with getLocationX() to set the location of an element using the setLocation function. For Example:

//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();

//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);

Table Row (tr)

id	ret

Table Cell (td)
Returns Number – The y location of the element in pixels.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var y =  forms.customer.elements.customer_id.getLocationY();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getName
class	node

Table Row (tr)

id	name

Table Cell (td)
getName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getName

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the name of an element. (may be null as well)

Table Row (tr)

id	ret

Table Cell (td)
Returns String – The name of the element.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var name = forms.customer.elements.customer_id.getName();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getScrollX
class	node

Table Row (tr)

id	name

Table Cell (td)
getScrollX

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getScrollX

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)

Returns the x scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).

NOTE: getScrollX() can be used with getScrollY() to set the scroll location of a portal using the setScroll function. For Example:

//returns the X and Y scroll coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();

//sets the new scroll location
forms.company.elements.portal50.setScroll(x+10,y+10);

Table Row (tr)

id	ret

Table Cell (td)
Returns Number – The x scroll location in pixels.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var x = forms.customer.elements.customer_id.getScrollX();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getScrollY
class	node

Table Row (tr)

id	name

Table Cell (td)
getScrollY

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getScrollY

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)

Returns the y scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).

NOTE: getScrollY() can be used with getScrollX() to set the scroll location of a portal using the setScroll function. For Example:

//returns the X and Y scroll coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();

//sets the new scroll location
forms.company.elements.portal50.setScroll(x+10,y+10);

Table Row (tr)

id	ret

Table Cell (td)
Returns Number – The y scroll location in pixels.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var y = forms.customer.elements.customer_id.getScrollY();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getSelectedIndex
class	node

Table Row (tr)

id	name

Table Cell (td)
getSelectedIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getSelectedIndex

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Gets the selected record index in the current cached foundset in the specified portal.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number – The selected index (integer).

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets the selected record index in the foundset
var current = forms.customer.elements.customer_id.getSelectedIndex();

//sets the next record index in the foundset
forms.customer.elements.customer_id.setSelectedIndex(current+1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getSortColumns
class	node

Table Row (tr)

id	name

Table Cell (td)
getSortColumns

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getSortColumns

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the sort columns names of the current portal (as comma separated string).

Table Row (tr)

id	ret

Table Cell (td)
Returns String – array with column names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var w = forms.customer.elements.customer_id.getSortColumns();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getWidth
class	node

Table Row (tr)

id	name

Table Cell (td)
getWidth

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getWidth

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)

Returns the width of the current element.

NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:

//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();

//sets the new size
forms.company.elements.faxBtn.setSize(w,h);

//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);

Table Row (tr)

id	ret

Table Cell (td)
Returns Number – The width of the element in pixels.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var w = forms.customer.elements.customer_id.getWidth();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newRecord
class	node

Table Row (tr)

id	name

Table Cell (td)
newRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

newRecord

Span

style	float: left;
id	iets

([addOnTop])

Table Row (tr)

id	des

Table Cell (td)
Creates a new portal row in the foundset of the specified portal.

Table Row (tr)

id	prs

Table Cell (td)
Parameters [addOnTop] – adds the new portal record as the topmost row of the foundset, default value is true

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// foreign key data is only filled in for equals (=) relation items 
//adds the new record on top
forms.customer.elements.customer_id.newRecord(true);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	putClientProperty
class	node

Table Row (tr)

id	name

Table Cell (td)
putClientProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

putClientProperty

Span

style	float: left;
id	iets

(key, value)

Table Row (tr)

id	des

Table Cell (td)

Sets the value for the specified element client property key.

NOTE: Depending on the operating system, a user interface property name may be available.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Object} key – user interface key (depends on operating system) {Object} value – a predefined value for the key

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setLocation
class	node

Table Row (tr)

id	name

Table Cell (td)
setLocation

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setLocation

Span

style	float: left;
id	iets

(x, y)

Table Row (tr)

id	des

Table Cell (td)

Sets the location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen.

NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example:

//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();

//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Number} x – the X coordinate of the element in pixels. {Number} y – the Y coordinate of the element in pixels.

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.setLocation(200,200);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setScroll
class	node

Table Row (tr)

id	name

Table Cell (td)
setScroll

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setScroll

Span

style	float: left;
id	iets

(x, y)

Table Row (tr)

id	des

Table Cell (td)

Sets the scroll location of a portal. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for a portal where the height of the portal is greater than the height of the portal filed(s).

NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of a portal; then use the X and Y coordinates with the setScroll function to set a new scroll location. For Example:

//returns the X and Y coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();

//sets the new location
forms.company.elements.portal50.setScroll(x+10,y+10);

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Number} x – the X coordinate of the portal scroll location in pixels {Number} y – the Y coordinate of the portal scroll location in pixels

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.setScroll(200,200);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setSelectedIndex
class	node

Table Row (tr)

id	name

Table Cell (td)
setSelectedIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setSelectedIndex

Span

style	float: left;
id	iets

(index)

Table Row (tr)

id	des

Table Cell (td)
Sets the selected record index in the current cached foundset in the specified portal.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Number} index – the specified record index

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets the selected record index in the foundset
var current = forms.customer.elements.customer_id.getSelectedIndex();

//sets the next record index in the foundset
forms.customer.elements.customer_id.setSelectedIndex(current+1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setSize
class	node

Table Row (tr)

id	name

Table Cell (td)
setSize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setSize

Span

style	float: left;
id	iets

(width, height)

Table Row (tr)

id	des

Table Cell (td)

Sets the size of the field. It takes as input the width and the height.

NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:

//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();

//sets the new size
forms.company.elements.faxBtn.setSize(w,h);

//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Number} width – the width of the element in pixels. {Number} height – the height of the element in pixels.

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.setSize(20,30);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 15

New Version Current

Key

bgcolor

border

enabled

fgcolor

readOnly

visible

deleteRecord

duplicateRecord

getAbsoluteFormLocationY

getClientProperty

getElementType

getHeight

getLocationX

getLocationY

getName

getScrollX

getScrollY

getSelectedIndex

getSortColumns

getWidth

newRecord

putClientProperty

setLocation

setScroll

setSelectedIndex

setSize