Portal (instance)

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

Parameters

String

Also see

External links

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.

Parameters

Boolean

Also see

External links

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

Parameters

String

Also see

External links

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.

Parameters

Boolean

Also see

External links

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.

Parameters

Boolean

Also see

External links

void

deleteRecord

()

Deletes the currently selected portal row in the foundset of the specified portal.

Parameters

void

Also see

External links

void

duplicateRecord

(addOnTop)

Duplicates the currently selected portal row in the foundset of the specified portal.

void

Also see

External links

Number

getAbsoluteFormLocationY

()

Returns the absolute form (designed) Y location.

Parameters

Number – The y location of the form in pixels.

Also see

External links

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.

Object – The value of the property for specified key.

Also see

External links

String

getElementType

()

Returns the type of a specified element.

Parameters

String – The display type of the element as String.

Also see

External links

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

Parameters

Number – The height of the element in pixels.

Also see

External links

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

Parameters

Number – The x location of the element in pixels.

Also see

External links

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

Parameters

Number – The y location of the element in pixels.

Also see

External links

String

getName

()

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

Parameters

String – The name of the element.

Also see

External links

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

Parameters

Number – The x scroll location in pixels.

Also see

External links

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

Parameters

Number – The y scroll location in pixels.

Also see

External links

Number

getSelectedIndex

()

Gets the selected record index in the current cached foundset in the specified portal.

Parameters

Number – The selected index (integer).

Also see

External links

String

getSortColumns

()

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

Parameters

String – array with column names

Also see

External links

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

Parameters

Number – The width of the element in pixels.

Also see

External links

void

newRecord

(addOnTop)

Creates a new portal row in the foundset of the specified portal.

void

Also see

External links

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.

void

Also see

External links

void

setBorder

(spec)

Sets the border attribute(s) of a specified element.

The border attributes:

borderType - Empty, Etched, Bevel, Line, Title, Matte, SpecialMatte.
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".

void

Also see

External links

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

void

Also see

External links

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

void

Also see

External links

void

setSelectedIndex

(index)

Sets the selected record index in the current cached foundset in the specified portal.

void

Also see

External links

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

void

Also see

External links