ph_getccobjfcolor PowerHome formula function
Description
Retrieves the foreground color for the specified Control Center object.
Syntax
ph_getccobjfcolor ( )
ph_getccobjfcolor ( 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
Long. Returns the color value of the specified objects foreground. This value is equivalent to the value returned from the rgb() function. Returns -1 if the object is not found.
Usage
Use this function to retrieve the
foreground color for a Control Center object on a CC tab. A typical use of this
function would be to retrieve the current foreground color 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 foreground color 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_getccobjfcolor( ) - If called
from within a formula that was triggered by the action of a Control Center
object, returns the foreground color for that CC
object
• ph_getccobjfcolor("TV","POWER") - Returns the
foreground color for the POWER object on the TV Control Center
tab