{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:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#bgcolor]
Gets or sets the background color of a field.{td}{tr}{tbody}{tbody}{tr}{td}[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}[#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:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[Number]{td}{td}[#getAbsoluteFormLocationY]\()
Returns the absolute form (designed) Y location.{td}{tr}{tbody}{tbody}{tr}{td}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}[#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}[Number]{td}{td}[#getLocationX]\()
Returns the x location of the current element.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getLocationY]\()
Returns the y location of the current element.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getName]\()
Returns the name of an element.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#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}[#setBorder]\(spec)
Sets
Cache
index
true
refresh
100d
showRefresh
true
id
doc
title
Refresh page
showDate
true
retry
Enable
servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientservoy sReturnTypes2100%height: 30px;2ExtendssWordListBLOCKservoy sSummary12%30%58%height: 30px;3Property SummaryGets or sets the background color of a field.Gets or sets the border attribute(s) of a specified element.Gets or sets the enabled state of a specified field, also known as "grayed".Gets or sets the foreground color of a field.Gets or sets the font name, style, and size of an element.Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.Gets or sets the transparency of an element; true - transparent; false - not transparent.Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).servoy sSummary12%30%58%height: 30px;3Methods SummaryvoidAdds a style to the styleClass property.Returns the absolute form (designed) Y location.Gets the specified client property for the element based on a key.Get the design-time properties of an element.Get a design-time property of an element.Returns the type of a specified element.Returns the name of the form.Returns the height of the current element.Returns the x location of the current element.Returns the y location of the current element.Returns the name of an element.Returns the width of the current element.voidCheck if an element already have a style from the styleClass property.voidSets the value for the specified element client property key.voidRemoves a style from the styleClass property.voidSets the location of an element.voidSets the size of an element.propertyservoy sDetail2100%height:30px2Property Detailsbgcolorname
bgcolor
dessIndent
Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowbordername
border
dessIndent
Gets or 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}{table}\\{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=3269FB9E-F591-4A65-9C22-448F351AE7D4}{tr:id=name}{td}h6.bgcolor{td}{tr}{tr:id=des}{td}{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_des|text=|trigger=button}{sub-section}{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_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=prs}{td}*Parameters*\\{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_ret|text=|trigger=button}{sub-section}{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_see|text=|trigger=button}{sub-section}{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_see|text=|trigger=button}{sub-section}{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_sam|text=|trigger=button}{sub-section}{sub-section:3269FB9E-F591-4A65-9C22-448F351AE7D4_sam|class=sIndent|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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=ECB1FF19-B86F-4CAB-966C-9530C3622F66}{tr:id=name}{td}h6.enabled{td}{tr}{tr:id=des}{td}{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_des|text=|trigger=button}{sub-section}{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_des|trigger=none|class=sIndent}Gets or sets the enabled state of a specified field, also known as "grayed".
true - enabled; false - not enabled; ! - the enabled state is inverted (the opposite).
NOTE: A disabled element cannot be selected by clicking the element (or by pressing the TAB key even if this option is supported by the operating system).
NOTE: A label or button element will not disable if the "displayType" design time property for a field is set to HTML_AREA.
NOTE: The disabled "grayed" color is dependent on the LAF set in the Servoy Client Application Preferences. For more information see Preferences: Look And Feel in the Servoy Developer User's Guide.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_ret|text=|trigger=button}{sub-section}{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_see|text=|trigger=button}{sub-section}{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_see|text=|trigger=button}{sub-section}{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_sam|text=|trigger=button}{sub-section}{sub-section:ECB1FF19-B86F-4CAB-966C-9530C3622F66_sam|class=sIndent|trigger=none}{code:language=javascript}
//gets the enabled state of the field
var currState = forms.customer.elements.customer_id.enabled;
//sets the enabled state of the field
forms.customer.elements.customer_id.enabled = !currentState;
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=12379D10-4207-45FF-A3FA-6F14931A9009}{tr:id=name}{td}h6.fgcolor{td}{tr}{tr:id=des}{td}{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_des|text=|trigger=button}{sub-section}{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_des|trigger=none|class=sIndent}Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_ret|text=|trigger=button}{sub-section}{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_see|text=|trigger=button}{sub-section}{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_see|text=|trigger=button}{sub-section}{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_sam|text=|trigger=button}{sub-section}{sub-section:12379D10-4207-45FF-A3FA-6F14931A9009_sam|class=sIndent|trigger=none}{code:language=javascript}
//sets the foreground color of the field
forms.customer.elements.customer_id.fgcolor = "#000000";
//gets the foreground color of the field
var c = forms.customer.elements.customer_id.fgcolor;
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=2C8EBDFF-6D53-4C14-840E-B04232803732}{tr:id=name}{td}h6.toolTipText{td}{tr}{tr:id=des}{td}{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_des|text=|trigger=button}{sub-section}{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_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:2C8EBDFF-6D53-4C14-840E-B04232803732_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_ret|text=|trigger=button}{sub-section}{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_see|text=|trigger=button}{sub-section}{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_see|text=|trigger=button}{sub-section}{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_sam|text=|trigger=button}{sub-section}{sub-section:2C8EBDFF-6D53-4C14-840E-B04232803732_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=0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74}{tr:id=name}{td}h6.transparent{td}{tr}{tr:id=des}{td}{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_des|text=|trigger=button}{sub-section}{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_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:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_ret|text=|trigger=button}{sub-section}{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_see|text=|trigger=button}{sub-section}{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_see|text=|trigger=button}{sub-section}{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_sam|text=|trigger=button}{sub-section}{sub-section:0EFDFFC2-BC54-45BB-9CC0-0135A0F84C74_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=4D66E943-B5A1-4558-84EB-9AD4265BD33E}{tr:id=name}{td}h6.visible{td}{tr}{tr:id=des}{td}{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_des|text=|trigger=button}{sub-section}{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_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:4D66E943-B5A1-4558-84EB-9AD4265BD33E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_ret|text=|trigger=button}{sub-section}{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_see|text=|trigger=button}{sub-section}{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_see|text=|trigger=button}{sub-section}{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_sam|text=|trigger=button}{sub-section}{sub-section:4D66E943-B5A1-4558-84EB-9AD4265BD33E_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=F98C464C-19CD-4B09-AB06-CBA43ABA5EBB}{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:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_des|text=|trigger=button}{sub-section}{sub-section:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_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:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_ret|text=|trigger=button}{sub-section}{sub-section:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_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:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_see|text=|trigger=button}{sub-section}{sub-section:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_see|text=|trigger=button}{sub-section}{sub-section:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_sam|text=|trigger=button}{sub-section}{sub-section:F98C464C-19CD-4B09-AB06-CBA43ABA5EBB_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=9659C2B1-1101-4CA0-94BD-BE4702DC5C56}{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:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_des|text=|trigger=button}{sub-section}{sub-section:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_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:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_prs|trigger=none}key -- user interface key (depends on operating system)
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_ret|text=|trigger=button}{sub-section}{sub-section:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_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:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_see|text=|trigger=button}{sub-section}{sub-section:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_see|text=|trigger=button}{sub-section}{sub-section:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_sam|text=|trigger=button}{sub-section}{sub-section:9659C2B1-1101-4CA0-94BD-BE4702DC5C56_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=013B9DD6-6EB8-438F-9C44-B0DF30928171}{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:013B9DD6-6EB8-438F-9C44-B0DF30928171_des|text=|trigger=button}{sub-section}{sub-section:013B9DD6-6EB8-438F-9C44-B0DF30928171_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:013B9DD6-6EB8-438F-9C44-B0DF30928171_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:013B9DD6-6EB8-438F-9C44-B0DF30928171_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:013B9DD6-6EB8-438F-9C44-B0DF30928171_ret|text=|trigger=button}{sub-section}{sub-section:013B9DD6-6EB8-438F-9C44-B0DF30928171_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:013B9DD6-6EB8-438F-9C44-B0DF30928171_see|text=|trigger=button}{sub-section}{sub-section:013B9DD6-6EB8-438F-9C44-B0DF30928171_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:013B9DD6-6EB8-438F-9C44-B0DF30928171_see|text=|trigger=button}{sub-section}{sub-section:013B9DD6-6EB8-438F-9C44-B0DF30928171_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:013B9DD6-6EB8-438F-9C44-B0DF30928171_sam|text=|trigger=button}{sub-section}{sub-section:013B9DD6-6EB8-438F-9C44-B0DF30928171_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=1007FA90-014E-45B4-B9E9-8398AFF0F542}{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:1007FA90-014E-45B4-B9E9-8398AFF0F542_des|text=|trigger=button}{sub-section}{sub-section:1007FA90-014E-45B4-B9E9-8398AFF0F542_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:1007FA90-014E-45B4-B9E9-8398AFF0F542_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1007FA90-014E-45B4-B9E9-8398AFF0F542_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:1007FA90-014E-45B4-B9E9-8398AFF0F542_ret|text=|trigger=button}{sub-section}{sub-section:1007FA90-014E-45B4-B9E9-8398AFF0F542_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:1007FA90-014E-45B4-B9E9-8398AFF0F542_see|text=|trigger=button}{sub-section}{sub-section:1007FA90-014E-45B4-B9E9-8398AFF0F542_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1007FA90-014E-45B4-B9E9-8398AFF0F542_see|text=|trigger=button}{sub-section}{sub-section:1007FA90-014E-45B4-B9E9-8398AFF0F542_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1007FA90-014E-45B4-B9E9-8398AFF0F542_sam|text=|trigger=button}{sub-section}{sub-section:1007FA90-014E-45B4-B9E9-8398AFF0F542_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=F41CB445-49A7-4343-A54B-74C28B12BD33}{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:F41CB445-49A7-4343-A54B-74C28B12BD33_des|text=|trigger=button}{sub-section}{sub-section:F41CB445-49A7-4343-A54B-74C28B12BD33_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:F41CB445-49A7-4343-A54B-74C28B12BD33_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:F41CB445-49A7-4343-A54B-74C28B12BD33_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:F41CB445-49A7-4343-A54B-74C28B12BD33_ret|text=|trigger=button}{sub-section}{sub-section:F41CB445-49A7-4343-A54B-74C28B12BD33_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:F41CB445-49A7-4343-A54B-74C28B12BD33_see|text=|trigger=button}{sub-section}{sub-section:F41CB445-49A7-4343-A54B-74C28B12BD33_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:F41CB445-49A7-4343-A54B-74C28B12BD33_see|text=|trigger=button}{sub-section}{sub-section:F41CB445-49A7-4343-A54B-74C28B12BD33_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:F41CB445-49A7-4343-A54B-74C28B12BD33_sam|text=|trigger=button}{sub-section}{sub-section:F41CB445-49A7-4343-A54B-74C28B12BD33_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=016CC589-1914-4F90-8525-0A39D848B466}{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:016CC589-1914-4F90-8525-0A39D848B466_des|text=|trigger=button}{sub-section}{sub-section:016CC589-1914-4F90-8525-0A39D848B466_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:016CC589-1914-4F90-8525-0A39D848B466_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:016CC589-1914-4F90-8525-0A39D848B466_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:016CC589-1914-4F90-8525-0A39D848B466_ret|text=|trigger=button}{sub-section}{sub-section:016CC589-1914-4F90-8525-0A39D848B466_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:016CC589-1914-4F90-8525-0A39D848B466_see|text=|trigger=button}{sub-section}{sub-section:016CC589-1914-4F90-8525-0A39D848B466_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:016CC589-1914-4F90-8525-0A39D848B466_see|text=|trigger=button}{sub-section}{sub-section:016CC589-1914-4F90-8525-0A39D848B466_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:016CC589-1914-4F90-8525-0A39D848B466_sam|text=|trigger=button}{sub-section}{sub-section:016CC589-1914-4F90-8525-0A39D848B466_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=EED34982-2730-4F9B-8746-541726A687B8}{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:EED34982-2730-4F9B-8746-541726A687B8_des|text=|trigger=button}{sub-section}{sub-section:EED34982-2730-4F9B-8746-541726A687B8_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:EED34982-2730-4F9B-8746-541726A687B8_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EED34982-2730-4F9B-8746-541726A687B8_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:EED34982-2730-4F9B-8746-541726A687B8_ret|text=|trigger=button}{sub-section}{sub-section:EED34982-2730-4F9B-8746-541726A687B8_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:EED34982-2730-4F9B-8746-541726A687B8_see|text=|trigger=button}{sub-section}{sub-section:EED34982-2730-4F9B-8746-541726A687B8_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EED34982-2730-4F9B-8746-541726A687B8_see|text=|trigger=button}{sub-section}{sub-section:EED34982-2730-4F9B-8746-541726A687B8_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EED34982-2730-4F9B-8746-541726A687B8_sam|text=|trigger=button}{sub-section}{sub-section:EED34982-2730-4F9B-8746-541726A687B8_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=DD4E981B-9540-4530-9E20-0DACF6558FC4}{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:DD4E981B-9540-4530-9E20-0DACF6558FC4_des|text=|trigger=button}{sub-section}{sub-section:DD4E981B-9540-4530-9E20-0DACF6558FC4_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:DD4E981B-9540-4530-9E20-0DACF6558FC4_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:DD4E981B-9540-4530-9E20-0DACF6558FC4_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:DD4E981B-9540-4530-9E20-0DACF6558FC4_ret|text=|trigger=button}{sub-section}{sub-section:DD4E981B-9540-4530-9E20-0DACF6558FC4_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:DD4E981B-9540-4530-9E20-0DACF6558FC4_see|text=|trigger=button}{sub-section}{sub-section:DD4E981B-9540-4530-9E20-0DACF6558FC4_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:DD4E981B-9540-4530-9E20-0DACF6558FC4_see|text=|trigger=button}{sub-section}{sub-section:DD4E981B-9540-4530-9E20-0DACF6558FC4_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:DD4E981B-9540-4530-9E20-0DACF6558FC4_sam|text=|trigger=button}{sub-section}{sub-section:DD4E981B-9540-4530-9E20-0DACF6558FC4_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=6588F3E9-AB7F-4D73-867E-63F5F3BB346B}{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:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_des|text=|trigger=button}{sub-section}{sub-section:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_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:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_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:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_ret|text=|trigger=button}{sub-section}{sub-section:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_see|text=|trigger=button}{sub-section}{sub-section:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_see|text=|trigger=button}{sub-section}{sub-section:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_sam|text=|trigger=button}{sub-section}{sub-section:6588F3E9-AB7F-4D73-867E-63F5F3BB346B_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=3D0CE0E1-51EF-47B6-A954-CD89F76AF873}{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:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_des|text=|trigger=button}{sub-section}{sub-section:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_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:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_prs|trigger=none}spec -- the border attributes
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_ret|text=|trigger=button}{sub-section}{sub-section:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_see|text=|trigger=button}{sub-section}{sub-section:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_see|text=|trigger=button}{sub-section}{sub-section:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_sam|text=|trigger=button}{sub-section}{sub-section:3D0CE0E1-51EF-47B6-A954-CD89F76AF873_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=E5BF4014-09F8-4951-9FDC-3DB10C058DBD}{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:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_des|text=|trigger=button}{sub-section}{sub-section:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_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:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_prs|trigger=none}spec -- the font name, style, size
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_ret|text=|trigger=button}{sub-section}{sub-section:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_see|text=|trigger=button}{sub-section}{sub-section:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_see|text=|trigger=button}{sub-section}{sub-section:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_sam|text=|trigger=button}{sub-section}{sub-section:E5BF4014-09F8-4951-9FDC-3DB10C058DBD_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=C364C6E8-66DC-458C-B48A-E60421F3EC94}{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:C364C6E8-66DC-458C-B48A-E60421F3EC94_des|text=|trigger=button}{sub-section}{sub-section:C364C6E8-66DC-458C-B48A-E60421F3EC94_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:
The border attributes:
borderType - EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder.
size - (numeric value) for: bottom, left, right, top.
color - (hexadecimal value) for: bottom, left, right, top.
dash pattern - (numeric value) for selected side(s).
rounding radius - (numeric value) for selected side(s).
It only returns it's correct value if it was explicitly set.
NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType".
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowenabledname
enabled
dessIndent
Gets or sets the enabled state of a specified field, also known as "grayed".
true - enabled; false - not enabled; ! - the enabled state is inverted (the opposite).
NOTE: A disabled element cannot be selected by clicking the element (or by pressing the TAB key even if this option is supported by the operating system).
NOTE: A label or button element will not disable if the "displayType" design time property for a field is set to HTML_AREA.
NOTE: The disabled "grayed" color is dependent on the LAF set in the Servoy Client Application Preferences. For more information see Preferences: Look And Feel in the Servoy Developer User's Guide.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowfgcolorname
fgcolor
dessIndent
Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowfontname
font
dessIndent
Gets or sets the font name, style, and size of an element.
font name - the name of the font family.
style - the type of the font. (plain = 0; bold = 1; italic = 2; bold-italic = 3).
size - the size of the font (in points).
It only returns it's correct value if it was explicitly set.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowtoolTipTextname
toolTipText
dessIndent
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.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowtransparentname
transparent
dessIndent
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
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowvisiblename
visible
dessIndent
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.
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.
prs
Parameters
sIndentkeyuser interface key (depends on operating system)ret
Returns
sIndent The value of the property for specified key.clients
sIndent The display type of the element as String.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetFormNamename
getFormName()
dessIndent
Returns the name of the form. (may be empty string as well)
ret
Returns
sIndent The name of the form.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetHeightname
getHeight()
dessIndent
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);
ret
Returns
sIndent The height of the element in pixels.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetLocationXname
getLocationX()
dessIndent
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);
ret
Returns
sIndent The x location of the element in pixels.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetLocationYname
getLocationY()
dessIndent
Returns the y location of the current element. The method can only be used in Record view.
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
{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:C364C6E8-66DC-458C-B48A-E60421F3EC94_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:C364C6E8-66DC-458C-B48A-E60421F3EC94_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:C364C6E8-66DC-458C-B48A-E60421F3EC94_ret|text=|trigger=button}{sub-section}{sub-section:C364C6E8-66DC-458C-B48A-E60421F3EC94_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:C364C6E8-66DC-458C-B48A-E60421F3EC94_see|text=|trigger=button}{sub-section}{sub-section:C364C6E8-66DC-458C-B48A-E60421F3EC94_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:C364C6E8-66DC-458C-B48A-E60421F3EC94_see|text=|trigger=button}{sub-section}{sub-section:C364C6E8-66DC-458C-B48A-E60421F3EC94_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:C364C6E8-66DC-458C-B48A-E60421F3EC94_sam|text=|trigger=button}{sub-section}{sub-section:C364C6E8-66DC-458C-B48A-E60421F3EC94_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=B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68}{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:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_des|text=|trigger=button}{sub-section}{sub-section:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_des|trigger=none|class=sIndent}Sets the size of the fieldret
Returns
sIndent The y location of the element in pixels.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetNamename
getName()
dessIndent
Returns the name of an element. (may be null as well)
ret
Returns
sIndent The name of the element.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetWidthname
getWidth()
dessIndent
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);
ret
Returns
sIndent The width of the element in pixels.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowhasStyleClassname
hasStyleClass(styleName)
dessIndent
Check if an element already have a style from the styleClass property.
prs
Parameters
sIndentstyleNamethe name of the style class to be checkedclients
Sets the value for the specified element client property key.
NOTE: Depending on the operating system, a user interface property name may be available.
prs
Parameters
sIndentkeyuser interface key (depends on operating system)valuea predefined value for the keyclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowremoveStyleClassname
removeStyleClass(styleName)
dessIndent
Removes a style from the styleClass property. This works only for NGClient where multiple styles are supported.
prs
Parameters
sIndentstyleNamethe name of the style class to removeclients
Supported Clients
sIndentNGClientsam
Sample
sIdentjavascriptlastDetailRowsetLocationname
setLocation(x, y)
dessIndent
Sets the location of an element. It takes as input the X
width
(horizontal) and Y (vertical) coordinates - starting from the
height.
NOTE: getWidth() can be used with getHeight() to set the size of
TOP LEFT side of the screen.
Please note that location should not be altered at runtime when an element
using
is
the
anchored.
setSize
Use
function.
the
For
solutionModel
Example:
insucha
//returns
situation.
the
width
NOTE:getLocationX(
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
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.
setSize(w+1,h+1);{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_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:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_ret|text=|trigger=button}{sub-section}{sub-section:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_see|text=|trigger=button}{sub-section}{sub-section:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_see|text=|trigger=button}{sub-section}{sub-section:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_sam|text=|trigger=button}{sub-section}{sub-section:B0CB3A1A-DE04-4F2D-BFB2-1C232AC23D68_sam|class=sIndent|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setSize(20,30);
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
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);
prs
Parameters
sIndentxthe X coordinate of the element in pixels.ythe Y coordinate of the element in pixels.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowsetSizename
setSize(width, height)
dessIndent
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);
prs
Parameters
sIndentwidththe width of the element in pixels.heightthe height of the element in pixels.clients