RuntimeDataLabel

Unknown macro: {td}

bgcolor
Gets or sets the background color of a field.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

border
Gets or sets the border attribute(s) of a specified element.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

enabled
Gets or sets the enabled state of a specified field, also known as "grayed".

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

fgcolor
Gets or sets the foreground color of a field.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

font
Gets or sets the font name, style, and size of an element.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {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.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

imageURL
Gets/Sets the image displayed on a button or label; based on URL.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {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.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

rolloverImageURL
Gets/Sets the image displayed on a button or label roll over; based on URL.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

transparent
Gets or sets the transparency of an element; true - transparent; false - not transparent.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

visible
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getDataProviderID()
Get the data provider this UI element (display) is showing.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getDesignTimeProperty()
Get a design-time property of an element.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getElementType()
Returns the type of a specified element.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getHeight()
Returns the height of the current element.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getLabelForElementName()
Gets the label for property of a label.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getLocationX()
Returns the x location of the current element.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getLocationY()
Returns the y location of the current element.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getName()
Returns the name of an element.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

byte[]

Unknown macro: {td}

getThumbnailJPGImage()
Returns the image data in .

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

byte[]

Unknown macro: {td}

getThumbnailJPGImage(width, height)
Returns the image data in .

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getWidth()
Returns the width of the current element.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

putClientProperty(key, value)
Sets the value for the specified element client property key.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

setLocation(x, y)
Sets the location of an element.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

setSize(width, height)
Sets the size of an element.

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

bgcolor

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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;

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

border

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

enabled

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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;

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

fgcolor

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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;

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

font

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

forms.customer.elements.customer_id.font = 'Tahoma,1,11';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

format

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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;

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

imageURL

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mnemonic

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

rolloverImageURL

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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';

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

toolTipText

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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.";

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

transparent

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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;

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

visible

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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;

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getAbsoluteFormLocationY

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getAbsoluteFormLocationY

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number – The y location of the form in pixels.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getClientProperty

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getClientProperty

Unknown macro: {span}

(key)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Object} key – user interface key (depends on operating system)

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Object – The value of the property for specified key.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getDataProviderID

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getDataProviderID

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – The data provider as String.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

forms.customer.elements.customer_id.getDataProviderID();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getDesignTimeProperty

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getDesignTimeProperty

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getElementType

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getElementType

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – The display type of the element as String.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var et = forms.customer.elements.customer_id.getElementType();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getHeight

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getHeight

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number – The height of the element in pixels.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var ht = forms.customer.elements.customer_id.getHeight();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getLabelForElementName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getLabelForElementName

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – The label for property (String).

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var name = forms.customer.elements.customer_id.getLabelForElementName();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getLocationX

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getLocationX

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number – The x location of the element in pixels.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var x = forms.customer.elements.customer_id.getLocationX();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getLocationY

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getLocationY

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number – The y location of the element in pixels.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var y =  forms.customer.elements.customer_id.getLocationY();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getName

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – The name of the element.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var name = forms.customer.elements.customer_id.getName();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getThumbnailJPGImage

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

byte[]

Unknown macro: {span}

getThumbnailJPGImage

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

byte[] – An array of bytes.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var jpgData = forms.customer.elements.customer_id.getThumbnailJPGImage();
plugins.file.writeFile("mypicture.jpg", jpgData);

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getThumbnailJPGImage

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

byte[]

Unknown macro: {span}

getThumbnailJPGImage

Unknown macro: {span}

(width, height)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} width – The target width, use -1 for original image width.
{Number} height – The target height, use -1 for original image height.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

byte[] – An array of bytes.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var jpgData = forms.customer.elements.customer_id.getThumbnailJPGImage(50, 50);
plugins.file.writeFile("mypicture.jpg", jpgData);

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getWidth

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}