Page History

Div

style	display:none

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.

Div

id	description

HTML Table

id
class	servoy sReturnTypes

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Extends

Table Row (tr)

Table Cell (td)

Span

class	sWordList

RuntimeComponent

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

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

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 Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
font Gets or sets the font name, style, and size of an element.

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 Row (tr)

Table Cell (td)
Object

Table Cell (td)
tabIndex Gets or sets the selected tab index for the specified tabpanel.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
toolTipText Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
transparent Gets or sets the transparency of an element; true - transparent; false - not transparent.

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

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addTab(form/formname, [name], [tabText], [tooltip], [iconURL], [fg], [bg], [relatedfoundset/relationname], [index]) Adds a relationless or related form as a tab in a specified tabpanel.

Table Row (tr)

Table Cell (td)
Number

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

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 Row (tr)

Table Cell (td)
Object

Table Cell (td)
getDesignTimeProperty() Get a design-time property of an element.

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getMaxTabIndex() Returns the maximum tab index for a specified tabpanel.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getMnemonicAt(i) Returns the mnemonic for a specified tab of a tabpanel.

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getTabFGColorAt(i) Returns the foreground color for a specified tab of a tabpanel.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getTabFormNameAt(i) Returns the form name for a specified tab of a tabpanel.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getTabNameAt(i) Returns the name - the "name" design time property value - for a specified tab of a tabpanel.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getTabRelationNameAt(i) Returns the relation name for a specified tab of a tabpanel.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getTabTextAt(i) Returns the text for a specified tab of a tabpanel.

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
isTabEnabledAt(i) Returns the enabled status of a specified tab in a tabpanel.

Table Row (tr)

Table Cell (td)
void

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeAllTabs() Removes all tabs for a specified tabpanel.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeTabAt(index) Removes a specified tab in a tabpanel; can be based on a relation or relationless.

Table Row (tr)

Table Cell (td)
void

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

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setMnemonicAt(index, text) Sets the mnemonic for a specified tab in a tabpanel.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setSize(width, height) Sets the size of an element.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setTabEnabledAt(i, b) Sets the status of a specified tab in a tabpanel.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setTabFGColorAt(i, s) Sets the foreground color for a specified tab in a tabpanel.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setTabTextAt(index, text) Sets the text for a specified tab in a tabpanel.

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	bgcolor

Table Row (tr)

id	name

Table Cell (td)
bgcolor

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
border

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

It only returns it's correct value if it was explicitly set.

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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"
forms.customer.elements.customer_id.border = 'LineBorder,1,#ccffcc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	enabled

Table Row (tr)

id	name

Table Cell (td)
enabled

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
fgcolor

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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	font

Table Row (tr)

id	name

Table Cell (td)
font

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets or sets the font name, style, and size of an element.

font name - the name of the font family.
style - the type of the font. (plain = 0; bold = 1; italic = 2; bold-italic = 3).
size - the size of the font (in points).

It only returns it's correct value if it was explicitly set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.font = 'Tahoma,1,11';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	readOnly

Table Row (tr)

id	name

Table Cell (td)
readOnly

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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	tabIndex

Table Row (tr)

id	name

Table Cell (td)
tabIndex

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets or sets the selected tab index for the specified tabpanel.
When setting the value either the tab index or the tab name can be used.
When getting the value, the tab index (not the name) will be returned all the time.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets the selected tab index of the tabpanel
var current = forms.customer.elements.customer_id.tabIndex;

//sets (goes to) the selected tabIndex of the tabpanel
forms.customer.elements.customer_id.tabIndex = current + 1;

//or sets (goes to) the tab with the specified name
forms.customer.elements.customer_id.tabIndex = 'tab_name';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	toolTipText

Table Row (tr)

id	name

Table Cell (td)
toolTipText

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.

NOTE: HTML should be used for multi-line tooltips; you can also use any valid HTML tags to format tooltip text.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets the tooltip text of the element
var toolTip = forms.customer.elements.customer_id.toolTipText;

//sets the tooltip text of the element
forms.customer.elements.customer_id.toolTipText = "New tip";
forms.customer.elements.customer_id.toolTipText = "<html>This includes <b>bolded text</b> and <font color='blue'>BLUE</font> text as well.";

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	transparent

Table Row (tr)

id	name

Table Cell (td)
transparent

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets or sets the transparency of an element; true - transparent; false - not transparent.

NOTE: transparency can be inverted using ! operator: elements.elementName.transparent = !elements.elementName.transparent;

NOTE: transparency will be mostly used for background color, a transparent element will receive the background of the element "beneath" it, a non transparent one will use its own background color

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets the transparency of the element
var currentState = forms.customer.elements.customer_id.transparent;

//sets the transparency of the element
forms.customer.elements.customer_id.transparent = !currentState;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	visible

Table Row (tr)

id	name

Table Cell (td)
visible

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	addTab-________

Table Row (tr)

id	name

Table Cell (td)
addTab

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addTab

Span
(form/formname, [name], [tabText], [tooltip], [iconURL], [fg], [bg], [relatedfoundset/relationname], [index])

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Adds a relationless or related form as a tab in a specified tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

form/formname - the specified form/form name you wish to add as a tab
[name] - the specified name for the tab or NULL (default is null)
[tabText] - the specified text for the tab (default is null)
[tooltip] - a specified tooltip for the tab (default is null)
[iconURL] - a specified icon image or icon URL for the tab (default is null)
[fg] - the HTML RGB Hexadecimal foreground color for the tab (default is null)
[bg] - the HTML RGB Hexadecimal background color for the tab (default is null)
[relatedfoundset/relationname] - the specified name of the related foundset (default is null)
[index] - the specified index of a tab, default is -1, will add tab to the end, this index is 0 based

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - a boolean value indicating if tab was successfully added

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.addTab(forms.orders,'ordersTab','Orders',null,null,'#000000','#BBCCEE');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAbsoluteFormLocationY

Table Row (tr)

id	name

Table Cell (td)
getAbsoluteFormLocationY

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getAbsoluteFormLocationY

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the absolute form (designed) Y location.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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-Object

Table Row (tr)

id	name

Table Cell (td)
getClientProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

getClientProperty

Span
(key)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{Object} key - user interface key (depends on operating system)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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	getDesignTimeProperty

Table Row (tr)

id	name

Table Cell (td)
getDesignTimeProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

getDesignTimeProperty

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get a design-time property of an element.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getElementType

Table Row (tr)

id	name

Table Cell (td)
getElementType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getElementType

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the type of a specified element.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
getHeight

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getHeight

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
getLocationX

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getLocationX

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
getLocationY

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getLocationY

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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	getMaxTabIndex

Table Row (tr)

id	name

Table Cell (td)
getMaxTabIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getMaxTabIndex

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the maximum tab index for a specified tabpanel.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - maximum tab index (number)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var max = forms.customer.elements.customer_id.getMaxTabIndex();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMnemonicAt-Number

Table Row (tr)

id	name

Table Cell (td)
getMnemonicAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getMnemonicAt

Span
(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the mnemonic for a specified tab of a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i - The number of the specified tab.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - The mnemonic.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var mnemonic = forms.customer.elements.customer_id.getMnemonicAt(3);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getName

Table Row (tr)

id	name

Table Cell (td)
getName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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	getTabFGColorAt-Number

Table Row (tr)

id	name

Table Cell (td)
getTabFGColorAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getTabFGColorAt

Span
(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the foreground color for a specified tab of a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i - the number of the specified tab

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - color as hexadecimal RGB string

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var color = forms.customer.elements.customer_id.getTabFGColorAt(3);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTabFormNameAt-Number

Table Row (tr)

id	name

Table Cell (td)
getTabFormNameAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getTabFormNameAt

Span
(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the form name for a specified tab of a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i - index of the tab

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the name of the form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var formName = forms.customer.elements.customer_id.getSelectedTabFormName(3);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTabNameAt-Number

Table Row (tr)

id	name

Table Cell (td)
getTabNameAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getTabNameAt

Span
(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the name - the "name" design time property value - for a specified tab of a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i - The number of the specified tab.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - The tab name

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var tabName = forms.customer.elements.customer_id.getTabNameAt(3);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTabRelationNameAt-Number

Table Row (tr)

id	name

Table Cell (td)
getTabRelationNameAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getTabRelationNameAt

Span
(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the relation name for a specified tab of a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i - index of the tab

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - relation name

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var relName = forms.customer.elements.customer_id.getTabRelationNameAt(3);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTabTextAt-Number

Table Row (tr)

id	name

Table Cell (td)
getTabTextAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getTabTextAt

Span
(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the text for a specified tab of a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i - The number of the specified tab.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - The tab text.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var tabText = forms.customer.elements.customer_id.getTabTextAt(3);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getWidth

Table Row (tr)

id	name

Table Cell (td)
getWidth

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getWidth

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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	isTabEnabledAt-Number

Table Row (tr)

id	name

Table Cell (td)
isTabEnabledAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isTabEnabledAt

Span
(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the enabled status of a specified tab in a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i - the number of the specified tab.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - True if tab is enabled, false otherwise.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var status = forms.customer.elements.customer_id.isTabEnabledAt(3);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	putClientProperty-Object_Object

Table Row (tr)

id	name

Table Cell (td)
putClientProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

putClientProperty

Span
(key, value)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{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

Div

class	sIndent

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	removeAllTabs

Table Row (tr)

id	name

Table Cell (td)
removeAllTabs

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeAllTabs

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes all tabs for a specified tabpanel.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - a boolean value indicating if tabs were successfully removed

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeTabAt-

Table Row (tr)

id	name

Table Cell (td)
removeTabAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeTabAt

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a specified tab in a tabpanel; can be based on a relation or relationless.

NOTE: In Servoy 4.x (and higher), the addTab function applies to relationless or related tabs in a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

index - The index of the tab to remove.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - a boolean value indicating if tab was successfully removed

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.removeTabAt(3);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setLocation-Number_Number

Table Row (tr)

id	name

Table Cell (td)
setLocation

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setLocation

Span
(x, y)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.
Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.

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

Div

class	sIndent

{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

Div

class	sIndent

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	setMnemonicAt-_

Table Row (tr)

id	name

Table Cell (td)
setMnemonicAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setMnemonicAt

Span
(index, text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets the mnemonic for a specified tab in a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

index - the number of the specified tab
text - the text to be set for the specified tab

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.setMnemonicAt(3,'a');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setSize-Number_Number

Table Row (tr)

id	name

Table Cell (td)
setSize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setSize

Span
(width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets the size of an element. It takes as input the width and the height.
Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.

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

Div

class	sIndent

{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

Div

class	sIndent

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)

Table Body (tbody)

id	setTabEnabledAt-Number_Boolean

Table Row (tr)

id	name

Table Cell (td)
setTabEnabledAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setTabEnabledAt

Span
(i, b)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets the status of a specified tab in a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i - the number of the specified tab.
{Boolean} b - true if enabled; or false if disabled.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.setTabEnabledAt(3,true);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setTabFGColorAt-Number_String

Table Row (tr)

id	name

Table Cell (td)
setTabFGColorAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setTabFGColorAt

Span
(i, s)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets the foreground color for a specified tab in a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i - the number of the specified tab
{String} s - the hexadecimal RGB color value to be set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.setTabFGColorAt(3,'#000000');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setTabTextAt-_

Table Row (tr)

id	name

Table Cell (td)
setTabTextAt

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setTabTextAt

Span
(index, text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets the text for a specified tab in a tabpanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

index - the number of the specified tab
text - the text to be set for the specified tab

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.elements.customer_id.setTabTextAt(3,'newTitle');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Page History

Versions Compared

Old Version 13

New Version Current

Key

bgcolor

border

enabled

fgcolor

font

readOnly

tabIndex

toolTipText

transparent

visible

addTab

getAbsoluteFormLocationY

getClientProperty

getDesignTimeProperty

getElementType

getHeight

getLocationX

getLocationY

getMaxTabIndex

getMnemonicAt

getName

getTabFGColorAt

getTabFormNameAt

getTabNameAt

getTabRelationNameAt

getTabTextAt

getWidth

isTabEnabledAt

putClientProperty

removeAllTabs

removeTabAt

setLocation

setMnemonicAt

setSize

setTabEnabledAt

setTabFGColorAt

setTabTextAt