useAnnotationDefinedModule
This parameter controls which module is loaded when the detected module or version differs from the one that was used to save the annotations for the document.
The way this parameter works is that you can assign one of the following values:
- always
- Always load the module that is defined in the annotations file.
- never
- Always load the module that is detected by the viewer.
- prompt
- Prompt the user as follows:
- If the module that was defined by the annotation is licensed, the user can choose to load it or load the module that is detected by the viewer.
- If the module that was defined by the annotation is not licensed, the user can choose to load the module that is detected by the viewer, or cancel.
Or you can assign any combination of the following values:
- hasuneditable
- Load the module that is defined in the annotations file if any uneditable annotations are present. Otherwise, load the module that is detected by the viewer.
- hassolid
- Load the module that is defined in the annotations file if any solid annotations are present. (A solid annotation can be a redaction, a redaction polygon, a rectangle, an oval, a polygon, or a nontransparent text annotation.) Otherwise, load the module that is detected by the viewer.
- hasoutofbounds
- Load the module that is defined in the annotations file if any out of bounds annotations are present. Otherwise, load the module that is detected by the viewer.
Values can be set as a comma-separated list (for example, hassolid,hasoutofbounds). The defined filter is loaded if any of the conditions are met.
Important: If you enter an invalid combination of values (for example
always, outofbounds), then the viewer ignores whatever is set
and uses the default value instead.
The default value for this parameter is always.
Sample syntax
<param name="useAnnotationDefinedModule" value="prompt" />