Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

scope

The scope object. The segment must be within the scope.

NOTE: This method does not support the Global Search scope.

Mandatory
layout

The editor grid layout. Only fields included in the layout can be updated by the batch operations.

If not set then a default layout will be created that covers only a minimal set of columns (typically source and target text).

Optional
queryAn optional query object. This allows to delimit the operation to a subset of the scope's segments.Optional
actionsA JSON object describing the actions to apply. See below.Optional
doSave

Optional, default is true. True: Changes are saved. False: Changes are not saved.

The latter permits to obtain statistics about what data the operation will update without actually updating.

Optional

...

items

An array with one or more actions to apply. The structure of each element is described below.

The action type is contained in property type. See the following links for details on each action type:

 

Child pages (Children Display)

 

 

Mandatory
onChangeBookmark

Optional.

When a segment text or a property of the text is updated by an operation then optionally update the bookmark value as follows:

  • null: Leave bookmarks unchanged
  • 0: Reset bookmark
  • 1: Set blue bookmark
  • 2: Set red bookmark

 

Optional
onChangeStatus

Optional.

When a segment text or a property of the text is updated by an operation then optionally update the status of the text as follows:

  • null: Leave status unchanged
  • 0: Reset status
  • 1: Set status to OK (green)
  • 2: Set status to Error (red)
 

...