ph_setccobjwidth PowerHome formula function
Description
Sets the width for the specified Control Center object
Syntax
ph_setccobjwidth ( ai_width )
ph_setccobjwidth ( as_tab, as_id, ai_width )
| 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_width
|
Integer . The width value to set the specified CC object to
|
Return value
Long. Returns 0
Usage
Use this function to set
the width for a Control Center object on a CC tab. A typical use of this
function would be to set the current width 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 width 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_setccobjwidth("TV","POWER",200)
- Sets
the width for the POWER object on the TV tab to
200