version 1
CT SET REFNUM (area; scope; refNum)
| Parameter | Type | Description | |
| area | Longint | 4D Chart area | |
| scope | Longint | Scope of the command | |
| -2 = Default | |||
| -1 = All | |||
| 0 = Selected objects | |||
| >0 = Object ID | |||
| refNum | Longint | Reference number |
Description
CT SET REFNUM makes refNum the reference number for the objects in area described by scope. A reference number is like an object name: it is a way to identify an object but it is not unique. A reference number is not an object ID number, which is a unique number assigned by 4D Chart for each object in a document.
If scope equals -2, CT SET REFNUM sets the default reference number. This is the reference number that will be used for any new objects.
If scope equals -1, CT SET REFNUM sets the reference number for all objects in the document.
If scope equals 0, CT SET REFNUM sets the reference number for the selected objects.
If scope is greater than 0, it must be equal to a specific object's ID. If the object does not exist, CT SET REFNUM does nothing.
A reference number is a non-unique long integer associated with an object. Reference numbers can only be manipulated programmatically. The default value for reference numbers is 0.
Example
This example changes the reference number of the selected objects to the value contained in the vNumber process variable.
CT SET REFNUM (Area;0;vNumber)
See Also