Home » Adobe Manuals » Computer Software » Adobe 27510753 » Manual Viewer

Adobe 27510753 Scripting Guide - Page 64

Dollar ($) object functions, objects, screens, strict, version, about, clearbp, getenv, setbp

UPC - 718659445294

Add to My Manuals
Save this manual to your list of manuals

Page 64 highlights

56 Using ExtendScript Tools and Features Adobe InDesign CS2 Scripting Guide objects os screens strict version Number The total count of all JavaScript objects defined so far. Read only. String The current operating system version. Read only. Array Boolean 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 is true if that object describes the primary display. 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 description; for example: "3.6.5 (debug)" Read only. Dollar ($) object functions about $.about () Displays the About box for the ExtendScript component, and returns the text of the About box as a string. bp $.bp ([condition]) Executes a breakpoint at the current position. Returns undefined. If no condition is needed, it is recommended that you use the JavaScript debugger statement in the script, rather than this method. condition 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. clearbp $.clearbp ([line]) Removes a breakpoint from the current script. Returns undefined. line gc $.gc () 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. getenv $.getenv (envname) Returns the value of the specified environment variable, or null if no such variable is defined. envname The name of the environment variable. list $.list ([classname]) Collects object information into a table and returns this table as a string. See the following "Object statistics" section. classname Optional. The type of object about which to collect information. If not supplied, collects information about all objects currently defined. setbp $.setbp ([line, condition]) Sets a breakpoint in the current script. Returns undefined. If no arguments are needed, it is recommended that you use the JavaScript debugger statement in the script, rather than this method. line Optional. The line at which to stop execution. If 0 or not supplied, sets the breakpoint at the current line number. condition 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.

Section	Page
1 Introduction	9
What is in this book	9
Who should read this book	9
What you need to use scripting	9
JavaScript	10
Macintosh	10
Windows	10
How to use the scripts in this document	10
Copying examples with long lines	11
Running JavaScript files	11
Where to find more information	11
InDesign online scripting resources	12
2 Scripting Basics	13
Introduction to scripting	13
What is scripting?	13
Why use scripting?	14
What about macros?	14
Making script files readable	15
Commenting the script	15
Continuing long lines in AppleScript and VBScript	15
Continuing long lines in JavaScript	15
Objects and classes	16
Objects	16
Object references	16
Values and variables	17
Values	17
Variables	18
Variable names	19
Assigning values to variables	19
Array variables	20
Converting values from one type to another	20
Finding the value type of a variable	21
Operators	22
Methods	22
Control structures	23
Conditional statements	23
Loops	24
Subroutines and handlers	25
3 Getting Started with InDesign Scripting	27
Measurements and positioning	27
Coordinates	27
Measurement units	28
The InDesign document object model	29
Looking at the InDesign object model	29
Your first InDesign script	30
Adding features to “Hello World”	33
Adding a user interface to \	37
Dialog box overview	37
Adding the user interface	38
Creating a more complex user interface	41
Handling errors	47
Using palettes to manage scripts	48
Using the Scripts palette	48
Using the Script Label palette	49
Testing and troubleshooting	50
AppleScript debugging	50
VBScript debugging	50
JavaScript debugging	50
4 Using ExtendScript Tools and Features	51
The ExtendScript Toolkit	52
Configuring the Toolkit window	52
Selecting a debugging target	53
Selecting scripts	54
Tracking data	55
The JavaScript console	56
The call stack	56
The Script Editor	57
Debugging in the Toolkit	58
Profiling	62
Dollar ($) Object	63
Dollar ($) object properties	63
Dollar ($) object functions	64
ExtendScript Reflection Interface	66
Reflection Object	66
ReflectionInfo Object	67
Localizing ExtendScript Strings	68
Variable values in localized strings	69
Enabling automatic localization	69
Locale names	70
Testing localization	70
Global localize function	71
User notification helper functions	71
Global alert function	72
Global confirm function	72
Global prompt function	73
Specifying measurement values	74
UnitValue object	74
Converting pixel and percentage values	75
Computing with unit values	76
Modular programming support	77
Preprocessor directives	77
Importing and exporting between scripts	79
Operator overloading	80
Application and namespace specifiers	81
Application specifiers	81
Namespace specifiers	82
Script locations and checking application installation	82
5 Working with Documents in AppleScript	83
Basic document management	84
Creating a new document	84
Opening a document	84
Closing a document	85
Saving a document	85
Basic page layout	86
Defining page size and document length	86
Defining bleed and slug areas	87
Setting page margins and columns	88
Changing the pasteboard's appearance	90
Using guides and grids	90
Defining guides	90
Setting grid preferences	92
Snapping to guides and grids	92
Changing measurement units and ruler	93
Defining and applying document presets	93
Creating a preset by copying values	93
Creating a preset using new values	94
Using a preset	95
Setting up master spreads	95
Setting text-formatting defaults	97
Setting application text defaults	97
Setting the active document's defaults	99
Using text defaults	99
Adding XMP metadata	99
Creating a document template	100
Printing a document	104
Printing using page ranges	104
Setting print preferences	104
Using printer presets	107
Creating printer presets from printing preferences	107
Exporting a document as PDF	112
Using current PDF export options	112
Setting PDF export options	112
Exporting a range of pages	114
Exporting pages separately	114
Exporting pages as EPS	115
Exporting all pages	116
Exporting a range of pages	116
Exporting with file naming	116
6 Working with Documents in JavaScript	119
Basic document management	120
Creating a new document	120
Opening a document	120
Closing a document	120
Saving a document	121
Basic page layout	122
Defining page size and document length	122
Defining bleed and slug areas	122
Setting page margins and columns	123
Changing the pasteboard's appearance	125
Using guides and grids	125
Defining guides	125
Setting grid preferences	127
Snapping to guides and grids	127
Changing measurement units and ruler	127
Defining and applying document presets	128
Creating a preset by copying values	128
Creating a preset using new values	129
Using a preset	130
Setting up master spreads	130
Setting text-formatting defaults	131
Setting application text defaults	131
Setting the active document's defaults	134
Using text defaults	134
Adding XMP metadata	134
Creating a document template	135
Printing a document	138
Printing using page ranges	138
Setting print preferences	138
Using printer presets	141
Creating printer presets from printing preferences	141
Exporting a document as PDF	146
Using current PDF export options	146
Setting PDF export options and exporting pages separately	147
Exporting a range of pages	149
Exporting pages as EPS	149
Exporting all pages	149
Exporting a range of pages	149
Controlling export options	150
7 Working with Documents in VBScript	151
Basic document management	152
Creating a new document	152
Opening a document	152
Closing a document	153
Saving a document	153
Basic page layout	154
Defining page size and document length	154
Defining bleed and slug areas	154
Setting page margins and columns	156
Changing the pasteboard's appearance	157
Using guides and grids	158
Defining guides	158
Setting grid preferences	160
Snapping to guides and grids	160
Changing measurement units and ruler	161
Defining and applying document presets	162
Creating a preset by copying values	162
Creating a preset using new values	163
Using a preset	163
Setting up master spreads	163
Setting text-formatting defaults	165
Setting application text defaults	165
Setting the active document's defaults	167
Using text defaults	168
Adding XMP metadata	168
Creating a document template	168
Printing a document	173
Printing using page ranges	173
Setting print preferences	174
Creating printer presets from printing preferences	177
Exporting a document as PDF	178
Using current PDF export options	178
Setting PDF export options	179
Exporting a range of pages	180
Exporting pages separately	180
Exporting pages as EPS	181
Exporting all pages	181
Exporting a range of pages	181

Match case Limit results 1 per page

Using ExtendScript Tools and Features

Adobe InDesign CS2 Scripting Guide

objects

Number

The total count of all JavaScript objects deﬁned so far. Read only.

String

The current operating system version. Read only.

screens

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

true

if that object describes the primary display.

strict

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

version

String

The version number of the ExtendScript engine as a three-part number and de-

scription; for example: “3.6.5 (debug)” Read only.

Dollar ($) object functions

about

$.about ()

Displays the About box for the ExtendScript component, and returns

the text of the About box as a string.

$.bp ([

condition

])

Executes a breakpoint at the current position. Returns

undefined

If no condition is needed, it is recommended that you use the

JavaScript

debugger

statement in the script, rather than this method.

condition

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.

clearbp

$.clearbp ([

line

])

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.

$.gc ()

Initiates garbage collection. Returns

undefined

getenv

$.getenv (

envname

)

Returns the value of the speciﬁed environment variable, or

null

if no

such variable is deﬁned.

envname

The name of the environment variable.

list

$.list ([

classname

])

Collects object information into a table and returns this table as a

string. See the following “Object statistics” section.

classname

Optional. The type of object about which to collect information. If not supplied, col-

lects information about all objects currently deﬁned.

setbp

$.setbp

([

line

condition

])

Sets a breakpoint in the current script. Returns

undefined

If no arguments are needed, it is recommended that you use the JavaS-

cript

debugger

statement in the script, rather than this method.

line

Optional. The line at which to stop execution. If 0 or not supplied, sets the breakpoint

at the current line number.

condition

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.