extern int gRun

Call situation of a script.

Documentation

In placeholder scripts the constant specifies the call situation (load, write, ... ) of the script. In paneland Front Row actions the constant describes the frame index of the call.

Placeholder Actions

Actions of placeholders. This actions are executed depending on the instructions of the user.

gRun script type description

-2 load load the content of a placeholder

-3 write write the content of a placeholder to the database

-4 status Does document still correspond to database content?

-5 structure structure of repeated sub-elements

-6 range list of all values, Not implemented

A complete description of the keywords used in the placeholders can be found here.

gRun	script type	description
-2	load	load the content of a placeholder
-3	write	write the content of a placeholder to the database
-4	status	Does document still correspond to database content?
-5	structure	structure of repeated sub-elements
-6	range	list of all values, Not implemented

Panel and Front Row Actions

This actions can be called depending on the current document selection and activated via the corresponding panel menu.

gRun selection description

1, ..., n frames selected At least one frame is selected

0 no selection No frame of text has been selected

-1 text selection text tool active and text cursor placed

gRun	selection	description
1, ..., n	frames selected	At least one frame is selected
0	no selection	No frame of text has been selected
-1	text selection	text tool active and text cursor placed

To execute a panel or front row script only once, regardless of the current document selection, simply add the following line at the beginning of the script:


if (gRunIn placeholder scripts the constant specifies the call situation (load, write, ... ) of the script. In paneland Front Row actions the constant describes the frame index of the call. > 1) return 0;

[Since v4.3 R36210] As an alternative to the test of gRun, you can also write the following line (in exactly this notation) at the beginning of the script and at the start of a line:


#pragma once

If this pragma is set, the script is only ever started once, regardless of the current frame selection. The pragma also works in Python scripts.


See Also: Script Environment

Alphabetic index HTML hierarchy of classes or Java

© Copyright 2003-2024 WERK II GmbH Duisburg Authors : Paul Seidel Christoph Soergel Leo Quensel Mihg This page was created using a modified version of doc++.
This documentation is part of the priint:comet InDesign^®, InDesign Server^® and Illustrator^® plug-in and of the comet_pdf packages and is subject to the same license terms as priint:comet itself. The documentation may neither be passed on nor installed on public servers without the consent of WERK II GmbH. The documentation describes the priint:comet scripting language cScript and provides support for solving technical problems when using the priint:comet plugins. The documentation is not a manual for the priint:comet plugins. A manual of the priint:comet plugins can be found here. The documentation has been prepared with the greatest possible care. In case of errors or hints, please do not hesitate to contact our support. However, faulty or incomplete functional descriptions shall in no case result in an obligation on the part of WERK II GmbH to adapt the described item. This copyright notice may not be removed or altered.

This documentation is part of the priint:comet InDesign^®, InDesign Server^® and Illustrator^® plug-in and of the comet_pdf packages and is subject to the same license terms as priint:comet itself. The documentation may neither be passed on nor installed on public servers without the consent of WERK II GmbH.

The documentation describes the priint:comet scripting language cScript and provides support for solving technical problems when using the priint:comet plugins. The documentation is not a manual for the priint:comet plugins. A manual of the priint:comet plugins can be found here.

The documentation has been prepared with the greatest possible care. In case of errors or hints, please do not hesitate to contact our support. However, faulty or incomplete functional descriptions shall in no case result in an obligation on the part of WERK II GmbH to adapt the described item.