Page History
| Wiki Markup |
|---|
{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{hidden}
{sub-section:description|text=}{sub-section}\\
{table:id=|class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Extends{th}{tr}{tr}{td}{span:class=sWordList}[RuntimeComponent]{span}{td}{tr}{table}\\
{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#URL]
Gets or sets the relative URL string contained in a field with a design time display property of HTML\_AREA only.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#bgcolor]
Gets or sets the background color of a field.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#border]
Gets or sets the border attribute(s) of a specified element.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#caretPosition]
Gets or sets the number value (position) of the text caret (text "I" bar) in a field.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#editable]
Gets or sets the editable/read\-only state of a field; true \- editable; false \- read\-only.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#enabled]
Gets or sets the enabled state of a specified field, also known as "grayed".{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#fgcolor]
Gets or sets the foreground color of a field.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#font]
Gets or sets the font name, style, and size of an element.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{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).{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#titleText]
Gets or sets the title text.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#toolTipText]
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#transparent]
Gets or sets the transparency of an element; true \- transparent; false \- not transparent.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#visible]
Gets or sets the visibility of an element; true \- visible; false \- not visible; ! \- the visibility state is inverted (the opposite).{td}{tr}{tbody}{table}\\
{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[Number]{td}{td}[#getAbsoluteFormLocationY]\()
Returns the absolute form (designed) Y location.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[Object]{td}{td}[#getClientProperty]\(key)
Gets the specified client property for the element based on a key.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getDataProviderID]\()
Get the data provider this UI element (display) is showing.{td}{tr}{tbody}{tbody}{tr}{td}[Object]{td}{td}[#getDesignTimeProperty]\()
Get a design\-time property of an element.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getElementType]\()
Returns the type of a specified element.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getHeight]\()
Returns the height of the current element.{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getLabelForElementNames]\()
Returns an Array of label element names that has this field filled in as the labelFor.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getLocationX]\()
Returns the x location of the current element.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getLocationY]\()
Returns the y location of the current element.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getName]\()
Returns the name of an element.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getSelectedText]\()
Returns the currently selected text in the specified text field or text area.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getWidth]\()
Returns the width of the current element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#putClientProperty]\(key, value)
Sets the value for the specified element client property key.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#replaceSelectedText]\(s)
Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#requestFocus]\()
Request the focus in this element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#requestFocus]\(mustExecuteOnFocusGainedMethod)
Request the focus in this element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#selectAll]\()
Selects all the contents of a field.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setLocation]\(x, y)
Sets the location of an element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setScroll]\(x, y)
Sets the scroll location of an element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setSize]\(width, height)
Sets the size of thean fieldelement.{td}{tr}{tbody}{table}\\
{table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=URL|class=node}{tr:id=name}{td}h6.URL{td}{tr}{tr:id=des}{td}{sub-section:URL_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:URL_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:URL_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:URL_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:URL_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:URL_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:URL_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:URL_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:URL_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:URL_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:URL_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:URL_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:URL_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:URL_sam|trigger=none}{code:language=javascript}
//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;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=baseURL|class=node}{tr:id=name}{td}h6.baseURL{td}{tr}{tr:id=des}{td}{sub-section:baseURL_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:baseURL_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:baseURL_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:baseURL_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:baseURL_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:baseURL_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:baseURL_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:baseURL_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:baseURL_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:baseURL_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:baseURL_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:baseURL_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:baseURL_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:baseURL_sam|trigger=none}{code:language=javascript}
//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";
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=bgcolor|class=node}{tr:id=name}{td}h6.bgcolor{td}{tr}{tr:id=des}{td}{sub-section:bgcolor_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:bgcolor_des|trigger=none|class=sIndent}Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:bgcolor_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:bgcolor_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:bgcolor_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:bgcolor_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:bgcolor_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:bgcolor_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:bgcolor_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:bgcolor_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:bgcolor_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:bgcolor_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:bgcolor_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:bgcolor_sam|trigger=none}{code:language=javascript}
//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;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=border|class=node}{tr:id=name}{td}h6.border{td}{tr}{tr:id=des}{td}{sub-section:border_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:border_des|trigger=none|class=sIndent}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).
It only returns it's correct value if it was explicitly set.
NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType".{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:border_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:border_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:border_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:border_prs|trigger=none|class=sIndent}spec -- the border attributes
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:border_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:border_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:border_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:border_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:border_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:border_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:border_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:border_sam|trigger=none}{code:language=javascript}
//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';
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=caretPosition|class=node}{tr:id=name}{td}h6.caretPosition{td}{tr}{tr:id=des}{td}{sub-section:caretPosition_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:caretPosition_des|trigger=none|class=sIndent}Gets or sets the number value (position) of the text caret (text "I" bar) in a field.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:caretPosition_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:caretPosition_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:caretPosition_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:caretPosition_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:caretPosition_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:caretPosition_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:caretPosition_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:caretPosition_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:caretPosition_link|text=|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:caretPosition_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:caretPosition_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:caretPosition_sam|trigger=none}{code:language=javascript}
//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;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=editable|class=node}{tr:id=name}{td}h6.editable{td}{tr}{tr:id=des}{td}{sub-section:editable_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:editable_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:editable_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:editable_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:editable_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:editable_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:editable_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:editable_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:editable_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:editable_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:editable_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:editable_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:editable_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:editable_sam|trigger=none}{code:language=javascript}
var currentState = forms.customer.elements.customer_id.editable;
forms.customer.elements.customer_id.editable = !currentState;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=enabled|class=node}{tr:id=name}{td}h6.enabled{td}{tr}{tr:id=des}{td}{sub-section:enabled_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:enabled_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:enabled_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:enabled_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:enabled_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:enabled_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:enabled_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:enabled_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:enabled_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:enabled_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:enabled_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:enabled_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:enabled_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:enabled_sam|trigger=none}{code:language=javascript}
//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;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=fgcolor|class=node}{tr:id=name}{td}h6.fgcolor{td}{tr}{tr:id=des}{td}{sub-section:fgcolor_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:fgcolor_des|trigger=none|class=sIndent}Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:fgcolor_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:fgcolor_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:fgcolor_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:fgcolor_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:fgcolor_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:fgcolor_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:fgcolor_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:fgcolor_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:fgcolor_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:fgcolor_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:fgcolor_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:fgcolor_sam|trigger=none}{code:language=javascript}
//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;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=font|class=node}{tr:id=name}{td}h6.font{td}{tr}{tr:id=des}{td}{sub-section:font_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:font_des|trigger=none|class=sIndent}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).{sub-section}{td
It only returns it's correct value if it was explicitly set.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:font_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:font_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:font_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:font_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:font_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:font_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:font_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:font_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:font_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:font_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:font_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:font_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.font = 'Tahoma,1,11';
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=readOnly|class=node}{tr:id=name}{td}h6.readOnly{td}{tr}{tr:id=des}{td}{sub-section:readOnly_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:readOnly_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:readOnly_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:readOnly_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:readOnly_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:readOnly_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:readOnly_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:readOnly_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:readOnly_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:readOnly_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:readOnly_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:readOnly_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:readOnly_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:readOnly_sam|trigger=none}{code:language=javascript}
//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;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=titleText|class=node}{tr:id=name}{td}h6.titleText{td}{tr}{tr:id=des}{td}{sub-section:titleText_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:titleText_des|trigger=none|class=sIndent}Gets or sets the title text.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:titleText_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:titleText_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:titleText_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:titleText_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:titleText_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:titleText_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:titleText_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:titleText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:titleText_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:titleText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:titleText_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:titleText_sam|trigger=none}{code:language=javascript}
var titleText = forms.customer.elements.customer_id.titleText;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=toolTipText|class=node}{tr:id=name}{td}h6.toolTipText{td}{tr}{tr:id=des}{td}{sub-section:toolTipText_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:toolTipText_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:toolTipText_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:toolTipText_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:toolTipText_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:toolTipText_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:toolTipText_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:toolTipText_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:toolTipText_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:toolTipText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:toolTipText_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:toolTipText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:toolTipText_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:toolTipText_sam|trigger=none}{code:language=javascript}
//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.";
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=transparent|class=node}{tr:id=name}{td}h6.transparent{td}{tr}{tr:id=des}{td}{sub-section:transparent_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:transparent_des|trigger=none|class=sIndent}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{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:transparent_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:transparent_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:transparent_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:transparent_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:transparent_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:transparent_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:transparent_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:transparent_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:transparent_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:transparent_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:transparent_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:transparent_sam|trigger=none}{code:language=javascript}
//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;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=visible|class=node}{tr:id=name}{td}h6.visible{td}{tr}{tr:id=des}{td}{sub-section:visible_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:visible_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:visible_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:visible_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:visible_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:visible_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:visible_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:visible_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:visible_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:visible_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:visible_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:visible_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:visible_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:visible_sam|trigger=none}{code:language=javascript}
//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;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\
{table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=getAbsoluteFormLocationY|class=node}{tr:id=name}{td}h6.getAbsoluteFormLocationY{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getAbsoluteFormLocationY{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getAbsoluteFormLocationY_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getAbsoluteFormLocationY_des|trigger=none|class=sIndent}Returns the absolute form (designed) Y location.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getAbsoluteFormLocationY_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getAbsoluteFormLocationY_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getAbsoluteFormLocationY_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getAbsoluteFormLocationY_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getAbsoluteFormLocationY_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getAbsoluteFormLocationY_ret|trigger=none|class=sIndent}[Number] -- The y location of the form in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getAbsoluteFormLocationY_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getAbsoluteFormLocationY_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getAbsoluteFormLocationY_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getAbsoluteFormLocationY_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getAbsoluteFormLocationY_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getAbsoluteFormLocationY_sam|trigger=none}{code:language=javascript}
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getAsPlainText|class=node}{tr:id=name}{td}h6.getAsPlainText{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getAsPlainText{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getAsPlainText_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getAsPlainText_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getAsPlainText_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getAsPlainText_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getAsPlainText_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getAsPlainText_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getAsPlainText_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getAsPlainText_ret|trigger=none|class=sIndent}[String] -- the plain text{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getAsPlainText_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getAsPlainText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getAsPlainText_link|text=|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getAsPlainText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getAsPlainText_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getAsPlainText_sam|trigger=none}{code:language=javascript}
var my_text = forms.customer.elements.customer_id.getAsPlainText();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getClientProperty|class=node}{tr:id=name}{td}h6.getClientProperty{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Object]{span}{span:id=iets|style=float: left; font-weight: bold;}getClientProperty{span}{span:id=iets|style=float: left;}\(key){span}{td}{tr}{tr:id=des}{td}{sub-section:getClientProperty_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getClientProperty_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getClientProperty_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getClientProperty_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getClientProperty_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getClientProperty_prs|trigger=none|class=sIndent}\{[Object]} key -- user interface key (depends on operating system)
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getClientProperty_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getClientProperty_ret|trigger=none|class=sIndent}[Object] -- The value of the property for specified key.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getClientProperty_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getClientProperty_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getClientProperty_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getClientProperty_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getClientProperty_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getClientProperty_sam|trigger=none}{code:language=javascript}
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDataProviderID|class=node}{tr:id=name}{td}h6.getDataProviderID{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getDataProviderID{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getDataProviderID_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getDataProviderID_des|trigger=none|class=sIndent}Get the data provider this UI element (display) is showing.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getDataProviderID_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getDataProviderID_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getDataProviderID_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getDataProviderID_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getDataProviderID_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getDataProviderID_ret|trigger=none|class=sIndent}[String] -- The data provider as String.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getDataProviderID_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getDataProviderID_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getDataProviderID_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getDataProviderID_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getDataProviderID_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getDataProviderID_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.getDataProviderID();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDesignTimeProperty|class=node}{tr:id=name}{td}h6.getDesignTimeProperty{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Object]{span}{span:id=iets|style=float: left; font-weight: bold;}getDesignTimeProperty{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getDesignTimeProperty_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getDesignTimeProperty_des|trigger=none|class=sIndent}Get a design\-time property of an element.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getDesignTimeProperty_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getDesignTimeProperty_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getDesignTimeProperty_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getDesignTimeProperty_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getDesignTimeProperty_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getDesignTimeProperty_ret|trigger=none|class=sIndent}[Object]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getDesignTimeProperty_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getDesignTimeProperty_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getDesignTimeProperty_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getDesignTimeProperty_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getDesignTimeProperty_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getDesignTimeProperty_sam|trigger=none}{code:language=javascript}
var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getElementType|class=node}{tr:id=name}{td}h6.getElementType{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getElementType{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getElementType_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getElementType_des|trigger=none|class=sIndent}Returns the type of a specified element.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getElementType_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getElementType_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getElementType_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getElementType_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getElementType_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getElementType_ret|trigger=none|class=sIndent}[String] -- The display type of the element as String.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getElementType_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getElementType_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getElementType_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getElementType_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getElementType_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getElementType_sam|trigger=none}{code:language=javascript}
var et = forms.customer.elements.customer_id.getElementType();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getHeight|class=node}{tr:id=name}{td}h6.getHeight{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getHeight{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getHeight_des|text=|trigger=button|text=}{sub-section}{sub-section:getHeight_des|trigger=none|class=sIndent}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);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getHeight_snc|trigger=button|text=}{sub-section}{sub-section:getHeight_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getHeight_prs|trigger=button|text=}{sub-section}{sub-section:getHeight_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getHeight_ret|trigger=button|text=}{sub-section}{sub-section:getHeight_ret|trigger=none|class=sIndent}[Number] -- The height of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getHeight_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getHeight_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getHeight_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getHeight_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getHeight_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getHeight_sam|trigger=none}{code:language=javascript}
var ht = forms.customer.elements.customer_id.getHeight();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLabelForElementNames|class=node}{tr:id=name}{td}h6.getLabelForElementNames{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getLabelForElementNames{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getLabelForElementNames_des|trigger=button|text=}{sub-section}{sub-section:getLabelForElementNames_des|trigger=none|class=sIndent}Returns an Array of label element names that has this field filled in as the labelFor.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getLabelForElementNames_snc|trigger=button|text=}{sub-section}{sub-section:getHeightgetLabelForElementNames_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getHeightgetLabelForElementNames_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getHeightgetLabelForElementNames_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getHeightgetLabelForElementNames_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getHeightgetLabelForElementNames_ret|trigger=none|class=sIndent}[NumberString]\[] -- TheAn heightarray of thewith element in pixelsnames.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getHeightgetLabelForElementNames_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getHeightgetLabelForElementNames_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getHeightgetLabelForElementNames_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getHeightgetLabelForElementNames_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getHeightgetLabelForElementNames_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getHeightgetLabelForElementNames_sam|trigger=none}{code:language=javascript}
var htarray = forms.customer.elements.customername_idfirst.getHeightgetLabelForElementNames();
for (var i = 0; i<array.length; i++)
{
elements[array[i]].fgcolor = "#ff00ff";
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationX|class=node}{tr:id=name}{td}h6.getLocationX{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getLocationX{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getLocationX_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getLocationX_des|trigger=none|class=sIndent}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);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getLocationX_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getLocationX_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getLocationX_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getLocationX_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getLocationX_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getLocationX_ret|trigger=none|class=sIndent}[Number] -- The x location of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getLocationX_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getLocationX_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getLocationX_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getLocationX_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getLocationX_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getLocationX_sam|trigger=none}{code:language=javascript}
var x = forms.customer.elements.customer_id.getLocationX();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationY|class=node}{tr:id=name}{td}h6.getLocationY{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getLocationY{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getLocationY_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getLocationY_des|trigger=none|class=sIndent}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);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getLocationY_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getLocationY_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getLocationY_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getLocationY_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getLocationY_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getLocationY_ret|trigger=none|class=sIndent}[Number] -- The y location of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getLocationY_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getLocationY_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getLocationY_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getLocationY_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getLocationY_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getLocationY_sam|trigger=none}{code:language=javascript}
var y = forms.customer.elements.customer_id.getLocationY();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getName|class=node}{tr:id=name}{td}h6.getName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getName_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getName_des|trigger=none|class=sIndent}Returns the name of an element. (may be null as well){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getName_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getName_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getName_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getName_ret|trigger=none|class=sIndent}[String] -- The name of the element.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getName_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getName_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getName_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getName_sam|trigger=none}{code:language=javascript}
var name = forms.customer.elements.customer_id.getName();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getScrollX|class=node}{tr:id=name}{td}h6.getScrollX{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getScrollX{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getScrollX_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getScrollX_des|trigger=none|class=sIndent}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);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getScrollX_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getScrollX_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getScrollX_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getScrollX_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getScrollX_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getScrollX_ret|trigger=none|class=sIndent}[Number] -- The x scroll location in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getScrollX_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getScrollX_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getScrollX_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getScrollX_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getScrollX_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getScrollX_sam|trigger=none}{code:language=javascript}
var x = forms.customer.elements.customer_id.getScrollX();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getScrollY|class=node}{tr:id=name}{td}h6.getScrollY{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getScrollY{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getScrollY_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getScrollY_des|trigger=none|class=sIndent}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);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getScrollY_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getScrollY_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getScrollY_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getScrollY_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getScrollY_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getScrollY_ret|trigger=none|class=sIndent}[Number] -- The y scroll location in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getScrollY_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getScrollY_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getScrollY_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getScrollY_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getScrollY_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getScrollY_sam|trigger=none}{code:language=javascript}
var y = forms.customer.elements.customer_id.getScrollY();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSelectedText|class=node}{tr:id=name}{td}h6.getSelectedText{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getSelectedText{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getSelectedText_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getSelectedText_des|trigger=none|class=sIndent}Returns the currently selected text in the specified text field or text area.
NOTE: This function is for field elements onlyNOTE: This does not work for text fields in the Web Client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getSelectedText_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getSelectedText_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getSelectedText_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getSelectedText_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getSelectedText_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getSelectedText_ret|trigger=none|class=sIndent}[String] -- The selected text from the component.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getSelectedText_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getSelectedText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getSelectedText_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getSelectedText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getSelectedText_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getSelectedText_sam|trigger=none}{code:language=javascript}
var my_text = forms.customer.elements.customer_id.getSelectedText();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getWidth|class=node}{tr:id=name}{td}h6.getWidth{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getWidth{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getWidth_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:getWidth_des|trigger=none|class=sIndent}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);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getWidth_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:getWidth_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getWidth_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:getWidth_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getWidth_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:getWidth_ret|trigger=none|class=sIndent}[Number] -- The width of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getWidth_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getWidth_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getWidth_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getWidth_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getWidth_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:getWidth_sam|trigger=none}{code:language=javascript}
var w = forms.customer.elements.customer_id.getWidth();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=putClientProperty|class=node}{tr:id=name}{td}h6.putClientProperty{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}putClientProperty{span}{span:id=iets|style=float: left;}\(key, value){span}{td}{tr}{tr:id=des}{td}{sub-section:putClientProperty_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:putClientProperty_des|trigger=none|class=sIndent}Sets the value for the specified element client property key.
NOTE: Depending on the operating system, a user interface property name may be available.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:putClientProperty_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:putClientProperty_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:putClientProperty_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:putClientProperty_prs|trigger=none|class=sIndent}\{[Object]} key -- user interface key (depends on operating system)
\{[Object]} value -- a predefined value for the key
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:putClientProperty_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:putClientProperty_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:putClientProperty_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:putClientProperty_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:putClientProperty_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:putClientProperty_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:putClientProperty_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:putClientProperty_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=replaceSelectedText|class=node}{tr:id=name}{td}h6.replaceSelectedText{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}replaceSelectedText{span}{span:id=iets|style=float: left;}\(s){span}{td}{tr}{tr:id=des}{td}{sub-section:replaceSelectedText_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:replaceSelectedText_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:replaceSelectedText_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:replaceSelectedText_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:replaceSelectedText_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:replaceSelectedText_prs|trigger=none|class=sIndent}\{[String]} s -- The replacement text.
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:replaceSelectedText_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:replaceSelectedText_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:replaceSelectedText_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:replaceSelectedText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:replaceSelectedText_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:replaceSelectedText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:replaceSelectedText_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:replaceSelectedText_sam|trigger=none}{code:language=javascript}
//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');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=requestFocus|class=node}{tr:id=name}{td}h6.requestFocus{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}requestFocus{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:requestFocus_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:requestFocus_des|trigger=none|class=sIndent}Request the focus in this element. (Focus is also a text cursor on text components).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:requestFocus_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:requestFocus_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:requestFocus_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:requestFocus_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:requestFocus_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:requestFocus_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:requestFocus_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:requestFocus_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:requestFocus_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:requestFocus_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:requestFocus_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:requestFocus_sam|trigger=none}{code:language=javascript}
//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();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=requestFocus-Boolean|class=node}{tr:id=name}{td}h6.requestFocus{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}requestFocus{span}{span:id=iets|style=float: left;}\(mustExecuteOnFocusGainedMethod){span}{td}{tr}{tr:id=des}{td}{sub-section:requestFocus-Boolean_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:requestFocus-Boolean_des|trigger=none|class=sIndent}Request the focus in this element. (Focus is also a text cursor on text components).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:requestFocus-Boolean_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:requestFocus-Boolean_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:requestFocus-Boolean_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:requestFocus-Boolean_prs|trigger=none|class=sIndent}\{[Boolean]} mustExecuteOnFocusGainedMethod -- If true will execute onFocusGained method, else will not; default value is true.
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:requestFocus-Boolean_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:requestFocus-Boolean_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:requestFocus-Boolean_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:requestFocus-Boolean_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:requestFocus-Boolean_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:requestFocus-Boolean_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:requestFocus-Boolean_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:requestFocus-Boolean_sam|trigger=none}{code:language=javascript}
//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);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=selectAll|class=node}{tr:id=name}{td}h6.selectAll{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}selectAll{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:selectAll_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:selectAll_des|trigger=none|class=sIndent}Selects all the contents of a field.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:selectAll_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:selectAll_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:selectAll_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:selectAll_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:selectAll_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:selectAll_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:selectAll_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:selectAll_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:selectAll_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:selectAll_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:selectAll_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:selectAll_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.selectAll();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setLocation|class=node}{tr:id=name}{td}h6.setLocation{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setLocation{span}{span:id=iets|style=float: left;}\(x, y){span}{td}{tr}{tr:id=des}{td}{sub-section:setLocation_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:setLocation_des|trigger=none|class=sIndent}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 screenLEFT side of the screen.
Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
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);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setLocation_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:setLocation_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setLocation_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:setLocation_prs|trigger=none|class=sIndent}\{[Number]} x -- the X coordinate of the element in pixels.
\{[Number]} y -- the Y coordinate of the element in pixels.
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setLocation_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:setLocation_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setLocation_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setLocation_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setLocation_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setLocation_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setLocation_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setLocation_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setLocation(200,200);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setScroll|class=node}{tr:id=name}{td}h6.setScroll{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setScroll{span}{span:id=iets|style=float: left;}\(x, y){span}{td}{tr}{tr:id=des}{td}{sub-section:setScroll_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:setScroll_des|trigger=none|class=sIndent}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);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setScroll_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:setScroll_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setScroll_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:setScroll_prs|trigger=none|class=sIndent}\{[Number]} x -- the X coordinate of the portal scroll location in pixels
\{[Number]} y -- the Y coordinate of the portal scroll location in pixels
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setScroll_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:setScroll_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setScroll_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setScroll_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setScroll_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setScroll_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setScroll_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setScroll_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setScroll(200,200);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setSize|class=node}{tr:id=name}{td}h6.setSize{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setSize{span}{span:id=iets|style=float: left;}\(width, height){span}{td}{tr}{tr:id=des}{td}{sub-section:setSize_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:setSize_des|trigger=none|class=sIndent}Sets the size of thean fieldelement. It takes as input the width and the height.
Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
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);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setSize_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:setSize_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setSize_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:setSize_prs|trigger=none|class=sIndent}\{[Number]} width -- the width of the element in pixels.
\{[Number]} height -- the height of the element in pixels.
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setSize_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:setSize_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setSize_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setSize_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setSize_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setSize_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setSize_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setSize_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setSize(20,30);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |
Overview
Content Tools
Activity