Page History

...

style	display:none

...

Div

id	description

ImageMedia fields are fields that can display images.

The user can, depending on the field state (enabled/readonly) get/set of update the contents of the field.

When the user sets/updates the content of the field, Servoy has special logic that retrieves the filename and mimetype of the uploaded file and stores those in dataproviders that follow the following naming convention:

filename: DataProviderID (of the ImageMedia field) + "_filename"
mimetype: DataProviderID (of the ImageMedia field) + "_mimetype"

...

Table Row (tr)

style	height: 30px;

Table Head (th)
Extends

Table Row (tr)

Table Cell (td)

Span

class	sWordList

RuntimeComponent

...

padding	0px
width	80px

...

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 Cell (td)
Boolean

...

Cache

index	true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sReturnTypes2100%height: 30px;2ExtendssWordListBLOCK

servoy sSummary12%30%58%height: 30px;3Property SummaryGets or sets the background color of a field.Gets or sets the border attribute(s) of a specified element.Gets or sets the editable/read-only state of a field; true - editable; false - read-only.Gets or sets the enabled state of a specified field, also known as "grayed".Gets or sets the foreground color of a field.Gets or sets the font name, style, and size of an element.Gets or sets the editable/read-only state of a field; true - read-only; false - editable;

...

! - the editable/read-only

...

Table Cell (td)
Boolean

...

state is inverted (the opposite).

Gets or sets the title text.

Gets or sets the

...

Table Cell (td)
String

...

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

Gets or sets the

...

Table Cell (td)
String

...

transparency of an element; true - transparent; false - not transparent.

Gets or sets the

...

visibility of an element

...

Table Cell (td)
Boolean

...

; true -

...

visible; false -

...

not visible; ! - the

...

visibility state is inverted (the opposite).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#titleText Gets or sets the title text.

Table Body (tbody)

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 Body (tbody)

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

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

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)
#getDataProviderID() Get the data provider this UI element (display) is showing.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Object

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

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 specified element - only for an element where height of element is less than the height of element content.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getScrollY() Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.

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)
#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 an element.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

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

...

id	property
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

...

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;

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

id	editable

Table Row (tr)

id	name

Table Cell (td)
editable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets or sets the editable/read-only state of a field; true - editable; false - read-only.

NOTE the "!" operator can be used to invert the editable state.

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


var currentState = forms.customer.elements.customer_id.editable;
forms.customer.elements.customer_id.editable = !currentState;

...

class	lastDetailRow

...

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;

...

class	lastDetailRow

...

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;

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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;

...

class	lastDetailRow

...

id	titleText

Table Row (tr)

id	name

Table Cell (td)
titleText

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets or sets the title 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


var titleText = forms.customer.elements.customer_id.titleText;

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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;

...

class	lastDetailRow

...

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;

...

class	lastDetailRow

...

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

Table Row (tr)

id	name

Table Cell (td)
getDataProviderID

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getDataProviderID

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the data provider this UI element (display) is showing.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – The data provider as String.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

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

Table Row (tr)

id	name

Table Cell (td)
getScrollX

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getScrollX

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.

NOTE: getScrollX() can be used with getScrollY() to set the scroll location of an element 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

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
getScrollY

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getScrollY

Span
()

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.

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

//returns the X and Y scroll coordinates
var x =

servoy sSummary

12%

30%

58%

height: 30px;

3

Methods Summary

void

Adds a style to the styleClass property.

Returns the absolute form (designed) Y location.

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

Get the data provider this UI element (display) is showing.

Get the design-time properties of an element.

Get a design-time property of an element.

Returns the type of a specified element.

Returns the name of the form.

Returns the height of the current element.

Returns the x location of the current element.

Returns the y location of the current element.

Returns the name of an element.

Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.

Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.

Returns the width of the current element.

void

Check if an element already have a style from the styleClass property.

void

Sets the value for the specified element client property key.

void

Removes a style from the styleClass property.

void

Sets the location of an element.

void

Sets the scroll location of an element.

void

Sets the size of an element.

propertyservoy sDetail2100%height:30px2Property Detailsbgcolorname

bgcolor

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

border

name

border

des

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

editable

name

editable

des

sIndent

Gets or sets the editable/read-only state of a field; true - editable; false - read-only.

NOTE the "!" operator can be used to invert the editable state.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

enabled

name

enabled

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

fgcolor

name

fgcolor

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

font

name

font

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

readOnly

name

readOnly

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

titleText

name

titleText

des

sIndent

Gets or sets the title text.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

toolTipText

name

toolTipText

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

transparent

name

transparent

des

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

visible

name

visible

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsaddStyleClassname

addStyleClass(styleName)

des

sIndent

Adds a style to the styleClass property. This works only for NGClient where multiple styles are supported.

prs

Parameters

sIndent

styleName

the name of the style class to add

clients

Supported Clients

sIndent

NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getAbsoluteFormLocationY

name

getAbsoluteFormLocationY()

des

sIndent

Returns the absolute form (designed) Y location.

ret

Returns

sIndent

The y location of the form in pixels.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getClientProperty

name

getClientProperty(key)

des

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.

prs

Parameters

sIndent

key

user interface key (depends on operating system)

ret

Returns

sIndent

The value of the property for specified key.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getDataProviderID

name

getDataProviderID()

des

sIndent

Get the data provider this UI element (display) is showing.

ret

Returns

sIndent

The data provider as String.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getDesignProperties

name

getDesignProperties()

des

sIndent

Get the design-time properties of an element.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getDesignTimeProperty

name

getDesignTimeProperty(key)

des

sIndent

Get a design-time property of an element.

prs

Parameters

sIndent

key

the name of the property

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getElementType

name

getElementType()

des

sIndent

Returns the type of a specified element.

ret

Returns

sIndent

The display type of the element as String.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getFormName

name

getFormName()

des

sIndent

Returns the name of the form. (may be empty string as well)

ret

Returns

sIndent

The name of the form.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getHeight

name

getHeight()

des

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

ret

Returns

sIndent

The height of the element in pixels.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getLocationX

name

getLocationX()

des

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

ret

Returns

sIndent

The x location of the element in pixels.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getLocationY

name

getLocationY()

des

sIndent

Returns the y location of the current element. The method can only be used in Record view.

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

ret

Returns

sIndent

The y location of the element in pixels.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getName

name

getName()

des

sIndent

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

ret

Returns

sIndent

The name of the element.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getScrollX

name

getScrollX()

des

sIndent

Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.

NOTE: getScrollX() can be used with getScrollY() to set the scroll location of an element 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

Div

class	sIndent

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

10);

ret

Returns

sIndent

The x scroll location in pixels.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getScrollY

name

getScrollY()

des

sIndent

Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.

NOTE: getScrollY() can be used with getScrollX() to set the scroll location of an element 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);

ret

Returns

sIndent

The y scroll location in pixels.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getWidth

name

getWidth()

des

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.

customer.elements.customer_id.getWidth(); 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	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

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

ret

Returns

sIndent

The width of the element in pixels.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

hasStyleClass

name

hasStyleClass(styleName)

des

sIndent

Check if an element already have a style from the styleClass property.

prs

Parameters

sIndent

styleName

the name of the style class to be checked

clients

Supported Clients

sIndent

NGClient

sam

Sample

sIdent

javascript

lastDetailRow

putClientProperty

name

putClientProperty(key, value)

des

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.

prs

Parameters

sIndent

key

user interface key (depends on operating system)

value

a predefined value for the key

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

removeStyleClass

name

removeStyleClass(styleName)

des

sIndent

Removes a style from the styleClass property. This works only for NGClient where multiple styles are supported.

prs

Parameters

sIndent

styleName

the name of the style class to remove

clients

Supported Clients

sIndent

NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setLocation

name

setLocation(x, y)

des

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.

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	setScroll-Number_Number

Table Row (tr)

id	name

Table Cell (td)
setScroll

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setScroll

Span
(x, y)

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

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

NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of an element; 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 =

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

prs

Parameters

sIndent

x

the X coordinate of the element in pixels.

y

the Y coordinate of the element in pixels.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setScroll

name

setScroll(x, y)

des

sIndent

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

NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of an element; 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

Div

class	sIndent

{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

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.setScroll(200,200);

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 =

);
var y = forms.company.elements.portal50.getScrollY();

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

prs

Parameters

sIndent

x

the X coordinate of the portal scroll location in pixels

y

the Y coordinate of the portal scroll location in pixels

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setSize

name

setSize(width, height)

des

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

tr

idParameters
 Divclassprs Table Cell (td)Parameters
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
tdclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRow

Child pages

Page History

Versions Compared

Old Version 14

New Version Current

Key

bgcolor

border

editable

enabled

fgcolor

font

readOnly

titleText

toolTipText

transparent

visible

getAbsoluteFormLocationY

getClientProperty

getDataProviderID

getDesignTimeProperty

getElementType

getHeight

getLocationX

getLocationY

getName

getScrollX

getScrollY

bgcolor

border

editable

enabled

fgcolor

font

readOnly

titleText

toolTipText

transparent

visible

addStyleClass(styleName)

getAbsoluteFormLocationY()

getClientProperty(key)

getDataProviderID()

getDesignProperties()

getDesignTimeProperty(key)

getElementType()

getFormName()

getHeight()

getLocationX()

getLocationY()

getName()

getScrollX()

getWidth

getScrollY()

getWidth()

putClientProperty

setLocation

hasStyleClass(styleName)

putClientProperty(key, value)

removeStyleClass(styleName)

setLocation(x, y)

setScroll

setScroll(x, y)

setSize

setSize(width, height)