Hi all, I'm trying to run some ExtendScript code when the user creates a new document but I'm not getting it to work. I've probably made a basic mistake, which someone can point out, but otherwise, could anyone test my script on their system?
I expect it to name the first Layer "TEST" but for me it throws an error (which the script handles and displays in an alert).
I'm using Indesign 19.0.1 and MacOS 14.1.2.
Here is my test case, whch I run from the Startup Scripts folder:
//@targetengine "test"
if (app.eventListeners.item("afterNew").isValid)
app.eventListeners.item("afterNew").remove();
app.eventListeners.add("afterNew", myHandler);
function myHandler(ev) {
var messages = [
'ev.parent.constructor.name = ' + ev.parent.constructor.name,
'app.layoutWindows.length = ' + app.layoutWindows.length,
'app.modalState = ' + app.modalState,
];
try {
// do something to the DOM
ev.parent.layers[0].name = 'TEST';
messages.unshift('Success');
}
catch (error) {
messages.unshift('Failed:');
messages.push('error: ' + error.message + ' (line: ' + error.line + ')');
}
finally {
alert(messages.join('\n'));
}
};
This is what I see every time I create a new document:
Thanks in advance.
- Mark
Edit 2023-12-05: added an alert even if the test was successful, added screenshot.
2 Correct answers
Tried with InDesign 19.0.1 and macOS 12.6.7.
It always succeeds when in the legacy new document dialog. New format new document dialog causes errors. Even when it succeeds, the modalState is true, and it seems to be executed before it finishes creating the document.
Hi Mark,
Since afterNew is triggered whenever a document is created, it can occur in various circumstances including when a modal dialog is active, due e.g. to the Preview checkbox of the New document dialog. (Maybe this also occurs under other conditions…)
The script below helps clarify this.
//----------------------------------
// TEST AFTER_NEW
// [REM] This script does not require a persistent engine,
// run it once to install the event handler.
//----------------------------------
(functio
34
Replies
Another idea: set the script to the Full debug mode.
Not sure if this works on Mac in VSCode, but on Windows, on clicking the OK button it is opened in ESTK so you can debug it step by step.
— Kas
No, modalState is true.
The event occurs while the new document window is open.
— Kas
Hi Mark, I haven‘t had a chance to test your code, but this works for me with CC2021 on Mojave directly from VSC:
#targetengine "namelayer"
var an = app.eventListeners.add("afterNew", setLayer);
function setLayer(e){
var d = e.parent;
e.parent.layers[0].name = 'TEST';
an.remove()
alert("Hello\r" + d.name + "\r" + d.layers[0].name)
}
Others have suggested that you don’t need a #targetengine line, but I always include one when using event listeners—not sure if that might be your problem?
Tried with InDesign 19.0.1 and macOS 12.6.7.
It always succeeds when in the legacy new document dialog. New format new document dialog causes errors. Even when it succeeds, the modalState is true, and it seems to be executed before it finishes creating the document.
Hi Mark,
Since afterNew is triggered whenever a document is created, it can occur in various circumstances including when a modal dialog is active, due e.g. to the Preview checkbox of the New document dialog. (Maybe this also occurs under other conditions…)
The script below helps clarify this.
//----------------------------------
// TEST AFTER_NEW
// [REM] This script does not require a persistent engine,
// run it once to install the event handler.
//----------------------------------
(function(/*any*/ev, doc,msg,ff,t)
{
if( !(ev||0).isValid )
{
// Install the event listener (if not yet installed!)
// ---
const UID = 'myAfterNewHandler';
(ff=File($.fileName)).exists
&& !((t=app.eventListeners).itemByName(UID)).isValid
&& ((t.add('afterNew',ff)).name=UID);
return;
}
// Checkpoint.
// ---
if( 'afterNew' != ev.eventType ) return; // Make sure this is the right event.
doc = ev.target||0;
if( 'Document' != doc.constructor.name ) return; // Make sure you're targeting a Doc.
// Process.
// ---
if( app.modalState )
{
msg = "You are probably in creating a Document with 'Preview' enabled. "
+ "Hence ID has a dialog box active (modalState==true), which prevents "
+ "calling an active DOM function at this time :-(";
}
else
{
try
{
doc.layers[0].name = 'TEST';
msg = "Worked fine."
}
catch(e)
{
msg = "An error occured:\r" + e.message + " [" + e.line + "]";
}
}
alert( msg );
})($.global.evt);
The crucial parameter is app.modalState. As expressed in the original error message you've encountered, you can't send an active DOM command when a modal window is active. That's is a golden rule of the scripting system. Depending on how the New document box is used, the app might be in “modal state” at the exact moment the document is generated. In particular, this happens when the Preview checkbox is turned on, making a document being created in the background (afterNew is fired then).
Apart from these situations, the script seems to work as expected in both macOS and Windows. The behavior of InDesign is consistent. I also observed that the document may be created (and the event notified) even before the "New document" dialog is opened, in which case it does not yet have an associated LayoutWindow. (But this is not an obstacle to renaming a layer)
Anyway, that background document remains an annoying problem when you want to achieve an afterNew handler that sends DOM commands. I haven't studied the issue further but I guess we may have to target another event…
Best,
Marc
AdChoices