May 03, 2024 05:26 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 Returns Supported Clients Sample Returns 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 Parameters Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns 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
continuousLayout
Gets or sets if the components should continuously be redrawn as the divider changes position.
Number
dividerLocation
Gets or sets divider location.
Number
dividerSize
Gets or sets divider size in pixels.
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.
Number
leftFormMinSize
Gets or sets left form minimum size in pixels.
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).
Number
resizeWeight
Specifies how to distribute extra space when the size of the split pane changes.
Number
rightFormMinSize
Gets or sets right form minimum size in pixels.
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.
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.
RuntimeForm
getLeftForm()
Returns the left form of the split pane.
Number
getLocationX()
Returns the x location of the current element.
Number
getLocationY()
Returns the y location of the current element.
String
getMnemonicAt(i)
Returns the mnemonic for a specified tab of a tabpanel.
String
getName()
Returns the name of an element.
RuntimeForm
getRightForm()
Returns the right form of the split pane.
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.
Boolean
setLeftForm(form)
Set a relationless or related form as left panel.
Boolean
setLeftForm(form, relation)
Set a relationless or related form as left panel.
void
setLocation(x, y)
Sets the location of an element.
void
setMnemonicAt(index, text)
Sets the mnemonic for a specified tab in a tabpanel.
Boolean
setRightForm(form)
Set a relationless or related form as right panel.
Boolean
setRightForm(form, relation)
Set a relationless or related form as right panel.
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';
continuousLayout
%%prefix%%%%elementName%%.continuousLayout = true;
dividerLocation
%%prefix%%%%elementName%%.dividerLocation = 0.75;
dividerSize
%%prefix%%%%elementName%%.dividerSize = 10;
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';
leftFormMinSize
%%prefix%%%%elementName%%.leftFormMinSize = 100;
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;
resizeWeight
%%prefix%%%%elementName%%.resizeWeight = 0.5;
rightFormMinSize
%%prefix%%%%elementName%%.rightFormMinSize = 100;
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');
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();
getLeftForm()
var leftForm = %%prefix%%%%elementName%%.getLeftForm();
getLocationX()
var x = %%prefix%%%%elementName%%.getLocationX();
getLocationY()
var y = %%prefix%%%%elementName%%.getLocationY();
getMnemonicAt(i)
Number
i
The number of the specified tab.
var mnemonic = %%prefix%%%%elementName%%.getMnemonicAt(3);
getName()
var name = %%prefix%%%%elementName%%.getName();
getRightForm()
var rightForm = %%prefix%%%%elementName%%.getRightForm();
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');
setLeftForm(form)
Object
form
the specified form or form name you wish to add as left panel
%%prefix%%%%elementName%%.setLeftForm(forms.orders);
setLeftForm(form, relation)
Object
form
the specified form or form name you wish to add as left panel
Object
relation
the relation name or a related foundset or null for relationless
%%prefix%%%%elementName%%.setLeftForm(forms.orders,'orders_to_order_details');
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);
setMnemonicAt(index, text)
void
index
the number of the specified tab
void
text
the text to be set for the specified tab
%%prefix%%%%elementName%%.setMnemonicAt(3,'a');
setRightForm(form)
Object
form
the specified form or form name you wish to add as right panel
%%prefix%%%%elementName%%.setRightForm(forms.orders);
setRightForm(form, relation)
Object
form
the specified form or form name you wish to add as right panel
Object
relation
the relation name or a related foundset or null for relationless
%%prefix%%%%elementName%%.setRightForm(forms.orders,'orders_to_order_details');
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);