JavaScript events to and from the Viewer

Prizm Content Connect is built in such a way that it can be truly integrated and embedded into your application. Events are JavaScript AJAX calls that the Viewer can generate when certain actions occur. Developers can also send JavaScript AJAX events to the Viewer from their code and have the Viewer perform certain actions without reloading the whole page.

Sending Events to the Viewer

To send events to the viewer, follow these steps:

1. Pass a FlashVar to ViewerEnterprise.swf to indicate you will be sending events to Viewer:

sendViewerEvents=Yes

2. Add the following code to the page where you call ViewerEnterprise.swf:

<script>
documentviewer = $.flash.create (
 {
  swf: 'ViewerEnterprise.swf',
  id:'ViewerEnterprise',
  height: 600,
  width: 750,
  wmode: 'window',
  scale: 'noscale',
  allowFullScreen: true,
  allowScriptAccess: 'always',
  hasVersion: 10,
  encodeParams: false,
  bgcolor: '#ffffff',  
  flashvars: {
   documentname: '<%=document %>',
   sendViewerEvents:'Yes',
   }
 }
);
$(document).ready(
 function () {
  $('#documentviewer').html(documentviewer);
 }
);
</script>

3. The sendTextToFlash function is used to interact with the viewer. (2 arguments are required: Command:String and Argument:String or Number)

Argument is 0 in all cases.

The following events can be sent:

Event	Details
Next	Move to next page
Previous	Move to previous page
ZoomIn	Zoom In on the document
ZoomOut	Zoom Out on document
FitWidth	Set Zoom=100%
MoveDown	Move the page down
MoveUp	Move the page up
MoveLeft	Move the page left
MoveRight	Move the page right
Print	Print the document. Opens print dialog.

<a href=javascript:ViewerEnterprise.sendTextToFlash("Previous")>Previous</a>
<a href=javascript:ViewerEnterprise.sendTextToFlash("Next")>Next</a>
<a href=javascript:ViewerEnterprise.sendTextToFlash("ZoomIn")>Next</a>

Receiving Events from the Viewer

The Viewer can send events when certain actions are performed.

To receive the events follow these steps:

1. Pass a FlashVar to ViewerEnterprise.swf to indicate you will be sending events to Viewer:

getViewerEvents=Yes

2. Add the JavaScript code in your page as shown below:

<script>
documentviewer = $.flash.create (
 {
  swf: 'ViewerEnterprise.swf',
  id:'ViewerEnterprise',
  height: 600,
  width: 750,
  wmode: 'window',
  scale: 'noscale',
  allowFullScreen: true,
  allowScriptAccess: 'always',
  hasVersion: 10,
  hasVersionFail: function (options) {
  alert("You do not have required flash version");
  },
  encodeParams: false,
  bgcolor: '#ffffff',  
  flashvars: {
   documentname: '<%=document %>',
   getViewerEvents:'Yes',
   }
 }
);
$(document).ready(
 function () {
  $('#documentviewer').html(documentviewer);
 }
);
</script>

The following events are sent by ViewerEnterprise.swf:

Highlight Events Sent by Viewer 

JavaScript method that is called : onHighlightEvent ( eventName , highlightXML )

eventNames
highlightSaveMenuOpened
highlightAdd
highlightExistingMenuOpened
highlightMenuCancelled
highlightRemove
highlightOpenLink

<script language="javascript">
function viewerOnDocumentPrint(documentname)
{
   alert(“document: ” + documentname);
}
function viewerOnSelectText(documentname,pagenumber,startpos,endpos,selecetdtext)
{
alert(startpos+" "+endpos);
}
function onHighlightEvent(eventName, highlightXML)
{
   alert(eventName + "  " + highlightXML);
}
</script>

Annotation Events to/from Viewer

Sending Events

To send Annotation Events to the Viewer, follow these steps:

1. Pass a FlashVar to ViewerEnterprise.swf to indicate you will be sending events to Viewer:

sendViewerEvents=Yes

2. In your page where you call ViewerEnterprise.swf, add the following code

<script>
documentviewer = $.flash.create(
 {
  swf: 'ViewerEnterprise.swf',
  id:'ViewerEnterprise',
  height: 600,
  width: 750,
  wmode: 'window',
  scale: 'noscale',
  allowFullScreen: true,
  allowScriptAccess: 'always',
  hasVersion: 10,
  encodeParams: false,
  bgcolor: '#ffffff',  
  flashvars: {
   documentname: '<%=document %>',
   sendViewerEvents:'Yes',
   }
 }
);
$(document).ready(
 function () {
  $('#documentviewer').html(documentviewer);
 }
);
</script>

Receiving Events

The Viewer can send events when certain actions are performed by the user.

To receive events, follow these steps:

1. Pass a FlashVar to ViewerEnterprise.swf to indicate you will be sending events to Viewer:

getViewerEvents=Yes

2. Add the javascript code in your page as shown below:

<script>
documentviewer = $.flash.create(
 {
  swf: 'ViewerEnterprise.swf',
  id:'ViewerEnterprise',
  height: 600,
  width: 750,
  wmode: 'window',
  scale: 'noscale',
  allowFullScreen: true,
  allowScriptAccess: 'always',
  hasVersion: 10,
  hasVersionFail: function (options) {
  alert("You do not have required flash version");
  },
  encodeParams: false,
  bgcolor: '#ffffff',  
  flashvars: {
   documentname: '<%=document %>',
   getViewerEvents:'Yes',
   }
 }
);
$(document).ready(
 function () {
  $('#documentviewer').html(documentviewer);
 }
);
</script>

The following events are sent by the Viewer:

©2013. Accusoft Corporation. All Rights Reserved.