Page History
| Wiki Markup |
|---|
{hidden}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
{sub-section:description|text=}{sub-section}\\
{table:id=|class=servoy sSummerysSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property SummerySummary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#bgcolor]
Gets or sets the background color of a field.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#border]
Gets or sets the border attribute(s) of a specified element.{td}{tr}{tbody}{tbody}{tr}{td}[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}[#mnemonic#font]
GetsSets orthe setsfont thename, specified character(s) \- typically an underlined letter\- used with/without the modifier key(s) for the label, button or imagestyle, and size of an element.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#text#imageURL]
Gets/Sets or sets the textimage thatdisplayed ison displayeda onbutton theor label,; buttonbased oron imageURL.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#toolTipText#mnemonic]
Gets or sets the tool tip text ofspecified character(s) \- typically an element; text displays when the mouse cursor hovers over an elementunderlined letter\- used with/without the modifier key(s) for the label, button or image.{td}{tr}{tbody}{tbody}{tr}{td}[BooleanString]{td}{td}[#transparent#rolloverImageURL]
Gets/Sets orthe setsimage thedisplayed transparencyon ofa anbutton element;or truelabel \-roll transparentover; falsebased \- not transparenton URL.{td}{tr}{tbody}{tbody}{tr}{td}[BooleanString]{td}{td}[#visible#text]
Gets or sets the visibilitytext ofthat anis element; true \- visible; false \- not visible; ! \-displayed on the visibilitylabel, statebutton is inverted (the opposite)or image.{td}{tr}{tbody}{tabletbody}\\
{table:id=|class=servoy sSummery{tr}{colgrouptd}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summery{th}{tr}{tbody}{tr}{td}[Number]{[String]{td}{td}[#getAbsoluteFormLocationY]\()
Returns the absolute form (designed) Y location#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}[ObjectBoolean]{td}{td}[#getClientProperty#transparent]\(key)
Gets or sets the specifiedtransparency of clientan propertyelement; fortrue the\- elementtransparent; basedfalse on\- anot keytransparent.{td}{tr}{tbody}{tbody}{tr}{td}[StringBoolean]{td}{td}[#getDataProviderID]\()
Get the data provider this UI element (display) is showing#visible]
Gets or sets the visibility of an element; true \- visible; false \- not visible; ! \- the visibility state is inverted (the opposite).{td}{tr}{tbody}{table}\\
{table:id=|class=servoy sSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[StringNumber]{td}{td}[#getElementType#getAbsoluteFormLocationY]\()
Returns the typeabsolute ofform a(designed) specifiedY elementlocation.{td}{tr}{tbody}{tbody}{tr}{td}[NumberObject]{td}{td}[#getHeight#getClientProperty]\(key)
ReturnsGets the height ofspecified client property for the current elementelement based on a key.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getLabelForElementName#getDataProviderID]\()
GetsGet the data provider labelthis forUI propertyelement of(display) ais labelshowing.{td}{tr}{tbody}{tbody}{tr}{td}[NumberString]{td}{td}[#getLocationX#getElementType]\()
Returns the xtype location of thea currentspecified element.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getLocationY#getHeight]\()
Returns the y locationheight of the current element.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getName#getLabelForElementName]\()
ReturnsGets the label namefor property of ana elementlabel.{td}{tr}{tbody}{tbody}{tr}{td}[StringNumber]{td}{td}[#getParameterValue#getLocationX]\(param)
GetsReturns the httpx requestlocation parameterof forthe a submit within html labelcurrent element.{td}{tr}{tbody}{tbody}{tr}{td}byte[Number]{td}{td}[#getThumbnailJPGImage#getLocationY]\(\[width\], \[height\])
Returns the y location imageof datathe incurrent element.{td}{tr}{tbody}{tbody}{tr}{td}[NumberString]{td}{td}[#getWidth#getName]\()
Returns the widthname of the currentan element.{td}{tr}{tbody}{tbody}{tr}{td}voidbyte[]{td}{td}[#putClientProperty#getThumbnailJPGImage]\(key\[width\], value\[height\])
SetsReturns the valueimage fordata the specified element client property keyin .{td}{tr}{tbody}{tbody}{tr}{td}void[Number]{td}{td}[#setBorder#getWidth]\(spec)
SetsReturns the borderwidth attribute(s) of athe specifiedcurrent element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setFont#putClientProperty]\(spec)
Sets the font name, style, and size of an element.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setImageURL]\(urlkey, value)
Sets the imagevalue displayedfor onthe aspecified buttonelement orclient label; based on URLproperty key.{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:id=property|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=bgcolor|class=node}{tr:id=name}{td}h6.bgcolor{td}{tr}{tr:id=des}{td}{sub-section:bgcolor_des|text=|trigger=button}{sub-section}{sub-section:bgcolor_des|trigger=none|class=sIndent}Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:bgcolor_snc|text=|trigger=button}{sub-section}{sub-section:bgcolor_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:bgcolor_prs|text=|trigger=button}{sub-section}{sub-section:bgcolor_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:bgcolor_ret|text=|trigger=button}{sub-section}{sub-section:bgcolor_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:bgcolor_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:bgcolor_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:bgcolor_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:bgcolor_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:bgcolor_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:bgcolor_sam|trigger=none}{code:language=javascript}
//sets the background color of the field
forms.customer.elements.customer_id.bgcolor = "#FFFFFF";
//gets the background color of the field
var c = forms.customer.elements.customer_id.bgcolor;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=enabledborder|class=node}{tr:id=name}{td}h6.enabledborder{td}{tr}{tr:id=des}{td}{sub-section:enabledborder_des|text=|trigger=button}{sub-section}{sub-section:enabledborder_des|trigger=none|class=sIndent}Gets or sets the enabled stateborder attribute(s) of a specified element.
field,
alsoThe knownborder as "grayed".
trueattributes:
borderType \- enabled; false \- not enabled; !EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder.
size \- the(numeric enabledvalue) statefor: isbottom, inverted (the opposite)left, right, top.
color 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\- (hexadecimal value) for: bottom, left, right, top.
dash pattern \- (numeric value) for selected side(s).
rounding radius \- (numeric value) for selected side(s).
NOTE: AUse labelthe or button element will not disable if the "displayType"same value(s) and order of attribute(s) from the element 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"borderType".{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:enabledborder_snc|text=|trigger=button}{sub-section}{sub-section:enabledborder_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:enabledborder_prs|text=|trigger=button}{sub-section}{sub-section:enabledborder_prs|trigger=none|class=sIndent}spec -- the border attributes
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:enabledborder_ret|text=|trigger=button}{sub-section}{sub-section:enabledborder_ret|trigger=none|class=sIndent}[BooleanString]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:enabledborder_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:enabledborder_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:enabledborder_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:enabledborder_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:enabledborder_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:enabledborder_sam|trigger=none}{code:language=javascript}
//getssets the enabledborder statetype ofto the field
var currState = forms.customer.elements.customer_id.enabled;
"LineBorder"
//sets a 1 px line width for the bottom and left side of the border
//sets the enabledhexadecimal statecolor of the field border to "#ccffcc"
var b = forms.customer.elements.customer_id.enabled = !currentStatesetBorder('LineBorder,1,#ccffcc');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=fgcolorenabled|class=node}{tr:id=name}{td}h6.fgcolorenabled{td}{tr}{tr:id=des}{td}{sub-section:fgcolorenabled_des|text=|trigger=button}{sub-section}{sub-section:fgcolorenabled_des|trigger=none|class=sIndent}Gets or sets the foregroundenabled colorstate of a specified field, also known as "grayed". The color has to be set using the hexadecimal RGB value as used in HTML.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:fgcolor_snc|text=|trigger=button}{sub-section}{sub-section:fgcolor_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show
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=prssnc}{td}*ParametersSince*\\{sub-section:fgcolorenabled_prssnc|text=|trigger=button}{sub-section}{sub-section:fgcolorenabled_prssnc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:fgcolorenabled_retprs|text=|trigger=button}{sub-section}{sub-section:fgcolorenabled_retprs|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=ret}{td}*Returns*\\{sub-section:enabled_ret|text=|trigger=button}{sub-section}{sub-section:enabled_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:fgcolorenabled_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:fgcolorenabled_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:fgcolorenabled_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:fgcolorenabled_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:fgcolorenabled_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:fgcolorenabled_sam|trigger=none}{code:language=javascript}
//setsgets the foregroundenabled colorstate of the field
var currState = forms.customer.elements.customer_id.fgcolor = "#000000"enabled;
//getssets the foregroundenabled colorstate of the field
var c =
forms.customer.elements.customer_id.fgcolorenabled = !currentState;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=mnemonicfgcolor|class=node}{tr:id=name}{td}h6.mnemonicfgcolor{td}{tr}{tr:id=des}{td}{sub-section:mnemonicfgcolor_des|text=|trigger=button}{sub-section}{sub-section:mnemonicfgcolor_des|trigger=none|class=sIndent}Gets or sets the specified character(s) \- typically an underlined letter\- used with/without the modifier key(s) for the label, button or image.
Modifiers key values:
1 SHIFT
2 CTRL
4 Meta/CMD (Macintosh)
8 ALT(Windows, Unix); OPTION (Macintosh)
NOTE: A mnemonic is usually a single key used with/without the CTRL, CMD, SHIFT, ALT, or OPTION key(s) to activate a menu item or command \- depending, in part on whether the menmonic applies in a command line or graphic interface. For one description, you can refer to this web page: http://msdn.microsoft.com/en\-us/library/bb158536.aspx or perform a search in a web browser search engine using the criteria "mnemonic".
NOTE2: Mnemonic is only supported in Smart Client.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=snc}{td}*Since*\\{sub-section:fgcolor_snc|text=|trigger=button}{sub-section}{sub-section:fgcolor_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:fgcolor_prs|text=|trigger=button}{sub-section}{sub-section:fgcolor_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=sncret}{td}*SinceReturns*\\{sub-section:mnemonicfgcolor_sncret|text=|trigger=button}{sub-section}{sub-section:mnemonicfgcolor_sncret|trigger=none|class=sIndent} Replace with version info[String]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prssee}{td}*ParametersAlso see*\\{sub-section:mnemonicfgcolor_prssee|text=|trigger=button}{sub-section}{sub-section:mnemonic_prs|trigger=none|classdiv:class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:mnemonic_ret|text=|trigger=button:fgcolor_see|trigger=none}{sub-section}{sub-section:mnemonic_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{trdiv}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=seelink}{td}*AlsoExternal seelinks*\\{sub-section:mnemonicfgcolor_seelink|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:mnemonicfgcolor_seelink|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksam}{td}*External linksSample*\\{sub-section:mnemonicfgcolor_linksam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:mnemonicfgcolor_linksam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:mnemonic_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:mnemonic_sam|trigger=none}{code:language=javascript}
//gets the mnemoniccode:language=javascript}
//sets the foreground color of the element
var my_mnemoic = field
forms.customer.elements.customer_id.mnemonicfgcolor = "#000000";
//setsgets the foreground mnemoniccolor of the elementfield
var c = forms.customer.elements.customer_id.mnemonic = 'f'fgcolor;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=textfont|class=node}{tr:id=name}{td}h6.textfont{td}{tr}{tr:id=des}{td}{sub-section:textfont_des|text=|trigger=button}{sub-section}{sub-section:textfont_des|trigger=none|class=sIndent}GetsSets orthe setsfont thename, textstyle, thatand issize displayedof onan theelement. label,
button
orfont image.name \- NOTE:the Thename .textof propertythe applies to labels, buttons, or images ONLYfont family.
style \- the type of the font. (plain = 0; bold = 1; italic = 2; bold\-italic = 3).
size \- the size of the font (in points).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:textfont_snc|text=|trigger=button}{sub-section}{sub-section:textfont_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:textfont_prs|text=|trigger=button}{sub-section}{sub-section:textfont_prs|trigger=none|class=sIndent}spec -- the font name, style, size
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:textfont_ret|text=|trigger=button}{sub-section}{sub-section:textfont_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:textfont_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:textfont_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:textfont_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:textfont_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:textfont_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:textfont_sam|trigger=none}{code:language=javascript}
//gets the text of
the element
var my_text = forms.customer.elements.customer_id.text;
//sets the text of the element
forms.customer.elements.customer_id.text = my_text + 'is cool'setFont('Tahoma,1,11');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=toolTipTextimageURL|class=node}{tr:id=name}{td}h6.toolTipTextimageURL{td}{tr}{tr:id=des}{td}{sub-section:toolTipTextimageURL_des|text=|trigger=button}{sub-section}{sub-section:toolTipTextimageURL_des|trigger=none|class=sIndent}Gets or sets/Sets the toolimage tipdisplayed texton ofa anbutton 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 textor label; based on URL.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:toolTipTextimageURL_snc|text=|trigger=button}{sub-section}{sub-section:toolTipTextimageURL_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:toolTipTextimageURL_prs|text=|trigger=button}{sub-section}{sub-section:toolTipTextimageURL_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:toolTipTextimageURL_ret|text=|trigger=button}{sub-section}{sub-section:toolTipTextimageURL_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:toolTipTextimageURL_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:toolTipTextimageURL_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:toolTipTextimageURL_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:toolTipTextimageURL_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:toolTipTextimageURL_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:toolTipTextimageURL_sam|trigger=none}{code:language=javascript}
//getsdynamically thesets tooltipan textimage ofdisplayed theon elementa varbutton toolTipor =label
forms.customer.elements.customer_id.toolTipText.imageURL = "http://www.servoy.com/images/test.gif";
//sets thean image tooltipfrom textyour ofown theimage elementlibrary
forms.customer.elements.customer_id.toolTipTextimageURL = "New tip";
media:///arrow.gif";
//loads an image (BLOB) from a field in a selected record into HTML
forms.customer.elements.customer_id.toolTipTextimageURL = "<html>This includes <b>bolded text</b> and <font color='blue'>BLUE</font> text as well."'media:///servoy_blobloader?datasource='+controller.getDataSource()+'&dataprovider=image_data&mimetype=image/jpeg&rowid1=2';
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=transparentmnemonic|class=node}{tr:id=name}{td}h6.transparentmnemonic{td}{tr}{tr:id=des}{td}{sub-section:transparentmnemonic_des|text=|trigger=button}{sub-section}{sub-section:transparentmnemonic_des|trigger=none|class=sIndent}Gets or sets the transparency of specified character(s) \- typically an element;underlined true letter\- transparent; false \- not transparent.
NOTE: transparency can be inverted using ! operator: elements.elementName.transparent = !elements.elementName.transparent;
NOTE: transparency will be mostly used for background color, a transparent element will receive the background of the element "beneath" it, a non transparent one will use its own background color{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:transparent_snc|text=|trigger=button}{sub-section}{sub-section:transparent_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:transparent_prs|text=|trigger=button}{sub-section}{sub-section:transparent_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:transparent_ret|text=|trigger=button}{sub-section}{sub-section:transparent_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:transparent_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:transparent_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:transparent_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:transparent_link|trigger=none}{sub-section}{div}{used with/without the modifier key(s) for the label, button or image.
Modifiers key values:
1 SHIFT
2 CTRL
4 Meta/CMD (Macintosh)
8 ALT(Windows, Unix); OPTION (Macintosh)
NOTE: A mnemonic is usually a single key used with/without the CTRL, CMD, SHIFT, ALT, or OPTION key(s) to activate a menu item or command \- depending, in part on whether the menmonic applies in a command line or graphic interface. For one description, you can refer to this web page: http://msdn.microsoft.com/en\-us/library/bb158536.aspx or perform a search in a web browser search engine using the criteria "mnemonic".
NOTE2: Mnemonic is only supported in Smart Client.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=samsnc}{td}*SampleSince*\\{sub-section:transparentmnemonic_samsnc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:transparentmnemonic_samsnc|trigger=none}{code:language=javascript}
//gets the transparency of the element
var currentState = forms.customer.elements.customer_id.transparent;
//sets the transparency of the element
forms.customer.elements.customer_id.transparent = !currentState;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:mnemonic_prs|text=|trigger=button}{sub-section}{sub-section:mnemonic_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{tbodybuilder-show}{tbodytr:id=visible|class=node}{tr:id=name}{td}h6.visible=ret}{td}*Returns*\\{sub-section:mnemonic_ret|text=|trigger=button}{sub-section}{sub-section:mnemonic_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=dessee}{td}*Also see*\\{sub-section:visiblemnemonic_dessee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visiblemnemonic_dessee|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}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snclink}{td}*SinceExternal links*\\{sub-section:visiblemnemonic_snclink|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visiblemnemonic_snclink|trigger=none|class=sIndent} Replace with version info{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prssam}{td}*ParametersSample*\\{sub-section:visiblemnemonic_prssam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visiblemnemonic_prssam|trigger=none|class=sIndent}{code:language=javascript}
//gets the mnemonic of the element
var my_mnemoic = forms.customer.elements.customer_id.mnemonic;
//sets the mnemonic of the element
forms.customer.elements.customer_id.mnemonic = 'f';
{code}{sub-section}{div}{td}{tr}{builder-show}{tr:idclass=retlastDetailRow}{td}*Returns*\\{sub-section:visible_ret|text=|trigger=button}{sub-section}{sub-section:visible_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit{td}{tr}{tbody}{tbody:id=rolloverImageURL|class=node}{tr:id=name}{td}h6.rolloverImageURL{td}{tr}{tr:id=seedes}{td}*Also see*\\{sub-section:visiblerolloverImageURL_seedes|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visiblerolloverImageURL_seedes|trigger=none|class=sIndent}Gets/Sets the image displayed on a button or label roll over; based on URL.{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksnc}{td}*External linksSince*\\{sub-section:visiblerolloverImageURL_linksnc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visiblerolloverImageURL_linksnc|trigger=none}none|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{builder-show:permission=edit}{tr:id=samprs}{td}*SampleParameters*\\{sub-section:visible_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visible_sam|trigger=none}{code:language=javascript}
//sets the element as visible
forms.company.elements.faxBtn.visible = true;
//gets the visibility of the element
var currentState = forms.company.elements.faxBtn.visible;
//sets the element as not visible when the current state is visible
forms.company.elements.faxBtn.visible = !currentState;
{code}{sub-section}{divrolloverImageURL_prs|text=|trigger=button}{sub-section}{sub-section:rolloverImageURL_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:rolloverImageURL_ret|text=|trigger=button}{sub-section}{sub-section:rolloverImageURL_ret|trigger=none|class=lastDetailRowsIndent}{td[String]{sub-section}{td}{tr}{tbody}{table}\\
{table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=getAbsoluteFormLocationY|class=node}{tr:id=name}{td}h6.getAbsoluteFormLocationY{td}{trbuilder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:rolloverImageURL_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:rolloverImageURL_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=siglink}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getAbsoluteFormLocationY{span}{span:id=iets|style=float: left;}\(){span*External links*\\{sub-section:rolloverImageURL_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:rolloverImageURL_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=dessam}{td}*Sample*\\{sub-section:getAbsoluteFormLocationYrolloverImageURL_dessam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getAbsoluteFormLocationYrolloverImageURL_dessam|trigger=none|class=sIndent}Returns the absolute form (designed) Y location.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getAbsoluteFormLocationY_snc|text=|trigger=button}{sub-section}{sub-section:getAbsoluteFormLocationY_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{code:language=javascript}
//dynamically sets a roll over image displayed on a button or label
forms.customer.elements.customer_id.rolloverImageURL = "http://www.servoy.com/images/test.gif";
//sets an image from your own image library
forms.customer.elements.customer_id.rolloverImageURL = "media:///arrow.gif";
//loads an image (BLOB) from a field in a selected record into HTML
forms.customer.elements.customer_id.rolloverImageURL = 'media:///servoy_blobloader?datasource='+controller.getDataSource()+'&dataprovider=image_data&mimetype=image/jpeg&rowid1=2';
{code}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prstr:class=lastDetailRow}{td}{td}*Parameters*\\{sub-section:getAbsoluteFormLocationY_prs|text=|trigger=button}{sub-section}{sub-section:getAbsoluteFormLocationY_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show{tr}{tbody}{tbody:id=text|class=node}{tr:id=name}{td}h6.text{td}{tr}{tr:id=retdes}{td}*Returns*\\{sub-section:getAbsoluteFormLocationYtext_retdes|text=|trigger=button}{sub-section}{sub-section:getAbsoluteFormLocationYtext_retdes|trigger=none|class=sIndent}[Number] -- The y location of the form in pixelsGets or sets the text that is displayed on the label, button or image.
NOTE: The .text property applies to labels, buttons, or images ONLY.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seesnc}{td}*Also seeSince*\\{sub-section:getAbsoluteFormLocationYtext_seesnc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getAbsoluteFormLocationYtext_seesnc|trigger=none|class=sIndent} Replace with version info{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkprs}{td}*External linksParameters*\\{sub-section:getAbsoluteFormLocationYtext_linkprs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getAbsoluteFormLocationYtext_linkprs|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{tr:id=samret}{td}*SampleReturns*\\{sub-section:getAbsoluteFormLocationYtext_samret|text=|trigger=button}{sub-section}{div:sub-section:text_ret|trigger=none|class=sIndent}[String]{sub-section:getAbsoluteFormLocationY_sam|trigger=none}{code:language=javascript}
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();
{code}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:text_see|text=|trigger=button}{sub-section}{div:class=sIndent}{tdsub-section:text_see|trigger=none}{trsub-section}{tr:class=lastDetailRowdiv}{td}{td}{tr}{tbodybuilder-show}{tbodybuilder-show:id=getClientProperty|class=nodepermission=edit}{tr:id=namelink}{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*External links*\\{sub-section:text_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:text_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=dessam}{td}*Sample*\\{sub-section:getClientPropertytext_dessam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getClientPropertytext_dessam|trigger=none|class=sIndent}Gets}{code:language=javascript}
//gets the specified client property fortext of the element
basedvar onmy_text a key.
NOTE: Depending on the operating system, a user interface property name may be available.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getClientProperty_snc|text=|trigger=button}{sub-section}{sub-section:getClientProperty_snc|trigger=none|class=sIndent} Replace with version info{sub-section= forms.customer.elements.customer_id.text;
//sets the text of the element
forms.customer.elements.customer_id.text = my_text + 'is cool';
{code}{sub-section}{div}{td}{tr}{builder-show}{tr:id=prsclass=lastDetailRow}{td}{td}*Parameters*\\{sub-section:getClientProperty_prs|text=|trigger=button}{sub-section}{sub-section:getClientProperty_prs|trigger=none|class=sIndent}\{[Object]} key -- user interface key (depends on operating system)
{sub-section}{tr}{tbody}{tbody:id=toolTipText|class=node}{tr:id=name}{td}h6.toolTipText{td}{tr}{tr:id=retdes}{td}*Returns*\\}{sub-section:getClientPropertytoolTipText_retdes|text=|trigger=button}{sub-section}{sub-section:getClientPropertytoolTipText_retdes|trigger=none|class=sIndent}[Object] -- The value of the property for specified keyGets 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=seesnc}{td}*Also seeSince*\\{sub-section:getClientPropertytoolTipText_seesnc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getClientPropertytoolTipText_seesnc|trigger=none|class=sIndent} Replace with version info{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkprs}{td}*External linksParameters*\\{sub-section:getClientPropertytoolTipText_linkprs|text=|trigger=button}{sub-section}{div:class=sIndentsub-section}{sub-section:getClientPropertytoolTipText_linkprs|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{tr:id=samret}{td}*SampleReturns*\\{sub-section:getClientPropertytoolTipText_samret|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getClientPropertytoolTipText_samret|trigger=none}{code:language=javascript}
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDataProviderID|class=node}{tr:id=name}{td}h6.getDataProviderID{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getDataProviderID{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getDataProviderID_des|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:toolTipText_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:toolTipText_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:toolTipText_link|text=|trigger=button}{sub-section}{sub-section:getDataProviderID_des|trigger=none|class=sIndent}Get the data provider this UI element (display) is showing.div:class=sIndent}{sub-section:toolTipText_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=sncsam}{td}*SinceSample*\\{sub-section:getDataProviderIDtoolTipText_sncsam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDataProviderIDtoolTipText_sncsam|trigger=none|class=sIndent} Replace with version info}{code:language=javascript}
//gets the tooltip text of the element
var toolTip = forms.customer.elements.customer_id.toolTipText;
//sets the tooltip text of the element
forms.customer.elements.customer_id.toolTipText = "New tip";
forms.customer.elements.customer_id.toolTipText = "<html>This includes <b>bolded text</b> and <font color='blue'>BLUE</font> text as well.";
{code}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prstr:class=lastDetailRow}{td}{td}*Parameters*\\{sub-section:getDataProviderID_prs|text=|trigger=button}{sub-section}{sub-section:getDataProviderID_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show{tr}{tbody}{tbody:id=transparent|class=node}{tr:id=name}{td}h6.transparent{td}{tr}{tr:id=retdes}{td}*Returns*\\{sub-section:getDataProviderIDtransparent_retdes|text=|trigger=button}{sub-section}{sub-section}{sub-section:getDataProviderID_ret|trigger=none|class=sIndent}[String] -- The data provider as String.-section:transparent_des|trigger=none|class=sIndent}Gets or sets the transparency of an element; true \- transparent; false \- not transparent.
NOTE: transparency can be inverted using ! operator: elements.elementName.transparent = !elements.elementName.transparent;
NOTE: transparency will be mostly used for background color, a transparent element will receive the background of the element "beneath" it, a non transparent one will use its own background color{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seesnc}{td}*Also seeSince*\\{sub-section:getDataProviderIDtransparent_seesnc|text=|trigger=button}{sub-section}{div:class=sIndentsection}{sub-section:getDataProviderIDtransparent_seesnc|trigger=none|class=sIndent} Replace with version info{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkprs}{td}*External linksParameters*\\{sub-section:getDataProviderIDtransparent_linkprs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDataProviderIDtransparent_linkprs|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{tr:id=samret}{td}*SampleReturns*\\{sub-section:getDataProviderIDtransparent_samret|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDataProviderIDtransparent_samret|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.getDataProviderID();
{code}{sub-section}{div|class=sIndent}[Boolean]{sub-section}{td}{tr}{trbuilder-show:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getElementType|class=node}{tr:id=name}{td}h6.getElementType{td}{trpermission=edit}{tr:id=sigsee}{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*Also see*\\{sub-section:transparent_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:transparent_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=deslink}{td}*External links*\\{sub-section:getElementTypetransparent_deslink|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getElementTypetransparent_des|trigger=none|class=sIndent}Returns the type of a specified element.link|trigger=none}{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=sncsam}{td}*SinceSample*\\{sub-section:getElementTypetransparent_sncsam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getElementTypetransparent_sncsam|trigger=none|class=sIndent} Replace with version info{sub-section}{code:language=javascript}
//gets the transparency of the element
var currentState = forms.customer.elements.customer_id.transparent;
//sets the transparency of the element
forms.customer.elements.customer_id.transparent = !currentState;
{code}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prstr:class=lastDetailRow}{td}{td}*Parameters*\\{sub-section:getElementType_prs|text=|trigger=button}{sub-section}{sub-section:getElementType_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show{tr}{tbody}{tbody:id=visible|class=node}{tr:id=name}{td}h6.visible{td}{tr}{tr:id=retdes}{td}*Returns*\\{sub-section:getElementTypevisible_retdes|text=|trigger=button}{sub-section}{sub-section:getElementTypevisible_retdes|trigger=none|class=sIndent}[String] -- The display type of the element as StringGets 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=seesnc}{td}*Also seeSince*\\{sub-section:getElementTypevisible_seesnc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getElementTypevisible_seesnc|trigger=none|class=sIndent} Replace with version info{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkprs}{td}*External linksParameters*\\{sub-section:getElementTypevisible_linkprs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getElementTypevisible_linkprs|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{tr:id=samret}{td}*SampleReturns*\\{sub-section:getElementTypevisible_samret|text=|trigger=button}{sub-section}{div:sub-section:visible_ret|trigger=none|class=sIndent}[Boolean]{sub-section:getElementType_sam|trigger=none}{code:language=javascript}
var et = forms.customer.elements.customer_id.getElementType();
{code}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:visible_see|text=|trigger=button}{sub-section}{div:class=sIndent}{tdsub-section:visible_see|trigger=none}{trsub-section}{tr:class=lastDetailRowdiv}{td}{td}{tr}{tbodybuilder-show}{tbodybuilder-show:id=getHeight|class=nodepermission=edit}{tr:id=namelink}{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*External links*\\{sub-section:visible_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:visible_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=dessam}{td}*Sample*\\{sub-section:getHeightvisible_dessam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getHeightvisible_dessam|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 = }{code:language=javascript}
//sets the element as visible
forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight()visible = true;
//setsgets the visibility of the new sizeelement
var currentState = forms.company.elements.faxBtn.setSize(w,h)visible;
//sets the newelement sizeas andnot addsvisible 1when pxthe tocurrent bothstate theis widthvisible
and height
forms.company.elements.faxBtn.setSize(w+1,h+1);{sub-section}{tdvisible = !currentState;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\
{table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{builder-show:permission=edittbody:id=getAbsoluteFormLocationY|class=node}{tr:id=snc}name}{td}h6.getAbsoluteFormLocationY{td}*Since*\\{sub-section:getHeight_snc|text=|trigger=button}{sub-section}{sub-section:getHeight_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr}{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=prsdes}{td}*Parameters*\\{sub-section:getHeightgetAbsoluteFormLocationY_prsdes|text=|trigger=button}{sub-section}{sub-section:getHeightgetAbsoluteFormLocationY_prsdes|trigger=none|class=sIndent}Returns the absolute form (designed) Y location.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=retsnc}{td}*ReturnsSince*\\{sub-section:getHeightgetAbsoluteFormLocationY_retsnc|text=|trigger=button}{sub-section}{sub-section:getHeightgetAbsoluteFormLocationY_retsnc|trigger=none|class=sIndent}[Number] --Replace Thewith height of the element in pixels.version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=seeprs}{td}*Also seeParameters*\\{sub-section:getHeightgetAbsoluteFormLocationY_seeprs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getHeightgetAbsoluteFormLocationY_seeprs|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkret}{td}*External linksReturns*\\{sub-section:getHeightgetAbsoluteFormLocationY_linkret|text=|trigger=button}{sub-section}{div:sub-section:getAbsoluteFormLocationY_ret|trigger=none|class=sIndent}{sub-section:getHeight_link|trigger=none}[Number] -- The y location of the form in pixels.{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=samsee}{td}*SampleAlso see*\\{sub-section:getHeightgetAbsoluteFormLocationY_samsee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getHeightgetAbsoluteFormLocationY_samsee|trigger=none}{code:language=javascript}
var ht = forms.customer.elements.customer_id.getHeight();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLabelForElementName|class=nodebuilder-show}{builder-show:permission=edit}{tr:id=namelink}{td}h6.getLabelForElementName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getLabelForElementName{span}{span:id=iets|style=float: left;}\(){span*External links*\\{sub-section:getAbsoluteFormLocationY_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getAbsoluteFormLocationY_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=dessam}{td}*Sample*\\{sub-section:getLabelForElementNamegetAbsoluteFormLocationY_dessam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementName_des|trigger=none|class=sIndent}Gets the label for property of a label. This property is used to link a label to a certain element (by default used for tableview header, form security, can be used for custom purposes ).{sub-section}{td}{tr}{builder-show:permission=editgetAbsoluteFormLocationY_sam|trigger=none}{code:language=javascript}
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getClientProperty|class=node}{tr:id=name}{td}h6.getClientProperty{td}{tr}{tr:id=sncsig}{td}*Since*\\{sub-section:getLabelForElementName_snc|text=|trigger=button}{sub-section}{sub-section:getLabelForElementName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{span:style=float: left; margin-right: 5px;}[Object]{span}{span:id=iets|style=float: left; font-weight: bold;}getClientProperty{span}{span:id=iets|style=float: left;}\(key){span}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prsdes}{td}*Parameters*\\{sub-section:getLabelForElementNamegetClientProperty_prsdes|text=|trigger=button}{sub-section}{sub-section:getLabelForElementNamegetClientProperty_prsdes|trigger=none|class=sIndent}Gets the specified client property for the element based on a key.
NOTE: Depending on the operating system, a user interface property name may be available.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=retsnc}{td}*ReturnsSince*\\{sub-section:getLabelForElementNamegetClientProperty_retsnc|text=|trigger=button}{sub-section}{sub-section:getLabelForElementNamegetClientProperty_retsnc|trigger=none|class=sIndent}[String] --Replace Thewith label for property (String).version info{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeprs}{td}*Also seeParameters*\\{sub-section:getLabelForElementNamegetClientProperty_seeprs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNamegetClientProperty_seeprs|trigger=none|class=sIndent}\{[Object]} key -- user interface key (depends on operating system)
{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkret}{td}*External linksReturns*\\{sub-section:getLabelForElementNamegetClientProperty_linkret|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNamegetClientProperty_linkret|trigger=none|class=sIndent}[Object] -- The value of the property for specified key.{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=samsee}{td}*SampleAlso see*\\{sub-section:getLabelForElementNamegetClientProperty_samsee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLabelForElementNamegetClientProperty_samsee|trigger=none}{code:language=javascript}
var name = forms.customer.elements.customer_id.getLabelForElementName();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationX|class=nodebuilder-show}{builder-show:permission=edit}{tr:id=namelink}{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*External links*\\{sub-section:getClientProperty_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getClientProperty_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=dessam}{td}*Sample*\\{sub-section:getLocationXgetClientProperty_dessam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetClientProperty_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 ysam|trigger=none}{code:language=javascript}
var property = forms.companycustomer.elements.faxBtncustomer_id.getLocationYgetClientProperty();
//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'ToolTipText');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDataProviderID|class=node}{tr:id=name}{td}h6.getDataProviderID{td}{tr}{tr:id=sncsig}{td}*Since*\\{sub-section:getLocationX_snc|text=|trigger=button}{sub-section}{sub-section:getLocationX_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit{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=prsdes}{td}*Parameters*\\{sub-section:getLocationXgetDataProviderID_prsdes|text=|trigger=button}{sub-section}{sub-section:getLocationX_prs|trigger=none|class=sIndent}getDataProviderID_des|trigger=none|class=sIndent}Get the data provider this UI element (display) is showing.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=retsnc}{td}*ReturnsSince*\\{sub-section:getLocationXgetDataProviderID_retsnc|text=|trigger=button}{sub-section}{sub-section:getLocationXgetDataProviderID_retsnc|trigger=none|class=sIndent}[Number] --Replace Thewith x location of the element in pixels.version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=seeprs}{td}*Also seeParameters*\\{sub-section:getLocationXgetDataProviderID_seeprs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetDataProviderID_seeprs|trigger=none|class=sIndent}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linkret}{td}*External linksReturns*\\{sub-section:getLocationXgetDataProviderID_linkret|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetDataProviderID_linkret|trigger=none|class=sIndent}[String] -- The data provider as String.{sub-section}{div}{td}{tr}{builder-show:permission=edit}{tr:id=samsee}{td}*SampleAlso see*\\{sub-section:getLocationXgetDataProviderID_samsee|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationXgetDataProviderID_samsee|trigger=none}{code:language=javascript}
var x = forms.customer.elements.customer_id.getLocationX();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationY|class=nodebuilder-show}{builder-show:permission=edit}{tr:id=namelink}{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*External links*\\{sub-section:getDataProviderID_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getDataProviderID_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=dessam}{td}*Sample*\\{sub-section:getLocationYgetDataProviderID_dessam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationYgetDataProviderID_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);sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.getDataProviderID();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getElementType|class=node}{tr:id=name}{td}h6.getElementType{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getElementType{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getElementType_des|text=|trigger=button}{sub-section}{sub-section:getElementType_des|trigger=none|class=sIndent}Returns the type of a specified element.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getLocationYgetElementType_snc|text=|trigger=button}{sub-section}{sub-section:getLocationYgetElementType_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getLocationYgetElementType_prs|text=|trigger=button}{sub-section}{sub-section:getLocationYgetElementType_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getLocationYgetElementType_ret|text=|trigger=button}{sub-section}{sub-section:getLocationYgetElementType_ret|trigger=none|class=sIndent}[NumberString] -- The ydisplay locationtype of the element inas pixelsString.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getLocationYgetElementType_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationYgetElementType_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getLocationYgetElementType_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationYgetElementType_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getLocationYgetElementType_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLocationYgetElementType_sam|trigger=none}{code:language=javascript}
var yet = forms.customer.elements.customer_id.getLocationYgetElementType();
{code}{sub-section}{div-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getHeight|class=node}{tr:id=name}{td}h6.getHeight{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getHeight{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:classid=lastDetailRowdes}{td}{td}{tr}{tbody}{tbody:id=getName|class=node}{tr:id=name}{td}h6.getName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getName_des|text=|trigger=button}{sub-section}{sub-section:getName_des|trigger=none|class=sIndent}Returns the name of an element. (may be null as well)sub-section:getHeight_des|text=|trigger=button}{sub-section}{sub-section:getHeight_des|trigger=none|class=sIndent}Returns the height of the current element.
NOTE: getHeight() can be used with getWidth() to set the size of an element using the setSize function. For example:
//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getNamegetHeight_snc|text=|trigger=button}{sub-section}{sub-section:getNamegetHeight_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getNamegetHeight_prs|text=|trigger=button}{sub-section}{sub-section:getNamegetHeight_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getNamegetHeight_ret|text=|trigger=button}{sub-section}{sub-section:getNamegetHeight_ret|trigger=none|class=sIndent}[StringNumber] -- The nameheight of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getNamegetHeight_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getNamegetHeight_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getNamegetHeight_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getNamegetHeight_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getNamegetHeight_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getNamegetHeight_sam|trigger=none}{code:language=javascript}
var nameht = forms.customer.elements.customer_id.getNamegetHeight();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getParameterValuegetLabelForElementName|class=node}{tr:id=name}{td}h6.getParameterValuegetLabelForElementName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getParameterValuegetLabelForElementName{span}{span:id=iets|style=float: left;}\(param){span}{td}{tr}{tr:id=des}{td}{sub-section:getParameterValuegetLabelForElementName_des|text=|trigger=button}{sub-section}{sub-section:getParameterValue_des|trigger=none|class=sIndent}Gets the http request parameter for a submit within html label-section:getLabelForElementName_des|trigger=none|class=sIndent}Gets the label for property of a label. This property is used to link a label to a certain element (by default used for tableview header, form security, can be used for custom purposes ).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getParameterValuegetLabelForElementName_snc|text=|trigger=button}{sub-section}{sub-section:getParameterValuegetLabelForElementName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getParameterValuegetLabelForElementName_prs|text=|trigger=button}{sub-section}{sub-section:getParameterValuegetLabelForElementName_prs|trigger=none|class=sIndent}\{[String]} param -- Parameter that was sent in request.
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getParameterValuegetLabelForElementName_ret|text=|trigger=button}{sub-section}{sub-section:getParameterValuegetLabelForElementName_ret|trigger=none|class=sIndent}[String] -- The parameterlabel valuefor asproperty (String).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getParameterValuegetLabelForElementName_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getParameterValuegetLabelForElementName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getParameterValuegetLabelForElementName_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getParameterValuegetLabelForElementName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getParameterValuegetLabelForElementName_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getParameterValuegetLabelForElementName_sam|trigger=none}{code:language=javascript}
var paramname = forms.customer.elements.customer_id.getParameterValuegetLabelForElementName('my_parameter');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getThumbnailJPGImagegetLocationX|class=node}{tr:id=name}{td}h6.getThumbnailJPGImagegetLocationX{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}byte[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getThumbnailJPGImagegetLocationX{span}{span:id=iets|style=float: left;}\(\[width\], \[height\]){span}{td}{tr}{tr:id=des}{td}{sub-section:getThumbnailJPGImagegetLocationX_des|text=|trigger=button}{sub-section}{sub-section:getThumbnailJPGImagegetLocationX_des|trigger=none|class=sIndent}Returns the x location imageof datathe incurrent .jpg format from an icon; thumbnailing only works in record view.
Syntax
elements.elementName.getThumbnailJPGImage(\[width\],\[height\])element.
NOTE: getLocationX() can be used with getLocationY() to set the location of an element using the setLocation function. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getThumbnailJPGImagegetLocationX_snc|text=|trigger=button}{sub-section}{sub-section:getThumbnailJPGImagegetLocationX_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getThumbnailJPGImagegetLocationX_prs|text=|trigger=button}{sub-section}{sub-section:getThumbnailJPGImagegetLocationX_prs|trigger=none|class=sIndent}\[width\] -- The target width, if not specified original image width will be used.
\[height\] -- The target height, if not specified original image width will be used.
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getThumbnailJPGImagegetLocationX_ret|text=|trigger=button}{sub-section}{sub-section:getThumbnailJPGImagegetLocationX_ret|trigger=none|class=sIndent}byte[Number] -- AnThe x arraylocation of bytesthe element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getThumbnailJPGImagegetLocationX_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getThumbnailJPGImagegetLocationX_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getThumbnailJPGImagegetLocationX_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getThumbnailJPGImagegetLocationX_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getThumbnailJPGImagegetLocationX_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getThumbnailJPGImagegetLocationX_sam|trigger=none}{code:language=javascript}
var jpgDatax = forms.customer.elements.customer_id.getThumbnailJPGImage(50,50);
application.writeFile("mypicture.jpg", jpgDatagetLocationX();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getWidthgetLocationY|class=node}{tr:id=name}{td}h6.getWidthgetLocationY{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}getWidthgetLocationY{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getWidthgetLocationY_des|text=|trigger=button}{sub-section}{sub-section:getWidthgetLocationY_des|trigger=none|class=sIndent}Returns the widthy location of the current element.
NOTE: getWidthgetLocationY() can be used with getHeightgetLocationX() to set the sizelocation of an element using the setSizesetLocation function. For Example:
//returns the width (w)X and heightY (h)coordinates
var wx = forms.company.elements.faxBtn.getWidthgetLocationX();
var hy = forms.company.elements.faxBtn.getHeightgetLocationY();
//sets the new sizelocation forms.company.elements.faxBtn.setSize(w,h);
//sets10 px to the new size and adds 1right; 10 px todown bothfrom the widthcurrent andlocation
height
forms.company.elements.faxBtn.setSizesetLocation(wx+110,hy+110);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getWidthgetLocationY_snc|text=|trigger=button}{sub-section}{sub-section:getWidthgetLocationY_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getWidthgetLocationY_prs|text=|trigger=button}{sub-section}{sub-section:getWidthgetLocationY_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getWidthgetLocationY_ret|text=|trigger=button}{sub-section}{sub-section:getWidthgetLocationY_ret|trigger=none|class=sIndent}[Number] -- The widthy location of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getWidthgetLocationY_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getWidthgetLocationY_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getWidthgetLocationY_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getWidthgetLocationY_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getWidthgetLocationY_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getWidthgetLocationY_sam|trigger=none}{code:language=javascript}
var wy = forms.customer.elements.customer_id.getWidthgetLocationY();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=putClientPropertygetName|class=node}{tr:id=name}{td}h6.putClientPropertygetName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void[String]{span}{span:id=iets|style=float: left; font-weight: bold;}putClientPropertygetName{span}{span:id=iets|style=float: left;}\(key, value){span}{td}{tr}{tr:id=des}{td}{sub-section:putClientPropertygetName_des|text=|trigger=button}{sub-section}{sub-section:putClientPropertygetName_des|trigger=none|class=sIndent}SetsReturns the valuename forof the specifiedan element client property key. (may NOTE:be Dependingnull on the operating system, a user interface property name may be available.as well){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:putClientPropertygetName_snc|text=|trigger=button}{sub-section}{sub-section:putClientPropertygetName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:putClientPropertygetName_prs|text=|trigger=button}{sub-section}{sub-section:putClientPropertygetName_prs|trigger=none|class=sIndent}\{[Object]} key -- user interface key (depends on operating system)
\{[Object]} value -- a predefined value for the key
=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:putClientPropertygetName_ret|text=|trigger=button}{sub-section}{sub-section:putClientPropertygetName_ret|trigger=none|class=sIndent}void[String] -- The name of the element.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:putClientPropertygetName_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:putClientPropertygetName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:putClientPropertygetName_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:putClientPropertygetName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:putClientPropertygetName_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:putClientPropertygetName_sam|trigger=none}{code:language=javascript}
var name = forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text'getName();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setBordergetThumbnailJPGImage|class=node}{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){spantd}h6.getThumbnailJPGImage{td}{tr}{tr:id=dessig}{td}{sub-section:setBorder_des|text=|trigger=button}{sub-section}{sub-section:setBorder_des|trigger=none|class=sIndent}Sets the border attribute(s) of a specified element.
The border attributes:
borderType \- EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder.
size \- (numeric value) for: bottom, left, right, top.
color \- (hexadecimal value) for: bottom, left, right, top.
dash pattern \- (numeric value) for selected side(s).
rounding radius \- (numeric value) for selected side(s).
NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType".span:style=float: left; margin-right: 5px;}byte[]{span}{span:id=iets|style=float: left; font-weight: bold;}getThumbnailJPGImage{span}{span:id=iets|style=float: left;}\(\[width\], \[height\]){span}{td}{tr}{tr:id=des}{td}{sub-section:getThumbnailJPGImage_des|text=|trigger=button}{sub-section}{sub-section:getThumbnailJPGImage_des|trigger=none|class=sIndent}Returns the image data in .jpg format from an icon; thumbnailing only works in record view.
Syntax
elements.elementName.getThumbnailJPGImage(\[width\],\[height\]){sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setBordergetThumbnailJPGImage_snc|text=|trigger=button}{sub-section}{sub-section:setBordergetThumbnailJPGImage_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setBordergetThumbnailJPGImage_prs|text=|trigger=button}{sub-section}{sub-section:setBordergetThumbnailJPGImage_prs|trigger=none|class=sIndent}\{[String]} spec -- the border attributeswidth\] -- The target width, if not specified original image width will be used.
\[height\] -- The target height, if not specified original image width will be used.
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setBordergetThumbnailJPGImage_ret|text=|trigger=button}{sub-section}{sub-section:setBordergetThumbnailJPGImage_ret|trigger=none|class=sIndent}voidbyte[] -- An array of bytes.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setBordergetThumbnailJPGImage_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setBordergetThumbnailJPGImage_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setBordergetThumbnailJPGImage_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setBordergetThumbnailJPGImage_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setBordergetThumbnailJPGImage_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setBordergetThumbnailJPGImage_sam|trigger=none}{code:language=javascript}
//sets the border type to "LineBorder"
//sets a 1 px line width for the bottom and left side of the border
//sets the hexadecimal color
of the border to "#ccffcc"
var bjpgData = forms.customer.elements.customer_id.setBordergetThumbnailJPGImage('LineBorder,1,#ccffcc'50,50);
application.writeFile("mypicture.jpg", jpgData);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setFontgetWidth|class=node}{tr:id=name}{td}h6.setFontgetWidth{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}setFontgetWidth{span}{span:id=iets|style=float: left;}\(spec){span}{td}{tr}{tr:id=des}{td}{sub-section:setFontgetWidth_des|text=|trigger=button}{sub-section}{sub-section:setFontgetWidth_des|trigger=none|class=sIndent}Sets the font name, style, andReturns 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:
font
name \-//returns the namewidth of(w) theand 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).height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setFontgetWidth_snc|text=|trigger=button}{sub-section}{sub-section:setFontgetWidth_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:setFontgetWidth_prs|text=|trigger=button}{sub-section}{sub-section:setFontgetWidth_prs|trigger=none|class=sIndent}\{[String]} spec -- the font name, style, size
{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:setFontgetWidth_ret|text=|trigger=button}{sub-section}{sub-section:setFontgetWidth_ret|trigger=none|class=sIndent}void[Number] -- The width of the element in pixels.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setFontgetWidth_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setFontgetWidth_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setFontgetWidth_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setFontgetWidth_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setFontgetWidth_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setFontgetWidth_sam|trigger=none}{code:language=javascript}
var w = forms.customer.elements.customer_id.setFont('Tahoma,1,11'getWidth();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setImageURLputClientProperty|class=node}{tr:id=name}{td}h6.setImageURLputClientProperty{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setImageURLputClientProperty{span}{span:id=iets|style=float: left;}\(urlkey, value){span}{td}{tr}{tr:id=des}{td}{sub-section:setImageURLputClientProperty_des|text=|trigger=button}{sub-section}{sub-section:setImageURLputClientProperty_des|trigger=none|class=sIndent}Sets the value for the image displayed on a button or label; based on URL.
Syntax
elements.elementName.setImageURL(String) specified element client property key.
NOTE: Depending on the operating system, a user interface property name may be available.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setImageURLputClientProperty_snc|text=|trigger=button}{sub-section}{sub-section:setImageURLputClientProperty_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setImageURLputClientProperty_prs|text=|trigger=button}{sub-section}{sub-section:setImageURLputClientProperty_prs|trigger=none|class=sIndent}url -- the specified URL.
}\{[Object]} key -- user interface key (depends on operating system)
\{[Object]} value -- a predefined value for the key
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setImageURLputClientProperty_ret|text=|trigger=button}{sub-section}{sub-section:setImageURLputClientProperty_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setImageURLputClientProperty_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setImageURLputClientProperty_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setImageURLputClientProperty_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setImageURLputClientProperty_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setImageURLputClientProperty_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setImageURL_sam|trigger=none}{code:language=javascript}
//dynamically sets an image displayed on a button or label
forms.customer.elements.customer_id.setImageURL("http://www.servoy.com/images/test.gif");
//sets an image from your own image library
forms.customer.elements.customer_id.setImageURL("media:///arrow.gif");
//loads an image (BLOB) from a field in a selected record into HTML
}{sub-section:putClientProperty_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setImageURLputClientProperty('media:///servoy_blobloader?datasource='+controller.getDataSource()+'&dataprovider=image_data&mimetype=image/jpeg&rowid1=2ToolTipText','some text');
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setLocation|class=node}{tr:id=name}{td}h6.setLocation{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setLocation{span}{span:id=iets|style=float: left;}\(x, y){span}{td}{tr}{tr:id=des}{td}{sub-section:setLocation_des|text=|trigger=button}{sub-section}{sub-section:setLocation_des|trigger=none|class=sIndent}Sets the location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates \- starting from the TOP LEFT side of the screen.
NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setLocation_snc|text=|trigger=button}{sub-section}{sub-section:setLocation_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setLocation_prs|text=|trigger=button}{sub-section}{sub-section:setLocation_prs|trigger=none|class=sIndent}\{[Number]} x -- the X coordinate of the element in pixels.
\{[Number]} y -- the Y coordinate of the element in pixels.
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setLocation_ret|text=|trigger=button}{sub-section}{sub-section:setLocation_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setLocation_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setLocation_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setLocation_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setLocation_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setLocation_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setLocation_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setLocation(200,200);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setSize|class=node}{tr:id=name}{td}h6.setSize{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setSize{span}{span:id=iets|style=float: left;}\(width, height){span}{td}{tr}{tr:id=des}{td}{sub-section:setSize_des|text=|trigger=button}{sub-section}{sub-section:setSize_des|trigger=none|class=sIndent}Sets the size of the field. It takes as input the width and the height.
NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:
//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setSize_snc|text=|trigger=button}{sub-section}{sub-section:setSize_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setSize_prs|text=|trigger=button}{sub-section}{sub-section:setSize_prs|trigger=none|class=sIndent}\{[Number]} width -- the width of the element in pixels.
\{[Number]} height -- the height of the element in pixels.
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setSize_ret|text=|trigger=button}{sub-section}{sub-section:setSize_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setSize_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setSize_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setSize_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setSize_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setSize_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:setSize_sam|trigger=none}{code:language=javascript}
forms.customer.elements.customer_id.setSize(20,30);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |
Overview
Content Tools
Activity