Child pages
  • RuntimeLabel

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay: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
iddescription



HTML Table
id
classservoy sReturnTypes
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Extends
Table Row (tr)
Table Cell (td)
Span
classsWordList
RuntimeComponent



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
bgcolor
Gets or sets the background color of a field.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
border
Gets or sets the border attribute(s) of a specified element.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
enabled
Gets or sets the enabled state of a specified field, also known as "grayed".
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
fgcolor
Gets or sets the foreground color of a field.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
font
Gets or sets the font name, style, and size of an element.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
format
Gets or sets the display formatting of an element for number and text values; does not affect the actual value stored in the database column.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
imageURL
Gets/Sets the image displayed on a button or label; based on URL.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
mnemonic
Gets or sets the specified character(s) - typically an underlined letter- used with/without the modifier key(s) for the label, button or image.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
rolloverImageURL
Gets/Sets the image displayed on a button or label roll over; based on URL.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
text
Gets or sets the text that is displayed on the label, button or image.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
toolTipText
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
transparent
Gets or sets the transparency of an element; true - transparent; false - not transparent.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
visible
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
getClientProperty(key)
Gets the specified client property for the element based on a key.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getDataProviderID()
Get the data provider this UI element (display) is showing.
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
getDesignTimeProperty()
Get a design-time property of an element.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getElementType()
Returns the type of a specified element.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getHeight()
Returns the height of the current element.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getLabelForElementName()
Gets the label for property of a label.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getLocationX()
Returns the x location of the current element.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getLocationY()
Returns the y location of the current element.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getName()
Returns the name of an element.
Table Row (tr)
Table Cell (td)
byte[]
Table Cell (td)
getThumbnailJPGImage()
Returns the image data in .
Table Row (tr)
Table Cell (td)
byte[]
Table Cell (td)
getThumbnailJPGImage(width, height)
Returns the image data in .
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getWidth()
Returns the width of the current element.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
putClientProperty(key, value)
Sets the value for the specified element client property key.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setLocation(x, y)
Sets the 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
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Details
Table Body (tbody)
idbgcolor
Table Row (tr)
idname
Table Cell (td)

bgcolor

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idborder
Table Row (tr)
idname
Table Cell (td)

border

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Gets 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".

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idenabled
Table Row (tr)
idname
Table Cell (td)

enabled

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idfgcolor
Table Row (tr)
idname
Table Cell (td)

fgcolor

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idfont
Table Row (tr)
idname
Table Cell (td)

font

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.font = 'Tahoma,1,11';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idformat
Table Row (tr)
idname
Table Cell (td)

format

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Gets or sets the display formatting of an element for number and text values; does not affect the actual value stored in the database column.

There are different options for the different dataprovider types that are assigned to this field.
For Integer fields, there is a display and an edit format, using http://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html and the max (string) length can be set.
For Text/String fields, there are options to force uppercase,lowercase or only numbers. Or a mask can be set that restrict the input the pattern chars can be found here: http://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html
A mask can have a placehoder (what is shown when there is no data) and if the data must be stored raw (without literals of the mask). A max text length can also be set to force
the max text length input, this doesn't work on mask because that max length is controlled with the mask.
For Date fields a display and edit format can be set by using a pattern from here: http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html, you can also say this must behave like a mask (the edit format)
A mask only works with when the edit format is exactly that mask (1 char is 1 number/char), because for example MM then only 2 numbers are allowed MMM that displays the month as a string is not supported as a mask.
Some examples are "dd-MM-yyyy", "MM-dd-yyyy", etc.
The format property is also used to set the UI Converter, this means that you can convert the value object to something else before it gets set into the field, this can also result in a type change of the data.
So a string in scripting/db is converted to a integer in the ui, then you have to set an integer format.
It only returns it's correct value if it was explicitly set, otherwise null.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//sets the display formatting of the field
forms.customer.elements.customer_id.format = '###';

//gets the display formatting of the field
var format = forms.customer.elements.customer_id.format;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idimageURL
Table Row (tr)
idname
Table Cell (td)

imageURL

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets/Sets the image displayed on a button or label; based on URL.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//dynamically sets an image displayed on a button or label
forms.customer.elements.customer_id.imageURL = "http://www.servoy.com/images/test.gif";

//sets an image from your own image library
forms.customer.elements.customer_id.imageURL = "media:///arrow.gif";

//loads an image (BLOB) from a field in a selected record into HTML
forms.customer.elements.customer_id.imageURL = 'media:///servoy_blobloader?datasource='+controller.getDataSource()+'&dataprovider=image_data&mimetype=image/jpeg&rowid1=2';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idmnemonic
Table Row (tr)
idname
Table Cell (td)

mnemonic

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idrolloverImageURL
Table Row (tr)
idname
Table Cell (td)

rolloverImageURL

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets/Sets the image displayed on a button or label roll over; based on URL.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtext
Table Row (tr)
idname
Table Cell (td)

text

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Gets or sets the text that is displayed on the label, button or image.

NOTE: The .text property applies to labels, buttons, or images ONLY.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtoolTipText
Table Row (tr)
idname
Table Cell (td)

toolTipText

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.

NOTE: HTML should be used for multi-line tooltips; you can also use any valid HTML tags to format tooltip text.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtransparent
Table Row (tr)
idname
Table Cell (td)

transparent

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idvisible
Table Row (tr)
idname
Table Cell (td)

visible

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idgetAbsoluteFormLocationY
Table Row (tr)
idname
Table Cell (td)

getAbsoluteFormLocationY

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getAbsoluteFormLocationY
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the absolute form (designed) Y location.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - The y location of the form in pixels.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetClientProperty-Object
Table Row (tr)
idname
Table Cell (td)

getClientProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
getClientProperty
Span
(key)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Gets the specified client property for the element based on a key.

NOTE: Depending on the operating system, a user interface property name may be available.

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} key - user interface key (depends on operating system)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object - The value of the property for specified key.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDataProviderID
Table Row (tr)
idname
Table Cell (td)

getDataProviderID

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getDataProviderID
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the data provider this UI element (display) is showing.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - The data provider as String.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.getDataProviderID();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDesignTimeProperty
Table Row (tr)
idname
Table Cell (td)

getDesignTimeProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
getDesignTimeProperty
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get a design-time property of an element.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetElementType
Table Row (tr)
idname
Table Cell (td)

getElementType

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getElementType
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the type of a specified element.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - The display type of the element as String.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var et = forms.customer.elements.customer_id.getElementType();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetHeight
Table Row (tr)
idname
Table Cell (td)

getHeight

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getHeight
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Returns the height of the current element.
NOTE: getHeight() can be used with getWidth() to set the size of an element using the setSize function. For example:

//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();

//sets the new size
forms.company.elements.faxBtn.setSize(w,h);

//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - The height of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var ht = forms.customer.elements.customer_id.getHeight();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetLabelForElementName
Table Row (tr)
idname
Table Cell (td)

getLabelForElementName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getLabelForElementName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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 ).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - The label for property (String).
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var name = forms.customer.elements.customer_id.getLabelForElementName();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetLocationX
Table Row (tr)
idname
Table Cell (td)

getLocationX

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getLocationX
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Returns the x location of the current element.

NOTE: getLocationX() can be used with getLocationY() to set the location of an element using the setLocation function. For Example:

//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();

//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - The x location of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var x = forms.customer.elements.customer_id.getLocationX();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetLocationY
Table Row (tr)
idname
Table Cell (td)

getLocationY

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getLocationY
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Returns the y location of the current element.

NOTE: getLocationY() can be used with getLocationX() to set the location of an element using the setLocation function. For Example:

//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();

//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - The y location of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var y =  forms.customer.elements.customer_id.getLocationY();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetName
Table Row (tr)
idname
Table Cell (td)

getName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the name of an element. (may be null as well)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - The name of the element.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var name = forms.customer.elements.customer_id.getName();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetThumbnailJPGImage
Table Row (tr)
idname
Table Cell (td)

getThumbnailJPGImage

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
byte[]
Span
stylefont-weight: bold;
getThumbnailJPGImage
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the image data in .jpg format from an icon; thumbnailing only works in record view.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
byte[] - An array of bytes.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var jpgData = forms.customer.elements.customer_id.getThumbnailJPGImage();
plugins.file.writeFile("mypicture.jpg", jpgData);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetThumbnailJPGImage-Number_Number
Table Row (tr)
idname
Table Cell (td)

getThumbnailJPGImage

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
byte[]
Span
stylefont-weight: bold;
getThumbnailJPGImage
Span
(width, height)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the image data in .jpg format from an icon; thumbnailing only works in record view.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} width - The target width, use -1 for original image width.
{Number} height - The target height, use -1 for original image height.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
byte[] - An array of bytes.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var jpgData = forms.customer.elements.customer_id.getThumbnailJPGImage(50, 50);
plugins.file.writeFile("mypicture.jpg", jpgData);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetWidth
Table Row (tr)
idname
Table Cell (td)

getWidth

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getWidth
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Returns the width of the current element.

NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:

//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();

//sets the new size
forms.company.elements.faxBtn.setSize(w,h);

//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - The width of the element in pixels.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var w = forms.customer.elements.customer_id.getWidth();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idputClientProperty-Object_Object
Table Row (tr)
idname
Table Cell (td)

putClientProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
putClientProperty
Span
(key, value)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Sets the value for the specified element client property key.

NOTE: Depending on the operating system, a user interface property name may be available.

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} key - user interface key (depends on operating system)
{Object} value - a predefined value for the key
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetLocation-Number_Number
Table Row (tr)
idname
Table Cell (td)

setLocation

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setLocation
Span
(x, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} x - the X coordinate of the element in pixels.
{Number} y - the Y coordinate of the element in pixels.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.setLocation(200,200);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetSize-Number_Number
Table Row (tr)
idname
Table Cell (td)

setSize

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setSize
Span
(width, height)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Sets the size of an element. It takes as input the width and the height.
Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.

NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:

//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();

//sets the new size
forms.company.elements.faxBtn.setSize(w,h);

//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} width - the width of the element in pixels.
{Number} height - the height of the element in pixels.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.elements.customer_id.setSize(20,30);
Table Row (tr)
classlastDetailRow
Table Cell (td)