ph_getccobjborder PowerHome formula function
Description
Retrieves the border value for the specified Control Center object.
Syntax
ph_getccobjborder ( )
ph_getccobjborder ( as_tab, as_id )
| 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
|
Return value
Integer. Returns the border value of the specified object. 0 is returned for no border, 2 is returned for a box border, 5 is returned for a lower border, 6 is returned for a raised border, and 10 is returned for a button border. Returns -1 if the object is not found.
Usage
Use this function to retrieve the
border value for a Control Center object on a CC tab. A
typical use of this function would be to retrieve 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 get 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_getccobjborder( ) - If called
from within a formula that was triggered by the action of a Control Center
object, returns the border value for that CC
object
• ph_getccobjborder("TV","POWER") - Returns the border
value for the POWER object on the TV Control Center
tab