URL Gets or sets the relative URL string contained in a field
indexstyle
true
display:none
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.
Div
id
description
The HTMLArea provides a way to show and edit HTML content. The capabilities and how they are presented to the user differ between the Smart and Web Client.
Smart Client
The HTMLArea in the Smart Client unfortunately does not support modern day HTML-related standards like HMTL5 and CSS3. It supports HTML3, a subset of HTML4 and CSS2. As such, it can be used to display and edit basic formatted text.
When editing HTML through the HTMLArea in the Smart Client the MenuBar with edit options is shown in the window's menubar area, so not in or directly above the HTMLArea itself.
Possible replacements for the HMTLArea in the Smart Client are:
svyJFXWebView component: Servoy module that wraps JavaFX's WebView and makes it easily usable form within Servoy. Does not have a HTML Editor embedded by default as it is just a browser component, which can be used to show a HTML Editor like TinyMCE or CK Editor. The svyJFXWebView component does require Java 7 or higher
Browser Suite The Browser Suite can render modern HTML and also includes a HTML Editor component. The downside of the Browser Suite is a hefty additional download and it (currently) doesn't work under Java 7 on OSX
In the Web Client the content of a HTMLArea is rendered inline in the HTML markup of the Servoy form, thus it comes down to the capabi
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 relative URL string contained in a field with a design time display property of HTML_AREA only.Gets or sets the absolute base URL for the URL string contained in a field with a design time display property of HTML_AREA only.Gets or sets the background color of a field.Gets or sets the border attribute(s) of a specified element.Gets or sets the number value (position) of the text caret (text "I" bar) in a field.Gets or sets the editable/read-only state of a field; true - editable; false - read-only.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 editable/read-only state of a field; true - read-only; false - editable; ! - the editable/read-only state is inverted (the opposite).Gets or sets the title text.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 plain text for the formatted HTML/RTF text of a specified field element with a design time display property of HTML_AREA/RTF only.
readOnly Gets or sets the editable/read-only state of a field; true - read-only; false - editable; ! - the editable/read-only state is inverted (the opposite).
getAsPlainText() Gets the plain text for the formatted HTML/RTF text of a specified field element the specified client property for the element based on a key.Get the data provider this UI element (display) is showing.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 an Array of label element names that has this field filled in as the labelFor.Returns the x location of the current element.Returns the y location of the current element.Returns the name of an element.Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.Returns the currently selected text in the specified text field or text area.Returns the width of the current element.voidSets the value for the specified element client property key.voidRemoves a style from the styleClass property.voidReplaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.voidRequest the focus in this element.voidRequest the focus in this element.voidSelects all the contents of a field.voidSets the location of an element.voidSets the scroll location of an element.voidSets the size of an element.propertyservoy sDetail2100%height:30px2Property DetailsURLname
URL
dessIndentGets or sets the relative URL string contained in a field with a design time display property of HTML_AREA /RTF only.
getScrollX() Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.
getScrollY() Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.
setLocation(x, y) Sets the location of an element.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setScroll(x, y) Sets the scroll location of an element.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setSize(width, height) Sets the size of an element.
HTML Table
id
property
class
servoy sDetail
Colgroup Tag
Col
colspan
2
width
100%
Col
Table Head (thead)
Table Row (tr)
style
height: 30px;
Table Head (th)
colspan
2
Property Details
Table Body (tbody)
id
URL
Table Row (tr)
id
name
Table Cell (td)
URL
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the relative URL string contained in a field with a design time display property of HTML_AREA only.
NOTE: For information about field element design time properties, see the section on Field elements in the Forms chapter of the Servoy Developer User's Guide.
//sets the relative URL of the HTML_AREA field
forms.customer.elements.customer_id.URL = "http://www.examples.com/icon.gif";
//gets the relative URL of the HTML_AREA field
var theURL = forms.customer.elements.customer_id.URL;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
baseURL
Table Row (tr)
id
name
Table Cell (td)
baseURL
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the absolute base URL for the URL string contained in a field with a design time display property of HTML_AREA only.
//gets the base URL of theField when display is HTML_AREA
var baseURL = forms.customer.elements.customer_id.baseURL;
//sets the base URL of theField when display is HTML_AREA
forms.customer.elements.customer_id.baseURL = "http://www.examples.com";
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
bgcolor
Table Row (tr)
id
name
Table Cell (td)
bgcolor
Table Row (tr)
id
des
Table Cell (td)
Div
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. It only returns it's correct value if it was explicitly set.
//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;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
border
Table Row (tr)
id
name
Table Cell (td)
border
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the border attribute(s) of a specified element.
//sets the border type to "LineBorder"
//sets a 1 px line width for the bottom and left side of the border
//sets the hexadecimal color of the border to "#ccffcc"
forms.customer.elements.customer_id.border = 'LineBorder,1,#ccffcc';
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
caretPosition
Table Row (tr)
id
name
Table Cell (td)
caretPosition
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the number value (position) of the text caret (text "I" bar) in a field.
//get the current caretposition
var caretPos = forms.customer.elements.customer_id.caretPosition;
//add one and set it
forms.customer.elements.customer_id.caretPosition = caretPos+1;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
editable
Table Row (tr)
id
name
Table Cell (td)
editable
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Gets or sets the editable/read-only state of a field; true - editable; false - read-only.
NOTE the "!" operator can be used to invert the editable state.
var currentState = forms.customer.elements.customer_id.editable;
forms.customer.elements.customer_id.editable = !currentState;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
enabled
Table Row (tr)
id
name
Table Cell (td)
enabled
Table Row (tr)
id
des
Table Cell (td)
Div
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.
//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;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
fgcolor
Table Row (tr)
id
name
Table Cell (td)
fgcolor
Table Row (tr)
id
des
Table Cell (td)
Div
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. It only returns it's correct value if it was explicitly set.
//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;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
font
Table Row (tr)
id
name
Table Cell (td)
font
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
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.
Gets or sets the editable/read-only state of a field; true - read-only; false - editable; ! - the editable/read-only state is inverted (the opposite).
NOTE: A field set as read-only can be selected by clicking (or pressing the TAB key if this option is supported by the operating system) and the field data can be copied.
//gets the editable/read-only state of the field
var currentState = forms.customer.elements.customer_id.readOnly;
//sets the editable/read-only state of the field
forms.customer.elements.customer_id.readOnly = !currentState;
//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.";
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
transparent
Table Row (tr)
id
name
Table Cell (td)
transparent
Table Row (tr)
id
des
Table Cell (td)
Div
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
//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;
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
visible
Table Row (tr)
id
name
Table Cell (td)
visible
Table Row (tr)
id
des
Table Cell (td)
Div
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.
//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;
Gets the plain text for the formatted HTML/RTF text of a specified field element with a design time display property of HTML_AREA/RTF only.
NOTE: As of Servoy 4.x (and higher) you can also get/set the relative or absolute URL for an HTML_AREA field element. For more detail, see the .URL and .baseURL field element runtime properties earlier in this section.
NOTE: For information about field element design time properties, see the section on Field elements in the Forms chapter of the Servoy Developer User's Guide.
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);
//returns the current selected text
var my_text = forms.customer.elements.customer_id.getSelectedText();
//replaces the current selected text
forms.customer.elements.customer_id.replaceSelectedText('John');
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
requestFocus
Table Row (tr)
id
name
Table Cell (td)
requestFocus
Table Row (tr)
id
sig
Table Cell (td)
Span
style
margin-right: 5px;
void
Span
style
font-weight: bold;
requestFocus
Span
()
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Request the focus in this element. (Focus is also a text cursor on text components).
Table Row (tr)
id
ret
Table Cell (td)
Returns
Div
class
sIndent
void
Table Row (tr)
id
sam
Table Cell (td)
Sample
Div
class
sIndent
Code Block
language
javascript
//request the focus in this forms.customer.elements.customer_id (focus is also a text cursor on text components)
forms.customer.elements.customer_id.requestFocus();
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
requestFocus-Boolean
Table Row (tr)
id
name
Table Cell (td)
requestFocus
Table Row (tr)
id
sig
Table Cell (td)
Span
style
margin-right: 5px;
void
Span
style
font-weight: bold;
requestFocus
Span
(mustExecuteOnFocusGainedMethod)
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Request the focus in this element. (Focus is also a text cursor on text components).
Table Row (tr)
id
prs
Table Cell (td)
Parameters
Div
class
sIndent
{Boolean} mustExecuteOnFocusGainedMethod - If true will execute onFocusGained method, else will not; default value is true.
Table Row (tr)
id
ret
Table Cell (td)
Returns
Div
class
sIndent
void
Table Row (tr)
id
sam
Table Cell (td)
Sample
Div
class
sIndent
Code Block
language
javascript
//request the focus in this forms.customer.elements.customer_id (focus is also a text cursor on text components), skip on focus gained method call
forms.customer.elements.customer_id.requestFocus(false);
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
selectAll
Table Row (tr)
id
name
Table Cell (td)
selectAll
Table Row (tr)
id
sig
Table Cell (td)
Span
style
margin-right: 5px;
void
Span
style
font-weight: bold;
selectAll
Span
()
Table Row (tr)
id
des
Table Cell (td)
Div
class
sIndent
Selects all the contents of a field.
Table Row (tr)
id
ret
Table Cell (td)
Returns
Div
class
sIndent
void
Table Row (tr)
id
sam
Table Cell (td)
Sample
Div
class
sIndent
Code Block
language
javascript
forms.customer.elements.customer_id.selectAll();
Table Row (tr)
class
lastDetailRow
Table Cell (td)
Table Body (tbody)
id
setLocation-Number_Number
Table Row (tr)
id
name
Table Cell (td)
setLocation
Table Row (tr)
id
sig
Table Cell (td)
Span
style
margin-right: 5px;
void
Span
style
font-weight: bold;
setLocation
Span
(x, y)
Table Row (tr)
id
des
Table Cell (td)
Div
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. Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example:
//returns the X and Y coordinates var x = forms.company.elements.faxBtn.getLocationX(); var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location forms.company.elements.faxBtn.setLocation(x+10,y+10);
Table Row (tr)
id
prs
Table Cell (td)
Parameters
Div
class
sIndent
{Number} x - the X coordinate of the element in pixels. {Number} y - the Y coordinate of the element in pixels.
only. NOTE: For information about field element design time properties, see the section on Field elements in the Forms chapter of the Servoy Developer User's Guide.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow baseURLname
baseURL
dessIndentGets or sets the absolute base URL for the URL string contained in a field with a design time display property of HTML_AREA only.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow bgcolorname
bgcolor
dessIndentGets 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
sIdentjavascriptlastDetailRow bordername
border
dessIndentGets or sets the border attribute(s) of a specified element. The border attributes: borderType - EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder. size - (numeric value) for: bottom, left, right, top. color - (hexadecimal value) for: bottom, left, right, top. dash pattern - (numeric value) for selected side(s). rounding radius - (numeric value) for selected side(s). It only returns it's correct value if it was explicitly set. NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType".ret
dessIndentGets or sets the number value (position) of the text caret (text "I" bar) in a field. NOTE: This does not work in Web Client.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow editablename
editable
dessIndentGets or sets the editable/read-only state of a field; true - editable; false - read-only. NOTE the "!" operator can be used to invert the editable state.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow enabledname
enabled
dessIndentGets 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
sIdentjavascriptlastDetailRow fgcolorname
fgcolor
dessIndentGets 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
sIdentjavascriptlastDetailRow fontname
font
dessIndentGets 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
sIdentjavascriptlastDetailRow readOnlyname
readOnly
dessIndentGets or sets the editable/read-only state of a field; true - read-only; false - editable; ! - the editable/read-only state is inverted (the opposite). NOTE: A field set as read-only can be selected by clicking (or pressing the TAB key if this option is supported by the operating system) and the field data can be copied.ret
dessIndentGets 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
dessIndentGets 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 colorret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow visiblename
visible
dessIndentGets 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.ret
dessIndentGets the plain text for the formatted HTML/RTF text of a specified field element with a design time display property of HTML_AREA/RTF only. NOTE: This does not work in Web Client. NOTE: As of Servoy 4.x (and higher) you can also get/set the relative or absolute URL for an HTML_AREA field element. For more detail, see the .URL and .baseURL field element runtime properties earlier in this section. NOTE: For information about field element design time properties, see the section on Field elements in the Forms chapter of the Servoy Developer User's Guide.ret
dessIndentGets 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
dessIndentReturns the name of the form. (may be empty string as well)ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow getHeightname
getHeight()
dessIndentReturns 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
dessIndentReturns 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
dessIndentReturns 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 forms.company.elements.faxBtn.setLocation(x+10,y+10);ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow getNamename
getName()
dessIndentReturns the name of an element. (may be null as well)ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow getScrollXname
getScrollX()
dessIndentReturns the x scroll location of specified element - only for an element where height of element is less than the height of element content. NOTE: getScrollX() can be used with getScrollY() to set the scroll location of an element using the setScroll function. For Example: //returns the X and Y scroll coordinates var x = forms.company.elements.portal50.getScrollX(); var y = forms.company.elements.portal50.getScrollY(); //sets the new scroll location forms.company.elements.portal50.setScroll(x+10,y+10);ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow getScrollYname
getScrollY()
dessIndentReturns the y scroll location of specified element - only for an element where height of element is less than the height of element content. NOTE: getScrollY() can be used with getScrollX() to set the scroll location of an element using the setScroll function. For Example: //returns the X and Y scroll coordinates var x = forms.company.elements.portal50.getScrollX(); var y = forms.company.elements.portal50.getScrollY(); //sets the new scroll location forms.company.elements.portal50.setScroll(x+10,y+10);ret
dessIndentReturns the currently selected text in the specified text field or text area. NOTE: This does not work for text fields in the Web Client.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow getWidthname
getWidth()
dessIndentReturns 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
dessIndentSets 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 keyret
dessIndentReplaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position. NOTE: replaceSelectedText applies to text fields and all XXX_AREA displayType text - RTF_AREA, HTML_AREA, or TEXT_AREA.prs
dessIndentSets the location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen. Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation. NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example: //returns the X and Y coordinates var x = forms.company.elements.faxBtn.getLocationX(); var y = forms.company.elements.faxBtn.getLocationY(); //sets the new location 10 px to the right; 10 px down from the current location forms.company.elements.faxBtn.setLocation(x+10,y+10);prs
Parameters
sIndentxthe X coordinate of the element in pixels.ythe Y coordinate of the element in pixels.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow setScrollname
setScroll(x, y)
dessIndentSets the scroll location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for an element where the height of the element is greater than the height of element content
NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of an element; then use the X and Y coordinates with the setScroll function to set a new scroll location. For Example:
//returns the X and Y coordinates var x = forms.company.elements.portal50.getScrollX(); var y = forms.company.elements.portal50.getScrollY();
//sets the new location forms.company.elements.portal50.setScroll(x+10,y+10);
Table Row (tr)
id
prs
Table Cell (td)
Parameters
Div
class
sIndent
{Number} x - the X coordinate of the portal scroll location in pixels {Number} y - the Y coordinate of the portal scroll location in pixels
the height of element content NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of an element; then use the X and Y coordinates with the setScroll function to set a new scroll location. For Example: //returns the X and Y coordinates var x = forms.company.elements.portal50.getScrollX(); var y = forms.company.elements.portal50.getScrollY(); //sets the new location forms.company.elements.portal50.setScroll(x+10,y+10);prs
Parameters
sIndentxthe X coordinate of the portal scroll location in pixelsythe Y coordinate of the portal scroll location in pixelsret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow setSizename
setSize(width, height)
dessIndentSets the size of an element. It takes as input the width and the height. Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation. NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example: //returns the width (w) and height (h) var w = forms.company.elements.faxBtn.getWidth(); var h = forms.company.elements.faxBtn.getHeight(); //sets the new size forms.company.elements.faxBtn.setSize(w,h); //sets the new size and adds 1 px to both the width and height forms.company.elements.faxBtn.setSize(w+1,h+1);
Table Row (tr)
id
prs
td
class
;prs
Parameters
Div
sIndent{Number} width- the width of the element in pixels. {Number} height- the height of the element in pixels.