Export (0) Print
Expand All

Button.OnClientClick Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the client-side script that executes when a Button control's Click event is raised.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in system.web.dll)

[ThemeableAttribute(false)] 
public virtual string OnClientClick { get; set; }
/** @property */
public String get_OnClientClick ()

/** @property */
public void set_OnClientClick (String value)

public function get OnClientClick () : String

public function set OnClientClick (value : String)

Property Value

The client-side script that executes when a Button control's Click event is raised.

Use the OnClientClick property to specify additional client-side script that executes when a Button control's Click event is raised. The script that you specify for this property is rendered in the Button control's OnClick attribute in addition to the control's predefined client-side script.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins Overview.

The following code example demonstrates how to use the OnClientClick property to specify additional client-side script that executes when a Button control is clicked.

<%@ page language="C#"%>
<script runat="server">

void Button1_Click (object sender, EventArgs e)
  {
    Label1.Text = "Thank you for visiting our site.";

  }
  
</script>
<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
    <title>Button.OnClientClick Example</title>
</head>
<body>
  <form id="form1" runat="server">
    
    <h3>Button.OnClientClick Example</h3> 
     
      
      <h4>Click to navigate to Microsoft.com:</h4>     
              
      <asp:button id="Button1"
       usesubmitbehavior="true"
       text="Open Web site"
       onclientclick="Navigate()"
       runat="server" onclick="Button1_Click" />
       
       <p></p>
      <asp:label id="Label1"
        runat="server">
      </asp:label>

    </form>
    
    <script type="text/javascript">
      function Navigate()
      {
        javascript:window.open("http://www.microsoft.com");
      }    
      
    </script>
</body>
</html>

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft