CcmComposerUIAPIV2.Model.RunOptions

The CcmComposerUIAPIV2.Model.RunOptions call returns a RunOptions object that can be passed to the Start call. The call takes a single object as an argument. From this object, the following attributes are registered as options:

• locale. Object. The value of the locale.ui attribute of this object is used to determine the user interface language to be used during interactive document composition. The following values are supported by default.

  Value	User interface language
  en	English
  de	German
  es	Spanish
  fr	French
  it	Italian
  ja	Japanese
  nl	Dutch
  pt-BR	Brazilian Portuguese

  For KCM ComposerUI for HTML5, the set of languages is extensible, so other values may apply. For more information, see the chapter Manage language packs in the Kofax Communications Manager Installation Guide.
• tbescripturl. This parameter has become obsolete. Its value will be ignored.
• tbeformatfunctions. Array. An array of format function objects to be presented to the end user in the formatting dialog in the Text Block Editor. A format function consists of the name attribute and the parameters attribute.

  Example [{name: 'Concat', parameters: ['prefix']}, {name: 'AsNumber', parameters: ['nr_of_decimals']}].

• stylemap. Object. A map of key/value pairs that determines the actual class names used for a number of logical class names. This allows the caller to determine the look and feel of a well-known subset of the UI using an application specific CSS file.