May 21, 2024 13:14 Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients SampleSupported Clients
SmartClient
WebClient
NGClient
MobileClient
Extends
RuntimeComponent
Property Summary
String
bgcolor
Gets or sets the background color of a field.
String
border
Gets or sets the border attribute(s) of a specified element.
Boolean
enabled
Gets or sets the enabled state of a specified field, also known as "grayed".
String
fgcolor
Gets or sets the foreground color of a field.
String
font
Gets or sets the font name, style, and size of an element.
String
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.
String
imageURL
Gets/Sets the image displayed on a button or label; based on URL.
String
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.
String
rolloverImageURL
Gets/Sets the image displayed on a button or label roll over; based on URL.
String
text
Gets or sets the text that is displayed on the label, button or image.
String
toolTipText
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.
Boolean
transparent
Gets or sets the transparency of an element; true - transparent; false - not transparent.
Boolean
visible
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).
Methods Summary
void
addStyleClass(styleName)
Adds a style to the styleClass property.
Number
getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
Object
getClientProperty(key)
Gets the specified client property for the element based on a key.
String
getDataProviderID()
Get the data provider this UI element (display) is showing.
Object
getDesignTimeProperty(key)
Get a design-time property of an element.
String
getElementType()
Returns the type of a specified element.
String
getFormName()
Returns the name of the form.
Number
getHeight()
Returns the height of the current element.
Number
getLocationX()
Returns the x location of the current element.
Number
getLocationY()
Returns the y location of the current element.
String
getName()
Returns the name of an element.
Array
getThumbnailJPGImage()
Returns the image data in .
Array
getThumbnailJPGImage(width, height)
Returns the image data in .
Number
getWidth()
Returns the width of the current element.
void
putClientProperty(key, value)
Sets the value for the specified element client property key.
void
removeStyleClass(styleName)
Removes a style from the styleClass property.
void
requestFocus()
Request the focus in this element.
void
requestFocus(mustExecuteOnFocusGainedMethod)
Request the focus in this element.
void
setLocation(x, y)
Sets the location of an element.
void
setSize(width, height)
Sets the size of an element.
Property Details
bgcolor
//sets the background color of the field
%%prefix%%%%elementName%%.bgcolor = "#FFFFFF";
//gets the background color of the field
var c = %%prefix%%%%elementName%%.bgcolor;
border
//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"
%%prefix%%%%elementName%%.border = 'LineBorder,1,#ccffcc';
enabled
//gets the enabled state of the field
var currState = %%prefix%%%%elementName%%.enabled;
//sets the enabled state of the field
%%prefix%%%%elementName%%.enabled = !currentState;
fgcolor
//sets the foreground color of the field
%%prefix%%%%elementName%%.fgcolor = "#000000";
//gets the foreground color of the field
var c = %%prefix%%%%elementName%%.fgcolor;
font
%%prefix%%%%elementName%%.font = 'Tahoma,1,11';
format
//sets the display formatting of the field
%%prefix%%%%elementName%%.format = '###';
//gets the display formatting of the field
var format = %%prefix%%%%elementName%%.format;
imageURL
//dynamically sets an image displayed on a button or label
%%prefix%%%%elementName%%.imageURL = "http://www.servoy.com/images/test.gif";
//sets an image from your own image library
%%prefix%%%%elementName%%.imageURL = "media:///arrow.gif";
//loads an image (BLOB) from a field in a selected record into HTML
%%prefix%%%%elementName%%.imageURL = 'media:///servoy_blobloader?datasource='+controller.getDataSource()+'&dataprovider=image_data&mimetype=image/jpeg&rowid1=2';
mnemonic
//gets the mnemonic of the element
var my_mnemoic = %%prefix%%%%elementName%%.mnemonic;
//sets the mnemonic of the element
%%prefix%%%%elementName%%.mnemonic = 'f';
rolloverImageURL
//dynamically sets a roll over image displayed on a button or label
%%prefix%%%%elementName%%.rolloverImageURL = "http://www.servoy.com/images/test.gif";
//sets an image from your own image library
%%prefix%%%%elementName%%.rolloverImageURL = "media:///arrow.gif";
//loads an image (BLOB) from a field in a selected record into HTML
%%prefix%%%%elementName%%.rolloverImageURL = 'media:///servoy_blobloader?datasource='+controller.getDataSource()+'&dataprovider=image_data&mimetype=image/jpeg&rowid1=2';
text
//gets the text of the element
var my_text = %%prefix%%%%elementName%%.text;
//sets the text of the element
%%prefix%%%%elementName%%.text = my_text + 'is cool';
toolTipText
//gets the tooltip text of the element
var toolTip = %%prefix%%%%elementName%%.toolTipText;
//sets the tooltip text of the element
%%prefix%%%%elementName%%.toolTipText = "New tip";
%%prefix%%%%elementName%%.toolTipText = "<html>This includes <b>bolded text</b> and <font color='blue'>BLUE</font> text as well.";
transparent
//gets the transparency of the element
var currentState = %%prefix%%%%elementName%%.transparent;
//sets the transparency of the element
%%prefix%%%%elementName%%.transparent = !currentState;
visible
//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;
Methods Details
addStyleClass(styleName)
String
styleName
the name of the style class to add
%%prefix%%%%elementName%%.addStyleClass('redbg');
getAbsoluteFormLocationY()
var absolute_y = %%prefix%%%%elementName%%.getAbsoluteFormLocationY();
getClientProperty(key)
Object
key
user interface key (depends on operating system)
var property = %%prefix%%%%elementName%%.getClientProperty('ToolTipText');
getDataProviderID()
%%prefix%%%%elementName%%.getDataProviderID();
getDesignTimeProperty(key)
String
key
the name of the property
var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')
getElementType()
var et = %%prefix%%%%elementName%%.getElementType();
getFormName()
var name = %%prefix%%%%elementName%%.getFormName();
getHeight()
var ht = %%prefix%%%%elementName%%.getHeight();
getLocationX()
var x = %%prefix%%%%elementName%%.getLocationX();
getLocationY()
var y = %%prefix%%%%elementName%%.getLocationY();
getName()
var name = %%prefix%%%%elementName%%.getName();
getThumbnailJPGImage()
var jpgData = %%prefix%%%%elementName%%.getThumbnailJPGImage();
plugins.file.writeFile("mypicture.jpg", jpgData);
getThumbnailJPGImage(width, height)
Number
width
The target width, use -1 for original image width.
Number
height
The target height, use -1 for original image height.
var jpgData = %%prefix%%%%elementName%%.getThumbnailJPGImage(50, 50);
plugins.file.writeFile("mypicture.jpg", jpgData);
getWidth()
var w = %%prefix%%%%elementName%%.getWidth();
putClientProperty(key, value)
Object
key
user interface key (depends on operating system)
Object
value
a predefined value for the key
%%prefix%%%%elementName%%.putClientProperty('ToolTipText','some text');
removeStyleClass(styleName)
String
styleName
the name of the style class to remove
%%prefix%%%%elementName%%.removeStyleClass('redbg');
requestFocus()
//request the focus in this %%prefix%%%%elementName%% (focus is also a text cursor on text components)
%%prefix%%%%elementName%%.requestFocus();
requestFocus(mustExecuteOnFocusGainedMethod)
Boolean
mustExecuteOnFocusGainedMethod
If true will execute onFocusGained method, else will not; default value is true.
//request the focus in this %%prefix%%%%elementName%% (focus is also a text cursor on text components), skip on focus gained method call
%%prefix%%%%elementName%%.requestFocus(false);
setLocation(x, y)
Number
x
the X coordinate of the element in pixels.
Number
y
the Y coordinate of the element in pixels.
%%prefix%%%%elementName%%.setLocation(200,200);
setSize(width, height)
Number
width
the width of the element in pixels.
Number
height
the height of the element in pixels.
%%prefix%%%%elementName%%.setSize(20,30);