ph_setccobjx PowerHome formula function
Description
Sets the x value for the specified Control Center object
Syntax
ph_setccobjx ( ai_x )
ph_setccobjx ( as_tab, as_id, ai_x )
| 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_x
|
Integer . The x value to set the specified CC object to. This is the horizontal position of the upper left corner of the object
|
Return value
Long. Returns 0
Usage
Use this function
to set the x value for
a Control Center object on a CC tab. A typical use of this function would
be to set the current x position 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 x 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_setccobjx("TV","POWER",320)
-
Sets the
x position for the POWER object on the TV tab to
320