{column:padding=0px|width=80px}{column}{column}{column}
Property Summary
rolloverImageURL
Gets/Sets the image displayed on a button or label roll over; based on URL.
toolTipText
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.
transparent
Gets or sets the transparency of an element; true - transparent; false - not transparent.
{column:padding=0px|width=80px}{column}{column}{column}
Method Summary
getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
getClientProperty(key)
Gets the specified client property for the element based on a key.
getDataProviderID()
Get the data provider this UI element (display) is showing.
getElementType()
Returns the type of a specified element.
getLabelForElementName()
Gets the label for property of a label.
getLocationX()
Returns the x location of the current element.
getLocationY()
Returns the y location of the current element.
byte[]
getThumbnailJPGImage([width], [height])
Returns the image data in .
void
putClientProperty(key, value)
Sets the value for the specified element client property key.
void
setLocation(x, y)
Sets the location of an element.
void
setSize(width, height)
Sets the size of the field.
{column:padding=0px|width=100%}{column}
Property Details
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
Replace with version info
Parameters
Returns
[String]
Also see
External links
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;
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".
Since
Replace with version info
Parameters
spec – the border attributes
Returns
[String]
Also see
External links
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');
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
Replace with version info
Parameters
Returns
[Boolean]
Also see
External links
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;
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
Replace with version info
Parameters
Returns
[String]
Also see
External links
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;
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
Replace with version info
Parameters
spec – the font name, style, size
Returns
[String]
Also see
External links
Sample
forms.customer.elements.customer_id.setFont('Tahoma,1,11');
Gets/Sets the image displayed on a button or label; based on URL.
Since
Replace with version info
Parameters
Returns
[String]
Also see
External links
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';
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.
Since
Replace with version info
Parameters
Returns
[String]
Also see
External links
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';
Gets/Sets the image displayed on a button or label roll over; based on URL.
Since
Replace with version info
Parameters
Returns
[String]
Also see
External links
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';
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.
Since
Replace with version info
Parameters
Returns
[String]
Also see
External links
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';
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
Replace with version info
Parameters
Returns
[String]
Also see
External links
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.";
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
Replace with version info
Parameters
Returns
[Boolean]
Also see
External links
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;
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
Replace with version info
Parameters
Returns
[Boolean]
Also see
External links
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;
{column:padding=0px|width=100%}{column}
Method Details
getAbsoluteFormLocationY
()
Returns the absolute form (designed) Y location.
Since
Replace with version info
Parameters
Returns
[Number] – The y location of the form in pixels.
Also see
External links
Sample
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();
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
Replace with version info
Parameters\\\{Object} key – user interface key (depends on operating system)
Returns
[Object] – The value of the property for specified key.
Also see
External links
Sample
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
getDataProviderID
()
Get the data provider this UI element (display) is showing.
Since
Replace with version info
Parameters
Returns
[String] – The data provider as String.
Also see
External links
Sample
forms.customer.elements.customer_id.getDataProviderID();
getElementType
()
Returns the type of a specified element.
Since
Replace with version info
Parameters
Returns
[String] – The display type of the element as String.
Also see
External links
Sample
var et = forms.customer.elements.customer_id.getElementType();
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
Replace with version info
Parameters
Returns
[Number] – The height of the element in pixels.
Also see
External links
Sample
var ht = forms.customer.elements.customer_id.getHeight();
getLabelForElementName
()
Gets the label for property of a label. This property is used to link a label to a certain element (by default used for tableview header, form security, can be used for custom purposes ).
Since
Replace with version info
Parameters
Returns
[String] – The label for property (String).
Also see
External links
Sample
var name = forms.customer.elements.customer_id.getLabelForElementName();
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
Replace with version info
Parameters
Returns
[Number] – The x location of the element in pixels.
Also see
External links
Sample
var x = forms.customer.elements.customer_id.getLocationX();
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
Replace with version info
Parameters
Returns
[Number] – The y location of the element in pixels.
Also see
External links
Sample
var y = forms.customer.elements.customer_id.getLocationY();
getName
()
Returns the name of an element. (may be null as well)
Since
Replace with version info
Parameters
Returns
[String] – The name of the element.
Also see
External links
Sample
var name = forms.customer.elements.customer_id.getName();
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])
Since
Replace with version info
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.
Also see
External links
Sample
var jpgData = forms.customer.elements.customer_id.getThumbnailJPGImage(50,50); application.writeFile("mypicture.jpg", jpgData);
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
Replace with version info
Parameters
Returns
[Number] – The width of the element in pixels.
Also see
External links
Sample
var w = forms.customer.elements.customer_id.getWidth();
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
Replace with version info
Returns
void
Also see
External links
Sample
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
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
Replace with version info
Returns
void
Also see
External links
Sample
forms.customer.elements.customer_id.setLocation(200,200);
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
Replace with version info
Returns
void
Also see
External links
Sample
forms.customer.elements.customer_id.setSize(20,30);