Table Row (tr) |
---|
| Table Head (th) |
---|
| Method Details |
| }{:=}{td}h6.addTab{td}{tr}{tr:id=sig}{td}{span:style= }[]{span}{span:style= }{span}{span}\ \\ \\ \\ \\ \\ \\ \ [relatedfoundset/relationname |
|
|
| \ \[index\]){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Adds a relationless or related form as a tab in a specified tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}form/formname -- the specified form/form name you wish to add as a tab
\[name\] -- the specified name for the tab or NULL (default is null)
\[tabText\] -- the specified text for the tab (default is null)
\[tooltip\] -- a specified tooltip for the tab (default is null)
\[iconURL\] -- a specified icon image or icon URL for the tab (default is null)
\[fg\] -- the HTML RGB Hexadecimal foreground color for the tab (default is null)
\[bg\] -- the HTML RGB Hexadecimal background color for the tab (default is null)
\[relatedfoundset/relationname\] -- the specified name of the related foundset (default is null)
\[index\] -- the specified index of a tab, default is \-1, will add tab to the end
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- a boolean value indicating if tab was successfully added{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Adds a relationless or related form as a tab in a specified tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| form/formname – the specified form/form name you wish to add as a tab [name] – the specified name for the tab or NULL (default is null) [tabText] – the specified text for the tab (default is null) [tooltip] – a specified tooltip for the tab (default is null) [iconURL] – a specified icon image or icon URL for the tab (default is null) [fg] – the HTML RGB Hexadecimal foreground color for the tab (default is null) [bg] – the HTML RGB Hexadecimal background color for the tab (default is null) [relatedfoundset/relationname] – the specified name of the related foundset (default is null) [index] – the specified index of a tab, default is -1, will add tab to the end |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Boolean – a boolean value indicating if tab was successfully added |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
forms.customer.elements.customer_id.addTab(forms.orders,'ordersTab','Orders',null,null,'#000000', |
|
|
|
| '#BBCCEE');
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getAbsoluteFormLocationY}{tr:id=name}{td}h6.getAbsoluteFormLocationY{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getAbsoluteFormLocationY{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the absolute form (designed) Y location.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- The y location of the form in pixels.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
id | getAbsoluteFormLocationY |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getAbsoluteFormLocationY |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the absolute form (designed) Y location. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Number – The y location of the form in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY(); |
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getClientProperty-Object}{tr:id=name}{td}h6.getClientProperty{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Object]{span}{span:style=font-weight: bold;}getClientProperty{span}{span}\(key){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets the specified client property for the element based on a key.
NOTE: Depending on the operating system, a user interface property name may be available.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} key -- user interface key (depends on operating system)
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Object] -- The value of the property for specified key.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
id | getClientProperty-Object |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getClientProperty |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Gets the specified client property for the element based on a key. NOTE: Depending on the operating system, a user interface property name may be available. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Object} key – user interface key (depends on operating system) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Object – The value of the property for specified key. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDesignTimeProperty}{tr:id=name}{td}h6.getDesignTimeProperty{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Object]{span}{span:style=font-weight: bold;}getDesignTimeProperty{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get a design\-time property of an element.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Object]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getDesignTimeProperty |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
| getDesignTimeProperty |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Get a design-time property of an element. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getElementType}{tr:id=name}{td}h6.getElementType{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getElementType{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the type of a specified element.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The display type of the element as String.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getElementType |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the type of a specified element. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| String – The display type of the element as String. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var et = forms.customer.elements.customer_id.getElementType();
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getHeight}{tr:id=name}{td}h6.getHeight{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getHeight{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the height of the current element.
NOTE: getHeight() can be used with getWidth() to set the size of an element using the setSize function. For example:
//returns the width (w) and height (h)
var w = Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the height of the current element. NOTE: getHeight() can be used with getWidth() to set the size of an element using the setSize function. For example: //returns the width (w) and height (h) var w = forms.company.elements.faxBtn.getWidth(); |
|
|
|
forms.company.elements.faxBtn.getHeight(); |
|
|
|
forms.company.elements.faxBtn.setSize(w,h);
|
|
|
|
forms.company.elements.faxBtn.setSize(w+1,h+
|
|
|
| 1);{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- The height of the element in pixels.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Number – The height of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var ht = forms.customer.elements.customer_id.getHeight();
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationX}{tr:id=name}{td}h6.getLocationX{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getLocationX{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the x location of the current element.
NOTE: getLocationX() can be used with getLocationY() to set the location of an element using the setLocation function. For Example:
//returns the X and Y coordinates
var x = Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getLocationX |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the x location of the current element. NOTE: getLocationX() can be used with getLocationY() to set the location of an element using the setLocation function. For Example: //returns the X and Y coordinates var x = forms.company.elements.faxBtn.getLocationX(); |
|
|
|
forms.company.elements.faxBtn.getLocationY(); |
|
|
|
forms.company.elements.faxBtn.setLocation(x+10,y+10);
|
|
|
| {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- The x location of the element in pixels.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Number – The x location of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var x = forms.customer.elements.customer_id.getLocationX();
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLocationY}{tr:id=name}{td}h6.getLocationY{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getLocationY{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the y location of the current element.
NOTE: getLocationY() can be used with getLocationX() to set the location of an element using the setLocation function. For Example:
//returns the X and Y coordinates
var x = Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getLocationY |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the y location of the current element. NOTE: getLocationY() can be used with getLocationX() to set the location of an element using the setLocation function. For Example: //returns the X and Y coordinates var x = forms.company.elements.faxBtn.getLocationX(); |
|
|
|
forms.company.elements.faxBtn.getLocationY(); |
|
|
|
forms.company.elements.faxBtn.setLocation(x+10,y+10);
|
|
|
| {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- The y location of the element in pixels.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Number – The y location of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var y = forms.customer.elements.customer_id.getLocationY();
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getMaxTabIndex}{tr:id=name}{td}h6.getMaxTabIndex{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getMaxTabIndex{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the maximum tab index for a specified tabpanel.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- maximum tab index (number){div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getMaxTabIndex |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the maximum tab index for a specified tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Number – maximum tab index (number) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var max = forms.customer.elements.customer_id.getMaxTabIndex();
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getMnemonicAt-Number}{tr:id=name}{td}h6.getMnemonicAt{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getMnemonicAt{span}{span}\(i){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the mnemonic for a specified tab of a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} i -- The number of the specified tab.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The mnemonic.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getMnemonicAt |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the mnemonic for a specified tab of a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} i – The number of the specified tab. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var mnemonic = forms.customer.elements.customer_id.getMnemonicAt(3);
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getName}{tr:id=name}{td}h6.getName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the name of an element. (may be null as well){div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The name of the element.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the name of an element. (may be null as well) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| String – The name of the element. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var name = forms.customer.elements.customer_id.getName();
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTabFGColorAt-Number}{tr:id=name}{td}h6.getTabFGColorAt{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getTabFGColorAt{span}{span}\(i){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the foreground color for a specified tab of a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} i -- the number of the specified tab
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- color as hexadecimal RGB string{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getTabFGColorAt |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the foreground color for a specified tab of a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} i – the number of the specified tab |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| String – color as hexadecimal RGB string |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var color = forms.customer.elements.customer_id.getTabFGColorAt(3);
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTabFormNameAt-Number}{tr:id=name}{td}h6.getTabFormNameAt{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getTabFormNameAt{span}{span}\(i){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the form name for a specified tab of a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} i -- index of the tab
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- the name of the form{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
id | getTabFormNameAt-Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the form name for a specified tab of a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} i – index of the tab |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| String – the name of the form |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var formName = forms.customer.elements.customer_id.getSelectedTabFormName(3);
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTabNameAt-Number}{tr:id=name}{td}h6.getTabNameAt{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getTabNameAt{span}{span}\(i){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the name \- the "name" design time property value \- for a specified tab of a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} i -- The number of the specified tab.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The tab name{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getTabNameAt |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the name - the "name" design time property value - for a specified tab of a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} i – The number of the specified tab. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var tabName = forms.customer.elements.customer_id.getTabNameAt(3);
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTabRelationNameAt-Number}{tr:id=name}{td}h6.getTabRelationNameAt{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getTabRelationNameAt{span}{span}\(i){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the relation name for a specified tab of a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} i -- index of the tab
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- relation name{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
id | getTabRelationNameAt-Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getTabRelationNameAt |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the relation name for a specified tab of a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} i – index of the tab |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var relName = forms.customer.elements.customer_id.getTabRelationNameAt(3);
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTabTextAt-Number}{tr:id=name}{td}h6.getTabTextAt{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getTabTextAt{span}{span}\(i){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the text for a specified tab of a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} i -- The number of the specified tab.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The tab text.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getTabTextAt |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the text for a specified tab of a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} i – The number of the specified tab. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var tabText = forms.customer.elements.customer_id.getTabTextAt(3);
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getWidth}{tr:id=name}{td}h6.getWidth{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getWidth{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the width of the current element.
NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:
//returns the width (w) and height (h)
var w = Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the width of the current element. NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example: //returns the width (w) and height (h) var w = forms.company.elements.faxBtn.getWidth(); |
|
|
|
forms.company.elements.faxBtn.getHeight(); |
|
|
|
forms.company.elements.faxBtn.setSize(w,h);
|
|
|
|
forms.company.elements.faxBtn.setSize(w+1,h+1);
|
|
|
| {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- The width of the element in pixels.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Number – The width of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var w = forms.customer.elements.customer_id.getWidth();
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isTabEnabledAt-Number}{tr:id=name}{td}h6.isTabEnabledAt{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}isTabEnabledAt{span}{span}\(i){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the enabled status of a specified tab in a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} i -- the number of the specified tab.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- True if tab is enabled, false otherwise.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
isTabEnabledAt |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns the enabled status of a specified tab in a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} i – the number of the specified tab. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Boolean – True if tab is enabled, false otherwise. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
var status = forms.customer.elements.customer_id.isTabEnabledAt(3);
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id= Table Body (tbody) |
---|
id | putClientProperty-Object_Object |
---|
| }{:=}{td}h6.putClientProperty{td}{tr}{tr:id=sig}{td}{span:style= | Table Cell (td) |
---|
putClientProperty |
|
| }{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets the value for the specified element client property key.
NOTE: Depending on the operating system, a user interface property name may be available.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} key -- user interface key (depends on operating system)
\{[Object]} value -- a predefined value for the key
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Sets the value for the specified element client property key. NOTE: Depending on the operating system, a user interface property name may be available. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Object} key – user interface key (depends on operating system) {Object} value – a predefined value for the key |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some |
|
|
|
| text');
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeAllTabs}{tr:id=name}{td}h6.removeAllTabs{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}removeAllTabs{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Removes all tabs for a specified tabpanel.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- a boolean value indicating if tabs were successfully removed{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
removeAllTabs |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Removes all tabs for a specified tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Boolean – a boolean value indicating if tabs were successfully removed |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
forms.customer.elements.customer_id.removeAllTabs() |
|
|
|
| ;
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeTabAt-}{tr:id=name}{td}h6.removeTabAt{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}removeTabAt{span}{span}\(index){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Removes a specified tab in a tabpanel; can be based on a relation or relationless.
NOTE: In Servoy 4.x (and higher), the addTab function applies to relationless or related tabs in a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}index -- The index of the tab to remove.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- a boolean value indicating if tab was successfully removed{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
removeTabAt |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Removes a specified tab in a tabpanel; can be based on a relation or relationless. NOTE: In Servoy 4.x (and higher), the addTab function applies to relationless or related tabs in a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| index – The index of the tab to remove. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns
Div |
---|
| Boolean – a boolean value indicating if tab was successfully removed |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
forms.customer.elements.customer_id.removeTabAt(3);
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id= Table Body (tbody) |
---|
id | setLocation-Number_Number |
---|
| }{:=}{td}h6.setLocation{td}{tr}{tr:id=sig}{td}{span:style= | Table Cell (td) |
---|
setLocation |
|
| }{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets the location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates \- starting from the TOP LEFT side of the screen.
Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example:
//returns the X and Y coordinates
var x = Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Sets the location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen. Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation. NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example: //returns the X and Y coordinates var x = forms.company.elements.faxBtn.getLocationX(); |
|
|
|
forms.company.elements.faxBtn.getLocationY(); |
|
|
|
forms.company.elements.faxBtn.setLocation(x+10,y+10);
|
|
|
| {div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} x -- the X coordinate of the element in pixels.
\{[Number]} y -- the Y coordinate of the element in pixels.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} x – the X coordinate of the element in pixels. {Number} y – the Y coordinate of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
forms.customer.elements.customer_id.setLocation(200,200 |
|
|
|
| );
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setMnemonicAt-_}{tr:id=name}{td}h6.setMnemonicAt{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setMnemonicAt{span}{span}\(index, text){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets the mnemonic for a specified tab in a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}index -- the number of the specified tab
text -- the text to be set for the specified tab
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setMnemonicAt |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Sets the mnemonic for a specified tab in a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| index – the number of the specified tab text – the text to be set for the specified tab |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
forms.customer.elements.customer_id.setMnemonicAt(3,'a');
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=}{:=}{td}h6.setSize{td}{tr}{tr:id=sig}{td}{span:style= }{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets the size of an element. It takes as input the width and the height.
Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:
//returns the width (w) and height (h)
var w = Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Sets the size of an element. It takes as input the width and the height. Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation. NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example: //returns the width (w) and height (h) var w = forms.company.elements.faxBtn.getWidth(); |
|
|
|
forms.company.elements.faxBtn.getHeight(); |
|
|
|
forms.company.elements.faxBtn.setSize(w,h);
|
|
|
|
forms.company.elements.faxBtn.setSize(w+1,h+1);
|
|
|
| {div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} width -- the width of the element in pixels.
\{[Number]} height -- the height of the element in pixels.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} width – the width of the element in pixels. {Number} height – the height of the element in pixels. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
forms.customer.elements.customer_id.setSize(20,30);
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id= Table Body (tbody) |
---|
id | setTabEnabledAt-Number_Boolean |
---|
| }{:=name}{td}h6.setTabEnabledAt{td}{tr}{tr:id=sig}{td}{span:style= | Table Cell (td) |
---|
setTabEnabledAt |
|
| }{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets the status of a specified tab in a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} i -- the number of the specified tab.
\{[Boolean]} b -- true if enabled; or false if disabled.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Sets the status of a specified tab in a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} i – the number of the specified tab. {Boolean} b – true if enabled; or false if disabled. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
forms.customer.elements.customer_id.setTabEnabledAt(3 |
|
|
|
| ,true);
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id= Table Body (tbody) |
---|
id | setTabFGColorAt-Number_String |
---|
| }{:=}{td}h6.setTabFGColorAt{td}{tr}{tr:id=sig}{td}{span:style= | Table Cell (td) |
---|
setTabFGColorAt |
|
| }{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets the foreground color for a specified tab in a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} i -- the number of the specified tab
\{[String]} s -- the hexadecimal RGB color value to be set.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Sets the foreground color for a specified tab in a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| {Number} i – the number of the specified tab {String} s – the hexadecimal RGB color value to be set. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
forms.customer.elements.customer_id.setTabFGColorAt(3,'#000000');
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setTabTextAt-_}{tr:id=name}{td}h6.setTabTextAt{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setTabTextAt{span}{span}\(index, text){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets the text for a specified tab in a tabpanel.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}index -- the number of the specified tab
text -- the text to be set for the specified tab
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
setTabTextAt |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Sets the text for a specified tab in a tabpanel. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters
Div |
---|
| index – the number of the specified tab text – the text to be set for the specified tab |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample
Div |
---|
| Code Block |
---|
|
forms.customer.elements.customer_id.setTabTextAt(3,'newTitle');
|
|
|
|
| {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |