Adobe 65009333 Scripting Guide - Page 68

Menus

Working with script menu actions

68

Working with script menu actions

You can use

scriptMenuAction

to create a new

menuAction

whose behavior is implemented through the

script registered to run when the

onInvoke

event

is triggered.

The following script shows how to create a

scriptMenuAction

and attach it to a menu item (for the

complete script, see MakeScriptMenuAction). This script simply displays an alert when the menu item is

selected.

var mySampleScriptAction = app.scriptMenuActions.add("Display Message");

var myEventListener = mySampleScriptAction.eventListeners.add("onInvoke",

function(){alert("This menu item was added by a script.");});

//If the submenu "Script Menu Action" does not already exist, create it.

try{

var mySampleScriptMenu = app.menus.item("$ID/Main").submenus.item(

"Script Menu Action");

mySampleScriptMenu.title;

}

catch (myError){

var mySampleScriptMenu = app.menus.item("$ID/Main").submenus.add

("Script Menu Action");

}

var mySampleScriptMenuItem = mySampleScriptMenu.menuItems.add(mySampleScriptAction);

To remove the

menu

,

submenu

,

menuItem

, and

scriptMenuAction

created by the above script, run the

following script fragment (from the RemoveScriptMenuAction tutorial script):

#targetengine "session"

var mySampleScriptAction = app.scriptMenuActions.item("Display Message");

mySampleScriptAction.remove();

var mySampleScriptMenu = app.menus.item("$ID/Main").submenus.item

("Script Menu Action");

mySampleScriptMenu.remove();

You also can remove all

scriptMenuAction

, as shown in the following script fragment (from the

RemoveAllScriptMenuActions tutorial script). This script also removes the menu listings of the

scriptMenuAction

, but it does not delete any menus or submenus you might have created.

#targetengine "session"

app.scriptMenuActions.everyItem().remove();

You can create a list of all current

scriptMenuActions

, as shown in the following script fragment (from

the GetScriptMenuActions tutorial script):

var myScriptMenuActionNames = app.scriptMenuActions.everyItem().name;

//Open a new text file.

var myTextFile = File.saveDialog("Save Script Menu Action Names As", undefined);

//If the user clicked the Cancel button, the result is null.

if(myTextFile != null){

//Open the file with write access.

myTextFile.open("w");

for(var myCounter = 0; myCounter < myScriptMenuActionNames.length; myCounter++){

myTextFile.writeln(myScriptMenuActionNames[myCounter]);

}

myTextFile.close();

}

scriptMenuAction

also can run scripts during their

beforeDisplay

event

, in which case they are

executed before an internal request for the state of the

scriptMenuAction

(e.g., when the menu item is

Section	Page
Introduction	6
How to use the scripts in this document	6
About the structure of the scripts	6
For more information	6
Getting Started	7
Installing scripts	7
Running scripts	8
Using the scripts panel	8
JavaScript language details	8
Using the scripts in this document	9
Your first InCopy script	9
Walking through the script	10
Scripting terminology and the InCopy object model	10
Scripting terminology	10
Comments	10
Values	10
Variables	11
Operators	12
Conditional statements	12
Control structures	13
Functions	13
Understanding the InDesign and InCopy object model	13
Looking at the InCopy object model	15
Measurements and positioning	16
Coordinates	16
Measurement units	16
Adding features to “Hello World”	17
Scripting Features	19
Script preferences	19
Getting the current script	20
Script versioning	21
Targeting	21
Compilation	21
Interpretation	21
Using the doScript method	21
Sending parameters to doScript	22
Returning values from doScript	22
Running scripts at start-up	23
Session and main script execution	23
Text and Type	25
Entering and importing text	25
Stories and text frames	25
Adding text to a story	25
Replacing text	26
Inserting special characters	26
Placing text and setting text-import preferences	27
Exporting text and setting text-export preferences	30
Text objects	34
Selections	35
Moving and copying text	36
Text objects and iteration	37
Formatting text	38
Setting text defaults	38
Fonts	41
Applying a font	42
Changing text properties	42
Changing text color	43
Creating and applying styles	43
Deleting a style	45
Importing paragraph and character styles	45
Finding and changing text	45
Find/change preferences	46
Finding text	46
Finding and changing formatting	47
Using grep	48
Using glyph search	50
Tables	50
Autocorrect	54
Footnotes	54
User Interfaces	55
Dialog-box overview	55
Your first InCopy dialog box	56
Adding a user interface to “Hello World”	57
Creating a more complex user interface	57
Working with ScriptUI	59
Creating a progress bar with ScriptUI	60
Creating a button-bar panel with ScriptUI	60
Menus	63
Understanding the menu model	63
Localization and menu names	65
Running a menu action from a script	66
Adding menus and menu items	66
Menus and events	67
Working with script menu actions	68
Events	70
Understanding the event scripting model	70
About event properties and event propagation	72
Working with eventListeners	73
A sample “afterNew” eventListener	75
XML	77
Overview	77
The best approach to scripting XML in InCopy	77
Scripting XML Elements	77
Setting XML preferences	78
Setting XML import preferences	78
Importing XML	79
Creating an XML tag	79
Loading XML tags	79
Saving XML tags	79
Creating an XML element	80
Moving an XML element	80
Deleting an XML element	80
Duplicating an XML element	80
Removing items from the XML structure	81
Creating an XML comment	81
Creating an XML processing instruction	81
Working with XML attributes	81
Working with XML stories	82
Exporting XML	83
Adding XML elements to a story	83
Associating XML elements with text	83
Inserting text in and around XML text elements	83
Mapping tags to styles	84
Mapping styles to tags	84
Applying styles to XML elements	85

Adobe 65009333 Scripting Guide - Page 68

Working with script menu actions

Page 68 highlights