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


Property Summary
String
#bgcolor
Gets or sets the background color of a field.
String
#border
Gets or sets the border attribute(s) of a specified element.
Boolean
#enabled
Gets or sets the enabled state of a specified field, also known as "grayed".
String
#fgcolor
Gets or sets the foreground color of a field.
Boolean
#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).
Boolean
#visible
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).

Method Summary
void
#deleteRecord()
Deletes the currently selected portal row in the foundset of the specified portal.
void
#duplicateRecord([addOnTop])
Duplicates the currently selected portal row in the foundset of the specified portal.
Number
#getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
Object
#getClientProperty(key)
Gets the specified client property for the element based on a key.
String
#getElementType()
Returns the type of a specified element.
Number
#getHeight()
Returns the height of the current element.
Number
#getLocationX()
Returns the x location of the current element.
Number
#getLocationY()
Returns the y location of the current element.
String
#getName()
Returns the name of an element.
Number
#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).
Number
#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).
Number
#getSelectedIndex()
Gets the selected record index in the current cached foundset in the specified portal.
String
#getSortColumns()
Returns the sort columns names of the current portal (as comma separated string).
Number
#getWidth()
Returns the width of the current element.
void
#newRecord([addOnTop])
Creates a new portal row in the foundset of the specified portal.
void
#putClientProperty(key, value)
Sets the value for the specified element client property key.
void
#setLocation(x, y)
Sets the location of an element.
void
#setScroll(x, y)
Sets the scroll location of a portal.
void
#setSelectedIndex(index)
Sets the selected record index in the current cached foundset in the specified portal.
void
#setSize(width, height)
Sets the size of the field.

Property Details
bgcolor
Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
Returns
String
Sample
//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;

border

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

Parameters
spec – the border attributes
Returns
String
Sample
//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');

enabled

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.

Returns
Boolean
Sample
//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;

fgcolor
Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
Returns
String
Sample
//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;

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

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.

Returns
Boolean
Sample
//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;

visible

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.

Returns
Boolean
Sample
//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;


Method Details
deleteRecord
void
deleteRecord
()
Deletes the currently selected portal row in the foundset of the specified portal.
Returns
void
Sample
forms.customer.elements.customer_id.deleteRecord();

duplicateRecord
void
duplicateRecord
([addOnTop])
Duplicates the currently selected portal row in the foundset of the specified portal.
Parameters
[addOnTop] – adds the duplicated record as the topmost record of the foundset, default value is true
Returns
void
Sample
//adds the duplicated record on top
forms.customer.elements.customer_id.duplicateRecord(true);

getAbsoluteFormLocationY
Number
getAbsoluteFormLocationY
()
Returns the absolute form (designed) Y location.
Returns
Number – The y location of the form in pixels.
Sample
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();

getClientProperty
Object
getClientProperty
(key)

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.

Parameters
{Object} key – user interface key (depends on operating system)
Returns
Object – The value of the property for specified key.
Sample
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');

getElementType
String
getElementType
()
Returns the type of a specified element.
Returns
String – The display type of the element as String.
Sample
var et = forms.customer.elements.customer_id.getElementType();

getHeight
Number
getHeight
()

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

Returns
Number – The height of the element in pixels.
Sample
var ht = forms.customer.elements.customer_id.getHeight();

getLocationX
Number
getLocationX
()

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

Returns
Number – The x location of the element in pixels.
Sample
var x = forms.customer.elements.customer_id.getLocationX();

getLocationY
Number
getLocationY
()

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

Returns
Number – The y location of the element in pixels.
Sample
var y =  forms.customer.elements.customer_id.getLocationY();

getName
String
getName
()
Returns the name of an element. (may be null as well)
Returns
String – The name of the element.
Sample
var name = forms.customer.elements.customer_id.getName();

getScrollX
Number
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).

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

Returns
Number – The x scroll location in pixels.
Sample
var x = forms.customer.elements.customer_id.getScrollX();

getScrollY
Number
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).

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

Returns
Number – The y scroll location in pixels.
Sample
var y = forms.customer.elements.customer_id.getScrollY();

getSelectedIndex
Number
getSelectedIndex
()
Gets the selected record index in the current cached foundset in the specified portal.
Returns
Number – The selected index (integer).
Sample
//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);

getSortColumns
String
getSortColumns
()
Returns the sort columns names of the current portal (as comma separated string).
Returns
String – array with column names
Sample
var w = forms.customer.elements.customer_id.getSortColumns();

getWidth
Number
getWidth
()

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

Returns
Number – The width of the element in pixels.
Sample
var w = forms.customer.elements.customer_id.getWidth();

newRecord
void
newRecord
([addOnTop])
Creates a new portal row in the foundset of the specified portal.
Parameters
[addOnTop] – adds the new portal record as the topmost row of the foundset, default value is true
Returns
void
Sample
// foreign key data is only filled in for equals (=) relation items 
//adds the new record on top
forms.customer.elements.customer_id.newRecord(true);

putClientProperty
void
putClientProperty
(key, value)

Sets the value for the specified element client property key.

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

Parameters
{Object} key – user interface key (depends on operating system)
{Object} value – a predefined value for the key
Returns
void
Sample
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');

setLocation
void
setLocation
(x, y)

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

Parameters
{Number} x – the X coordinate of the element in pixels.
{Number} y – the Y coordinate of the element in pixels.
Returns
void
Sample
forms.customer.elements.customer_id.setLocation(200,200);

setScroll
void
setScroll
(x, y)

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

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
Returns
void
Sample
forms.customer.elements.customer_id.setScroll(200,200);

setSelectedIndex
void
setSelectedIndex
(index)
Sets the selected record index in the current cached foundset in the specified portal.
Parameters
{Number} index – the specified record index
Returns
void
Sample
//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);

setSize
void
setSize
(width, height)

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

Parameters
{Number} width – the width of the element in pixels.
{Number} height – the height of the element in pixels.
Returns
void
Sample
forms.customer.elements.customer_id.setSize(20,30);