Page History

{div:style=}

Wiki Markup

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.\\ \\ Enter additional information related to this 'class' inside the \{div} macro with 'id=description'{div} {div:id=description}{div}\\ {table:id=|class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Extends{th}{tr}{tr}{td}{span:class=sWordList}[RuntimeComponent]{span}{td}{tr}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#bgcolor] Gets or sets the background color of a field.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#border] Gets or sets the border attribute(s) of a specified element.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#editable] Gets or sets the editable/read\-only state of a field; true \- editable; false \- read\-only.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#enabled] Gets or sets the enabled state of a specified field, also known as "grayed".{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#fgcolor] Gets or sets the foreground color of a field.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#font] Gets or sets the font name, style, and size of an element.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#format] Gets or sets the display formatting of an element for number and text values; does not affect the actual value stored in the database column.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{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).{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#titleText] Gets or sets the title text.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#toolTipText] Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#transparent] Gets or sets the transparency of an element; true \- transparent; false \- not transparent.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#visible] Gets or sets the visibility of an element; true \- visible; false \- not visible; ! \- the visibility state is inverted (the opposite).{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[Number]{td}{td}[#getAbsoluteFormLocationY]\() Returns the absolute form (designed) Y location.{td}{tr}{tbody}{tbody}{tr}{td}[Object]{td}{td}[#getClientProperty]\(key) Gets the specified client property for the element based on a key.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getDataProviderID]\() Get the data provider this UI element (display) is showing.{td}{tr}{tbody}{tbody}{tr}{td}[Object]{td}{td}[#getDesignTimeProperty]\() Get a design\-time property of an element.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getElementType]\() Returns the type of a specified element.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getHeight]\() Returns the height of the current element.{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getLabelForElementNames]\() Returns an Array of label element names that has this field filled in as the labelFor.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getLocationX]\() Returns the x location of the current element.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getLocationY]\() Returns the y location of the current element.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getName]\() Returns the name of an element.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getValueListName]\() Returns the current valuelist name for the specified field; returns NULL if no valuelist.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getWidth]\() Returns the width of the current element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#putClientProperty]\(key, value) Sets the value for the specified element client property key.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#requestFocus]\() Request the focus in this element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#requestFocus]\(mustExecuteOnFocusGainedMethod) Request the focus in this element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setLocation]\(x, y) Sets the location of an element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setSize]\(width, height) Sets the size of an element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setValueListItems]\(value) Sets the display/real values to the custom valuelist of the element (if element has custom valuelist).{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=bgcolor}{tr:id=name}{td}h6.bgcolor{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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)
editable Gets or sets the editable/read-only state of a field; true - editable; false - read-only.

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

Table Cell (td)
format Gets or sets the display formatting of an element for number and text values; does not affect the actual value stored in the database column.

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

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

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

Table Cell (td)
getDataProviderID() Get the data provider this UI element (display) is showing.

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)
String[]

Table Cell (td)
getLabelForElementNames() Returns an Array of label element names that has this field filled in as the labelFor.

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

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getValueListName() Returns the current valuelist name for the specified field; returns NULL if no valuelist.

Table Row (tr)

Table Cell (td)
Number

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

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

Table Cell (td)
requestFocus() Request the focus in this element.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
requestFocus(mustExecuteOnFocusGainedMethod) Request the focus in this element.

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)
setSize(width, height) Sets the size of an element.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setValueListItems(value) Sets the display/real values to the custom valuelist of the element (if element has custom valuelist).

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=border}{tr:id=name}{td}h6.border{td}{tr}{tr:id=des}{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".{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=editable}{tr:id=name}{td}h6.editable{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=enabled}{tr:id=name}{td}h6.enabled{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=fgcolor}{tr:id=name}{td}h6.fgcolor{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=font}{tr:id=name}{td}h6.font{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=format}{tr:id=name}{td}h6.format{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets or sets the display formatting of an element for number and text values; does not affect the actual value stored in the database column. There are different options for the different dataprovider types that are assigned to this field. For Integer fields, there is a display and an edit format, using

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	format

Table Row (tr)

id	name

Table Cell (td)
format

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets or sets the display formatting of an element for number and text values; does not affect the actual value stored in the database column.

There are different options for the different dataprovider types that are assigned to this field.
For Integer fields, there is a display and an edit format, using http://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html

and

the

max

(string)

length

can

be

set.

For

Text/String

fields,

there

are

options

to

force

uppercase,lowercase

or

only

numbers.

Or

a

mask

can

be

set

that

restrict

the

input

the

pattern

chars

can

be

found

here:

http://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html

A

mask

can

have

a

placehoder

(what

is

shown

when

there

is

no

data)

and

if

the

data

must

be

stored

raw

(without

literals

of

the

mask).

A

max

text

length

can

also

be

set

to

force

the

max

text

length

input,

this

doesn't

work

on

mask

because

that

max

length

is

controlled

with

the

mask.

For

Date

fields

a

display

and

edit

format

can

be

set

by

using

a

pattern

from

here:

http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html,

you

can

also

say

this

must

behave

like

a

mask

(the

edit

format)

A

mask

only

works

with

when

the

edit

format

is

exactly

that

mask

(1

char

is

1

number/char),

because

for

example

MM

then

only

2

numbers

are

allowed

MMM

that

displays

the

month

as

a

string

is

not

supported

as

a

mask.

Some

examples

are

"dd

\

-MM

\

-yyyy",

"MM

\

-dd

\

-yyyy",

etc.

The

format

property

is

also

used

to

set

the

UI

Converter,

this

means

that

you

can

convert

the

value

object

to

something

else

before

it

gets

set

into

the

field,

this

can

also

result

in

a

type

change

of

the

data.

So

a

string

in

scripting/db

is

converted

to

a

integer

in

the

ui,

then

you

have

to

set

an

integer

format.

It

only

returns

it's

correct

value

if

it

was

explicitly

set,

otherwise

null.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

null.

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 display formatting of the field
forms.customer.elements.customer_id.format = '###';

//gets the display formatting of the field
var format = forms.customer.elements.customer_id.format;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=readOnly}{tr:id=name}{td}h6.readOnly{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=titleText}{tr:id=name}{td}h6.titleText{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets or sets the title text.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=toolTipText}{tr:id=name}{td}h6.toolTipText{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=transparent}{tr:id=name}{td}h6.transparent{td}{tr}{tr:id=des}{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 =

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{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=visible}{tr:id=name}{td}h6.visible{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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;

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=getAbsoluteFormLocationY}{tr:id=name}{td}h6.getAbsoluteFormLocationY{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getAbsoluteFormLocationY{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the absolute form (designed) Y location.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- The y location of the form in pixels.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getClientProperty-Object}{tr:id=name}{td}h6.getClientProperty{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Object]{span}{span:style=font-weight: bold;}getClientProperty{span}{span}\(key){span}{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} key -- user interface key (depends on operating system) {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Object] -- The value of the property for specified key.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDataProviderID}{tr:id=name}{td}h6.getDataProviderID{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getDataProviderID{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the data provider this UI element (display) is showing.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The data provider as String.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDesignTimeProperty}{tr:id=name}{td}h6.getDesignTimeProperty{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Object]{span}{span:style=font-weight: bold;}getDesignTimeProperty{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get a design\-time property of an element.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Object]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getElementType}{tr:id=name}{td}h6.getElementType{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getElementType{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the type of a specified element.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The display type of the element as String.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getHeight}{tr:id=name}{td}h6.getHeight{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getHeight{span}{span}\(){span}{td}{tr}{tr:id=des}{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 =

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

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- The height of the element in pixels.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLabelForElementNames}{tr:id=name}{td}h6.getLabelForElementNames{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getLabelForElementNames{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns an Array of label element names that has this field filled in as the labelFor.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[] -- An array with element names.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLabelForElementNames

Table Row (tr)

id	name

Table Cell (td)
getLabelForElementNames

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getLabelForElementNames

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an Array of label element names that has this field filled in as the labelFor.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String[] - An array with element names.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var array = elements.name_first.getLabelForElementNames();
for (var i = 0; i<array.length; i++)
{
	elements[array[i]].fgcolor = "#ff00ff";
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationX}{tr:id=name}{td}h6.getLocationX{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getLocationX{span}{span}\(){span}{td}{tr}{tr:id=des}{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 =

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

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- The x location of the element in pixels.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationY}{tr:id=name}{td}h6.getLocationY{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getLocationY{span}{span}\(){span}{td}{tr}{tr:id=des}{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 =

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

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- The y location of the element in pixels.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getName}{tr:id=name}{td}h6.getName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the name of an element. (may be null as well){div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The name of the element.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getValueListName}{tr:id=name}{td}h6.getValueListName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getValueListName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the current valuelist name for the specified field; returns NULL if no valuelist.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The valuelist name.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getValueListName

Table Row (tr)

id	name

Table Cell (td)
getValueListName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getValueListName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the current valuelist name for the specified field; returns NULL if no valuelist.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - The valuelist name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getWidth}{tr:id=name}{td}h6.getWidth{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getWidth{span}{span}\(){span}{td}{tr}{tr:id=des}{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 =

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

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- The width of the element in pixels.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	putClientProperty-Object_Object

}{

Table Row (tr)

:

id

=

	name

}{td}h6.putClientProperty{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
putClientProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}

void

{span}{span:style=

Span

style	font-weight:

bold;

}

putClientProperty

{span}{span}\

Span
(key,

value)

{span}{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} key -- user interface key (depends on operating system) \{[Object]} value -- a predefined value for the key {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=requestFocus}{tr:id=name}{td}h6.requestFocus{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}requestFocus{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Request the focus in this element. (Focus is also a text cursor on text components).{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	requestFocus

Table Row (tr)

id	name

Table Cell (td)
requestFocus

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

requestFocus

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Request the focus in this element. (Focus is also a text cursor on text components).

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

//request the focus in this forms.customer.elements.customer_id (focus is also a text cursor on text components)
forms.customer.elements.customer_id.requestFocus();

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=requestFocus-Boolean}{tr:id=name}{td}h6.requestFocus{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}requestFocus{span}{span}\(mustExecuteOnFocusGainedMethod){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Request the focus in this element. (Focus is also a text cursor on text components).{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} mustExecuteOnFocusGainedMethod -- If true will execute onFocusGained method, else will not; default value is true. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	requestFocus-Boolean

Table Row (tr)

id	name

Table Cell (td)
requestFocus

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

requestFocus

Span
(mustExecuteOnFocusGainedMethod)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Request the focus in this element. (Focus is also a text cursor on text components).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} mustExecuteOnFocusGainedMethod - If true will execute onFocusGained method, else will not; default value is true.

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

//request the focus in this forms.customer.elements.customer_id (focus is also a text cursor on text components), skip on focus gained method call
forms.customer.elements.customer_id.requestFocus(false);

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setLocation-Number_Number

}{

Table Row (tr)

:

id

=

	name

}{td}h6.setLocation{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
setLocation

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}

void

{span}{span:style=

Span

style	font-weight:

bold;

}

setLocation

{span}{span}\

Span
(x,

y)

{span}{td}{tr}{tr:id=des}{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 =

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

{div}{td}{tr}{tr:id=prs}{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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setSize-Number_Number

}{

Table Row (tr)

:

id

=

	name

}{td}h6.setSize{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
setSize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}

void

{span}{span:style=

Span

style	font-weight:

bold;

}

setSize

{span}{span}\

Span
(width,

height)

{span}{td}{tr}{tr:id=des}{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 =

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

{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} width -- the width of the element in pixels. \{[Number]} height -- the height of the element in pixels. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

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

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setValueListItems-Object}{tr:id=name}{td}h6.setValueListItems{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setValueListItems{span}{span}\(value){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets the display/real values to the custom valuelist of the element (if element has custom valuelist). This does not effect the value list with same name list on other elements or value lists at application level. Should receive a dataset parameter, first column is for display values, second column (optional) is for real values. NOTE: if you modify values for checkbox/radio field, note that having one value in valuelist is a special case, so switching between one value and 0/multiple values after form is created may have side effects{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} value -- first column is display value, second column is real value {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setValueListItems-Object

Table Row (tr)

id	name

Table Cell (td)
setValueListItems

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setValueListItems

Span
(value)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets the display/real values to the custom valuelist of the element (if element has custom valuelist).
This does not effect the value list with same name list on other elements or value lists at application level.

Should receive a dataset parameter, first column is for display values, second column (optional) is for real values.

NOTE: if you modify values for checkbox/radio field, note that having one value in valuelist is a special case, so switching between one value and 0/multiple values after form is created may have side effects

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} value - first column is display value, second column is real value

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

var dataset = databaseManager.createEmptyDataSet(0,new Array('display_values','optional_real_values'));
dataset.addRow(['aa',1]);
dataset.addRow(['bb',2]);
dataset.addRow(['cc',3]);
// forms.customer.elements.customer_id should have a valuelist attached
forms.customer.elements.customer_id.setValueListItems(dataset);

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 25

New Version Current

Key

bgcolor

border

editable

enabled

fgcolor

font

format

readOnly

titleText

toolTipText

transparent

visible

getAbsoluteFormLocationY

getClientProperty

getDataProviderID

getDesignTimeProperty

getElementType

getHeight

getLabelForElementNames

getLocationX

getLocationY

getName

getValueListName

getWidth

putClientProperty

requestFocus

requestFocus

setLocation

setSize

setValueListItems