Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Divcache
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
String
Table Cell (td)bgcolor
styleindexdisplay: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
iddescription
HTML Tableidclassservoy sReturnTypes
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Extends
Table Row (tr)
Table Cell (td)
Span
classsWordList
RuntimeComponent
HTML Table
true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

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

Table Cell (td)
String
Table Cell (td)border
Table Cell (td)enabled
Gets or sets the border attribute(s) of a specified element. Table Row (tr)
Table Cell (td)
Boolean
Gets or sets the enabled state of a specified field, also known as "grayed". Table Row (tr)
Table Cell (td)
String
Table Cell (td)fgcolor
Gets or sets the foreground color of a field. Table Row (tr)
Table Cell (td)
String
Table Cell (td)font
Gets or sets the font name, style, and size of an element. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)readOnly
Table Row (tr)
Table Cell (td)
String
Table Cell (td)toolTipText
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 Cell (td)
Boolean
Table Cell (td)transparent
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element. Table Row (tr)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

idclassservoy sSummaryid

Colgroup Tag
Col
width80px
Col
Table Head (thead) Table Row (tr)styleservoy sSummary12%30%58%height: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)getAbsoluteFormLocationY()
3Methods SummaryvoidAdds a style to the styleClass property.Returns the absolute form (designed) Y location. Table Row (tr)
Table Cell (td)
Object
Table Cell (td)getClientProperty(key)
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)getDesignTimeProperty()
Gets the specified client property for the element based on a key. Table Row (tr)
Table Cell (td)
String
Table Cell (td)getElementType()
Get a design-time property of an element. Table Row (tr)
Table Cell (td)
Number
Table Cell (td)getHeight()
Returns the type of a specified element.Returns the name of the form.Returns the height of the current element. Table Row (tr)
Table Cell (td)
Number
Table Cell (td)getLocationX()
getLocationY()
Returns the x location of the current element. Table Row (tr)
Table Cell (td)
Number
Table Cell (td) Table Row (tr)
Table Cell (td)
String
Table Cell (td)getName()
Returns the y location of the current element. Table Row (tr)
Table Cell (td)
Number
Table Cell (td)getWidth()
Returns the name of an element.Returns the width of the current element. Table Row (tr)
Table Cell (td)
void
Table Cell (td)putClientProperty(key, value)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)setLocation(x, y)
voidCheck if an element already have a style from the styleClass property.voidSets the value for the specified element client property key. Table Row (tr) Table Cell (td)voidRemoves a style from the styleClass property.voidSets the location of an element.void Table Cell (td)setSize(width, height)
Sets the size of an element.

HTML Table

propertyclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col
Table Head (thead) Table Row (tr)styleheight:30px; Table Head (th)colspan2Property Details Table Body (tbody)ididbgcolor Table Row (tr)name

Table Cell (td)id

bgcolor

Table Row (tr) Divclassdes Table Cell (td)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.

id

It only returns it's correct value if it was explicitly set.
Table Row (tr)ret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
String Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//sets the background color of the field
forms.customer.elements.customer_id.bgcolor = "#FFFFFF";
//gets the background color of the field
var c = forms.customer.elements.customer_id.bgcolor;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idborder
Table Row (tr)
idname
Table Cell (td)

border

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//sets the border type to "LineBorder"
//sets a 1 px line width for the bottom and left side of the border
//sets the hexadecimal color of the border to "#ccffcc"
forms.customer.elements.customer_id.border = 'LineBorder,1,#ccffcc';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idenabled
Table Row (tr)
idname
Table Cell (td)

enabled

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//gets the enabled state of the field
var currState = forms.customer.elements.customer_id.enabled;

//sets the enabled state of the field
forms.customer.elements.customer_id.enabled = !currentState;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idfgcolor
Table Row (tr)
idname
Table Cell (td)

fgcolor

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//sets the foreground color of the field
forms.customer.elements.customer_id.fgcolor = "#000000";

//gets the foreground color of the field
var c = forms.customer.elements.customer_id.fgcolor;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idfont
Table Row (tr)
idname
Table Cell (td)

font

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.font = 'Tahoma,1,11';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idreadOnly
Table Row (tr)
idname
Table Cell (td)

readOnly

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//gets the editable/read-only state of the field
var currentState = forms.customer.elements.customer_id.readOnly;

//sets the editable/read-only state of the field
forms.customer.elements.customer_id.readOnly = !currentState;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtoolTipText
Table Row (tr)
idname
Table Cell (td)

toolTipText

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//gets the tooltip text of the element
var toolTip = forms.customer.elements.customer_id.toolTipText;

//sets the tooltip text of the element
forms.customer.elements.customer_id.toolTipText = "New tip";
forms.customer.elements.customer_id.toolTipText = "<html>This includes <b>bolded text</b> and <font color='blue'>BLUE</font> text as well.";
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtransparent
Table Row (tr)
idname
Table Cell (td)

transparent

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//gets the transparency of the element
var currentState = forms.customer.elements.customer_id.transparent;

//sets the transparency of the element
forms.customer.elements.customer_id.transparent = !currentState;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idvisible
Table Row (tr)
idname
Table Cell (td)

visible

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//sets the element as visible
forms.company.elements.faxBtn.visible = true;

//gets the visibility of the element
var currentState = forms.company.elements.faxBtn.visible;

//sets the element as not visible when the current state is visible
forms.company.elements.faxBtn.visible = !currentState;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idgetAbsoluteFormLocationY
Table Row (tr)
idname
Table Cell (td)

getAbsoluteFormLocationY

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getAbsoluteFormLocationY
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the absolute form (designed) Y location.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - The y location of the form in pixels.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetClientProperty-Object
Table Row (tr)
idname
Table Cell (td)

getClientProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
getClientProperty
Span
(key)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Parameters

Div
classsIndent
{Object} key - user interface key (depends on operating system)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object - The value of the property for specified key.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDesignTimeProperty
Table Row (tr)
idname
Table Cell (td)

getDesignTimeProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
getDesignTimeProperty
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get a design-time property of an element.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetElementType
Table Row (tr)
idname
Table Cell (td)

getElementType

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getElementType
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the type of a specified element.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - The display type of the element as String.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var et = forms.customer.elements.customer_id.getElementType();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetHeight
Table Row (tr)
idname
Table Cell (td)

getHeight

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getHeight
Span
()
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent

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

border

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
enabledname

enabled

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
fgcolorname

fgcolor

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
fontname

font

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
readOnlyname

readOnly

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
toolTipTextname

toolTipText

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
transparentname

transparent

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
visiblename

visible

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsaddStyleClassname

addStyleClass(styleName)

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

Parameters

sIndentstyleNamethe name of the style class to add
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getAbsoluteFormLocationYname

getAbsoluteFormLocationY()

dessIndent
Returns the absolute form (designed) Y location.
ret

Returns

sIndent The y location of the form in pixels.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getClientPropertyname

getClientProperty(key)

dessIndent
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

sIndentkeyuser interface key (depends on operating system)
ret

Returns

sIndent The value of the property for specified key.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDesignTimePropertyname

getDesignTimeProperty(key)

dessIndent
Get a design-time property of an element.
prs

Parameters

sIndentkeythe name of the property
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getElementTypename

getElementType()

dessIndent
Returns the type of a specified element.
ret

Returns

sIndent The display type of the element as String.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormNamename

getFormName()

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

Returns

sIndent The name of the form.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getHeightname

getHeight()

dessIndent
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

id

forms.company.elements.faxBtn.setSize(w+1,h+1);
Table Row (tr)ret

Table Cell (td)class

Returns

DivsIndentNumber - id The height of the element in pixels.clients

Table Row (tr)

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var ht = forms.customer.elements.customer_id.getHeight();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetLocationX
Table Row (tr)
idname
Table Cell (td)

getLocationX

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getLocationX
Span
()
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent

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

getLocationX()

dessIndent
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

id

forms.company.elements.faxBtn.setLocation(x+10,y+10);
Table Row (tr)ret

Table Cell (td)class

Returns

DivsIndentNumber - id The x location of the element in pixels.clients

Table Row (tr)

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetLocationY
Table Row (tr)
idname
Table Cell (td)

getLocationY

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getLocationY
Span
()
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent

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 =

Sample

Div
classsIndent
Code Block
languagejavascript
var x = forms.customer.elements.customer_id.getLocationX();
sIdentjavascriptlastDetailRowgetLocationYname

getLocationY()

dessIndent
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

id

forms.company.elements.faxBtn.setLocation(x+10,y+10);
Table Row (tr)ret

Table Cell (td)class

Returns

DivsIndentNumber - id The y location of the element in pixels.clients

Table Row (tr)

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetName
Table Row (tr)
idname
Table Cell (td)

getName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the name of an element. (may be null as well)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String -

Sample

Div
classsIndent
Code Block
languagejavascript
var y =  forms.customer.elements.customer_id.getLocationY();
idsIdentjavascriptlastDetailRowgetNamename

getName()

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

Returns

sIndent The name of the element.
clients

Table Row (tr)

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetWidth
Table Row (tr)
idname
Table Cell (td)

getWidth

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getWidth
Span
()
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent

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 =

Sample

Div
classsIndent
Code Block
languagejavascript
var name = forms.customer.elements.customer_id.getName();
sIdentjavascriptlastDetailRowgetWidthname

getWidth()

dessIndent
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

id

forms.company.elements.faxBtn.setSize(w+1,h+1);
Table Row (tr)ret

Table Cell (td)class

Returns

DivsIndentNumber - id The width of the element in pixels.clients

Table Row (tr)

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idputClientProperty-Object_Object
Table Row (tr)
idname
Table Cell (td)

putClientProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
putClientProperty
Span

Sample

Div
classsIndent
Code Block
languagejavascript
var w = forms.customer.elements.customer_id.getWidth();
idsIdentjavascriptlastDetailRowhasStyleClassname

hasStyleClass(styleName)

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

Parameters

sIndentstyleNamethe name of the style class to be checked
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
putClientPropertyname

putClientProperty(key, value)

Table Row (tr) Divclassdes Table Cell (td)sIndent
Sets the value for the specified element client property key.
id


NOTE: Depending on the operating system, a user interface property name may be available.
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{Object} key - user interface key (depends on operating system)
{Object} value - Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setLocation
Spana predefined value for the keyclients

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetLocation-Number_Number
Table Row (tr)
idname
Table Cell (td)

setLocation

id

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeStyleClassname

removeStyleClass(styleName)

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

Parameters

sIndentstyleNamethe name of the style class to remove
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
setLocationname

setLocation(x, y)

Table Row (tr) Divclassdes Table Cell (td)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

id

forms.company.elements.faxBtn.setLocation(x+10,y+10);
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{Number} x - the X coordinate of the element in pixels.
{Number} y -
Table Row (tr)
idname
Table Cell (td)

setSize

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setSize
Spanthe Y coordinate of the element in pixels.clients

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.setLocation(200,200);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetSize-Number_Number
id

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setSizename

setSize(width, height)

Table Row (tr)des Table Cell (td) DivclasssIndent
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

id

forms.company.elements.faxBtn.setSize(w+1,h+1);
Table Row (tr)prs

Table Cell (td)class

Parameters

DivsIndent{Number} width - the width of the element in pixels.
{Number} height - the height of the element in pixels.clients

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.setSize(20,30);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow