Sys.UI.DomEvent $removeHandler Method

Provides a shortcut to the removeHandler method of the Sys.UI.DomEvent class. This member is static and can be invoked without creating an instance of the class.

$removeHandler(element, eventName, handler);

Parameters

Term

Definition

element

The DOM element that exposes the event.

eventName

The name of the DOM event.

handler

The event handler to remove.

Remarks

For details about the method that this shortcut represents, see Sys.UI.DomEvent removeHandler Method.

Example

The following example shows how to remove an event handler from an element by using the $removeHandler shortcut method.

<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "https://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">

<head id="Head1" runat="server">
    <title>$removeHandler Example</title>
</head>
<body>
    <h1>$removeHandler Example</h1>
    <form id="form1" runat="server">
        <asp:ScriptManager ID="ScriptManager1" runat="server"/>
        <asp:UpdatePanel ID="UpdatePanel1" runat="server" ChildrenAsTriggers="False" UpdateMode="Conditional">
            <ContentTemplate>
                <asp:Panel ID="Panel1" runat="server" GroupingText="Update Panel">
                   <asp:Label ID="Label1" runat="server" Text="Move cursor over button and click to see event types."></asp:Label>
                   <br />
                   <asp:Button ID="Button1" runat="server" Text="Button 1" AccessKey="b"  />
                   <br />
                   <asp:Label ID="Label2" runat="server"></asp:Label>
                   <br />
                   <asp:Button ID="Button2" runat="server" Text="Remove Click Event" />
                </asp:Panel>
            </ContentTemplate>
        </asp:UpdatePanel>
    </form>
</body>
</html>

<script type="text/javascript">
    $addHandlers($get("Button1"), {click:processEventInfo,mouseover:processEventInfo,mouseout:processEventInfo});
    $addHandler($get("Button2"), "click", removeClick);

    // Event handler displays types for multiple events
    function processEventInfo(eventElement) {
        var result = '';
        result += eventElement.type;
        $get('Label2').innerHTML = result;
    }

    // Event handler removes Click event from Button1
    function removeClick(eventElement) {
        $removeHandler($get("Button1"), "click", processEventInfo);
    }
 </script>
<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "https://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">

<head id="Head1" runat="server">
    <title>$removeHandler Example</title>
</head>
<body>
    <h1>$removeHandler Example</h1>
    <form id="form1" runat="server">
        <asp:ScriptManager ID="ScriptManager1" runat="server"/>
        <asp:UpdatePanel ID="UpdatePanel1" runat="server" ChildrenAsTriggers="False" UpdateMode="Conditional">
            <ContentTemplate>
                <asp:Panel ID="Panel1" runat="server" GroupingText="Update Panel">
                   <asp:Label ID="Label1" runat="server" Text="Move cursor over button and click to see event types."></asp:Label>
                   <br />
                   <asp:Button ID="Button1" runat="server" Text="Button 1" AccessKey="b"  />
                   <br />
                   <asp:Label ID="Label2" runat="server"></asp:Label>
                   <br />
                   <asp:Button ID="Button2" runat="server" Text="Remove Click Event" />
                </asp:Panel>
            </ContentTemplate>
        </asp:UpdatePanel>
    </form>
</body>
</html>

<script type="text/javascript">
    $addHandlers($get("Button1"), {click:processEventInfo,mouseover:processEventInfo,mouseout:processEventInfo});
    $addHandler($get("Button2"), "click", removeClick);

    // Event handler displays types for multiple events
    function processEventInfo(eventElement) {
        var result = '';
        result += eventElement.type;
        $get('Label2').innerHTML = result;
    }

    // Event handler removes Click event from Button1
    function removeClick(eventElement) {
        $removeHandler($get("Button1"), "click", processEventInfo);
    }
 </script>

See Also

Reference

Sys.UI.DomEvent Class

Other Resources

Language Reference