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}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{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}[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}{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}[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}[String]{td}{td}[#getValueListName]\()
Returns the current valuelist name for the specified field; returns NULL if no valuelist.{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}[#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}[#setLocation]\(x, y)
Sets the location of an element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setSize]\(width, height)
Sets the size of an element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setValueListItems]\(datasetvalue)
Sets the display/real values to the custom valuelist of the element (if element has custom valuelist).{td}{tr}{tbody}{table}\\
{table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=bgcolor|class=node}{tr:id=name}{td}h6.bgcolor{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:bgcolor_des|trigger=button|text=}{sub-section}{sub-section:bgcolor_des|trigger=none|class=sIndent}GetsReplace 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.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:bgcolor_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:border_des|trigger=button|text=}{sub-section}{sub-section:border_des|trigger=none|class=sIndent}GetsReplace 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}{trwith description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:border_snc|trigger=button|text=}{sub-section}{sub-section:border_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sncprs}{td}*SinceParameters*\\{sub-section:border_sncprs|trigger=button|text=}{sub-section}{sub-section:border_sncprs|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prsret}{td}*ParametersReturns*\\{sub-section:border_prsret|trigger=button|text=}{sub-section}{sub-section:border_prsret|trigger=none|class=sIndent}spec -- the border attributes
[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=retsee}{td}*ReturnsAlso see*\\{sub-section:border_retsee|trigger=button|text=}{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|trigger=button|text=}{sub-section}{div:classdiv: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|trigger=button|text=}{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|trigger=button|text=}{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=enabled|class=node}{tr:id=name}{td}h6.enabled{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:enabled_des|trigger=button|text=}{sub-section}{sub-section:enabled_des|trigger=none|class=sIndent}GetsReplace 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-with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:enabled_snc|trigger=button|text=}{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=sncprs}{td}*SinceParameters*\\{sub-section:enabled_sncprs|trigger=button|text=}{sub-section}{sub-section:enabled_sncprs|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prsret}{td}*ParametersReturns*\\{sub-section:enabled_prsret|trigger=button|text=}{sub-section}{sub-section:enabled_prsret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=retsee}{td}*Returns*\\{sub-section:enabled_ret|trigger=button|text=}{sub-section}{sub-section:enabled_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also Also see*\\{sub-section:enabled_see|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:fgcolor_des|trigger=button|text=}{sub-section}{sub-section:fgcolor_des|trigger=none|class=sIndent}GetsReplace 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=sncwith description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:fgcolor_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:font_des|trigger=button|text=}{sub-section}{sub-section:font_des|trigger=none|class=sIndent}GetsReplace 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).
It only returns it's correct value if it was explicitly set.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:font_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:readOnly_des|trigger=button|text=}{sub-section}{sub-section:readOnly_des|trigger=none|class=sIndent}GetsReplace 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}{with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:readOnly_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:titleText_des|trigger=button|text=}{sub-section}{sub-section:titleText_des|trigger=none|class=sIndent}GetsReplace or sets the title text.with description{sub-section}{td}{tr}{builder-show:}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:titleText_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:toolTipText_des|trigger=button|text=}{sub-section}{sub-section:toolTipText_des|trigger=none|class=sIndent}GetsReplace 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.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:toolTipText_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:transparent_des|trigger=button|text=}{sub-section}{sub-section:transparent_des|trigger=none|class=sIndent}GetsReplace 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}{with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:transparent_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:visible_des|trigger=button|text=}{sub-section}{sub-section:visible_des|trigger=none|class=sIndent}GetsReplace 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-sectionwith description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:visible_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getAbsoluteFormLocationY_des|trigger=button|text=}{sub-section}{sub-section:getAbsoluteFormLocationY_des|trigger=none|class=sIndent}ReturnsReplace the absolute form (designed) Y location.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getAbsoluteFormLocationY_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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=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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getClientProperty_des|trigger=button|text=}{sub-section}{sub-section:getClientProperty_des|trigger=none|class=sIndent}GetsReplace 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}{trwith description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getClientProperty_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getDataProviderID_des|trigger=button|text=}{sub-section}{sub-section:getDataProviderID_des|trigger=none|class=sIndent}GetReplace the data provider this UI element (display) is showing.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getDataProviderID_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getDesignTimeProperty_des|trigger=button|text=}{sub-section}{sub-section:getDesignTimeProperty_des|trigger=none|class=sIndent}GetReplace a design\-time property of an element.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getDesignTimeProperty_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getElementType_des|trigger=button|text=}{sub-section}{sub-section:getElementType_des|trigger=none|class=sIndent}ReturnsReplace the type of a specified element.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getElementType_snc|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getHeight_des|trigger=button|text=}{sub-section}{sub-section:getHeight_des|trigger=none|class=sIndent}ReturnsReplace 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);with description{sub-section}{td}{tr}{builder-show}{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=sncsee}{td}*SinceAlso see*\\{sub-section:getHeight_sncsee|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getHeight_sncsee|trigger=none|class=sIndent} Replace with version info{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prslink}{td}*ParametersExternal links*\\{sub-section:getHeight_prslink|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getHeight_prslink|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{tr:id=retsam}{td}*ReturnsSample*\\{sub-section:getHeight_retsam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getHeight_retsam|trigger=none|class=sIndent}[Number] -- The height of the element in pixels.}{code:language=javascript}
var ht = forms.customer.elements.customer_id.getHeight();
{code}{sub-section}{div}{td}{tr}{builder-showtr:permissionclass=editlastDetailRow}{tr:id=seetd}{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{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}{builder-show:permission=edit}{tr:id=linkdes}{td}*External links*\\{sub-section:getHeightgetLabelForElementNames_linkdes|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getHeightgetLabelForElementNames_linkdes|trigger=none|class=sIndent}Replace with description{sub-section}{divtd}{tdtr}{trbuilder-show}{builder-show:permission=edit}{tr:id=samsnc}{td}*SampleSince*\\{sub-section:getHeightgetLabelForElementNames_samsnc|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getHeightgetLabelForElementNames_samsnc|trigger=none}{code:language=javascript|class=sIndent} varReplace htwith = forms.customer.elements.customer_id.getHeight();
{code}{version info{sub-section}{divtd}{tdtr}{trbuilder-show}{trbuilder-show:classpermission=lastDetailRowedit}{tdtr:id=prs}{td}{tr}{tbody}{tbody:id=getLabelForElementNames|class=node}{tr:id=name}{td}h6.getLabelForElementNames{td}{tr*Parameters*\\{sub-section:getLabelForElementNames_prs|trigger=button|text=}{sub-section}{sub-section:getLabelForElementNames_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=sigret}{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*Returns*\\{sub-section:getLabelForElementNames_ret|trigger=button|text=}{sub-section}{sub-section:getLabelForElementNames_ret|trigger=none|class=sIndent}[String]\[] -- An array with element names.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=dessee}{td}*Also see*\\{sub-section:getLabelForElementNames_dessee|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNames_dessee|trigger=none|class=sIndent}Returns an Array of label element names that has this field filled in as the labelFor.{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snclink}{td}*SinceExternal links*\\{sub-section:getLabelForElementNames_snclink|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNames_snclink|trigger=none|class=sIndent} Replace with version info{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prssam}{td}*ParametersSample*\\{sub-section:getLabelForElementNames_prssam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNames_prssam|trigger=none|class=sIndent}{code:language=javascript}
var array = elements.name_first.getLabelForElementNames();
for (var i = 0; i<array.length; i++)
{
elements[array[i]].fgcolor = "#ff00ff";
}
{code}{sub-section}{div}{td}{tr}{builder-show}{tr:id=retclass=lastDetailRow}{td}{td}*Returns*\\{sub-section:getLabelForElementNames_ret|trigger=button|text=}{sub-section}{sub-section:getLabelForElementNames_ret|trigger=none|class=sIndent}[String]\[] -- An array with element names.{sub-section}{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}{builder-show:permission=edit}{tr:id=seedes}{td}*Also see*\\{sub-section:getLabelForElementNamesgetLocationX_seedes|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNamesgetLocationX_seedes|trigger=none|class=sIndent}Replace with description{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksnc}{td}*External linksSince*\\{sub-section:getLabelForElementNamesgetLocationX_linksnc|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNamesgetLocationX_linksnc|trigger=none|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{builder-show:permission=edit}{tr:id=samprs}{td}*SampleParameters*\\{sub-section:getLabelForElementNamesgetLocationX_samprs|trigger=button|text=}{sub-section}{div:sub-section:getLocationX_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getLabelForElementNamesgetLocationX_samret|trigger=nonebutton|text=}{sub-section}{code:language=javascript}
var array = elements.name_first.getLabelForElementNames();
for (var i = 0; i<array.length; i++)
{
elements[array[i]].fgcolor = "#ff00ff";
}
{code}{sub-section:getLocationX_ret|trigger=none|class=sIndent}[Number] -- The x location of the element in pixels.{sub-section}{divtd}{tdtr}{trbuilder-show:permission=edit}{tr:classid=lastDetailRowsee}{td}{td}{tr}{tbody}{tbody:id=getLocationX|class=node}{tr:id=name}{td}h6.getLocationX{td}{tr*Also see*\\{sub-section:getLocationX_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLocationX_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=siglink}{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*External links*\\{sub-section:getLocationX_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLocationX_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=dessam}{td}*Sample*\\{sub-section:getLocationX_dessam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLocationX_dessam|trigger=none|class=sIndent}Returns the}{code:language=javascript}
var x location of the current element.
NOTE: = forms.customer.elements.customer_id.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;
{code}{sub-section}{div}{td}{tr}{builder-show:permission=edittr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationY|class=node}{tr:id=snc}name}{td}h6.getLocationY{td}*Since*\\{sub-section:getLocationX_snc|trigger=button|text=}{sub-section}{sub-section:getLocationX_snc|trigger=none|class=sIndent} Replace with version info{sub-section{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}{builder-show}{builder-show:permission=edit}{tr:id=prsdes}{td}*Parameters*\\{sub-section:getLocationXgetLocationY_prsdes|trigger=button|text=}{sub-section}{sub-section:getLocationXgetLocationY_prsdes|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=retsnc}{td}*ReturnsSince*\\{sub-section:getLocationXgetLocationY_retsnc|trigger=button|text=}{sub-section}{sub-section:getLocationXgetLocationY_retsnc|trigger=none|class=sIndent}[Number] --Replace Thewith x location of the element in pixels.version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=seeprs}{td}*Also seeParameters*\\{sub-section:getLocationXgetLocationY_seeprs|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetLocationY_seeprs|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkret}{td}*External linksReturns*\\{sub-section:getLocationXgetLocationY_linkret|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetLocationY_linkret|trigger=none|class=sIndent}[Number] -- The y location of the element in pixels.{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=samsee}{td}*SampleAlso see*\\{sub-section:getLocationXgetLocationY_samsee|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetLocationY_samsee|trigger=none}{code:language=javascript}
var x = forms.customer.elements.customer_id.getLocationX();
{code}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:classid=lastDetailRowlink}{td}{td}{tr}{tbody}{tbody:id=getLocationY|class=node}{tr:id=name}{td}h6.getLocationY*External links*\\{sub-section:getLocationY_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLocationY_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sigsam}{td}{span:style=float:*Sample*\\{sub-section:getLocationY_sam|trigger=button|text=}{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;}[NumberString]{span}{span:id=iets|style=float: left; font-weight: bold;}getLocationYgetName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getLocationYgetName_des|trigger=button|text=}{sub-section}{sub-section:getLocationYgetName_des|trigger=none|class=sIndent}ReturnsReplace 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:permissionwith description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getName_snc|trigger=button|text=}{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=sncprs}{td}*SinceParameters*\\{sub-section:getLocationYgetName_sncprs|trigger=button|text=}{sub-section}{sub-section:getLocationYgetName_sncprs|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-showtr:permissionid=editret}{tr:id=prs}{td}*Parameters*\\{sub-section:getLocationY_prs|trigger=button|text=}{sub-section}{sub-section:getLocationY_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getLocationYgetName_ret|trigger=button|text=}{sub-section}{sub-section:getLocationYgetName_ret|trigger=none|class=sIndent}[NumberString] -- The yname location of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getLocationYgetName_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLocationYgetName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getLocationYgetName_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLocationYgetName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getLocationYgetName_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getLocationYgetName_sam|trigger=none}{code:language=javascript}
var yname = forms.customer.elements.customer_id.getLocationYgetName();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getNamegetValueListName|class=node}{tr:id=name}{td}h6.getNamegetValueListName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getNamegetValueListName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getNamegetValueListName_des|trigger=button|text=}{sub-section}{sub-section:getNamegetValueListName_des|trigger=none|class=sIndent}ReturnsReplace the name of an element. (may be null as well)with description{sub-section}{td}{tr}{builder-show:permission=edit}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getNamegetValueListName_snc|trigger=button|text=}{sub-section}{sub-section:getNamegetValueListName_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:getNamegetValueListName_prs|trigger=button|text=}{sub-section}{sub-section:getNamegetValueListName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getNamegetValueListName_ret|trigger=button|text=}{sub-section}{sub-section:getNamegetValueListName_ret|trigger=none|class=sIndent}[String] -- The name of the elementvaluelist name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getNamegetValueListName_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getNamegetValueListName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getNamegetValueListName_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getNamegetValueListName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getNamegetValueListName_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getNamegetValueListName_sam|trigger=none}{code:language=javascript}
var name = forms.customer.elements.customer_id.getNamegetValueListName();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getValueListNamegetWidth|class=node}{tr:id=name}{td}h6.getValueListNamegetWidth{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[StringNumber]{span}{span:id=iets|style=float: left; font-weight: bold;}getValueListNamegetWidth{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getValueListNamegetWidth_des|trigger=button|text=}{sub-section}{sub-section:getValueListNamegetWidth_des|trigger=none|class=sIndent}ReturnsReplace the current valuelist name for the specified field; returns NULL if no valuelist.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getValueListNamegetWidth_snc|trigger=button|text=}{sub-section}{sub-section:getValueListNamegetWidth_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:getValueListNamegetWidth_prs|trigger=button|text=}{sub-section}{sub-section:getValueListNamegetWidth_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getValueListNamegetWidth_ret|trigger=button|text=}{sub-section}{sub-section:getValueListNamegetWidth_ret|trigger=none|class=sIndent}[StringNumber] -- The valuelist name width of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getValueListNamegetWidth_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getValueListNamegetWidth_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getValueListNamegetWidth_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getValueListNamegetWidth_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getValueListNamegetWidth_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getValueListNamegetWidth_sam|trigger=none}{code:language=javascript}
var namew = forms.customer.elements.customer_id.getValueListNamegetWidth();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getWidthputClientProperty|class=node}{tr:id=name}{td}h6.getWidthputClientProperty{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]void{span}{span:id=iets|style=float: left; font-weight: bold;}getWidthputClientProperty{span}{span:id=iets|style=float: left;}\()key, value){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getWidthputClientProperty_des|trigger=button|text=}{sub-section}{sub-section:getWidthputClientProperty_des|trigger=none|class=sIndent}ReturnsReplace 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}*Sincewith description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:putClientProperty_snc|trigger=button|text=}{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|trigger=button|text=}{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:getWidthputClientProperty_sncret|trigger=button|text=}{sub-section}{sub-section:getWidthputClientProperty_sncret|trigger=none|class=sIndent} Replace with version infovoid{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prssee}{td}*ParametersAlso see*\\{sub-section:getWidthputClientProperty_prssee|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getWidthputClientProperty_prssee|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=retlink}{td}*ReturnsExternal links*\\{sub-section:getWidthputClientProperty_retlink|trigger=button|text=}{sub-section}{sub-section:getWidth_retdiv:class=sIndent}{sub-section:putClientProperty_link|trigger=none|class=sIndent}[Number] -- The width of the element in pixels.{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=seesam}{td}*Also seeSample*\\{sub-section:getWidthputClientProperty_seesam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getWidthputClientProperty_seesam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
{code}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linktr:class=lastDetailRow}{td}{td}*External links*\\{sub-section:getWidth_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getWidth_link|trigger=none}{sub-section}{div{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}{builder-show:permission=edit}{tr:id=samdes}{td}*Sample*\\{sub-section:getWidthrequestFocus_samdes|trigger=button|text=}{sub-section}{div:sub-section:requestFocus_des|trigger=none|class=sIndent}Replace with description{sub-section:getWidth_sam|trigger=none}{code:language=javascript}
var w = forms.customer.elements.customer_id.getWidth();
{code}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:requestFocus_snc|trigger=button|text=}{sub-section}{sub-section:requestFocus_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{trbuilder-show:classpermission=lastDetailRowedit}{tdtr:id=prs}{td}{tr}{tbody}{tbody:id=putClientProperty|class=node}{tr:id=name}{td}h6.putClientProperty{td}{tr*Parameters*\\{sub-section:requestFocus_prs|trigger=button|text=}{sub-section}{sub-section:requestFocus_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=sigret}{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*Returns*\\{sub-section:requestFocus_ret|trigger=button|text=}{sub-section}{sub-section:requestFocus_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=dessee}{td}*Also see*\\{sub-section:putClientPropertyrequestFocus_dessee|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:putClientPropertyrequestFocus_dessee|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}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*SinceExternal links*\\{sub-section:putClientPropertyrequestFocus_snclink|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:putClientPropertyrequestFocus_snclink|trigger=none|class=sIndent} Replace with version info{sub-section}{div}{td}{tr}{builder-show}{tr:id=prssam}{td}*ParametersSample*\\{sub-section:putClientPropertyrequestFocus_prssam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:putClientPropertyrequestFocus_prssam|trigger=none|class=sIndent}\{[Object]} key -- user interface key (depends on operating system)
\{[Object]} value -- a predefined value for the key
{sub-section{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:id=retclass=lastDetailRow}{td}{td}*Returns*\\{sub-section:putClientProperty_ret|trigger=button|text=}{sub-section}{sub-section:putClientProperty_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit{tr}{tbody}{tbody:id=requestFocus-Boolean|class=node}{tr:id=name}{td}h6.requestFocus{td}{tr}{tr:id=seesig}{td}*Also see*\\{sub-section:putClientProperty_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:putClientProperty_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show{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}{builder-show:permission=edit}{tr:id=linkdes}{td}*External links*\\{sub-section:putClientPropertyrequestFocus-Boolean_linkdes|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:putClientPropertyrequestFocus-Boolean_linkdes|trigger=none|class=sIndent}Replace with description{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samsnc}{td}*SampleSince*\\{sub-section:putClientPropertyrequestFocus-Boolean_samsnc|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:putClientPropertyrequestFocus-Boolean_samsnc|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
{code}{|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:classid=lastDetailRowprs}{td}{td}{tr}{tbody}{tbody:id=requestFocus|class=node}{tr:id=name}{td}h6.requestFocus*Parameters*\\{sub-section:requestFocus-Boolean_prs|trigger=button|text=}{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=sigret}{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*Returns*\\{sub-section:requestFocus-Boolean_ret|trigger=button|text=}{sub-section}{sub-section:requestFocus-Boolean_desret|trigger=none|class=sIndent}Request the focus in this element. (Focus is also a text cursor on text components).void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=sncsee}{td}*SinceAlso see*\\{sub-section:requestFocus-Boolean_sncsee|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:requestFocus-Boolean_sncsee|trigger=none|class=sIndent} Replace with version info{}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prslink}{td}*ParametersExternal links*\\{sub-section:requestFocus-Boolean_prslink|trigger=button|text=}{sub-section}{sub-section:requestFocus_prs|trigger=none|div:class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:requestFocus_ret|trigger=button|text=:requestFocus-Boolean_link|trigger=none}{sub-section}{sub-section:requestFocus_ret|trigger=none|class=sIndent}void{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=seesam}{td}*Also seeSample*\\{sub-section:requestFocus-Boolean_seesam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:requestFocus-Boolean_seesam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:requestFocus_link|trigger=button|text=}{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|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:requestFocus_sam|trigger=none}{code:language=javascript}
//request 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=requestFocus-BooleansetLocation|class=node}{tr:id=name}{td}h6.requestFocussetLocation{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}requestFocussetLocation{span}{span:id=iets|style=float: left;}\(mustExecuteOnFocusGainedMethodx, y){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:requestFocus-BooleansetLocation_des|trigger=button|text=}{sub-section}{sub-section:requestFocus-BooleansetLocation_des|trigger=none|class=sIndent}RequestReplace the focus in this element. (Focus is also a text cursor on text components).with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:requestFocus-BooleansetLocation_snc|trigger=button|text=}{sub-section}{sub-section:requestFocus-BooleansetLocation_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:requestFocus-BooleansetLocation_prs|trigger=button|text=}{sub-section}{sub-section:requestFocus-BooleansetLocation_prs|trigger=none|class=sIndent}\{[BooleanNumber]} mustExecuteOnFocusGainedMethodx -- If true will execute onFocusGained method, else will not; default value is true 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:requestFocus-BooleansetLocation_ret|trigger=button|text=}{sub-section}{sub-section:requestFocus-BooleansetLocation_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:requestFocus-BooleansetLocation_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:requestFocus-BooleansetLocation_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:requestFocus-BooleansetLocation_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:requestFocus-BooleansetLocation_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:requestFocus-BooleansetLocation_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:requestFocus-BooleansetLocation_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.setLocation(200,200);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setLocationsetSize|class=node}{tr:id=name}{td}h6.setLocationsetSize{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setLocationsetSize{span}{span:id=iets|style=float: left;}\(xwidth, yheight){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:setLocationsetSize_des|trigger=button|text=}{sub-section}{sub-section:setLocationsetSize_des|trigger=none|class=sIndent}SetsReplace 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.
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);{with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setSize_snc|trigger=button|text=}{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|trigger=button|text=}{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}{builder-show:permission=edit}{tr:id=sncret}{td}*SinceReturns*\\{sub-section:setLocationsetSize_sncret|trigger=button|text=}{sub-section}{sub-section:setLocationsetSize_sncret|trigger=none|class=sIndent} Replace with version infovoid{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssee}{td}*ParametersAlso see*\\{sub-section:setLocationsetSize_prssee|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setLocationsetSize_prssee|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}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=retlink}{td}*ReturnsExternal links*\\{sub-section:setLocationsetSize_retlink|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setLocationsetSize_retlink|trigger=none|class=sIndent}void{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=seesam}{td}*Also seeSample*\\{sub-section:setLocationsetSize_seesam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setLocationsetSize_seesam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setSize(20,30);
{code}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linktr:class=lastDetailRow}{td}{td}*External links*\\{sub-section:setLocation_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setLocation_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show{tr}{tbody}{tbody:id=setValueListItems|class=node}{tr:id=samname}{td}*Sample*\\{sub-section:setLocation_sam|trigger=button|text=}{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}{h6.setValueListItems{td}{tr}{tr:classid=lastDetailRowsig}{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|trigger=button|text=}{sub-section}{sub-section:setSize_des|trigger=none|class=sIndent}Sets the size of an element. 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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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|trigger=button|text=}{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}{tbody:id=setValueListItems|class=node}{tr:id=name}{td}h6.setValueListItems{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setValueListItems{span}{span:id=iets|style=float: left;}\(dataset){span}{td}{tr}{tr:id=des}{td}{sub-section:setValueListItems_des|trigger=button|text=}{sub-section}{sub-section:setValueListItems_des|trigger=none|class=sIndent}Sets the display/real values to the custom valuelist of the element (if element has custom valuelist).
This does not effect the value list with same name list on other elements or value lists at application level.
Should receive a dataset parameter, first column is for display values, second column (optional) is for real values.
NOTE: if you modify values for checkbox/radio field, note that having one value in valuelist is a special case, so switching between one value and 0/multiple values after form is created may have side effectsstyle=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setValueListItems{span}{span:id=iets|style=float: left;}\(value){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:setValueListItems_des|trigger=button|text=}{sub-section}{sub-section:setValueListItems_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setValueListItems_snc|trigger=button|text=}{sub-section}{sub-section:setValueListItems_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setValueListItems_prs|trigger=button|text=}{sub-section}{sub-section:setValueListItems_prs|trigger=none|class=sIndent}dataset\{[Object]} value -- first column is display value, second column is real value
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setValueListItems_ret|trigger=button|text=}{sub-section}{sub-section:setValueListItems_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setValueListItems_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setValueListItems_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setValueListItems_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setValueListItems_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setValueListItems_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:setValueListItems_sam|trigger=none}{code:language=javascript}
var dataset = databaseManager.createEmptyDataSet(0,new Array('display_values','optional_real_values'));
dataset.addRow(['aa',1]);
dataset.addRow(['bb',2]);
dataset.addRow(['cc',3]);
// forms.customer.elements.customer_id should have a valuelist attached
forms.customer.elements.customer_id.setValueListItems(dataset);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |
Overview
Content Tools
Activity