Child pages
  • RTF Area, HTML Area (instance)

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Hidden
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


HTML Table
classservoy sSummery
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summery
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#URL
Gets or sets the relative URL string contained in a field with a design time display property of HTML_AREA only.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (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.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#bgcolor
Gets or sets the background color of a field.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#caretPosition
Gets or sets the number value (position) of the text caret (text "I" bar) in a field.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#editable
Gets or sets the editable/read-only state of a field; true - editable; false - read-only.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#enabled
Gets or sets the enabled state of a specified field, also known as "grayed".
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#fgcolor
Gets or sets the foreground color of a field.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (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).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#toolTipText
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#transparent
Gets or sets the transparency of an element; true - transparent; false - not transparent.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#visible
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).

HTML Table
classservoy sSummery
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summery
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (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.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
#getClientProperty(key)
Gets the specified client property for the element based on a key.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getDataProviderID()
Get the data provider this UI element (display) is showing.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getElementType()
Returns the type of a specified element.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getHeight()
Returns the height of the current element.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
#getLabelForElementNames()
Returns an Array of label element names that has this field filled in as the labelFor.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getLocationX()
Returns the x location of the current element.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getLocationY()
Returns the y location of the current element.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getName()
Returns the name of an element.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getScrollX()
Returns the x scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getScrollY()
Returns the y scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getSelectedText()
Returns the currently selected text in the specified field.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getTitleText()
Get the title text.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getWidth()
Returns the width of the current element.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#putClientProperty(key, value)
Sets the value for the specified element client property key.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#replaceSelectedText(s)
Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#requestFocus([mustExecuteOnFocusGainedMethod])
Requests the focus for an element; can skip the onFocusGained event for an element by using requestFocus(false).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#selectAll()
Selects all the contents of a field.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setBorder(spec)
Sets the border attribute(s) of a specified element.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setFont(spec)
Sets the font name, style, and size of an element.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setLocation(x, y)
Sets the location of an element.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setScroll(x, y)
Sets the scroll location of a portal.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
#setSize(width, height)
Sets the size of the field.

HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
idURL
classnode
Table Row (tr)
idname
Table Cell (td)
URL
Table Row (tr)
iddes
Table Cell (td)

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.

Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//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;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idbaseURL
classnode
Table Row (tr)
idname
Table Cell (td)
baseURL
Table Row (tr)
iddes
Table Cell (td)
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.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//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";
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idbgcolor
classnode
Table Row (tr)
idname
Table Cell (td)
bgcolor
Table Row (tr)
iddes
Table Cell (td)
Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//sets the background color of the field
forms.customer.elements.customer_id.bgcolor = "#FFFFFF";
//gets the background color of the field
var c = forms.customer.elements.customer_id.bgcolor;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idcaretPosition
classnode
Table Row (tr)
idname
Table Cell (td)
caretPosition
Table Row (tr)
iddes
Table Cell (td)
Gets or sets the number value (position) of the text caret (text "I" bar) in a field.
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//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;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
ideditable
classnode
Table Row (tr)
idname
Table Cell (td)
editable
Table Row (tr)
iddes
Table Cell (td)

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.

Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var currentState = forms.customer.elements.customer_id.editable;
forms.customer.elements.customer_id.editable = !currentState;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idenabled
classnode
Table Row (tr)
idname
Table Cell (td)
enabled
Table Row (tr)
iddes
Table Cell (td)

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.

Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//gets the enabled state of the field
var currState = forms.customer.elements.customer_id.enabled;

//sets the enabled state of the field
forms.customer.elements.customer_id.enabled = !currentState;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idfgcolor
classnode
Table Row (tr)
idname
Table Cell (td)
fgcolor
Table Row (tr)
iddes
Table Cell (td)
Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//sets the foreground color of the field
forms.customer.elements.customer_id.fgcolor = "#000000";

//gets the foreground color of the field
var c = forms.customer.elements.customer_id.fgcolor;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idreadOnly
classnode
Table Row (tr)
idname
Table Cell (td)
readOnly
Table Row (tr)
iddes
Table Cell (td)

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.

Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//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;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtoolTipText
classnode
Table Row (tr)
idname
Table Cell (td)
toolTipText
Table Row (tr)
iddes
Table Cell (td)

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.

Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//gets the tooltip text of the element
var toolTip = forms.customer.elements.customer_id.toolTipText;

//sets the tooltip text of the element
forms.customer.elements.customer_id.toolTipText = "New tip";
forms.customer.elements.customer_id.toolTipText = "<html>This includes <b>bolded text</b> and <font color='blue'>BLUE</font> text as well.";
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtransparent
classnode
Table Row (tr)
idname
Table Cell (td)
transparent
Table Row (tr)
iddes
Table Cell (td)

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

Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//gets the transparency of the element
var currentState = forms.customer.elements.customer_id.transparent;

//sets the transparency of the element
forms.customer.elements.customer_id.transparent = !currentState;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idvisible
classnode
Table Row (tr)
idname
Table Cell (td)
visible
Table Row (tr)
iddes
Table Cell (td)

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.

Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//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;
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idgetAbsoluteFormLocationY
classnode
Table Row (tr)
idname
Table Cell (td)
getAbsoluteFormLocationY
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getAbsoluteFormLocationY
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns the absolute form (designed) Y location.
Table Row (tr)
idret
Table Cell (td)
Returns
Number – The y location of the form in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetAsPlainText
classnode
Table Row (tr)
idname
Table Cell (td)
getAsPlainText
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
String
Span
stylefloat: left; font-weight: bold;
idiets
getAsPlainText
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)

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.

Table Row (tr)
idret
Table Cell (td)
Returns
String – the plain text
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var my_text = forms.customer.elements.customer_id.getAsPlainText();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetClientProperty
classnode
Table Row (tr)
idname
Table Cell (td)
getClientProperty
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Object
Span
stylefloat: left; font-weight: bold;
idiets
getClientProperty
Span
stylefloat: left;
idiets
(key)
Table Row (tr)
iddes
Table Cell (td)

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.

Table Row (tr)
idprs
Table Cell (td)
Parameters
{Object} key – user interface key (depends on operating system)
Table Row (tr)
idret
Table Cell (td)
Returns
Object – The value of the property for specified key.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetDataProviderID
classnode
Table Row (tr)
idname
Table Cell (td)
getDataProviderID
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
String
Span
stylefloat: left; font-weight: bold;
idiets
getDataProviderID
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Get the data provider this UI element (display) is showing.
Table Row (tr)
idret
Table Cell (td)
Returns
String – The data provider as String.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.getDataProviderID();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetElementType
classnode
Table Row (tr)
idname
Table Cell (td)
getElementType
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
String
Span
stylefloat: left; font-weight: bold;
idiets
getElementType
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns the type of a specified element.
Table Row (tr)
idret
Table Cell (td)
Returns
String – The display type of the element as String.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var et = forms.customer.elements.customer_id.getElementType();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetHeight
classnode
Table Row (tr)
idname
Table Cell (td)
getHeight
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getHeight
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)

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

Table Row (tr)
idret
Table Cell (td)
Returns
Number – The height of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var ht = forms.customer.elements.customer_id.getHeight();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetLabelForElementNames
classnode
Table Row (tr)
idname
Table Cell (td)
getLabelForElementNames
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
String[]
Span
stylefloat: left; font-weight: bold;
idiets
getLabelForElementNames
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns an Array of label element names that has this field filled in as the labelFor.
Table Row (tr)
idret
Table Cell (td)
Returns
String[] – An array with element names.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var array =elements.name_first.getLabelForElementNames();
for (var i =0; i<array.length;i++)
{
	elements[array[i]].fgcolor = "#ff00ff";
}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetLocationX
classnode
Table Row (tr)
idname
Table Cell (td)
getLocationX
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getLocationX
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)

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

Table Row (tr)
idret
Table Cell (td)
Returns
Number – The x location of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var x = forms.customer.elements.customer_id.getLocationX();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetLocationY
classnode
Table Row (tr)
idname
Table Cell (td)
getLocationY
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getLocationY
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)

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

Table Row (tr)
idret
Table Cell (td)
Returns
Number – The y location of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var y =  forms.customer.elements.customer_id.getLocationY();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetName
classnode
Table Row (tr)
idname
Table Cell (td)
getName
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
String
Span
stylefloat: left; font-weight: bold;
idiets
getName
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns the name of an element. (may be null as well)
Table Row (tr)
idret
Table Cell (td)
Returns
String – The name of the element.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var name = forms.customer.elements.customer_id.getName();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetScrollX
classnode
Table Row (tr)
idname
Table Cell (td)
getScrollX
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getScrollX
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)

Returns the x scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).

NOTE: getScrollX() can be used with getScrollY() to set the scroll location of a portal 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);

Table Row (tr)
idret
Table Cell (td)
Returns
Number – The x scroll location in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var x = forms.customer.elements.customer_id.getScrollX();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetScrollY
classnode
Table Row (tr)
idname
Table Cell (td)
getScrollY
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getScrollY
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)

Returns the y scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).

NOTE: getScrollY() can be used with getScrollX() to set the scroll location of a portal 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);

Table Row (tr)
idret
Table Cell (td)
Returns
Number – The y scroll location in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var y = forms.customer.elements.customer_id.getScrollY();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetSelectedText
classnode
Table Row (tr)
idname
Table Cell (td)
getSelectedText
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
String
Span
stylefloat: left; font-weight: bold;
idiets
getSelectedText
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)

Returns the currently selected text in the specified field.

NOTE: This function is for field elements only.

Table Row (tr)
idret
Table Cell (td)
Returns
String – The selected text from the component.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var my_text = forms.customer.elements.customer_id.getSelectedText();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetTitleText
classnode
Table Row (tr)
idname
Table Cell (td)
getTitleText
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
String
Span
stylefloat: left; font-weight: bold;
idiets
getTitleText
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Get the title text.
Table Row (tr)
idret
Table Cell (td)
Returns
String – The title text.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var titleText = forms.customer.elements.customer_id.getTitleText();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetWidth
classnode
Table Row (tr)
idname
Table Cell (td)
getWidth
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getWidth
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)

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

Table Row (tr)
idret
Table Cell (td)
Returns
Number – The width of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var w = forms.customer.elements.customer_id.getWidth();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idputClientProperty
classnode
Table Row (tr)
idname
Table Cell (td)
putClientProperty
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
putClientProperty
Span
stylefloat: left;
idiets
(key, value)
Table Row (tr)
iddes
Table Cell (td)

Sets the value for the specified element client property key.

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

Table Row (tr)
idprs
Table Cell (td)
Parameters
{Object} key – user interface key (depends on operating system)
{Object} value – a predefined value for the key
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idreplaceSelectedText
classnode
Table Row (tr)
idname
Table Cell (td)
replaceSelectedText
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
replaceSelectedText
Span
stylefloat: left;
idiets
(s)
Table Row (tr)
iddes
Table Cell (td)

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.

Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} s – The replacement text.
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//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');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idrequestFocus
classnode
Table Row (tr)
idname
Table Cell (td)
requestFocus
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
requestFocus
Span
stylefloat: left;
idiets
([mustExecuteOnFocusGainedMethod])
Table Row (tr)
iddes
Table Cell (td)

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

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

Table Row (tr)
idprs
Table Cell (td)
Parameters
[mustExecuteOnFocusGainedMethod] – true - to execute the onFocusGained method; false - to prevent the onFocusGained method from executing, default is true (if not specified).
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//requests the focus for the element
//prevents the onFocusGained method from executing
forms.customer.elements.customer_id.requestFocus(false);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idselectAll
classnode
Table Row (tr)
idname
Table Cell (td)
selectAll
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
selectAll
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Selects all the contents of a field.
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.selectAll();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetBorder
classnode
Table Row (tr)
idname
Table Cell (td)
setBorder
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setBorder
Span
stylefloat: left;
idiets
(spec)
Table Row (tr)
iddes
Table Cell (td)

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

Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} spec – the border attributes
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//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');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetFont
classnode
Table Row (tr)
idname
Table Cell (td)
setFont
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setFont
Span
stylefloat: left;
idiets
(spec)
Table Row (tr)
iddes
Table Cell (td)

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

Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} spec – the font name, style, size
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.setFont('Tahoma,1,11');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetLocation
classnode
Table Row (tr)
idname
Table Cell (td)
setLocation
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setLocation
Span
stylefloat: left;
idiets
(x, y)
Table Row (tr)
iddes
Table Cell (td)

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

Table Row (tr)
idprs
Table Cell (td)
Parameters
{Number} x – the X coordinate of the element in pixels.
{Number} y – the Y coordinate of the element in pixels.
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.setLocation(200,200);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetScroll
classnode
Table Row (tr)
idname
Table Cell (td)
setScroll
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setScroll
Span
stylefloat: left;
idiets
(x, y)
Table Row (tr)
iddes
Table Cell (td)

Sets the scroll location of a portal. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for a portal where the height of the portal is greater than the height of the portal filed(s).

NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of a portal; 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);

Table Row (tr)
idprs
Table Cell (td)
Parameters
{Number} x – the X coordinate of the portal scroll location in pixels
{Number} y – the Y coordinate of the portal scroll location in pixels
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.setScroll(200,200);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetSize
classnode
Table Row (tr)
idname
Table Cell (td)
setSize
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
void
Span
stylefloat: left; font-weight: bold;
idiets
setSize
Span
stylefloat: left;
idiets
(width, height)
Table Row (tr)
iddes
Table Cell (td)

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

Table Row (tr)
idprs
Table Cell (td)
Parameters
{Number} width – the width of the element in pixels.
{Number} height – the height of the element in pixels.
Table Row (tr)
idret
Table Cell (td)
Returns
void
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.setSize(20,30);
Table Row (tr)
classlastDetailRow
Table Cell (td)