oncontextmenu Event

Fires when the user clicks the right mouse button in the client area.

Syntax

Inline HTML	<ELEMENT oncontextmenu = "handler" ... >	All platforms
Event property	object.oncontextmenu = handler	JScript™ (compatible with ECMA 262 language specification) only
Named script	<SCRIPT FOR=object EVENT=oncontextmenu>	Microsoft® Internet Explorer only

Remarks

Bubbles	Yes
Cancels	Yes
To invoke	Right-click the object.
Default action	Opens the context menu. To cancel the default behavior, set the returnValue property of the event object to FALSE.

Event Object Properties

Although event handlers in the DHTML Object Model do not receive parameters directly, the handler can query the event object for data.

Event Object Properties

altKey	Retrieves the current state of the ALT key.
cancelBubble	Sets or retrieves whether the current event should bubble up the hierarchy of event handlers.
clientX	Retrieves the x-coordinate of the position of the cursor when the mouse is clicked, relative to the size of the client area of the window but excluding window decorations or scroll bars.
clientY	Returns the y-coordinate of the position of the cursor when the mouse is clicked, relative to the size of the client area of the window but excluding window decorations or scroll bars.
ctrlKey	Retrieves the state of the CTRL key.
offsetX	Retrieves the horizontal coordinate of the mouse's position relative to the object firing the event.
offsetY	Retrieves the vertical coordinate of the mouse's position relative to the object firing the event.
returnValue	Sets or retrieves the return value from the event.
screenX	Retrieves the horizontal position of the mouse, in pixels, relative to the user's screen.
screenY	Retrieves the vertical position of the mouse, in pixels, relative to the user's screen.
shiftKey	Retrieves the state of the SHIFT key.
srcElement	Retrieves the object that fired the event.
type	Retrieves the event name from the event object.
x	Returns the horizontal position of the mouse when the event fires.
y	Returns the vertical position of the mouse when the event fires.

Example

The example demonstrates the oncontextmenu event handlers for the document.

Sample Code

<SCRIPT FOR = document EVENT = oncontextmenu>
   document.oncontextmenu = fnContextMenu;
</SCRIPT>

<SCRIPT>
function fnContextMenu(){
   event.returnValue = false;
}
</SCRIPt>

This feature requires Internet Explorer 4.0 or later. Click the icon below to install the latest version. Then reload this page to view the sample.

Applies To

document

Does this content meet your programming needs? Write us!

Back to top