Apr 29, 2024 02:52 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 Parameters Returns 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 Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Supported Clients Sample Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Returns 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).
Object
tabIndex
Gets or sets the selected tab index for the specified tabpanel.
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.
Boolean
addTab(form/formname, name, tabText, tooltip, iconURL, fg, bg, relatedfoundset/relationname, index)
Adds a relationless or related form as a tab in a specified tabpanel.
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.
Number
getMaxTabIndex()
Returns the maximum tab index for a specified tabpanel.
String
getMnemonicAt(i)
Returns the mnemonic for a specified tab of a tabpanel.
String
getName()
Returns the name of an element.
String
getTabFGColorAt(i)
Returns the foreground color for a specified tab of a tabpanel.
String
getTabFormNameAt(i)
Returns the form name for a specified tab of a tabpanel.
String
getTabNameAt(i)
Returns the name - the "name" design time property value - for a specified tab of a tabpanel.
String
getTabRelationNameAt(i)
Returns the relation name for a specified tab of a tabpanel.
String
getTabTextAt(i)
Returns the text for a specified tab of a tabpanel.
Number
getWidth()
Returns the width of the current element.
Boolean
isTabEnabledAt(i)
Returns the enabled status of a specified tab in a tabpanel.
void
putClientProperty(key, value)
Sets the value for the specified element client property key.
Boolean
removeAllTabs()
Removes all tabs for a specified tabpanel.
void
removeStyleClass(styleName)
Removes a style from the styleClass property.
Boolean
removeTabAt(index)
Removes a specified tab in a tabpanel; can be based on a relation or relationless.
void
setLocation(x, y)
Sets the location of an element.
void
setMnemonicAt(index, text)
Sets the mnemonic for a specified tab in a tabpanel.
void
setSize(width, height)
Sets the size of an element.
void
setTabEnabledAt(i, b)
Sets the status of a specified tab in a tabpanel.
void
setTabFGColorAt(i, s)
Sets the foreground color for a specified tab in a tabpanel.
void
setTabTextAt(index, text)
Sets the text for a specified tab in a tabpanel.
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;
tabIndex
//gets the selected tab index of the tabpanel
var current = %%prefix%%%%elementName%%.tabIndex;
//sets (goes to) the selected tabIndex of the tabpanel
%%prefix%%%%elementName%%.tabIndex = current + 1;
//or sets (goes to) the tab with the specified name
%%prefix%%%%elementName%%.tabIndex = 'tab_name';
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');
addTab(form/formname, name, tabText, tooltip, iconURL, fg, bg, relatedfoundset/relationname, index)
void
form/formname
the specified form/form name you wish to add as a tab
void
name
the specified name for the tab or NULL (default is null)
void
tabText
the specified text for the tab (default is null)
void
tooltip
a specified tooltip for the tab (default is null)
void
iconURL
a specified icon image or icon URL for the tab (default is null)
void
fg
the HTML RGB Hexadecimal foreground color for the tab (default is null)
void
bg
the HTML RGB Hexadecimal background color for the tab (default is null)
void
relatedfoundset/relationname
the specified name of the related foundset (default is null)
void
index
the specified index of a tab, default is -1, will add tab to the end, this index is 0 based
%%prefix%%%%elementName%%.addTab(forms.orders,'ordersTab','Orders',null,null,'#000000','#BBCCEE');
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();
getMaxTabIndex()
var max = %%prefix%%%%elementName%%.getMaxTabIndex();
getMnemonicAt(i)
Number
i
The number of the specified tab.
var mnemonic = %%prefix%%%%elementName%%.getMnemonicAt(3);
getName()
var name = %%prefix%%%%elementName%%.getName();
getTabFGColorAt(i)
Number
i
the number of the specified tab
var color = %%prefix%%%%elementName%%.getTabFGColorAt(3);
getTabFormNameAt(i)
Number
i
index of the tab
var formName = %%prefix%%%%elementName%%.getSelectedTabFormName(3);
getTabNameAt(i)
Number
i
The number of the specified tab.
var tabName = %%prefix%%%%elementName%%.getTabNameAt(3);
getTabRelationNameAt(i)
Number
i
index of the tab
var relName = %%prefix%%%%elementName%%.getTabRelationNameAt(3);
getTabTextAt(i)
Number
i
The number of the specified tab.
var tabText = %%prefix%%%%elementName%%.getTabTextAt(3);
getWidth()
var w = %%prefix%%%%elementName%%.getWidth();
isTabEnabledAt(i)
Number
i
the number of the specified tab.
var status = %%prefix%%%%elementName%%.isTabEnabledAt(3);
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');
removeAllTabs()
%%prefix%%%%elementName%%.removeAllTabs();
removeStyleClass(styleName)
String
styleName
the name of the style class to remove
%%prefix%%%%elementName%%.removeStyleClass('redbg');
removeTabAt(index)
void
index
The index of the tab to remove.
%%prefix%%%%elementName%%.removeTabAt(3);
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');
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);
setTabEnabledAt(i, b)
Number
i
the number of the specified tab.
Boolean
b
true if enabled; or false if disabled.
%%prefix%%%%elementName%%.setTabEnabledAt(3,true);
setTabFGColorAt(i, s)
Number
i
the number of the specified tab
String
s
the hexadecimal RGB color value to be set.
%%prefix%%%%elementName%%.setTabFGColorAt(3,'#000000');
setTabTextAt(index, text)
void
index
the number of the specified tab
void
text
the text to be set for the specified tab
%%prefix%%%%elementName%%.setTabTextAt(3,'newTitle');