ph_setccobjheight PowerHome formula function
Description
Sets the height for the specified Control Center object.
Syntax
ph_setccobjheight ( ai_height )
ph_setccobjheight ( as_tab, as_id, ai_height )
| Argument |
Description |
|
as_tab
|
String (Optional). The ID of the Control Center tab containing the object. If this parameter is omitted, the system variable CCTAB will be used
|
|
as_id
|
String (Optional). The ID of the Control Center object on the specified tab. If this parameter is omitted, the system variable CCOBJ will be used
|
|
ai_height
|
Integer< /span > . The height value to set the
specified CC object to< /span >
|
Return value
Long. Returns 0
Usage
Use this function to set
the height for a Control Center object on a CC tab. A typical use of this
function would be to set the current height of a Control Center
object that was triggered and initiated an action such as a formula or macro. In
that use case scenario, you can call the function without parameters
and the ID's for both the tab and object will be automatically supplied by the system variables. If you wish to set the height for a CC object other than one that initiated an action, you must specify both the tab and object ID's
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_setccobjheight("TV","POWER",200)
- Sets
the height for the POWER object on the TV tab to
200