Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
Unknown macro: {sub-section}
Unknown macro: {table} Unknown macro: {tr} Unknown macro: {th} Extends
Unknown macro: {table}
{column:padding=0px|width=80px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Property Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} URL
Gets or sets the relative URL string contained in a field with a design time display property of HTML_AREA only.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} baseURL
Gets or sets the absolute base URL for the URL string contained in a field with a design time display property of HTML_AREA only.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} bgcolor
Gets or sets the background color of a field.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} border
Gets or sets the border attribute(s) of a specified element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} caretPosition
Gets or sets the number value (position) of the text caret (text "I" bar) in a field.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} editable
Gets or sets the editable/read-only state of a field; true - editable; false - read-only.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} enabled
Gets or sets the enabled state of a specified field, also known as "grayed".
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} fgcolor
Gets or sets the foreground color of a field.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} font
Gets or sets the font name, style, and size of an element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} readOnly
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).
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} titleText
Gets or sets the title text.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} toolTipText
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} transparent
Gets or sets the transparency of an element; true - transparent; false - not transparent.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} visible
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).
Unknown macro: {table}
{column:padding=0px|width=80px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Method Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getAsPlainText()
Gets the plain text for the formatted HTML/RTF text of a specified field element with a design time display property of HTML_AREA/RTF only.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getClientProperty(key)
Gets the specified client property for the element based on a key.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getDataProviderID()
Get the data provider this UI element (display) is showing.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getElementType()
Returns the type of a specified element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getHeight()
Returns the height of the current element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getLocationX()
Returns the x location of the current element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getLocationY()
Returns the y location of the current element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getName()
Returns the name of an element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getScrollX()
Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getScrollY()
Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getSelectedText()
Returns the currently selected text in the specified field.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getWidth()
Returns the width of the current element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} putClientProperty(key, value)
Sets the value for the specified element client property key.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} replaceSelectedText(s)
Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} requestFocus()
Request the focus in this element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} requestFocus(mustExecuteOnFocusGainedMethod)
Request the focus in this element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} selectAll()
Selects all the contents of a field.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setLocation(x, y)
Sets the location of an element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setScroll(x, y)
Sets the scroll location of an element.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setSize(width, height)
Sets the size of the field.
Unknown macro: {table}
{column:padding=0px|width=100%}{column}
Unknown macro: {tr} Unknown macro: {th} Property Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Gets or sets the relative URL string contained in a field with a design time display property of HTML_AREA only.
NOTE: For information about field element design time properties, see the section on Field elements in the Forms chapter of the Servoy Developer User's Guide.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//sets the relative URL of the HTML_AREA field
forms.customer.elements.customer_id.URL = "http://www.examples.com/icon.gif";
//gets the relative URL of the HTML_AREA field
var theURL = forms.customer.elements.customer_id.URL;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} baseURL
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Gets or sets the absolute base URL for the URL string contained in a field with a design time display property of HTML_AREA only.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//gets the base URL of theField when display is HTML_AREA
var baseURL = forms.customer.elements.customer_id.baseURL;
//sets the base URL of theField when display is HTML_AREA
forms.customer.elements.customer_id.baseURL = "http://www.examples.com";
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} bgcolor
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} border
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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".
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} spec – the border attributes
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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';
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} caretPosition
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Gets or sets the number value (position) of the text caret (text "I" bar) in a field.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Number
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} editable
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Boolean
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var currentState = forms.customer.elements.customer_id.editable;
forms.customer.elements.customer_id.editable = !currentState;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} enabled
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Boolean
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} fgcolor
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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).
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
forms.customer.elements.customer_id.font = 'Tahoma,1,11';
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} readOnly
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Boolean
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} titleText
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Gets or sets the title text.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var titleText = forms.customer.elements.customer_id.titleText;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} toolTipText
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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.";
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} transparent
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Boolean
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} visible
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Boolean
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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;
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {table}
{column:padding=0px|width=100%}{column}
Unknown macro: {tr} Unknown macro: {th} Method Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getAbsoluteFormLocationY
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getAbsoluteFormLocationY
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Returns the absolute form (designed) Y location.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Number – The y location of the form in pixels.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getAsPlainText
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getAsPlainText
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Gets the plain text for the formatted HTML/RTF text of a specified field element with a design time display property of HTML_AREA/RTF only.
NOTE: As of Servoy 4.x (and higher) you can also get/set the relative or absolute URL for an HTML_AREA field element. For more detail, see the .URL and .baseURL field element runtime properties earlier in this section.
NOTE: For information about field element design time properties, see the section on Field elements in the Forms chapter of the Servoy Developer User's Guide.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String – the plain text
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var my_text = forms.customer.elements.customer_id.getAsPlainText();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getClientProperty
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getClientProperty
Unknown macro: {span} (key)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} {Object} key – user interface key (depends on operating system)
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Object – The value of the property for specified key.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getDataProviderID
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getDataProviderID
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Get the data provider this UI element (display) is showing.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String – The data provider as String.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
forms.customer.elements.customer_id.getDataProviderID();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getDesignTimeProperty
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getDesignTimeProperty
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Get a design-time property of an element.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Object
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getElementType
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getElementType
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Returns the type of a specified element.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String – The display type of the element as String.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var et = forms.customer.elements.customer_id.getElementType();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getHeight
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getHeight
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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);
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Number – The height of the element in pixels.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var ht = forms.customer.elements.customer_id.getHeight();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getLocationX
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getLocationX
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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);
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Number – The x location of the element in pixels.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var x = forms.customer.elements.customer_id.getLocationX();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getLocationY
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getLocationY
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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);
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Number – The y location of the element in pixels.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var y = forms.customer.elements.customer_id.getLocationY();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getName
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getName
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Returns the name of an element. (may be null as well)
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String – The name of the element.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var name = forms.customer.elements.customer_id.getName();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getScrollX
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getScrollX
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.
NOTE: getScrollX() can be used with getScrollY() to set the scroll location of an element using the setScroll function. For Example:
//returns the X and Y scroll coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new scroll location
forms.company.elements.portal50.setScroll(x+10,y+10);
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Number – The x scroll location in pixels.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var x = forms.customer.elements.customer_id.getScrollX();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getScrollY
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getScrollY
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.
NOTE: getScrollY() can be used with getScrollX() to set the scroll location of an element using the setScroll function. For Example:
//returns the X and Y scroll coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new scroll location
forms.company.elements.portal50.setScroll(x+10,y+10);
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Number – The y scroll location in pixels.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var y = forms.customer.elements.customer_id.getScrollY();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getSelectedText
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getSelectedText
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Returns the currently selected text in the specified field.
NOTE: This function is for field elements only.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String – The selected text from the component.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var my_text = forms.customer.elements.customer_id.getSelectedText();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getWidth
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getWidth
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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);
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Number – The width of the element in pixels.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var w = forms.customer.elements.customer_id.getWidth();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} putClientProperty
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} putClientProperty
Unknown macro: {span} (key, value)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Sets the value for the specified element client property key.
NOTE: Depending on the operating system, a user interface property name may be available.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} {Object} key – user interface key (depends on operating system)
{Object} value – a predefined value for the key
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} replaceSelectedText
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} replaceSelectedText
Unknown macro: {span} (s)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} {String} s – The replacement text.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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');
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} requestFocus
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} requestFocus
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Request the focus in this element. (Focus is also a text cursor on text components).
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} requestFocus
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} requestFocus
Unknown macro: {span} (mustExecuteOnFocusGainedMethod)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Request the focus in this element. (Focus is also a text cursor on text components).
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} {Boolean} mustExecuteOnFocusGainedMethod – If true will execute onFocusGained method, else will not; default value is true.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
//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);
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} selectAll
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} selectAll
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Selects all the contents of a field.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
forms.customer.elements.customer_id.selectAll();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setLocation
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} setLocation
Unknown macro: {span} (x, y)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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);
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} {Number} x – the X coordinate of the element in pixels.
{Number} y – the Y coordinate of the element in pixels.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
forms.customer.elements.customer_id.setLocation(200,200);
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setScroll
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} setScroll
Unknown macro: {span} (x, y)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Sets the scroll location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for an element where the height of the element is greater than the height of element content
NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of an element; then use the X and Y coordinates with the setScroll function to set a new scroll location. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new location
forms.company.elements.portal50.setScroll(x+10,y+10);
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} {Number} x – the X coordinate of the portal scroll location in pixels
{Number} y – the Y coordinate of the portal scroll location in pixels
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
forms.customer.elements.customer_id.setScroll(200,200);
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setSize
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} setSize
Unknown macro: {span} (width, height)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} 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);
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} {Number} width – the width of the element in pixels.
{Number} height – the height of the element in pixels.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
forms.customer.elements.customer_id.setSize(20,30);
Unknown macro: {tr} Unknown macro: {td}