May 03, 2024 01:08 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 Supported Clients Sample Supported Clients Sample Supported Clients Sample Parameters Supported Clients Sample Returns Supported Clients Sample Parameters 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 Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients SampleSupported Clients
SmartClient
WebClient
NGClient
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.
Boolean
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).
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.
void
deleteRecord()
Deletes the currently selected portal row in the foundset of the specified portal.
void
duplicateRecord()
Duplicates the currently selected portal row in the foundset of the specified portal.
void
duplicateRecord(addOnTop)
Duplicates the currently selected portal row in the foundset of the specified portal.
Number
getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
Object
getClientProperty(key)
Gets the specified client property for the element based on a key.
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.
Number
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.
Number
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.
Number
getSelectedIndex()
Gets the selected record index in the current cached foundset in the specified portal.
String
getSortColumns()
Returns the sort columns names of the current portal (as comma separated string).
Number
getWidth()
Returns the width of the current element.
void
newRecord()
Creates a new portal row in the foundset of the specified portal.
void
newRecord(addOnTop)
Creates a new portal row in the foundset of the specified portal.
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
setLocation(x, y)
Sets the location of an element.
void
setScroll(x, y)
Sets the scroll location of an element.
void
setSelectedIndex(index)
Sets the selected record index in the current cached foundset in the specified portal.
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';
readOnly
//gets the editable/read-only state of the field
var currentState = %%prefix%%%%elementName%%.readOnly;
//sets the editable/read-only state of the field
%%prefix%%%%elementName%%.readOnly = !currentState;
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');
deleteRecord()
%%prefix%%%%elementName%%.deleteRecord();
duplicateRecord()
// adds the duplicated record on top
%%prefix%%%%elementName%%.duplicateRecord();
adds the duplicated record as the topmost record of the foundset
duplicateRecord(addOnTop)
Boolean
addOnTop
add on top (default true)
adds the duplicated record to the foundset
// adds the duplicated record on top
%%prefix%%%%elementName%%.duplicateRecord(true);
getAbsoluteFormLocationY()
var absolute_y = %%prefix%%%%elementName%%.getAbsoluteFormLocationY();
getClientProperty(key)
Object
key
user interface key (depends on operating system)
var property = %%prefix%%%%elementName%%.getClientProperty('ToolTipText');
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();
getScrollX()
var x = %%prefix%%%%elementName%%.getScrollX();
getScrollY()
var y = %%prefix%%%%elementName%%.getScrollY();
getSelectedIndex()
//gets the selected record index in the foundset
var current = %%prefix%%%%elementName%%.getSelectedIndex();
//sets the next record index in the foundset
%%prefix%%%%elementName%%.setSelectedIndex(current+1);
getSortColumns()
var w = %%prefix%%%%elementName%%.getSortColumns();
getWidth()
var w = %%prefix%%%%elementName%%.getWidth();
newRecord()
// foreign key data is only filled in for equals (=) relation items
%%prefix%%%%elementName%%.newRecord();
newRecord(addOnTop)
Boolean
addOnTop
adds the new portal record as the topmost row of the foundset, default value is true
// foreign key data is only filled in for equals (=) relation items
//adds the new record on top
%%prefix%%%%elementName%%.newRecord(true);
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');
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);
setScroll(x, y)
Number
x
the X coordinate of the portal scroll location in pixels
Number
y
the Y coordinate of the portal scroll location in pixels
%%prefix%%%%elementName%%.setScroll(200,200);
setSelectedIndex(index)
Number
index
the specified record index
//gets the selected record index in the foundset
var current = %%prefix%%%%elementName%%.getSelectedIndex();
//sets the next record index in the foundset
%%prefix%%%%elementName%%.setSelectedIndex(current+1);
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);