Warning Older Docs! - You are viewing documentation for a previous released version of RhoMobile Suite.

MacroPdfExclusive Decoder Setting

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;
MacroPdfExclusive Ruby Object Syntax:
By default the Ruby Object 'Scanner' will exist on the current page and can be used to interact directly with the MacroPdfExclusive.
To Set MacroPdfExclusive parameters via Ruby 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.

Name Possible Values Description Default Value
macroPdfExclusive:[Value] true / false If 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 Version 1.0.0 or above
Supported Devices All supported devices except: Enterprise Tablet.
Minimum Requirements Scanner or Imager module and device that supports MacroPDF.
Persistence Transient - 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">
Back to Top