DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE


Property Summary
String
#bgcolor
Gets or sets the background color of a field.
String
#border
Gets or sets the border attribute(s) of a specified element.
Boolean
#enabled
Gets or sets the enabled state of a specified field, also known as "grayed".
String
#fgcolor
Gets or sets the foreground color of a field.
String
#font
Sets the font name, style, and size of an element.
String
#imageURL
Gets/Sets the image displayed on a button or label; based on URL.
String
#mnemonic
Gets or sets the specified character(s) - typically an underlined letter- used with/without the modifier key(s) for the label, button or image.
String
#rolloverImageURL
Gets/Sets the image displayed on a button or label roll over; based on URL.
String
#text
Gets or sets the text that is displayed on the label, button or image.
String
#toolTipText
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.
Boolean
#transparent
Gets or sets the transparency of an element; true - transparent; false - not transparent.
Boolean
#visible
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).

Method Summary
Number
#getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
Object
#getClientProperty(key)
Gets the specified client property for the element based on a key.
String
#getDataProviderID()
Get the data provider this UI element (display) is showing.
String
#getElementType()
Returns the type of a specified element.
Number
#getHeight()
Returns the height of the current element.
Number
#getLocationX()
Returns the x location of the current element.
Number
#getLocationY()
Returns the y location of the current element.
String
#getName()
Returns the name of an element.
byte[]
#getThumbnailJPGImage([width], [height])
Returns the image data in .
Number
#getWidth()
Returns the width of the current element.
void
#putClientProperty(key, value)
Sets the value for the specified element client property key.
void
#requestFocus([mustExecuteOnFocusGainedMethod])
Request the focus in this element.
void
#setLocation(x, y)
Sets the location of an element.
void
#setSize(width, height)
Sets the size of the field.

Property Details
bgcolor
Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
Returns
String
Sample
//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;

border

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

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

Parameters
spec – the border attributes
Returns
String
Sample
//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"
var b = forms.customer.elements.customer_id.setBorder('LineBorder,1,#ccffcc');

enabled

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.

Returns
Boolean
Sample
//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;

fgcolor
Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
Returns
String
Sample
//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;

font

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

Parameters
spec – the font name, style, size
Returns
String
Sample
forms.customer.elements.customer_id.setFont('Tahoma,1,11');

imageURL
Gets/Sets the image displayed on a button or label; based on URL.
Returns
String
Sample
//dynamically sets an image displayed on a button or label
forms.customer.elements.customer_id.imageURL = "http://www.servoy.com/images/test.gif";

//sets an image from your own image library
forms.customer.elements.customer_id.imageURL = "media:///arrow.gif";

//loads an image (BLOB) from a field in a selected record into HTML
forms.customer.elements.customer_id.imageURL = 'media:///servoy_blobloader?datasource='+controller.getDataSource()+'&dataprovider=image_data&mimetype=image/jpeg&rowid1=2';

mnemonic

Gets or sets the specified character(s) - typically an underlined letter- used with/without the modifier key(s) for the label, button or image.

Modifiers key values:
1 SHIFT
2 CTRL
4 Meta/CMD (Macintosh)
8 ALT(Windows, Unix); OPTION (Macintosh)

NOTE: A mnemonic is usually a single key used with/without the CTRL, CMD, SHIFT, ALT, or OPTION key(s) to activate a menu item or command - depending, in part on whether the menmonic applies in a command line or graphic interface. For one description, you can refer to this web page: http://msdn.microsoft.com/en\-us/library/bb158536.aspx or perform a search in a web browser search engine using the criteria "mnemonic".
NOTE2: Mnemonic is only supported in Smart Client.

Returns
String
Sample
//gets the mnemonic of the element
var my_mnemoic = forms.customer.elements.customer_id.mnemonic;

//sets the mnemonic of the element
forms.customer.elements.customer_id.mnemonic = 'f';

rolloverImageURL
Gets/Sets the image displayed on a button or label roll over; based on URL.
Returns
String
Sample
//dynamically sets a roll over image displayed on a button or label
forms.customer.elements.customer_id.rolloverImageURL = "http://www.servoy.com/images/test.gif";

//sets an image from your own image library
forms.customer.elements.customer_id.rolloverImageURL = "media:///arrow.gif";

//loads an image (BLOB) from a field in a selected record into HTML
forms.customer.elements.customer_id.rolloverImageURL = 'media:///servoy_blobloader?datasource='+controller.getDataSource()+'&dataprovider=image_data&mimetype=image/jpeg&rowid1=2';

text

Gets or sets the text that is displayed on the label, button or image.

NOTE: The .text property applies to labels, buttons, or images ONLY.

Returns
String
Sample
//gets the text of the element
var my_text = forms.customer.elements.customer_id.text;

//sets the text of the element
forms.customer.elements.customer_id.text = my_text + 'is cool';

toolTipText

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.

Returns
String
Sample
//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.";

transparent

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

Returns
Boolean
Sample
//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;

visible

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.

Returns
Boolean
Sample
//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;


Method Details
getAbsoluteFormLocationY
Number
getAbsoluteFormLocationY
()
Returns the absolute form (designed) Y location.
Returns
Number – The y location of the form in pixels.
Sample
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();

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

Parameters
{Object} key – user interface key (depends on operating system)
Returns
Object – The value of the property for specified key.
Sample
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');

getDataProviderID
String
getDataProviderID
()
Get the data provider this UI element (display) is showing.
Returns
String – The data provider as String.
Sample
forms.customer.elements.customer_id.getDataProviderID();

getElementType
String
getElementType
()
Returns the type of a specified element.
Returns
String – The display type of the element as String.
Sample
var et = forms.customer.elements.customer_id.getElementType();

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

Returns
Number – The height of the element in pixels.
Sample
var ht = forms.customer.elements.customer_id.getHeight();

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

Returns
Number – The x location of the element in pixels.
Sample
var x = forms.customer.elements.customer_id.getLocationX();

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

Returns
Number – The y location of the element in pixels.
Sample
var y =  forms.customer.elements.customer_id.getLocationY();

getName
String
getName
()
Returns the name of an element. (may be null as well)
Returns
String – The name of the element.
Sample
var name = forms.customer.elements.customer_id.getName();

getThumbnailJPGImage
byte[]
getThumbnailJPGImage
([width], [height])

Returns the image data in .jpg format from an icon; thumbnailing only works in record view.

Syntax
elements.elementName.getThumbnailJPGImage([width],[height])

Parameters
[width] – The target width, if not specified original image width will be used.
[height] – The target height, if not specified original image width will be used.
Returns
byte[] – An array of bytes.
Sample
var jpgData = forms.customer.elements.customer_id.getThumbnailJPGImage(50,50);
application.writeFile("mypicture.jpg", jpgData);

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

Returns
Number – The width of the element in pixels.
Sample
var w = forms.customer.elements.customer_id.getWidth();

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

Parameters
{Object} key – user interface key (depends on operating system)
{Object} value – a predefined value for the key
Returns
void
Sample
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');

requestFocus
void
requestFocus
([mustExecuteOnFocusGainedMethod])
Request the focus in this element. (Focus is also a text cursor on text components).
Parameters
[mustExecuteOnFocusGainedMethod] – If true will execute onFocusGained method, else will not; default value is true.
Returns
void
Sample
//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();

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

Parameters
{Number} x – the X coordinate of the element in pixels.
{Number} y – the Y coordinate of the element in pixels.
Returns
void
Sample
forms.customer.elements.customer_id.setLocation(200,200);

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

Parameters
{Number} width – the width of the element in pixels.
{Number} height – the height of the element in pixels.
Returns
void
Sample
forms.customer.elements.customer_id.setSize(20,30);