Operation JScript

From RealWorld Wiki

Jump to: navigation, search
RealWorld scripting reference

This document operation contains a JScript code that is executed when the operation is run. The code can access the active document and multiple of global objects.

The actual global objects and interfaces accessible from the JavaScript code may depend on the application you are using and the current document.

Contents

[edit] Global objects

[edit] Common

These globals are likely to be available regardless the application used.

  • Application - get name and version of the application, open a create new documents, get or set contents of clipboard as text.
  • Configuration - make scripted operations configurable at runtime.
  • Document - provides access to the current document (save, duplicate, get/set name, get type-dependent interface).
  • Operation - configure and execute an operation.
  • Context - access window states (like selection or active color), stop preocessing and report errors.

[edit] Raster Image

  • DrawTool - modify raster image using draw tools.
  • Blender - combine an image with another one or a single color using defined blending function.

[edit] Internals

GUID: AC42806D-4914-42B8-B321-B77D5039B01C

Configuration
Parameter nameTypeDefaultValueNote
Scriptstring JavaScript code performing the operation
CfgScriptstring JavaScript code initializing configuration dialog