.NET Framework Class Library
ButtonOnClientClick Property

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)
Syntax
<[%$TOPIC/48zx42tc_en-us_VS_110_3_0_0_0_0%](False)> _
Public Overridable Property OnClientClick As [%$TOPIC/48zx42tc_en-us_VS_110_3_0_0_0_1%]
[[%$TOPIC/48zx42tc_en-us_VS_110_3_0_1_0_0%](false)]
public virtual [%$TOPIC/48zx42tc_en-us_VS_110_3_0_1_0_1%] OnClientClick { get; set; }
[[%$TOPIC/48zx42tc_en-us_VS_110_3_0_2_0_0%](false)]
public:
virtual property [%$TOPIC/48zx42tc_en-us_VS_110_3_0_2_0_1%]^ OnClientClick {
	[%$TOPIC/48zx42tc_en-us_VS_110_3_0_2_0_2%]^ get ();
	void set ([%$TOPIC/48zx42tc_en-us_VS_110_3_0_2_0_3%]^ value);
}
[<[%$TOPIC/48zx42tc_en-us_VS_110_3_0_3_0_0%](false)>]
abstract OnClientClick : [%$TOPIC/48zx42tc_en-us_VS_110_3_0_3_0_1%] with get, set
[<[%$TOPIC/48zx42tc_en-us_VS_110_3_0_3_0_2%](false)>]
override OnClientClick : [%$TOPIC/48zx42tc_en-us_VS_110_3_0_3_0_3%] with get, set
function get OnClientClick () : [%$TOPIC/48zx42tc_en-us_VS_110_3_0_4_0_0%] 
function set OnClientClick (value : [%$TOPIC/48zx42tc_en-us_VS_110_3_0_4_0_1%])

Property Value

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

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.

Examples

A Visual Studio Web site project with source code is available to accompany this topic: Download.

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="VB"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs)
    Label1.Text = "Thank you for visiting our site."
  End Sub

</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>
<%@ page language="C#"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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>
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0