set_ContextMenuFunc Method

In This Topic

Sets a handler for "contextmenu" event of the viewer.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.UI.WebImageViewerJS(controlId);

var returnValue; // Type: any

// Parameters
var value; // Type: function

returnValue = instance.set_ContextMenuFunc(value);

function set_ContextMenuFunc(
   valueA function OR null that equals to "function(event){ return false; }".
 : Function
) : any;

Parameters

value: A function OR null that equals to "function(event){ return false; }".

Exceptions

Exception	Description
	Thrown if argument has wrong type.

Remarks

The default handler of "contextmenu" event only disables the browser context menu.
Important: Handler for "contextmenu" event will NOT be called if "get_VisualTool" property returns NOT nothing and visual tool get_DisableContextMenu property returns True.
Important: Use this property if you need to change the handler of "contexmenu" - subscribing to the viewer container "contextmenu" will not have an effect.

Example

JavaScript

 // define functions
 function __contextMenuFunc(event){
   console.log("Event: ", event);
   // show browser context menu
   return true;
 }

 // set function
 imageViewer1.set_ContextMenuFunc(__contextMenuFunc);

Browser Compatibility

56+

45+

Reference

WebImageViewerJS Class
WebImageViewerJS Members

Send Feedback