Dollar ($) Object Functions - Adobe 27510753 - InDesign CS2 - PC Manual

56 Using ExtendScript Tools and Features
objects
os
screens
strict
version

Dollar ($) object functions

about
$.about ()
bp
$.bp ([
condition
clearbp
$.clearbp ([
line
gc
$.gc ()
getenv
$.getenv (
envname
list
$.list ([
classname
setbp
$.setbp
line
([ ,
line
condition
Number The total count of all JavaScript objects defined so far. Read only.
String The current operating system version. Read only.
Array An array of objects containing information about the display screens attached to
your computer. Each object has the properties left , top , right , and bottom ,
which contain the four corners of each screen in global coordinates. A property
primary
Boolean When true , any attempt to write to a read-only property causes a runtime error.
Some objects do not permit the creation of new properties when true .
String The version number of the ExtendScript engine as a three-part number and de-
scription; for example: "3.6.5 (debug)" Read only.
Displays the About box for the ExtendScript component, and returns
the text of the About box as a string.
Executes a breakpoint at the current position. Returns undefined .
condition
])
If no condition is needed, it is recommended that you use the
JavaScript debugger statement in the script, rather than this method.
Optional. A string containing a JavaScript statement to be used as a condition. If the
statement evaluates to true or nonzero when this point is reached, execution stops.
Removes a breakpoint from the current script. Returns undefined .
line
])
Optional. The line at which to clear the breakpoint. If 0 or not supplied, clears the
breakpoint at the current line number.
Initiates garbage collection. Returns undefined .
Returns the value of the specified environment variable, or null if no
envname
)
such variable is defined.
The name of the environment variable.
Collects object information into a table and returns this table as a
classname
])
string. See the following "Object statistics" section.
Optional. The type of object about which to collect information. If not supplied, col-
lects information about all objects currently defined.
Sets a breakpoint in the current script. Returns undefined .
If no arguments are needed, it is recommended that you use the JavaS-
condition
])
cript debugger statement in the script, rather than this method.
Optional. The line at which to stop execution. If 0 or not supplied, sets the breakpoint
at the current line number.
Optional. A string containing a JavaScript statement to be used for a conditional
breakpoint. If the statement evaluates to true or nonzero when the line is reached,
execution stops.
is true if that object describes the primary display.
Adobe InDesign CS2 Scripting Guide