MacroPdfExclusive Decoder Setting

RhoElements 2.x API

Overview

The MacroPdfExclusive Decoder Setting is used to set the macroPdfExclusive property.

Syntax

macroPdfExclusive (Decoder Setting) <META> Syntax

<META HTTP-Equiv="scanner" content="macroPdfExclusive:[parameter]">

macroPdfExclusive JavaScript Object Syntax:
By default the JavaScript Object 'scanner' will exist on the current page and can be used to interact directly with the macroPdfExclusive.
To Set macroPdfExclusive parameters via JavaScript use the following syntax: scanner.Parameter = Value;

e.g. scanner.macroPdfExclusive = Value;

Parameters

Items listed in this section indicate parameters, or attributes which can be set.

NamePossible ValuesDescriptionDefault Value
macroPdfExclusive:[Value] true / falseIf true, the scanner driver will not complete read requests while in the middle of a macroPdf sequence. Once a macroPdf sequence has been started it must be completed or cancelled before the scan driver will complete other read requests.Device specific

Requirements

RhoElements Version1.0.0 or above
Supported DevicesAll supported devices except: Enterprise Tablet.
Minimum RequirementsScanner or Imager module and device that supports MacroPDF.
PersistenceTransient - Decoder settings are only guaranteed to persist until the Scanner is disabled

HTML/JavaScript Examples

The following example enables the scanner and sets macroPdfExclusive property

<META HTTP-Equiv="scanner" Content="macroPdf:enabled">
<META HTTP-Equiv="scanner" Content="macroPdfExclusive:true">
<META HTTP-Equiv="scanner" Content="enabled">