Child pages
  • RuntimeTextField

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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'
Divcache
styleindexdisplay:none

...

iddescription

...

Table Row (tr)
styleheight: 30px;
Table Head (th)
Extends
Table Row (tr)
Table Cell (td)
Span
classsWordList
RuntimeComponent

...

padding0px
width80px

...

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary

...

Table Cell (td)
String

...

Table Cell (td)
String

...

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.

...

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

...

Table Cell (td)
Number

...

Gets or sets the number value (position) of the text caret (text "I" bar) in a field.

...

Table Cell (td)
Boolean

...

Table Cell (td)
Boolean

...

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

...

...

Table Cell (td)
String

...

Gets or sets the enabled state of a specified field, also known as "grayed".

...

...

Table Cell (td)
String

...

Gets or sets the foreground color of a field.

...

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

...

Table Cell (td)
String

...

Table Cell (td)
String

...

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.

...

Gets or sets the placeholder text in a field.

...

Table Cell (td)
Boolean

...

Table Cell (td)
String

...

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

...

Gets or sets the title text.

...

Table Cell (td)
String

...

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

...

Table Cell (td)
Boolean

...

Table Cell (td)
Boolean

...

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

...

...

Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).

...

...

padding0px
width80px

...

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary

...

Table Cell (td)
Number

...

servoy sSummary12%30%58%height: 30px;3Methods SummaryvoidAdds a style to the styleClass property.Returns the absolute form (designed) Y location.

...

Table Cell (td)
Object

...

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

...

Table Cell (td)
String

...

Table Cell (td)
Object

...

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

...

...

Table Cell (td)
String

...

Get the design-time properties of an element.Get a design-time property of an element.

...

...

Table Cell (td)
Number

...

Returns the type of a specified element.

...

Returns the name of the form.Returns the height of the current element.

...

Table Cell (td)
String[]

...

...

Table Cell (td)
Number

...

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

...

Table Cell (td)
Number

...

Returns the x location of the current element.

...

Returns the y location of the current element.

...

Table Cell (td)
String

...

Returns the name of an element.

...

Table Cell (td)
String

...

Table Cell (td)
String

...

Returns the currently selected text in the specified text field or text area.

...

...

Table Cell (td)
Number

...

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

...

Returns the width of the current element.voidCheck if an element

...

Table Cell (td)
void

...

already have a style from the styleClass property.voidSets the value for the specified element client property key.

...

Table Cell (td)
void

...

voidRemoves a style from the styleClass property.voidReplaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.

...

void

...

Request the focus in this element.

...

void

...

Request the focus in this element.

...

void

...

Selects all the contents of a field.

...

void

...

Sets the location of an element.

...

void

...

Sets the size of an element.

...

Table Cell (td)
void

...

table
voidSets the display/real values to the custom valuelist of the element (if element has custom valuelist).

...

servoy sDetail2Property Detailsbgcolorname

bgcolor

id

des

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


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

Returns

divsIndentclients

classtd

Supported Clients

sIndent
SmartClient,WebClient,NGClientsam

Sample

//sIdentjavascriptlastDetailRowbordername

border

dessIndent
Gets or sets the 
background color
border attribute(s) of 
the
a 
field forms.customer.elements.customer_id.bgcolor = "#FFFFFF"; //gets the background color of the field var c = forms.customer.elements.customer_id.bgcolor;

id

property

class
Colgroup Tag
Column
padding0px
width100%
Table Row (tr)
style2100%height:30px;
Table Head (th)
colspan1
Table Body (tbody)
idid
Table Row (tr)
Table Cell (td)
Table Row (tr)
Table Cell (td)
Div
classid
Table Row (tr)
String
Table Row (tr)
idsam
Div
classsIndent
Code Block
languagejavascript
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)
idcaretPosition
Table Row (tr)
idname
Table Cell (td)
caretPosition
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets or sets the number value (position) of the text caret (text "I" bar) in a field.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//get the current caretposition
var caretPos = forms.customer.elements.customer_id.caretPosition;
//add one and set it
forms.customer.elements.customer_id.caretPosition = caretPos+1;
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
ideditable
Table Row (tr)
idname
Table Cell (td)
editable
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var currentState = forms.customer.elements.customer_id.editable;
forms.customer.elements.customer_id.editable = !currentState;
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)
idformat
Table Row (tr)
idname
Table Cell (td)
format
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent

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

caretPosition

dessIndent
Gets or sets the number value (position) of the text caret (text "I" bar) in a field.
 
NOTE: This does not work in Web Client.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
editablename

editable

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

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

Returns

sIndent
clients

Supported Clients

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
formatname

format

dessIndent
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/
DecimalFormat
SimpleDateFormat.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.
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 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;
Table Row (tr)
classlastDetailRow
Table Cell (td) Table Body (tbody)
idplaceholderText
Table Row (tr)
idname
Table Cell (td)
placeholderText
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets or sets the placeholder text in a field.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//get the placeholder text
var placeholderText = forms.customer.elements.customer_id.placeholderText;
//set another placeholder
forms.customer.elements.customer_id.placeholderText = 'Search..';
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)
idtitleText
Table Row (tr)
idname
Table Cell (td)
titleText
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets or sets the title 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
var titleText = forms.customer.elements.customer_id.titleText;
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)

...

idfunction
classservoy sDetail

...

padding0px
width100%
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details

...

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

...

classlastDetailRow

...

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

...

classlastDetailRow

...

idgetDataProviderID
Table Row (tr)
idname
Table Cell (td)
getDataProviderID
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getDataProviderID
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the data provider this UI element (display) is showing.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String - The data provider as String.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.getDataProviderID();

...

classlastDetailRow

...

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

...

classlastDetailRow

...

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

...

classlastDetailRow

...

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 = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();

//sets the new size
forms.company.elements.faxBtn.setSize(w,h);

//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number - The height of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var ht = forms.customer.elements.customer_id.getHeight();

...

classlastDetailRow

...

idgetLabelForElementNames
Table Row (tr)
idname
Table Cell (td)
getLabelForElementNames
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getLabelForElementNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an Array of label element names that has this field filled in as the labelFor.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String[] - An array with element names.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var array = elements.name_first.getLabelForElementNames();
for (var i = 0; i<array.length; i++)
{
	elements[array[i]].fgcolor = "#ff00ff";
}

...

classlastDetailRow

...

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 = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();

//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number - The x location of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var x = forms.customer.elements.customer_id.getLocationX();

...

classlastDetailRow

...

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 = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();

//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number - The y location of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var y =  forms.customer.elements.customer_id.getLocationY();

...

classlastDetailRow

...

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 - The name of the element.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var name = forms.customer.elements.customer_id.getName();

...

classlastDetailRow

...

idgetSelectedText
Table Row (tr)
idname
Table Cell (td)
getSelectedText
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getSelectedText
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Returns the currently selected text in the specified text field or text area.

NOTE: This does not work for text fields in the Web Client.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String - The selected text from the component.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var my_text = forms.customer.elements.customer_id.getSelectedText();

...

classlastDetailRow

...

idgetValueListName
Table Row (tr)
idname
Table Cell (td)
getValueListName
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getValueListName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the current valuelist name for the specified field; returns NULL if no valuelist.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String - The valuelist name.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var name = forms.customer.elements.customer_id.getValueListName();

...

classlastDetailRow

...

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 = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();

//sets the new size
forms.company.elements.faxBtn.setSize(w,h);

//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number - The width of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var w = forms.customer.elements.customer_id.getWidth();

...

classlastDetailRow

...

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

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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{Object} key - user interface key (depends on operating system)
{Object} value - a predefined value for the key
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');

...

classlastDetailRow

...

idreplaceSelectedText-String
Table Row (tr)
idname
Table Cell (td)
replaceSelectedText
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
replaceSelectedText
Span
(s)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.

NOTE: replaceSelectedText applies to text fields and all XXX_AREA displayType text - RTF_AREA, HTML_AREA, or TEXT_AREA.

Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} s - The replacement text.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//returns the current selected text
var my_text = forms.customer.elements.customer_id.getSelectedText();

//replaces the current selected text
forms.customer.elements.customer_id.replaceSelectedText('John');

...

classlastDetailRow

...

idrequestFocus
Table Row (tr)
idname
Table Cell (td)
requestFocus
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
requestFocus
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Request the focus in this element. (Focus is also a text cursor on text components).
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//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();

...

classlastDetailRow

...

idrequestFocus-Boolean
Table Row (tr)
idname
Table Cell (td)
requestFocus
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
requestFocus
Span
(mustExecuteOnFocusGainedMethod)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Request the focus in this element. (Focus is also a text cursor on text components).
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{Boolean} mustExecuteOnFocusGainedMethod - If true will execute onFocusGained method, else will not; default value is true.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//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);

...

classlastDetailRow

...

idselectAll
Table Row (tr)
idname
Table Cell (td)
selectAll
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
selectAll
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Selects all the contents of a field.
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.selectAll();

...

classlastDetailRow

...

idsetLocation-Number_Number
Table Row (tr)
idname
Table Cell (td)
setLocation
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setLocation
Span
(x, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Sets the location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen.
Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.

NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example:

//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();

//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);

Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{Number} x - the X coordinate of the element in pixels.
{Number} y - the Y coordinate of the element in pixels.
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);

...

classlastDetailRow

...

idsetSize-Number_Number
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
Span
(width, height)

...

iddes

...

classsIndent

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:

...

, 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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
placeholderTextname

placeholderText

dessIndent
Gets or sets the placeholder text in a field.
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
titleTextname

titleText

dessIndent
Gets or sets the title text.
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
lastDetailRowgetAbsoluteFormLocationYname

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
getDataProviderIDname

getDataProviderID()

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

Returns

sIndent The data provider as String.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDesignPropertiesname

getDesignProperties()

dessIndent
Get the design-time properties of an element.
ret

Returns

sIndent
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
forms.company.elements.faxBtn.setSize(w+1,h+1);
ret

Returns

sIndent The height of the element in pixels.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getLabelForElementNamesname

getLabelForElementNames()

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

Returns

sIndent An array with element names.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getLocationXname

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
forms.company.elements.faxBtn.setLocation(x+10,y+10);
ret

Returns

sIndent The x location of the element in pixels.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getLocationYname

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
forms.company.elements.faxBtn.setLocation(x+10,y+10);
ret

Returns

sIndent The y location of the element in pixels.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getNamename

getName()

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

Returns

sIndent The name of the element.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getSelectedTextname

getSelectedText()

dessIndent
Returns the currently selected text in the specified text field or text area. 

NOTE: This does not work for text fields in the Web Client.
ret

Returns

sIndent The selected text from the component.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getValueListNamename

getValueListName()

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

Returns

sIndent The valuelist name.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getWidthname

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
forms.company.elements.faxBtn.setSize(w+1,h+1);
ret

Returns

sIndent The width of the element in pixels.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
hasStyleClassname

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)

dessIndent
Sets the value for the specified element client property key.

NOTE: Depending on the operating system, a user interface property name may be available.
prs

Parameters

sIndentkeyuser interface key (depends on operating system)valuea predefined value for the key
clients

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
replaceSelectedTextname

replaceSelectedText(s)

dessIndent
Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.

NOTE: replaceSelectedText applies to text fields and all XXX_AREA displayType text - RTF_AREA, HTML_AREA, or TEXT_AREA.
prs

Parameters

sIndentsThe replacement text.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
requestFocusname

requestFocus()

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

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
requestFocusname

requestFocus(mustExecuteOnFocusGainedMethod)

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

Parameters

sIndentmustExecuteOnFocusGainedMethodIf true will execute onFocusGained method, else will not; default value is true.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
selectAllname

selectAll()

dessIndent
Selects all the contents of a field.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setLocationname

setLocation(x, y)

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

Parameters

sIndentxthe X coordinate of the element in pixels.ythe Y coordinate of the element in pixels.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setSizename

setSize(width, height)

dessIndent
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

...

Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{Number} width - the width of the element in pixels.
{Number} height - the height of the element in pixels.
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);

...

classlastDetailRow

...

idsetValueListItems-Object
Table Row (tr)
idname
Table Cell (td)
setValueListItems
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setValueListItems
Span
(value)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{Object} value - first column is display value, second column is real value
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
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);

...

classlastDetailRow

...

);

//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);
prs

Parameters

sIndentwidththe width of the element in pixels.heightthe height of the element in pixels.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setValueListItemsname

setValueListItems(value)

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

Parameters

sIndentvaluefirst column is display value, second column is real value
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow