ph_getccobjwidth PowerHome formula function
Description
Retrieves the width for the specified Control Center object.
Syntax
ph_getccobjwidth ( )
ph_getccobjwidth ( 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 graphic
object. If this parameter is omitted, the system variable CCOBJ will be used
|
Return value
Long. Returns the width of the specified object. Returns -1 if the object is not found.
Usage
Use this function to retrieve
the width for a Control Center object on a CC tab. A typical use of this
function would be to retrieve 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 get 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_getccobjwidth("TV","POWER") -
Returns the width for the CC object POWER located on the TV tab of the Control
Center