TextField (instance)

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

Since

Parameters

String

Also see

External links

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

Since

Parameters

Number

Also see

External links

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.

Since

Parameters

Boolean

Also see

External links

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.

Since

Parameters

Boolean

Also see

External links

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

Since

Parameters

String

Also see

External links

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

Since

Parameters

String

Also see

External links

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.

Since

Parameters

Boolean

Also see

External links

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.

Since

Parameters

String

Also see

External links

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

Since

Parameters

Boolean

Also see

External links

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.

Since

Parameters

Boolean

Also see

External links

Number

getAbsoluteFormLocationY

()

Returns the absolute form (designed) Y location.

Since

Parameters

Number – The y location of the form in pixels.

Also see

External links

Object

getClientProperty

(key)

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.

Since

{Object} key – user interface key (depends on operating system)

Object – The value of the property for specified key.

Also see

External links

String

getDataProviderID

()

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

Since

Parameters

String – The data provider as String.

Also see

External links

String

getElementType

()

Returns the type of a specified element.

Since

Parameters

String – The display type of the element as String.

Also see

External links

Number

getHeight

()

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

Since

Parameters

Number – The height of the element in pixels.

Also see

External links

String[]

getLabelForElementNames

()

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

Since

Parameters

String[] – An array with element names.

Also see

External links

Number

getLocationX

()

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

Since

Parameters

Number – The x location of the element in pixels.

Also see

External links

Number

getLocationY

()

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

Since

Parameters

Number – The y location of the element in pixels.

Also see

External links

String

getName

()

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

Since

Parameters

String – The name of the element.

Also see

External links

String

getSelectedText

()

Returns the currently selected text in the specified field.

NOTE: This function is for field elements only.

Since

Parameters

String – The selected text from the component.

Also see

External links

String

getTitleText

()

Get the title text.

Since

Parameters

String – The title text.

Also see

External links

String

getValueListName

()

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

Since

Parameters

String – The valuelist name.

Also see

External links

Number

getWidth

()

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

Since

Parameters

Number – The width of the element in pixels.

Also see

External links

void

putClientProperty

(key, value)

Sets the value for the specified element client property key.

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

Since

{Object} key – user interface key (depends on operating system)
{Object} value – a predefined value for the key

void

Also see

External links

void

replaceSelectedText

(s)

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.

Since

{String} s – The replacement text.

void

Also see

External links

void

requestFocus

([mustExecuteOnFocusGainedMethod])

Requests the focus for an element; can skip the onFocusGained event for an element by using requestFocus(false).
When focus is requested on a text field, a text cursor will be displayed in the specified field.

NOTE: This function is for field elements only; for more information about the optional parameter, see the onFocusGained design time property in the section on Fields.

Since

[mustExecuteOnFocusGainedMethod] – true - to execute the onFocusGained method; false - to prevent the onFocusGained method from executing, default is true (if not specified).

void

Also see

External links

void

selectAll

()

Selects all the contents of a field.

Since

Parameters

void

Also see

External links

void

setBorder

(spec)

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

NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType".

Since

{String} spec – the border attributes

void

Also see

External links

void

setFont

(spec)

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

Since

{String} spec – the font name, style, size

void

Also see

External links

void

setLocation

(x, y)

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.

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

Since

{Number} x – the X coordinate of the element in pixels.
{Number} y – the Y coordinate of the element in pixels.

void

Also see

External links

void

setSize

(width, height)

Sets the size of the field. It takes as input the width and the height.

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

Since

{Number} width – the width of the element in pixels.
{Number} height – the height of the element in pixels.

void

Also see

External links

void

setValueListItems

(dataset)

Sets the display/real values to the custom valuelist of the element (if element has custom valuelist).
Should receive a dataset parameter, first column is for display values, second column (optional) is for real values.

Since

dataset – first column is display value, second column is real value

void

Also see

External links