Table Head (thead) |
---|
Table Row (tr) |
---|
| Table Head (th) |
---|
| Method Details |
|
|
Table Body (tbody) |
---|
id | getAbsoluteFormLocationY |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getAbsoluteFormLocationY |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getAbsoluteFormLocationY |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the absolute form (designed) Y location. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Number - The y location of the form in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY(); |
|
|
|
|
Table Body (tbody) |
---|
id | getClientProperty-Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getClientProperty |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Gets the specified client property for the element based on a key. NOTE: Depending on the operating system, a user interface property name may be available. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Object} key - user interface key (depends on operating system) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Object - The value of the property for specified key. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText'); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getDataProviderID |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Get the data provider this UI element (display) is showing. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| String - The data provider as String. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| forms.customer.elements.customer_id. |
|
|
|
| fgcolor = "#000000";
//gets the foreground color of the field
var c = forms.customer.elements.customer_id.fgcolor;
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB}{tr:id=name}{td}h6.readOnly{td}{tr}{tr:id=des}{td}{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_des|text=|trigger=button}{sub-section}{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_des|trigger=none|class=sIndent}Gets or sets the editable/read-only state of a field; true - read-only; false - editable; ! - the editable/read-only state is inverted (the opposite).
NOTE: A field set as read-only can be selected by clicking (or pressing the TAB key if this option is supported by the operating system) and the field data can be copied.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_ret|text=|trigger=button}{sub-section}{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_see|text=|trigger=button}{sub-section}{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_see|text=|trigger=button}{sub-section}{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_sam|text=|trigger=button}{sub-section}{sub-section:BEA4FE09-A461-4EFD-A64F-F7C6DD8A4CAB_sam|class=sIndent|trigger=none}{code:language=javascript}
//gets the editable/read-only state of the field
var currentState = forms.customer.elements.customer_id.readOnly;
//sets the editable/read-only state of the field
forms.customer.elements.customer_id.readOnly = !currentState;
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=33333B35-1182-498A-84D8-C17EDEFF536B}{tr:id=name}{td}h6.toolTipText{td}{tr}{tr:id=des}{td}{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_des|text=|trigger=button}{sub-section}{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_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=prs}{td}*Parameters*\\{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_ret|text=|trigger=button}{sub-section}{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_see|text=|trigger=button}{sub-section}{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_see|text=|trigger=button}{sub-section}{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_sam|text=|trigger=button}{sub-section}{sub-section:33333B35-1182-498A-84D8-C17EDEFF536B_sam|class=sIndent|trigger=none}{code:language=javascript}
//gets the tooltip text of the element
var toolTip = forms.customer.elements.customer_id.toolTipText;
//sets the tooltip text of the element
forms.customer.elements.customer_id.toolTipText = "New tip";
forms.customer.elements.customer_id.toolTipText = "<html>This includes <b>bolded text</b> and <font color='blue'>BLUE</font> text as well.";
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=551B2199-B245-409F-B6F7-CAEBE8B20DF3}{tr:id=name}{td}h6.transparent{td}{tr}{tr:id=des}{td}{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_des|text=|trigger=button}{sub-section}{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_des|trigger=none|class=sIndent}Gets or sets the transparency of an element; true - transparent; false - not transparent.
NOTE: transparency can be inverted using ! operator: elements.elementName.transparent = !elements.elementName.transparent;
NOTE: transparency will be mostly used for background color, a transparent element will receive the background of the element "beneath" it, a non transparent one will use its own background color{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_ret|text=|trigger=button}{sub-section}{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_see|text=|trigger=button}{sub-section}{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_see|text=|trigger=button}{sub-section}{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_sam|text=|trigger=button}{sub-section}{sub-section:551B2199-B245-409F-B6F7-CAEBE8B20DF3_sam|class=sIndent|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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=B96F884D-B400-4956-9F9D-A58C666ABD89}{tr:id=name}{td}h6.visible{td}{tr}{tr:id=des}{td}{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_des|text=|trigger=button}{sub-section}{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_des|trigger=none|class=sIndent}Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).
NOTE: The visibility of an element is not persistent; the state of visibility only applies to the current user in his/her current session.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_ret|text=|trigger=button}{sub-section}{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_see|text=|trigger=button}{sub-section}{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_see|text=|trigger=button}{sub-section}{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_sam|text=|trigger=button}{sub-section}{sub-section:B96F884D-B400-4956-9F9D-A58C666ABD89_sam|class=sIndent|trigger=none}{code:language=javascript}
//sets the element as visible
forms.company.elements.faxBtn.visible = true;
//gets the visibility of the element
var currentState = forms.company.elements.faxBtn.visible;
//sets the element as not visible when the current state is visible
forms.company.elements.faxBtn.visible = !currentState;
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=E00EE702-697A-480B-9216-3BC5745401A8}{tr:id=name}{td}h6.getAbsoluteFormLocationY{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getAbsoluteFormLocationY{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_des|text=|trigger=button}{sub-section}{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_des|trigger=none|class=sIndent}Returns the absolute form (designed) Y location.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_ret|text=|trigger=button}{sub-section}{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_ret|trigger=none|class=sIndent}[Number] -- The y location of the form in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_see|text=|trigger=button}{sub-section}{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_see|text=|trigger=button}{sub-section}{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_sam|text=|trigger=button}{sub-section}{sub-section:E00EE702-697A-480B-9216-3BC5745401A8_sam|class=sIndent|trigger=none}{code:language=javascript}
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875}{tr:id=name}{td}h6.getClientProperty{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}Object{span}{span:id=iets|style=float: left; font-weight: bold;}getClientProperty{span}{span:id=iets|style=float: left;}\(key){span}{td}{tr}{tr:id=des}{td}{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_des|text=|trigger=button}{sub-section}{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_des|trigger=none|class=sIndent}Gets the specified client property for the element based on a key.
NOTE: Depending on the operating system, a user interface property name may be available.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_prs|trigger=none}key -- user interface key (depends on operating system)
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_ret|text=|trigger=button}{sub-section}{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_ret|trigger=none|class=sIndent}Object -- The value of the property for specified key.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_see|text=|trigger=button}{sub-section}{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_see|text=|trigger=button}{sub-section}{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_sam|text=|trigger=button}{sub-section}{sub-section:F62FAEEB-6A1B-47D8-9CC5-E4A5C78B6875_sam|class=sIndent|trigger=none}{code:language=javascript}
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=6B5C595E-64E5-4D87-B01B-9909565E0FF6}{tr:id=name}{td}h6.getDataProviderID{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getDataProviderID{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_des|text=|trigger=button}{sub-section}{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_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=prs}{td}*Parameters*\\{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_ret|text=|trigger=button}{sub-section}{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_ret|trigger=none|class=sIndent}[String] -- The data provider as String.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_see|text=|trigger=button}{sub-section}{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_see|text=|trigger=button}{sub-section}{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_sam|text=|trigger=button}{sub-section}{sub-section:6B5C595E-64E5-4D87-B01B-9909565E0FF6_sam|class=sIndent|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.getDataProviderID();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=968C3F01-E231-4E47-99D6-BABDD6F48696}{tr:id=name}{td}h6.getElementType{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getElementType{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_des|text=|trigger=button}{sub-section}{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_des|trigger=none|class=sIndent}Returns the type of a specified element.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_ret|text=|trigger=button}{sub-section}{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_ret|trigger=none|class=sIndent}[String] -- The display type of the element as String.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_see|text=|trigger=button}{sub-section}{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_see|text=|trigger=button}{sub-section}{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_sam|text=|trigger=button}{sub-section}{sub-section:968C3F01-E231-4E47-99D6-BABDD6F48696_sam|class=sIndent|trigger=none}{code:language=javascript}
var et = forms.customer.elements.customer_id.getElementType();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=E4A237AB-45CB-43FD-A80D-3B24AD8940CE}{tr:id=name}{td}h6.getHeight{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getHeight{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_des|text=|trigger=button}{sub-section}{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_des|trigger=none|class=sIndent}Returns the height of the current element.
NOTE: getHeight() can be used with getWidth() to set the size of an element using the setSize function. For example:
//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_ret|text=|trigger=button}{sub-section}{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_ret|trigger=none|class=sIndent}[Number] -- The height of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_see|text=|trigger=button}{sub-section}{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_see|text=|trigger=button}{sub-section}{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_sam|text=|trigger=button}{sub-section}{sub-section:E4A237AB-45CB-43FD-A80D-3B24AD8940CE_sam|class=sIndent|trigger=none}{code:language=javascript}
var ht = forms.customer.elements.customer_id.getHeight();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=BF22D4F2-956D-4442-BBBA-88DB3EFD2173}{tr:id=name}{td}h6.getLabelForElementNames{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getLabelForElementNames{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_des|text=|trigger=button}{sub-section}{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_des|trigger=none|class=sIndent}Returns an Array of label element names that has this field filled in as the labelFor.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_ret|text=|trigger=button}{sub-section}{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_ret|trigger=none|class=sIndent}[String]\[] -- An array with element names.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_see|text=|trigger=button}{sub-section}{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_see|text=|trigger=button}{sub-section}{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_sam|text=|trigger=button}{sub-section}{sub-section:BF22D4F2-956D-4442-BBBA-88DB3EFD2173_sam|class=sIndent|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}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=753CC809-5554-4E41-9D58-30990967164B}{tr:id=name}{td}h6.getLocationX{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getLocationX{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:753CC809-5554-4E41-9D58-30990967164B_des|text=|trigger=button}{sub-section}{sub-section:753CC809-5554-4E41-9D58-30990967164B_des|trigger=none|class=sIndent}Returns the x location of the current element.
NOTE: getLocationX() can be used with getLocationY() to set the location of an element using the setLocation function. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:753CC809-5554-4E41-9D58-30990967164B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:753CC809-5554-4E41-9D58-30990967164B_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:753CC809-5554-4E41-9D58-30990967164B_ret|text=|trigger=button}{sub-section}{sub-section:753CC809-5554-4E41-9D58-30990967164B_ret|trigger=none|class=sIndent}[Number] -- The x location of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:753CC809-5554-4E41-9D58-30990967164B_see|text=|trigger=button}{sub-section}{sub-section:753CC809-5554-4E41-9D58-30990967164B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:753CC809-5554-4E41-9D58-30990967164B_see|text=|trigger=button}{sub-section}{sub-section:753CC809-5554-4E41-9D58-30990967164B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:753CC809-5554-4E41-9D58-30990967164B_sam|text=|trigger=button}{sub-section}{sub-section:753CC809-5554-4E41-9D58-30990967164B_sam|class=sIndent|trigger=none}{code:language=javascript}
var x = forms.customer.elements.customer_id.getLocationX();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=288CCEF7-3F0D-4B5C-B757-6E1186D68A58}{tr:id=name}{td}h6.getLocationY{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getLocationY{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_des|text=|trigger=button}{sub-section}{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_des|trigger=none|class=sIndent}Returns the y location of the current element.
NOTE: getLocationY() can be used with getLocationX() to set the location of an element using the setLocation function. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_ret|text=|trigger=button}{sub-section}{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_ret|trigger=none|class=sIndent}[Number] -- The y location of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_see|text=|trigger=button}{sub-section}{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_see|text=|trigger=button}{sub-section}{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_sam|text=|trigger=button}{sub-section}{sub-section:288CCEF7-3F0D-4B5C-B757-6E1186D68A58_sam|class=sIndent|trigger=none}{code:language=javascript}
var y = forms.customer.elements.customer_id.getLocationY();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0}{tr:id=name}{td}h6.getName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_des|text=|trigger=button}{sub-section}{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_des|trigger=none|class=sIndent}Returns the name of an element. (may be null as well){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_ret|text=|trigger=button}{sub-section}{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_ret|trigger=none|class=sIndent}[String] -- The name of the element.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_see|text=|trigger=button}{sub-section}{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_see|text=|trigger=button}{sub-section}{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_sam|text=|trigger=button}{sub-section}{sub-section:94673D95-DAB8-4D5C-9CB9-2572C2F4F2A0_sam|class=sIndent|trigger=none}{code:language=javascript}
var name = forms.customer.elements.customer_id.getName();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=233789C7-21DA-4E58-A03B-5474D2C6F8FF}{tr:id=name}{td}h6.getScrollX{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getScrollX{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_des|text=|trigger=button}{sub-section}{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_des|trigger=none|class=sIndent}Returns the x scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).
NOTE: getScrollX() can be used with getScrollY() to set the scroll location of a portal using the setScroll function. For Example:
//returns the X and Y scroll coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new scroll location
forms.company.elements.portal50.setScroll(x+10,y+10);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_ret|text=|trigger=button}{sub-section}{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_ret|trigger=none|class=sIndent}[Number] -- The x scroll location in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_see|text=|trigger=button}{sub-section}{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_see|text=|trigger=button}{sub-section}{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_sam|text=|trigger=button}{sub-section}{sub-section:233789C7-21DA-4E58-A03B-5474D2C6F8FF_sam|class=sIndent|trigger=none}{code:language=javascript}
var x = forms.customer.elements.customer_id.getScrollX();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=06F657F1-B322-4280-846A-5DE7E4A2DF0A}{tr:id=name}{td}h6.getScrollY{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getScrollY{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_des|text=|trigger=button}{sub-section}{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_des|trigger=none|class=sIndent}Returns the y scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).
NOTE: getScrollY() can be used with getScrollX() to set the scroll location of a portal using the setScroll function. For Example:
//returns the X and Y scroll coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new scroll location
forms.company.elements.portal50.setScroll(x+10,y+10);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_ret|text=|trigger=button}{sub-section}{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_ret|trigger=none|class=sIndent}[Number] -- The y scroll location in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_see|text=|trigger=button}{sub-section}{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_see|text=|trigger=button}{sub-section}{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_sam|text=|trigger=button}{sub-section}{sub-section:06F657F1-B322-4280-846A-5DE7E4A2DF0A_sam|class=sIndent|trigger=none}{code:language=javascript}
var y = forms.customer.elements.customer_id.getScrollY();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=60684867-4E22-46C1-9D15-B3946373FF1D}{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:60684867-4E22-46C1-9D15-B3946373FF1D_des|text=|trigger=button}{sub-section}{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_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=prs}{td}*Parameters*\\{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_ret|text=|trigger=button}{sub-section}{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_ret|trigger=none|class=sIndent}[String] -- The selected text from the component.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_see|text=|trigger=button}{sub-section}{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_see|text=|trigger=button}{sub-section}{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_sam|text=|trigger=button}{sub-section}{sub-section:60684867-4E22-46C1-9D15-B3946373FF1D_sam|class=sIndent|trigger=none}{code:language=javascript}
var my_text = forms.customer.elements.customer_id.getSelectedText();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=B38E82D6-1B68-4043-BBED-9D916F439B7D}{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:B38E82D6-1B68-4043-BBED-9D916F439B7D_des|text=|trigger=button}{sub-section}{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_des|trigger=none|class=sIndent}Get the title text.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_ret|text=|trigger=button}{sub-section}{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_ret|trigger=none|class=sIndent}[String] -- The title text.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_see|text=|trigger=button}{sub-section}{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_see|text=|trigger=button}{sub-section}{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_sam|text=|trigger=button}{sub-section}{sub-section:B38E82D6-1B68-4043-BBED-9D916F439B7D_sam|class=sIndent|trigger=none}{code:language=javascript}
var titleText = forms.customer.elements.customer_id.getTitleText();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=CF1753A9-4F11-4253-B338-7A395E436734}{tr:id=name}{td}h6.getWidth{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getWidth{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_des|text=|trigger=button}{sub-section}{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_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=prs}{td}*Parameters*\\{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_ret|text=|trigger=button}{sub-section}{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_ret|trigger=none|class=sIndent}[Number] -- The width of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_see|text=|trigger=button}{sub-section}{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_see|text=|trigger=button}{sub-section}{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_sam|text=|trigger=button}{sub-section}{sub-section:CF1753A9-4F11-4253-B338-7A395E436734_sam|class=sIndent|trigger=none}{code:language=javascript}
var w = forms.customer.elements.customer_id.getWidth();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=2BA40333-8EB1-4B8E-BF48-826E32EB5FE6}{tr:id=name}{td}h6.putClientProperty{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}putClientProperty{span}{span:id=iets|style=float: left;}\(key, value){span}{td}{tr}{tr:id=des}{td}{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_des|text=|trigger=button}{sub-section}{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_des|trigger=none|class=sIndent}Sets the value for the specified element client property key.
NOTE: Depending on the operating system, a user interface property name may be available.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_prs|trigger=none}key -- user interface key (depends on operating system)
value -- a predefined value for the key
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_ret|text=|trigger=button}{sub-section}{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_see|text=|trigger=button}{sub-section}{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_see|text=|trigger=button}{sub-section}{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_sam|text=|trigger=button}{sub-section}{sub-section:2BA40333-8EB1-4B8E-BF48-826E32EB5FE6_sam|class=sIndent|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=83803E55-98A5-4DA5-8243-D3F8E0DDBFA9}{tr:id=name}{td}h6.replaceSelectedText{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}replaceSelectedText{span}{span:id=iets|style=float: left;}\(s){span}{td}{tr}{tr:id=des}{td}{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_des|text=|trigger=button}{sub-section}{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_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}{tr:id=prs}{td}*Parameters*\\{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_prs|trigger=none}s -- The replacement text.
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_ret|text=|trigger=button}{sub-section}{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_see|text=|trigger=button}{sub-section}{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_see|text=|trigger=button}{sub-section}{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_sam|text=|trigger=button}{sub-section}{sub-section:83803E55-98A5-4DA5-8243-D3F8E0DDBFA9_sam|class=sIndent|trigger=none}{code:language=javascript}
//returns the current selected text
var my_text = forms.customer.elements.customer_id.getSelectedText();
//replaces the current selected text
forms.customer.elements.customer_id.replaceSelectedText('John');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=018C4BE2-FBC7-485B-9C41-74FBFAC8FF50}{tr:id=name}{td}h6.requestFocus{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}requestFocus{span}{span:id=iets|style=float: left;}\(mustExecuteOnFocusGainedMethod){span}{td}{tr}{tr:id=des}{td}{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_des|text=|trigger=button}{sub-section}{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_des|trigger=none|class=sIndent}Requests the focus for an element; can skip the onFocusGained event for an element by using requestFocus(false).
When focus is requested on a text field, a text cursor will be displayed in the specified field.
NOTE: This function is for field elements only; for more information about the optional parameter, see the onFocusGained design time property in the section on Fields.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_prs|trigger=none}\[mustExecuteOnFocusGainedMethod\] -- true - to execute the onFocusGained method; false - to prevent the onFocusGained method from executing, default is true (if not specified).
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_ret|text=|trigger=button}{sub-section}{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_see|text=|trigger=button}{sub-section}{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_see|text=|trigger=button}{sub-section}{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_sam|text=|trigger=button}{sub-section}{sub-section:018C4BE2-FBC7-485B-9C41-74FBFAC8FF50_sam|class=sIndent|trigger=none}{code:language=javascript}
//requests the focus for the element
//prevents the onFocusGained method from executing
forms.customer.elements.customer_id.requestFocus(false);
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=B3B8138F-151D-40F9-ADAA-2CC08A4C9683}{tr:id=name}{td}h6.selectAll{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}selectAll{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_des|text=|trigger=button}{sub-section}{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_des|trigger=none|class=sIndent}Selects all the contents of a field.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_ret|text=|trigger=button}{sub-section}{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_see|text=|trigger=button}{sub-section}{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_see|text=|trigger=button}{sub-section}{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_sam|text=|trigger=button}{sub-section}{sub-section:B3B8138F-151D-40F9-ADAA-2CC08A4C9683_sam|class=sIndent|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.selectAll();
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=E0C71451-1A24-4630-AEA2-EF4DAB97BB22}{tr:id=name}{td}h6.setBorder{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setBorder{span}{span:id=iets|style=float: left;}\(spec){span}{td}{tr}{tr:id=des}{td}{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_des|text=|trigger=button}{sub-section}{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_des|trigger=none|class=sIndent}Sets the border attribute(s) of a specified element.
The border attributes:
borderType - Empty, Etched, Bevel, Line, Title, Matte, SpecialMatte.
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}{tr:id=prs}{td}*Parameters*\\{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_prs|trigger=none}spec -- the border attributes
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_ret|text=|trigger=button}{sub-section}{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_see|text=|trigger=button}{sub-section}{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_see|text=|trigger=button}{sub-section}{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_sam|text=|trigger=button}{sub-section}{sub-section:E0C71451-1A24-4630-AEA2-EF4DAB97BB22_sam|class=sIndent|trigger=none}{code:language=javascript}
//sets the border type to "Line"
//sets a 1 px line width for the bottom and left side of the border
//sets the hexadecimal color of the border to "#ccffcc"
var b = forms.customer.elements.customer_id.setBorder('Line,1,1,#ccffcc');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=827DB615-45EE-46E1-B484-A94309F113D0}{tr:id=name}{td}h6.setFont{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setFont{span}{span:id=iets|style=float: left;}\(spec){span}{td}{tr}{tr:id=des}{td}{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_des|text=|trigger=button}{sub-section}{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_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).{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_prs|trigger=none}spec -- the font name, style, size
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_ret|text=|trigger=button}{sub-section}{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_see|text=|trigger=button}{sub-section}{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_see|text=|trigger=button}{sub-section}{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_sam|text=|trigger=button}{sub-section}{sub-section:827DB615-45EE-46E1-B484-A94309F113D0_sam|class=sIndent|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setFont('Tahoma,1,11');
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=BCE763E7-1B17-417B-A12B-93F6DC1CEF50}{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:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_des|text=|trigger=button}{sub-section}{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_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}{tr:id=prs}{td}*Parameters*\\{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_prs|trigger=none}x -- the X coordinate of the element in pixels.
y -- the Y coordinate of the element in pixels.
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_ret|text=|trigger=button}{sub-section}{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_see|text=|trigger=button}{sub-section}{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_see|text=|trigger=button}{sub-section}{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_sam|text=|trigger=button}{sub-section}{sub-section:BCE763E7-1B17-417B-A12B-93F6DC1CEF50_sam|class=sIndent|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setLocation(200,200);
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=241C4136-4D27-48FD-A394-A631A04A0349}{tr:id=name}{td}h6.setScroll{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setScroll{span}{span:id=iets|style=float: left;}\(x, y){span}{td}{tr}{tr:id=des}{td}{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_des|text=|trigger=button}{sub-section}{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_des|trigger=none|class=sIndent}Sets the scroll location of a portal. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for a portal where the height of the portal is greater than the height of the portal filed(s).
NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of a portal; then use the X and Y coordinates with the setScroll function to set a new scroll location. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new location
forms.company.elements.portal50.setScroll(x+10,y+10);{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_prs|trigger=none}x -- the X coordinate of the portal scroll location in pixels
y -- the Y coordinate of the portal scroll location in pixels
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_ret|text=|trigger=button}{sub-section}{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_see|text=|trigger=button}{sub-section}{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_see|text=|trigger=button}{sub-section}{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_sam|text=|trigger=button}{sub-section}{sub-section:241C4136-4D27-48FD-A394-A631A04A0349_sam|class=sIndent|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setScroll(200,200);
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=733A0F28-0007-4AC6-9FC8-C2B595D093FC}{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:733A0F28-0007-4AC6-9FC8-C2B595D093FC_des|text=|trigger=button}{sub-section}{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_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}{tr:id=prs}{td}*Parameters*\\{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_prs|trigger=none}width -- the width of the element in pixels.
height -- the height of the element in pixels.
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_ret|text=|trigger=button}{sub-section}{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_see|text=|trigger=button}{sub-section}{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_see|text=|trigger=button}{sub-section}{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_sam|text=|trigger=button}{sub-section}{sub-section:733A0F28-0007-4AC6-9FC8-C2B595D093FC_sam|class=sIndent|trigger=none}{code:language=javascript}
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getDesignTimeProperty |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getDesignTimeProperty |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Get a design-time property of an element. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop') |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getElementType |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the type of a specified element. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| String - The display type of the element as String. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var et = forms.customer.elements.customer_id.getElementType(); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the height of the current element. NOTE: getHeight() can be used with getWidth() to set the size of an element using the setSize function. For example: //returns the width (w) and height (h) var w = forms.company.elements.faxBtn.getWidth(); var h = forms.company.elements.faxBtn.getHeight(); //sets the new size forms.company.elements.faxBtn.setSize(w,h); //sets the new size and adds 1 px to both the width and height forms.company.elements.faxBtn.setSize(w+1,h+1); |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Number - The height of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var ht = forms.customer.elements.customer_id.getHeight(); |
|
|
|
|
Table Body (tbody) |
---|
id | getLabelForElementNames |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getLabelForElementNames |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getLabelForElementNames |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an Array of label element names that has this field filled in as the labelFor. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| String[] - An array with element names. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var array = elements.name_first.getLabelForElementNames();
for (var i = 0; i<array.length; i++)
{
elements[array[i]].fgcolor = "#ff00ff";
} |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getLocationX |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the x location of the current element. NOTE: getLocationX() can be used with getLocationY() to set the location of an element using the setLocation function. For Example: //returns the X and Y coordinates var x = forms.company.elements.faxBtn.getLocationX(); var y = forms.company.elements.faxBtn.getLocationY(); //sets the new location 10 px to the right; 10 px down from the current location forms.company.elements.faxBtn.setLocation(x+10,y+10); |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Number - The x location of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var x = forms.customer.elements.customer_id.getLocationX(); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getLocationY |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the y location of the current element. NOTE: getLocationY() can be used with getLocationX() to set the location of an element using the setLocation function. For Example: //returns the X and Y coordinates var x = forms.company.elements.faxBtn.getLocationX(); var y = forms.company.elements.faxBtn.getLocationY(); //sets the new location 10 px to the right; 10 px down from the current location forms.company.elements.faxBtn.setLocation(x+10,y+10); |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Number - The y location of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var y = forms.customer.elements.customer_id.getLocationY(); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the name of an element. (may be null as well) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| String - The name of the element. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var name = forms.customer.elements.customer_id.getName(); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getScrollX |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content. NOTE: getScrollX() can be used with getScrollY() to set the scroll location of an element using the setScroll function. For Example: //returns the X and Y scroll coordinates var x = forms.company.elements.portal50.getScrollX(); var y = forms.company.elements.portal50.getScrollY(); //sets the new scroll location forms.company.elements.portal50.setScroll(x+10,y+10); |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Number - The x scroll location in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var x = forms.customer.elements.customer_id.getScrollX(); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getScrollY |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content. NOTE: getScrollY() can be used with getScrollX() to set the scroll location of an element using the setScroll function. For Example: //returns the X and Y scroll coordinates var x = forms.company.elements.portal50.getScrollX(); var y = forms.company.elements.portal50.getScrollY(); //sets the new scroll location forms.company.elements.portal50.setScroll(x+10,y+10); |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Number - The y scroll location in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var y = forms.customer.elements.customer_id.getScrollY(); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getSelectedText |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the currently selected text in the specified text field or text area. NOTE: This does not work for text fields in the Web Client. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| String - The selected text from the component. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var my_text = forms.customer.elements.customer_id.getSelectedText(); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the width of the current element. NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example: //returns the width (w) and height (h) var w = forms.company.elements.faxBtn.getWidth(); var h = forms.company.elements.faxBtn.getHeight(); //sets the new size forms.company.elements.faxBtn.setSize(w,h); //sets the new size and adds 1 px to both the width and height forms.company.elements.faxBtn.setSize(w+1,h+1); |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Number - The width of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var w = forms.customer.elements.customer_id.getWidth(); |
|
|
|
|
Table Body (tbody) |
---|
id | putClientProperty-Object_Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
putClientProperty |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Sets the value for the specified element client property key. NOTE: Depending on the operating system, a user interface property name may be available. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Object} key - user interface key (depends on operating system) {Object} value - a predefined value for the key |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text'); |
|
|
|
|
Table Body (tbody) |
---|
id | replaceSelectedText-String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
replaceSelectedText |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position. NOTE: replaceSelectedText applies to text fields and all XXX_AREA displayType text - RTF_AREA, HTML_AREA, or TEXT_AREA. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} s - The replacement text. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| //returns the current selected text
var my_text = forms.customer.elements.customer_id.getSelectedText();
//replaces the current selected text
forms.customer.elements.customer_id.replaceSelectedText('John'); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
requestFocus |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Request the focus in this element. (Focus is also a text cursor on text components). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| //request the focus in this forms.customer.elements.customer_id (focus is also a text cursor on text components)
forms.customer.elements.customer_id.requestFocus(); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
requestFocus |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(mustExecuteOnFocusGainedMethod) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Request the focus in this element. (Focus is also a text cursor on text components). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Boolean} mustExecuteOnFocusGainedMethod - If true will execute onFocusGained method, else will not; default value is true. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| //request the focus in this forms.customer.elements.customer_id (focus is also a text cursor on text components), skip on focus gained method call
forms.customer.elements.customer_id.requestFocus(false); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Selects all the contents of a field. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| forms.customer.elements.customer_id.selectAll(); |
|
|
|
|
Table Body (tbody) |
---|
id | setLocation-Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setLocation |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| 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. Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation. NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example: //returns the X and Y coordinates var x = forms.company.elements.faxBtn.getLocationX(); var y = forms.company.elements.faxBtn.getLocationY(); //sets the new location 10 px to the right; 10 px down from the current location forms.company.elements.faxBtn.setLocation(x+10,y+10); |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} x - the X coordinate of the element in pixels. {Number} y - the Y coordinate of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| forms.customer.elements.customer_id.setLocation(200,200); |
|
|
|
|
Table Body (tbody) |
---|
id | setScroll-Number_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Sets the scroll location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for an element where the height of the element is greater than the height of element content NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of an element; then use the X and Y coordinates with the setScroll function to set a new scroll location. For Example: //returns the X and Y coordinates var x = forms.company.elements.portal50.getScrollX(); var y = forms.company.elements.portal50.getScrollY(); //sets the new location forms.company.elements.portal50.setScroll(x+10,y+10); |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} x - the X coordinate of the portal scroll location in pixels {Number} y - the Y coordinate of the portal scroll location in pixels |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| forms.customer.elements.customer_id.setScroll(200,200); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Sets the size of an element. It takes as input the width and the height. Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation. NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example: //returns the width (w) and height (h) var w = forms.company.elements.faxBtn.getWidth(); var h = forms.company.elements.faxBtn.getHeight(); //sets the new size forms.company.elements.faxBtn.setSize(w,h); //sets the new size and adds 1 px to both the width and height forms.company.elements.faxBtn.setSize(w+1,h+1); |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {Number} width - the width of the element in pixels. {Number} height - the height of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| forms.customer.elements.customer_id.setSize(20,30); |
|
|
|
|
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |