ph_setccobjborder PowerHome formula function
Description
Updates the border value for the specified Control Center object
Syntax
ph_setccobjborder ( ai_border )
ph_setccobjborder ( as_tab, as_id, ai_border )
| 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_border
|
Integer. The border of the object. 0 = No border, 2 = Box, 5 = lowered, 6 = raised, and 10 = button
|
Return value
Integer. Returns 0
Usage
Use this function to update the
border value for a Control Center object on a CC tab. A
typical use of this function would be to set the current border
value 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 border value 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_setccobjborder(5)
- If called from within
a formula that was triggered by the action of a Control Center object, sets
the border value for that CC object to
"lowered"
• ph_setccobjborder("TV","POWER",6) -
Sets the border value for
the POWER object on the TV Control Center tab to
"raised"