button Property

Gets or sets a value indicating whether the event should be canceled.

Syntax

JavaScript

this.cancel;

Property Value

Type: Integer

Value	Description
0	Specifies the left (primary) mouse-button
2	Specifies the right (secondary) mouse-button

Remarks

This property's value should not be changed.

Examples

The following example uses the ObjectClickEventArgs Class to handle the "objectClick" event of the PdfWebControlApi Class.

JavaScript

Copy

//declare event handler function (which accepts an object of type ObjectClickEventArgs as an argument)
  function objectClickHandler(evt)
  {
      //if this object was right clicked
      if(evt.button == 2)
      {
          //make the new object unmovable
          evt.obj.setProperties( {"movable" : false} );
      }
  }

  //get API class
  var myApi = new PdfWebControlApi("PdfWebControl1"); // where "PdfWebControl1" is the ID (ClientID) assigned to the PdfWebControl instance

  //attach event handler to objectClick event
  myApi.addEventListener("objectClick", objectClickHandler);

Other Resources

ObjectClickEventArgs Properties

PdfWebControlApi Events