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.
refresh
100d
showRefresh
true
id
doc
title
Refresh page
showDate
true
retry
Enable
id
class
servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientservoy sReturnTypes2100%height: 30px;2ExtendssWordListBLOCKservoy sSummary12%30%58%height: 30px;3Property SummaryGets or sets the background color of a field.
titleText Gets or sets the 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.
getClientProperty(key) 12%30%58%height: 30px;3Methods SummaryvoidAdds a style to the styleClass property.Returns the absolute form (designed) Y location.
Table Row (tr)
Gets the specified client property for the element based on a key.
getElementType() Returns the Get the design-time properties of an element.Get a design-time property of an element.Returns the type of a specified element.
getWidth() Returns the current valuelist name for the specified field; returns NULL if no valuelist.Returns the width of the current element.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
putClientProperty(key, value) voidCheck if an element already have a style from the styleClass property.voidSets the value for the specified element client property key.
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 = 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.
//sets the background color of the field
forms.customer.elements.customer_id.bgcolor = "#FFFFFF";
//gets the background color of the field
var c = forms.customer.elements.customer_id.bgcolor;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
border
Table Row (tr)
id
name
Table Cell (td)
border
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the border attribute(s) of a specified element.
//sets the border type to "LineBorder"
//sets a 1 px line width for the bottom and left side of the border
//sets the hexadecimal color of the border to "#ccffcc"
forms.customer.elements.customer_id.border = 'LineBorder,1,#ccffcc';
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
enabled
Table Row (tr)
id
name
Table Cell (td)
enabled
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the enabled state of a specified field, also known as "grayed". true - enabled; false - not enabled; ! - the enabled state is inverted (the opposite).
NOTE: A disabled element cannot be selected by clicking the element (or by pressing the TAB key even if this option is supported by the operating system).
NOTE: A label or button element will not disable if the "displayType" design time property for a field is set to HTML_AREA.
NOTE: The disabled "grayed" color is dependent on the LAF set in the Servoy Client Application Preferences. For more information see Preferences: Look And Feel in the Servoy Developer User's Guide.
//gets the enabled state of the field
var currState = forms.customer.elements.customer_id.enabled;
//sets the enabled state of the field
forms.customer.elements.customer_id.enabled = !currentState;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
fgcolor
Table Row (tr)
id
name
Table Cell (td)
fgcolor
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML. It only returns it's correct value if it was explicitly set.
//sets the foreground color of the field
forms.customer.elements.customer_id.fgcolor = "#000000";
//gets the foreground color of the field
var c = forms.customer.elements.customer_id.fgcolor;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
font
Table Row (tr)
id
name
Table Cell (td)
font
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the font name, style, and size of an element.
font name - the name of the font family. style - the type of the font. (plain = 0; bold = 1; italic = 2; bold-italic = 3). size - the size of the font (in points).
It only returns it's correct value if it was explicitly set.
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.
//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;
//gets the tooltip text of the element
var toolTip = forms.customer.elements.customer_id.toolTipText;
//sets the tooltip text of the element
forms.customer.elements.customer_id.toolTipText = "New tip";
forms.customer.elements.customer_id.toolTipText = "<html>This includes <b>bolded text</b> and <font color='blue'>BLUE</font> text as well.";
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
transparent
Table Row (tr)
id
name
Table Cell (td)
transparent
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the transparency of an element; true - transparent; false - not transparent.
NOTE: transparency can be inverted using ! operator: elements.elementName.transparent = !elements.elementName.transparent;
NOTE: transparency will be mostly used for background color, a transparent element will receive the background of the element "beneath" it, a non transparent one will use its own background color
//gets the transparency of the element
var currentState = forms.customer.elements.customer_id.transparent;
//sets the transparency of the element
forms.customer.elements.customer_id.transparent = !currentState;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
visible
Table Row (tr)
id
name
Table Cell (td)
visible
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).
NOTE: The visibility of an element is not persistent; the state of visibility only applies to the current user in his/her current session.
//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;
Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowenabledname
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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowfgcolorname
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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowfontname
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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowreadOnlyname
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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowtitleTextname
titleText
dessIndent
Gets or sets the title text.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowtoolTipTextname
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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowtransparentname
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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowvisiblename
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.
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
sIndent The display type of the element as String.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetFormNamename
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,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetHeightname
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
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,NGClientsam
Sample
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
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,NGClientsam
Sample
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
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,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetNamename
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,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetValueListNamename
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,NGClientsam
Sample
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();
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 keyclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowremoveStyleClassname
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 removeclients
Supported Clients
sIndentNGClientsam
Sample
sIdentjavascriptlastDetailRowrequestFocusname
requestFocus()
dessIndent
Request the focus in this element. (Focus is also a text cursor on text components).
clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowrequestFocusname
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,NGClientsam
Sample
sIdentjavascriptlastDetailRowsetLocationname
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.
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
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,NGClientsam
Sample
sIdentjavascriptlastDetailRowsetSizename
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.
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();
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);
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
setLocation-Number_Number
Table Row (tr)
id
name
Table Cell (td)
setLocation
Table Row (tr)
id
sig
Table Cell (td)
Span
style
margin-right: 5px;
void
Span
style
font-weight: bold;
setLocation
Span
(x, y)
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Sets the location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen. Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example:
//returns the X and Y coordinates var x = forms.company.elements.faxBtn.getLocationX(); var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location forms.company.elements.faxBtn.setLocation(x+10,y+10);
Table Row (tr)
id
prs
Table Cell (td)
Parameters
Div
class
sIndent
{Number} x - the X coordinate of the element in pixels. {Number} y - the Y coordinate of the element in pixels.
Sets the size of an element. It takes as input the width and the height. Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:
//returns the width (w) and height (h) var w = forms.company.elements.faxBtn.getWidth(); var h = forms.company.elements.faxBtn.getHeight();
//sets the new size forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height forms.company.elements.faxBtn.setSize(w+1,h+1);
Table Row (tr)
id
prs
Table Cell (td)
Parameters
Div
class
sIndent
{Number} width - the width of the element in pixels. {Number} height - the height of the element in pixels.
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);
Table Row (tr)
class
lastDetailRow
Table Cell (td)
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);
prs
Parameters
sIndentwidththe width of the element in pixels.heightthe height of the element in pixels.clients
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 valueclients