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 sSummerysSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property SummerySummary{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}[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]
Sets the font name, style, and size of an element.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#format]
Gets or sets the display formatting of a field for number and text values; does not affect the actual value stored in the database column.{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 sSummerysSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method SummerySummary{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}[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}[#getSelectedText]\()
Returns the currently selected text in the specified field.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getTitleText#getValueListName]\()
GetReturns the current title text.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getValueListName]\()
Returns the current valuelist 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}[#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]\(\[mustExecuteOnFocusGainedMethod\])
Requests the focus for an element; can skip the onFocusGained event for an element by using requestFocus(false).{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}[#setBorder]\(spec)
Sets the border attribute(s) of a specified element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setFont]\(spec)
Sets the font name, style, and size of an 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 the field.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setValueListItems]\(dataset)
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:padding=0px|width=100%}{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}{tr:id=des}{td}{sub-section:bgcolor_des|text=|trigger=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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:bgcolor_snc|text=|trigger=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|text=|trigger=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|text=|trigger=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|text=|trigger=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|text=|trigger=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|text=|trigger=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=caretPositionborder|class=node}{tr:id=name}{td}h6.caretPositionborder{td}{tr}{tr:id=des}{td}{sub-section:caretPositionborder_des|text=|trigger=button}{sub-section}{sub-section:caretPositionborder_des|trigger=none|class=sIndent}Gets or sets the numberborder value attribute(positions) 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|text=|trigger=button}{sub-section}{sub-section:caretPosition_snc|trigger=none|class=sIndent} Replace with version info{sub-a specified element.
The border attributes:
borderType \- EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder.
size \- (numeric value) for: bottom, left, right, top.
color \- (hexadecimal value) for: bottom, left, right, top.
dash pattern \- (numeric value) for selected side(s).
rounding radius \- (numeric value) for selected side(s).
NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType".{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:caretPositionborder_prssnc|text=|trigger=button}{sub-section}{sub-section:caretPositionborder_prssnc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:caretPositionborder_retprs|text=|trigger=button}{sub-section}{sub-section:caretPositionborder_retprs|trigger=none|class=sIndent}[Number]spec -- the border attributes
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:caretPositionborder_seeret|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:caretPositionborder_seeret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:border_see|text=|trigger=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:caretPositionborder_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:caretPositionborder_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:caretPositionborder_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:caretPositionborder_sam|trigger=none}{code:language=javascript}
//get the current caretposition
var caretPos
//sets the border type to "LineBorder"
//sets a 1 px line width for the bottom and left side of the border
//sets the hexadecimal color of the border to "#ccffcc"
var b = forms.customer.elements.customer_id.caretPosition;
//add one and set it
forms.customer.elements.customer_id.caretPosition = caretPos+1setBorder('LineBorder,1,#ccffcc');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=editablecaretPosition|class=node}{tr:id=name}{td}h6.editablecaretPosition{td}{tr}{tr:id=des}{td}{sub-section:editablecaretPosition_des|text=|trigger=button}{sub-section}{sub-section:editablecaretPosition_des|trigger=none|class=sIndent}Gets or sets the editable/read\-only state number value (position) of athe field;text true \- editable; false \- read\-only.
NOTE the "!" operator can be used to invert the editable statecaret (text "I" bar) in a field.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:editablecaretPosition_snc|text=|trigger=button}{sub-section}{sub-section:editablecaretPosition_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:editablecaretPosition_prs|text=|trigger=button}{sub-section}{sub-section:editablecaretPosition_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:editablecaretPosition_ret|text=|trigger=button}{sub-section}{sub-section:editablecaretPosition_ret|trigger=none|class=sIndent}[BooleanNumber]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:editablecaretPosition_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:editablecaretPosition_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:editablecaretPosition_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:editablecaretPosition_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:editablecaretPosition_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:editablecaretPosition_sam|trigger=none}{code:language=javascript}
//get the current caretposition
var currentStatecaretPos = forms.customer.elements.customer_id.editablecaretPosition;
//add one and set it
forms.customer.elements.customer_id.editablecaretPosition = !currentStatecaretPos+1;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=enablededitable|class=node}{tr:id=name}{td}h6.enablededitable{td}{tr}{tr:id=des}{td}{sub-section:enablededitable_des|text=|trigger=button}{sub-section}{sub-section:enablededitable_des|trigger=none|class=sIndent}Gets or sets the enablededitable/read\-only state of a specified field, also known as "grayed".field; true \- enablededitable; false \- not enabled; ! \- the enabled state is inverted (the opposite)read\-only.
NOTE: Athe disabled"!" elementoperator cannotcan be selectedused byto clickinginvert 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}{treditable state.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:editable_snc|text=|trigger=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=sncprs}{td}*SinceParameters*\\{sub-section:enablededitable_sncprs|text=|trigger=button}{sub-section}{sub-section:enablededitable_sncprs|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|text=|trigger=button}{sub-section}{sub-section:enabled_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:enablededitable_ret|text=|trigger=button}{sub-section}{sub-section:enablededitable_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:enablededitable_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:enablededitable_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:enablededitable_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:enablededitable_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:enablededitable_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:enablededitable_sam|trigger=none}{code:language=javascript}
//gets the enabled
state of the field
var currStatecurrentState = forms.customer.elements.customer_id.enablededitable;
//sets the enabled state of the field
forms.customer.elements.customer_id.enablededitable = !currentState;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=fgcolorenabled|class=node}{tr:id=name}{td}h6.fgcolorenabled{td}{tr}{tr:id=des}{td}{sub-section:fgcolorenabled_des|text=|trigger=button}{sub-section}{sub-section:fgcolorenabled_des|trigger=none|class=sIndent}Gets or sets the foregroundenabled colorstate of a specified field., Thealso colorknown has to be set using the hexadecimal RGB value as used in HTMLas "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:fgcolorenabled_snc|text=|trigger=button}{sub-section}{sub-section:fgcolorenabled_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:fgcolorenabled_prs|text=|trigger=button}{sub-section}{sub-section:fgcolorenabled_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:fgcolorenabled_ret|text=|trigger=button}{sub-section}{sub-section:fgcolorenabled_ret|trigger=none|class=sIndent}[StringBoolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:fgcolorenabled_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:fgcolorenabled_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:fgcolorenabled_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:fgcolorenabled_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:fgcolorenabled_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:fgcolorenabled_sam|trigger=none}{code:language=javascript}
//setsgets the foregroundenabled colorstate of the field
var currState = forms.customer.elements.customer_id.fgcolor = "#000000"enabled;
//getssets the foregroundenabled colorstate of the field
var c = forms.customer.elements.customer_id.fgcolorenabled = !currentState;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=formatfgcolor|class=node}{tr:id=name}{td}h6.formatfgcolor{td}{tr}{tr:id=des}{td}{sub-section:formatfgcolor_des|text=|trigger=button}{sub-section}{sub-section:formatfgcolor_des|trigger=none|class=sIndent}Gets or sets the displayforeground formattingcolor of a field. forThe numbercolor andhas textto values;be doesset notusing affectthe thehexadecimal actualRGB value storedas used in the database columnHTML.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:formatfgcolor_snc|text=|trigger=button}{sub-section}{sub-section:formatfgcolor_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:formatfgcolor_prs|text=|trigger=button}{sub-section}{sub-section:formatfgcolor_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:formatfgcolor_ret|text=|trigger=button}{sub-section}{sub-section:formatfgcolor_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:formatfgcolor_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:formatfgcolor_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:formatfgcolor_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:formatfgcolor_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:formatfgcolor_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:formatfgcolor_sam|trigger=none}{code:language=javascript}
//sets the displayforeground formattingcolor of the field
forms.customer.elements.customer_id.formatfgcolor = '###'"#000000";
//gets the displayforeground formattingcolor of the field
var formatc = forms.customer.elements.customer_id.formatfgcolor;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=readOnlyfont|class=node}{tr:id=name}{td}h6.readOnlyfont{td}{tr}{tr:id=des}{td}{sub-section:readOnlyfont_des|text=|trigger=button}{sub-section}{sub-section:readOnlyfont_des|trigger=none|class=sIndent}Gets or setsSets the editable/read\-only state of a field; true \- read\-only; false \- editable; !font name, style, and size of an element.
font name \- 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 copiedname 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}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:readOnlyfont_snc|text=|trigger=button}{sub-section}{sub-section:readOnlyfont_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=editshow}{tr:id=prs}{td}*Parameters*\\{sub-section:readOnlyfont_prs|text=|trigger=button}{sub-section}{sub-section:readOnlyfont_prs|trigger=none|class=sIndent}spec -- the font name, style, size
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:readOnlyfont_ret|text=|trigger=button}{sub-section}{sub-section:readOnlyfont_ret|trigger=none|class=sIndent}[BooleanString]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:readOnlyfont_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:readOnlyfont_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:readOnlyfont_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:readOnlyfont_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:readOnlyfont_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:readOnlyfont_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;
setFont('Tahoma,1,11');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=toolTipTextformat|class=node}{tr:id=name}{td}h6.toolTipTextformat{td}{tr}{tr:id=des}{td}{sub-section:toolTipTextformat_des|text=|trigger=button}{sub-section}{sub-section:toolTipTextformat_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}Gets or sets the display formatting of a field for number and text values; does not affect the actual value stored in the database column.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:toolTipTextformat_snc|text=|trigger=button}{sub-section}{sub-section:toolTipTextformat_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:toolTipTextformat_prs|text=|trigger=button}{sub-section}{sub-section:toolTipTextformat_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:toolTipTextformat_ret|text=|trigger=button}{sub-section}{sub-section:toolTipTextformat_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:toolTipTextformat_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:toolTipTextformat_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:toolTipTextformat_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:toolTipTextformat_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:toolTipTextformat_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:toolTipTextformat_sam|trigger=none}{code:language=javascript}
//getssets the tooltipdisplay textformatting of the element
var toolTip = field
forms.customer.elements.customer_id.toolTipTextformat = '###';
//setsgets the tooltipdisplay textformatting 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."field
var format = forms.customer.elements.customer_id.format;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=transparentreadOnly|class=node}{tr:id=name}{td}h6.transparentreadOnly{td}{tr}{tr:id=des}{td}{sub-section:transparentreadOnly_des|text=|trigger=button}{sub-section}{sub-section:transparentreadOnly_des|trigger=none|class=sIndent}Gets or sets the transparencyeditable/read\-only state of ana elementfield; true \- transparentread\-only; false \- noteditable; 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 colorthe 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:transparentreadOnly_snc|text=|trigger=button}{sub-section}{sub-section:transparentreadOnly_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:transparentreadOnly_prs|text=|trigger=button}{sub-section}{sub-section:transparentreadOnly_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:transparentreadOnly_ret|text=|trigger=button}{sub-section}{sub-section:transparentreadOnly_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:transparentreadOnly_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:transparentreadOnly_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:transparentreadOnly_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:transparentreadOnly_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:transparentreadOnly_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:transparentreadOnly_sam|trigger=none}{code:language=javascript}
//gets the transparency editable/read-only state of the elementfield
var currentState = forms.customer.elements.customer_id.transparentreadOnly;
//sets the transparency editable/read-only state of the elementfield
forms.customer.elements.customer_id.transparentreadOnly = !currentState;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=visibletitleText|class=node}{tr:id=name}{td}h6.visibletitleText{td}{tr}{tr:id=des}{td}{sub-section:visibletitleText_des|text=|trigger=button}{sub-section}{sub-section:visibletitleText_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.title text.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:visibletitleText_snc|text=|trigger=button}{sub-section}{sub-section:visibletitleText_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:visibletitleText_prs|text=|trigger=button}{sub-section}{sub-section:visibletitleText_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:visibletitleText_ret|text=|trigger=button}{sub-section}{sub-section:visibletitleText_ret|trigger=none|class=sIndent}[BooleanString]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:visibletitleText_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visibletitleText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:visibletitleText_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visibletitleText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:visibletitleText_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visibletitleText_sam|trigger=none}{code:language=javascript}
//sets the element as visible
forms.company.elements.faxBtn.visible = true;
//gets the
visibility of the element
var currentStatetitleText = forms.companycustomer.elements.faxBtncustomer_id.visibletitleText;
//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:padding=0px|width=100%}{column}{colgroup}{td}{tr}{tr:style=height: 30px;}{th:colspan=1}Method Details{thclass=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getAbsoluteFormLocationYtoolTipText|class=node}{tr:id=name}{td}h6.getAbsoluteFormLocationYtoolTipText{td}{tr}{tr:id=sigdes}{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|text=|trigger=button}{sub-section}{sub-section:getAbsoluteFormLocationY_des|trigger=none|class=sIndent}Returns the absolute form (designed) Y locationsub-section:toolTipText_des|text=|trigger=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:getAbsoluteFormLocationYtoolTipText_snc|text=|trigger=button}{sub-section}{sub-section:getAbsoluteFormLocationYtoolTipText_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:getAbsoluteFormLocationYtoolTipText_prs|text=|trigger=button}{sub-section}{sub-section:getAbsoluteFormLocationYtoolTipText_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getAbsoluteFormLocationYtoolTipText_ret|text=|trigger=button}{sub-section}{sub-section:getAbsoluteFormLocationYtoolTipText_ret|trigger=none|class=sIndent}[Number] -- The y location of the form in pixels.String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getAbsoluteFormLocationYtoolTipText_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getAbsoluteFormLocationYtoolTipText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getAbsoluteFormLocationYtoolTipText_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getAbsoluteFormLocationYtoolTipText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getAbsoluteFormLocationYtoolTipText_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getAbsoluteFormLocationY_sam|trigger=none}{code:language=javascript}
var absolute_y =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.getAbsoluteFormLocationY()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=getClientProperty|class=node}{tr:id=name}{td}h6.getClientProperty{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Object]{spantbody}{spantbody:id=ietstransparent|style=float: left; font-weight: bold;}getClientProperty{span}{span:id=iets|style=float: left;}\(key){span}class=node}{tr:id=name}{td}h6.transparent{td}{tr}{tr:id=des}{td}{sub-section:getClientPropertytransparent_des|text=|trigger=button}{sub-section}{sub-section:getClientPropertytransparent_des|trigger=none|class=sIndent}Gets or sets 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. 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:getClientPropertytransparent_snc|text=|trigger=button}{sub-section}{sub-section:getClientPropertytransparent_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:getClientPropertytransparent_prs|text=|trigger=button}{sub-section}{sub-section:getClientPropertytransparent_prs|trigger=none|class=sIndent}\{[Object]} key -- user interface key (depends on operating system)
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getClientPropertytransparent_ret|text=|trigger=button}{sub-section}{sub-section:getClientPropertytransparent_ret|trigger=none|class=sIndent}[Object] -- The value of the property for specified key.{sub-section}{td}{trBoolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:transparent_see|text=|trigger=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=seelink}{td}*AlsoExternal seelinks*\\{sub-section:getClientPropertytransparent_seelink|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getClientPropertytransparent_seelink|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksam}{td}*External linksSample*\\{sub-section:getClientPropertytransparent_linksam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section}{div:class=sIndent}{sub-section:getClientProperty_link|trigger=none}{sub-section}{div}{: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}{tr:id=samdes}{td}*Sample*\\{sub-section:getClientPropertyvisible_samdes|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getClientPropertyvisible_samdes|trigger=none}{code:language=javascript}
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
{code}|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}{div}{td}{tr}{trbuilder-show:class=lastDetailRow}{td}{tdpermission=edit}{tr}{tbody}{tbody:id=getDataProviderID|class=node}{tr:id=namesnc}{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*Since*\\{sub-section:visible_snc|text=|trigger=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=desprs}{td}*Parameters*\\{sub-section:getDataProviderIDvisible_desprs|text=|trigger=button}{sub-section}{sub-section:getDataProviderIDvisible_desprs|trigger=none|class=sIndent}Get the data provider this UI element (display) is showing.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=sncret}{td}*SinceReturns*\\{sub-section:getDataProviderIDvisible_sncret|text=|trigger=button}{sub-section}{sub-section:getDataProviderIDvisible_sncret|trigger=none|class=sIndent} Replace with version info[Boolean]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prssee}{td}*ParametersAlso see*\\{sub-section:getDataProviderIDvisible_prssee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDataProviderIDvisible_prssee|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=retlink}{td}*ReturnsExternal links*\\{sub-section:getDataProviderIDvisible_retlink|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDataProviderIDvisible_ret|trigger=none|class=sIndent}[String] -- The data provider as String.link|trigger=none}{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=seesam}{td}*Also seeSample*\\{sub-section:getDataProviderIDvisible_seesam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDataProviderIDvisible_seesam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getDataProviderID_link|text=|trigger=buttoncode: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:class=sIndent}{sub-section:getDataProviderID_link|trigger=nonetd}{sub-sectiontr}{divtr:class=lastDetailRow}{td}{trtd}{builder-showtr}{tr:id=samtbody}{tdtable}*Sample*\\{sub-section:getDataProviderID_sam|text=|trigger=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
{table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody}{tbody:id=getElementTypegetAbsoluteFormLocationY|class=node}{tr:id=name}{td}h6.getElementTypegetAbsoluteFormLocationY{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[StringNumber]{span}{span:id=iets|style=float: left; font-weight: bold;}getElementTypegetAbsoluteFormLocationY{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getElementTypegetAbsoluteFormLocationY_des|text=|trigger=button}{sub-section}{sub-section:getElementTypegetAbsoluteFormLocationY_des|trigger=none|class=sIndent}Returns the typeabsolute ofform a(designed) specifiedY elementlocation.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getElementTypegetAbsoluteFormLocationY_snc|text=|trigger=button}{sub-section}{sub-section:getElementTypegetAbsoluteFormLocationY_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:getElementTypegetAbsoluteFormLocationY_prs|text=|trigger=button}{sub-section}{sub-section:getElementTypegetAbsoluteFormLocationY_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getElementTypegetAbsoluteFormLocationY_ret|text=|trigger=button}{sub-section}{sub-section:getElementTypegetAbsoluteFormLocationY_ret|trigger=none|class=sIndent}[StringNumber] -- The displayy typelocation of the elementform asin Stringpixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getElementTypegetAbsoluteFormLocationY_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getElementTypegetAbsoluteFormLocationY_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getElementTypegetAbsoluteFormLocationY_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getElementTypegetAbsoluteFormLocationY_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getElementTypegetAbsoluteFormLocationY_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getElementTypegetAbsoluteFormLocationY_sam|trigger=none}{code:language=javascript}
var etabsolute_y = forms.customer.elements.customer_id.getElementTypegetAbsoluteFormLocationY();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getHeightgetClientProperty|class=node}{tr:id=name}{td}h6.getHeightgetClientProperty{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[NumberObject]{span}{span:id=iets|style=float: left; font-weight: bold;}getHeightgetClientProperty{span}{span:id=iets|style=float: left;}\(key){span}{td}{tr}{tr:id=des}{td}{sub-section:getHeightgetClientProperty_des|text=|trigger=button}{sub-section}{sub-section:getHeightgetClientProperty_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);=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:getHeightgetClientProperty_snc|text=|trigger=button}{sub-section}{sub-section:getHeightgetClientProperty_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:getHeightgetClientProperty_prs|text=|trigger=button}{sub-section}{sub-section:getHeightgetClientProperty_prs|trigger=none|class=sIndent}\{[Object]} key -- user interface key (depends on operating system)
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getHeightgetClientProperty_ret|text=|trigger=button}{sub-section}{sub-section:getHeightgetClientProperty_ret|trigger=none|class=sIndent}[NumberObject] -- The heightvalue of the elementproperty for inspecified pixelskey.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getHeightgetClientProperty_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getHeightgetClientProperty_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getHeightgetClientProperty_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getHeightgetClientProperty_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getHeightgetClientProperty_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getHeightgetClientProperty_sam|trigger=none}{code:language=javascript}
var htproperty = forms.customer.elements.customer_id.getHeightgetClientProperty('ToolTipText');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{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}{tr}{tbody}{tbody:id=getLabelForElementNames|class=node}{tr:id=name}{td}h6.getLabelForElementNames{td}{trsub-section:getDataProviderID_des|text=|trigger=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=sigsnc}{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*Since*\\{sub-section:getDataProviderID_snc|text=|trigger=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=desprs}{td}*Parameters*\\{sub-section:getLabelForElementNamesgetDataProviderID_desprs|text=|trigger=button}{sub-section}{sub-section:getLabelForElementNamesgetDataProviderID_desprs|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=sncret}{td}*SinceReturns*\\{sub-section:getLabelForElementNamesgetDataProviderID_sncret|text=|trigger=button}{sub-section}{sub-section:getLabelForElementNamesgetDataProviderID_sncret|trigger=none|class=sIndent} Replace with version info[String] -- The data provider as String.{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prssee}{td}*ParametersAlso see*\\{sub-section:getLabelForElementNamesgetDataProviderID_prssee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNamesgetDataProviderID_prssee|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=retlink}{td}*ReturnsExternal links*\\{sub-section:getLabelForElementNamesgetDataProviderID_retlink|text=|trigger=button}{sub-section-section}{div:class=sIndent}{sub-section:getLabelForElementNamesgetDataProviderID_retlink|trigger=none|class=sIndent}[String]\[] -- An array with element names.{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=seesam}{td}*Also seeSample*\\{sub-section:getLabelForElementNamesgetDataProviderID_seesam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNamesgetDataProviderID_seesam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.getDataProviderID();
{code}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edittr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getElementType|class=node}{tr:id=name}{td}h6.getElementType{td}{tr}{tr:id=linksig}{td}*External links*\\{sub-section:getLabelForElementNames_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNames_link|trigger=none}{sub-section}{div{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}{tr:id=samdes}{td}*Sample*\\{sub-section:getLabelForElementNamesgetElementType_samdes|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNamesgetElementType_samdes|trigger=none}{code:language=javascript}
var array =elements.name_first.getLabelForElementNames();
for (var i =0; i<array.length;i++)
{
elements[array[i]].fgcolor = "#ff00ff";
}
{code}{|class=sIndent}Returns the type of a specified element.{sub-section}{divtd}{td}{trtr}{builder-show:permission=edit}{tr:classid=lastDetailRowsnc}{td}{td}{tr}{tbody}{tbody:id=getLocationX|class=node}{tr:id=name}{td}h6.getLocationX{td}{tr*Since*\\{sub-section:getElementType_snc|text=|trigger=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=sigprs}{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*Parameters*\\{sub-section:getElementType_prs|text=|trigger=button}{sub-section}{sub-section:getElementType_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=desret}{td}*Returns*\\{sub-section:getLocationXgetElementType_desret|text=|trigger=button}{sub-section}{sub-section:getLocationXgetElementType_desret|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);[String] -- The display type of the element as String.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=sncsee}{td}*SinceAlso see*\\{sub-section:getLocationXgetElementType_sncsee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetElementType_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:getLocationXgetElementType_prslink|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetElementType_prslink|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{tr:id=retsam}{td}*ReturnsSample*\\{sub-section:getLocationXgetElementType_retsam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetElementType_retsam|trigger=none|class=sIndent}[Number] -- The x location of the element in pixels.}{code:language=javascript}
var et = forms.customer.elements.customer_id.getElementType();
{code}{sub-section}{div}{td}{tr}{builder-showtr:permissionclass=editlastDetailRow}{tr:id=seetd}{td}*Also see*\\{sub-section:getLocationX_see|text=|trigger=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|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationX_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show{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=samdes}{td}*Sample*\\{sub-section:getLocationXgetHeight_samdes|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetHeight_samdes|trigger=none}{code:language=javascript}
var x = forms.customer.elements.customer_id.getLocationX();
{code}{sub-section}{div}{|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}{trbuilder-show:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationY|class=node}{permission=edit}{tr:id=namesnc}{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*Since*\\{sub-section:getHeight_snc|text=|trigger=button}{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=desprs}{td}*Parameters*\\{sub-section:getLocationYgetHeight_desprs|text=|trigger=button}{sub-section}{sub-section:getLocationYgetHeight_desprs|trigger=none|class=sIndent}{sub-section}{td}{tr}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);{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getHeight_ret|text=|trigger=button}{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:getLocationYgetHeight_sncsee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationYgetHeight_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:getLocationYgetHeight_prslink|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationYgetHeight_prslink|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{tr:id=retsam}{td}*ReturnsSample*\\{sub-section:getLocationYgetHeight_retsam|text=|trigger=button}{sub-section}{sub-section:getLocationY_ret|trigger=none|div: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|text=|trigger=button:getHeight_sam|trigger=none}{code:language=javascript}
var ht = forms.customer.elements.customer_id.getHeight();
{code}{sub-section}{div}{td}{tr}{tr:class=sIndentlastDetailRow}{td}{td}{tr}{tbody}{sub-section:getLocationY_see|trigger=none}{sub-section}{div}tbody:id=getLabelForElementNames|class=node}{tr:id=name}{td}h6.getLabelForElementNames{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksig}{td}*External links*\\{sub-section:getLocationY_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationY_link|trigger=none}{sub-section}{div{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}{tr:id=samdes}{td}*Sample*\\{sub-section:getLocationYgetLabelForElementNames_samdes|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationYgetLabelForElementNames_samdes|trigger=none}{code:language=javascript}
var y = forms.customer.elements.customer_id.getLocationY();
{code}{sub-section}{div|class=sIndent}Returns an Array of label element names that has this field filled in as the labelFor.{sub-section}{td}{tr}{trbuilder-show:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getName|class=node}{permission=edit}{tr:id=namesnc}{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*Since*\\{sub-section:getLabelForElementNames_snc|text=|trigger=button}{sub-section}{sub-section:getLabelForElementNames_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=desprs}{td}*Parameters*\\{sub-section:getNamegetLabelForElementNames_desprs|text=|trigger=button}{sub-section}{sub-section:getNamegetLabelForElementNames_desprs|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=sncret}{td}*SinceReturns*\\{sub-section:getNamegetLabelForElementNames_sncret|text=|trigger=button}{sub-section}{sub-section:getNamegetLabelForElementNames_sncret|trigger=none|class=sIndent} Replace[String]\[] -- An array with versionelement infonames.{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prssee}{td}*Parameters*Also see*\\{sub-section:getNamegetLabelForElementNames_prssee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getNamegetLabelForElementNames_prssee|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=retlink}{td}*ReturnsExternal links*\\{sub-section:getNamegetLabelForElementNames_retlink|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getNamegetLabelForElementNames_retlink|trigger=none|class=sIndent}[String] -- The name of the element.{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=seesam}{td}*Also seeSample*\\{sub-section:getNamegetLabelForElementNames_seesam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getNamegetLabelForElementNames_seesam|trigger=none=none}{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}{builder-show:permission=edittr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationX|class=node}{tr:id=link}name}{td}h6.getLocationX{td}*External links*\\{sub-section:getName_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getName_link|trigger=none}{sub-section}{div}{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}{tr:id=samdes}{td}*Sample*\\{sub-section:getNamegetLocationX_samdes|text=|trigger=button}{sub-section}{div:class=sIndent-section}{sub-section:getNamegetLocationX_samdes|trigger=none}{code:language=javascript}
var name = forms.customer.elements.customer_id.getName();
{code}{sub-section}{div|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}{trbuilder-show:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSelectedText|class=node}{permission=edit}{tr:id=namesnc}{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*Since*\\{sub-section:getLocationX_snc|text=|trigger=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=desprs}{td}*Parameters*\\{sub-section:getSelectedTextgetLocationX_desprs|text=|trigger=button}{sub-section}{sub-section:getSelectedTextgetLocationX_desprs|trigger=none|class=sIndent}Returns the currently selected text in the specified field.
NOTE: This function is for field elements only.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=sncret}{td}*SinceReturns*\\{sub-section:getSelectedTextgetLocationX_sncret|text=|trigger=button}{sub-section}{sub-section:getSelectedTextgetLocationX_sncret|trigger=none|class=sIndent} Replace with version info[Number] -- The x location of the element in pixels.{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prssee}{td}*ParametersAlso see*\\{sub-section:getSelectedTextgetLocationX_prssee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getSelectedTextgetLocationX_prssee|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=retlink}{td}*ReturnsExternal links*\\{sub-section:getSelectedTextgetLocationX_retlink|text=|trigger=button}{sub-sectionsection}{div:class=sIndent}{sub-section:getSelectedTextgetLocationX_retlink|trigger=none|class=sIndent}[String] -- The selected text from the component.{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=seesam}{td}*Also seeSample*\\{sub-section:getSelectedTextgetLocationX_seesam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getSelectedTextgetLocationX_seesam|trigger=none}{code:language=javascript}
var x = forms.customer.elements.customer_id.getLocationX();
{code}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edittr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationY|class=node}{tr:id=name}{td}h6.getLocationY{td}{tr}{tr:id=linksig}{td}*External links*\\{sub-section:getSelectedText_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getSelectedText_link|trigger=none}{sub-section}{div{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}{tr:id=samdes}{td}*Sample*\\{sub-section:getSelectedTextgetLocationY_samdes|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getSelectedTextgetLocationY_sam|trigger=none}{code:language=javascript}
var my_textdes|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.customercompany.elements.customer_idfaxBtn.getSelectedTextgetLocationX();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTitleText|class=node}{tr:id=name}{td}h6.getTitleText{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getTitleText{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getTitleText_des|text=|trigger=button}{sub-section}{sub-section:getTitleText_des|trigger=none|class=sIndent}Get the title text.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:getTitleTextgetLocationY_snc|text=|trigger=button}{sub-section}{sub-section:getTitleTextgetLocationY_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:getTitleTextgetLocationY_prs|text=|trigger=button}{sub-section}{sub-section:getTitleTextgetLocationY_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getTitleTextgetLocationY_ret|text=|trigger=button}{sub-section}{sub-section:getTitleTextgetLocationY_ret|trigger=none|class=sIndent}[StringNumber] -- The title texty location of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getTitleTextgetLocationY_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getTitleTextgetLocationY_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getTitleTextgetLocationY_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getTitleTextgetLocationY_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getTitleTextgetLocationY_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getTitleTextgetLocationY_sam|trigger=none}{code:language=javascript}
var titleTexty = forms.customer.elements.customer_id.getTitleTextgetLocationY();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getValueListNamegetName|class=node}{tr:id=name}{td}h6.getValueListNamegetName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getValueListNamegetName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getValueListName_des|text=|trigger=button}{sub-section}{sub-section:getValueListName_des|trigger=none|class=sIndent}Returns the current valuelist name for the specified field; returns NULL if no valuelist.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getValueListName_snc|text=|trigger=button}{sub-section}{sub-section:getValueListName_snc|trigger=none|class=sIndent} Replace with version info{sub-section|style=float: left;}\(){span}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prsdes}{td}*Parameters*\\{sub-section:getValueListNamegetName_prsdes|text=|trigger=button}{sub-section}{sub-section:getValueListNamegetName_prsdes|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=retsnc}{td}*ReturnsSince*\\{sub-section:getValueListNamegetName_retsnc|text=|trigger=button}{sub-section}{sub-section:getValueListNamegetName_retsnc|trigger=none|class=sIndent}[String] --Replace Thewith valuelistversion name.info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=seeprs}{td}*Also seeParameters*\\{sub-section:getValueListNamegetName_seeprs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getValueListNamegetName_seeprs|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkret}{td}*External linksReturns*\\{sub-section:getValueListNamegetName_linkret|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getValueListNamegetName_linkret|trigger=none|class=sIndent}[String] -- The name of the element.{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=samsee}{td}*SampleAlso see*\\{sub-section:getValueListNamegetName_samsee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getValueListNamegetName_samsee|trigger=none}{code:language=javascript}
var name = forms.customer.elements.customer_id.getValueListName();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getWidth|class=nodebuilder-show}{builder-show:permission=edit}{tr:id=namelink}{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*External links*\\{sub-section:getName_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=dessam}{td}*Sample*\\{sub-section:getWidthgetName_dessam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getWidthgetName_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 wsam|trigger=none}{code:language=javascript}
var name = forms.companycustomer.elements.faxBtncustomer_id.getWidthgetName();
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);{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|text=|trigger=button}{sub-section}{sub-section:getSelectedText_des|trigger=none|class=sIndent}Returns the currently selected text in the specified field.
NOTE: This function is for field elements only.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getWidthgetSelectedText_snc|text=|trigger=button}{sub-section}{sub-section:getWidthgetSelectedText_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:getWidthgetSelectedText_prs|text=|trigger=button}{sub-section}{sub-section:getWidthgetSelectedText_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getWidthgetSelectedText_ret|text=|trigger=button}{sub-section}{sub-section:getWidthgetSelectedText_ret|trigger=none|class=sIndent}[NumberString] -- The selected widthtext offrom the element in pixelscomponent.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getWidthgetSelectedText_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getWidthgetSelectedText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getWidthgetSelectedText_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getWidthgetSelectedText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getWidthgetSelectedText_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getWidthgetSelectedText_sam|trigger=none}{code:language=javascript}
var wmy_text = forms.customer.elements.customer_id.getWidthgetSelectedText();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=putClientPropertygetValueListName|class=node}{tr:id=name}{td}h6.putClientPropertygetValueListName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void[String]{span}{span:id=iets|style=float: left; font-weight: bold;}putClientPropertygetValueListName{span}{span:id=iets|style=float: left;}\(key, value){span}{td}{tr}{tr:id=des}{td}{sub-section:putClientPropertygetValueListName_des|text=|trigger=button}{sub-section}{sub-section:putClientPropertygetValueListName_des|trigger=none|class=sIndent}SetsReturns the valuecurrent valuelist name for the specified elementfield; clientreturns propertyNULL key.if
NOTE: Depending on the operating system, a user interface property name may be availableno valuelist.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:putClientPropertygetValueListName_snc|text=|trigger=button}{sub-section}{sub-section:putClientPropertygetValueListName_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:putClientPropertygetValueListName_prs|text=|trigger=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
=button}{sub-section}{sub-section:getValueListName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:putClientPropertygetValueListName_ret|text=|trigger=button}{sub-section}{sub-section:putClientPropertygetValueListName_ret|trigger=none|class=sIndent}void[String] -- The valuelist name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:putClientPropertygetValueListName_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:putClientPropertygetValueListName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:putClientPropertygetValueListName_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:putClientPropertygetValueListName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:putClientPropertygetValueListName_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:putClientPropertygetValueListName_sam|trigger=none}{code:language=javascript}
var name = forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text'getValueListName();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=replaceSelectedTextgetWidth|class=node}{tr:id=name}{td}h6.replaceSelectedTextgetWidth{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}replaceSelectedTextgetWidth{span}{span:id=iets|style=float: left;}\(s){span}{td}{tr}{tr:id=des}{td}{sub-section:replaceSelectedTextgetWidth_des|text=|trigger=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}{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:replaceSelectedTextgetWidth_snc|text=|trigger=button}{sub-section}{sub-section:replaceSelectedTextgetWidth_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:replaceSelectedTextgetWidth_prs|text=|trigger=button}{sub-section}{sub-section:replaceSelectedTextgetWidth_prs|trigger=none|class=sIndent}\{[String]} s -- The replacement text.
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:replaceSelectedTextgetWidth_ret|text=|trigger=button}{sub-section}{sub-section:replaceSelectedTextgetWidth_ret|trigger=none|class=sIndent}void[Number] -- The width of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:replaceSelectedTextgetWidth_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:replaceSelectedTextgetWidth_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:replaceSelectedTextgetWidth_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:replaceSelectedTextgetWidth_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:replaceSelectedTextgetWidth_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:replaceSelectedTextgetWidth_sam|trigger=none}{code:language=javascript}
//returns the current selected text
var my_textw = forms.customer.elements.customer_id.getSelectedTextgetWidth();
//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=requestFocusputClientProperty|class=node}{tr:id=name}{td}h6.requestFocusputClientProperty{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}requestFocusputClientProperty{span}{span:id=iets|style=float: left;}\(\[mustExecuteOnFocusGainedMethod\]\(key, value){span}{td}{tr}{tr:id=des}{td}{sub-section:requestFocusputClientProperty_des|text=|trigger=button}{sub-section}{sub-section:requestFocusputClientProperty_des|trigger=none|class=sIndent}RequestsSets the focusvalue for an element; can skip the onFocusGained event for an specified element byclient using requestFocus(false).
When focus is requested on a text field, a text cursor will be displayed in the specified fieldproperty key.
NOTE: ThisDepending function is for field elements only; for more information about the optional parameter, see the onFocusGained design time property in the section on Fieldson 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:requestFocusputClientProperty_snc|text=|trigger=button}{sub-section}{sub-section:requestFocusputClientProperty_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:requestFocusputClientProperty_prs|text=|trigger=button}{sub-section}{sub-section:requestFocusputClientProperty_prs|trigger=none|class=sIndent}\{[mustExecuteOnFocusGainedMethod\Object]} key -- trueuser \-interface to execute the onFocusGained method; false \- to prevent the onFocusGained method from executing, default is true (if not specified).key (depends on operating system)
\{[Object]} value -- a predefined value for the key
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:requestFocusputClientProperty_ret|text=|trigger=button}{sub-section}{sub-section:requestFocusputClientProperty_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:requestFocusputClientProperty_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:requestFocusputClientProperty_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:requestFocusputClientProperty_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:requestFocusputClientProperty_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:requestFocusputClientProperty_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:requestFocusputClientProperty_sam|trigger=none}{code:language=javascript}
//requests the focus for the element
//prevents
the onFocusGained method from executing
forms.customer.elements.customer_id.requestFocus(falseputClientProperty('ToolTipText','some text');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=selectAllreplaceSelectedText|class=node}{tr:id=name}{td}h6.selectAllreplaceSelectedText{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}selectAllreplaceSelectedText{span}{span:id=iets|style=float: left;}\(s){span}{td}{tr}{tr:id=des}{td}{sub-section:selectAllreplaceSelectedText_des|text=|trigger=button}{sub-section}{sub-section:selectAll_des|trigger=none|class=sIndent}Selects all the contents of a fieldreplaceSelectedText_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:selectAllreplaceSelectedText_snc|text=|trigger=button}{sub-section}{sub-section:selectAllreplaceSelectedText_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:selectAllreplaceSelectedText_prs|text=|trigger=button}{sub-section}{sub-section:selectAllreplaceSelectedText_prs|trigger=none|class=sIndent}\{[String]} s -- The replacement text.
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:selectAllreplaceSelectedText_ret|text=|trigger=button}{sub-section}{sub-section:selectAllreplaceSelectedText_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:selectAllreplaceSelectedText_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:selectAllreplaceSelectedText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:selectAllreplaceSelectedText_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:selectAllreplaceSelectedText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:selectAllreplaceSelectedText_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:selectAllreplaceSelectedText_sam|trigger=none}{code:language=javascript}
//returns the current selected text
var my_text = forms.customer.elements.customer_id.selectAll(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=setBorderrequestFocus|class=node}{tr:id=name}{td}h6.setBorderrequestFocus{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setBorderrequestFocus{span}{span:id=iets|style=float: left;}\(spec\[mustExecuteOnFocusGainedMethod\]){span}{td}{tr}{tr:id=des}{td}{sub-section:setBorderrequestFocus_des|text=|trigger=button}{sub-section}{sub-section:setBorderrequestFocus_des|trigger=none|class=sIndent}SetsRequests the border attribute(s) of a specified element.
The border attributes:
borderType \- EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder.
size \- (numeric value) for: bottom, left, right, top.
color \- (hexadecimal value) for: bottom, left, right, top.
dash pattern \- (numeric value) for selected side(s).
rounding radius \- (numeric value) for selected side(s).
NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType"focus for an element; can skip the onFocusGained event for an element by using requestFocus(false).
When focus is requested on a text field, a text cursor will be displayed in the specified field.
NOTE: This function is for field elements only; for more information about the optional parameter, see the onFocusGained design time property in the section on Fields.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setBorderrequestFocus_snc|text=|trigger=button}{sub-section}{sub-section:setBorderrequestFocus_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setBorderrequestFocus_prs|text=|trigger=button}{sub-section}{sub-section:setBorderrequestFocus_prs|trigger=none|class=sIndent}\{[String]} spec -- the border attributesmustExecuteOnFocusGainedMethod\] -- true \- to execute the onFocusGained method; false \- to prevent the onFocusGained method from executing, default is true (if not specified).
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setBorderrequestFocus_ret|text=|trigger=button}{sub-section}{sub-section:setBorderrequestFocus_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setBorderrequestFocus_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setBorderrequestFocus_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setBorderrequestFocus_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setBorderrequestFocus_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setBorderrequestFocus_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setBorderrequestFocus_sam|trigger=none}{code:language=javascript}
//setsrequests the border type to "LineBorder"
//sets a 1 px line width focus for the bottom and left side of the border
element
//setsprevents the hexadecimal color of the border to "#ccffcc"
var b =onFocusGained method from executing
forms.customer.elements.customer_id.setBorder('LineBorder,1,#ccffcc'requestFocus(false);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setFontselectAll|class=node}{tr:id=name}{td}h6.setFontselectAll{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setFontselectAll{span}{span:id=iets|style=float: left;}\(spec){span}{td}{tr}{tr:id=des}{td}{sub-section:setFont_des|text=|trigger=button}{sub-section}{sub-section:setFont_des|trigger=none|class=sIndent}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):id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:selectAll_des|text=|trigger=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:setFontselectAll_snc|text=|trigger=button}{sub-section}{sub-section:setFontselectAll_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:setFontselectAll_prs|text=|trigger=button}{sub-section}{sub-section:setFontselectAll_prs|trigger=none|class=sIndent}\{[String]} spec -- the font name, style, size
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:setFontselectAll_ret|text=|trigger=button}{sub-section}{sub-section:setFontselectAll_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setFontselectAll_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setFontselectAll_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setFontselectAll_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setFontselectAll_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setFontselectAll_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setFontselectAll_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setFont('Tahoma,1,11'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|text=|trigger=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 screen.
NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setLocation_snc|text=|trigger=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|text=|trigger=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|text=|trigger=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|text=|trigger=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|text=|trigger=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|text=|trigger=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=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|text=|trigger=button}{sub-section}{sub-section:setSize_des|trigger=none|class=sIndent}Sets the size of the field. It takes as input the width and the height.
NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:
//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setSize_snc|text=|trigger=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|text=|trigger=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|text=|trigger=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|text=|trigger=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|text=|trigger=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|text=|trigger=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}{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|text=|trigger=button}{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).
Should receive a dataset parameter, first column is for display values, second column (optional) is for real values.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setValueListItems_snc|text=|trigger=button}{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|text=|trigger=button}{sub-section}{sub-section:setValueListItems_prs|trigger=none|class=sIndent}dataset -- first column is display value, second column is real value
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setValueListItems_ret|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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|text=|trigger=button}{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