Edit

Share via

LinkButton.OnClientClick Property

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

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

public:
 virtual property System::String ^ OnClientClick { System::String ^ get(); void set(System::String ^ value); };
[System.Web.UI.Themeable(false)]
public virtual string OnClientClick { get; set; }
[<System.Web.UI.Themeable(false)>]
member this.OnClientClick : string with get, set
Public Overridable Property OnClientClick As String

Property Value

String

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

Attributes
ThemeableAttribute

Examples

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

<%@ 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 LinkButton1_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>LinkButton.OnClientClick Example</title>
</head>
<body>
  <form id="form1" runat="server">
    
    <h3>LinkButton.OnClientClick Example</h3> 
     
      <br />
      
      <h4>Click to navigate to Microsoft.com:</h4>     
      
      <br />
        
      <asp:linkbutton id="LinkButton1"
       text="Open Web site"
       onclientclick="Navigate()"
       onclick="LinkButton1_Click"
       runat="Server" />
       
       <br /><br />
       
      <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="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 LinkButton1_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>LinkButton.OnClientClick Example</title>
</head>
<body>
  <form id="form1" runat="server">
    
    <h3>LinkButton.OnClientClick Example</h3> 
     
      <br />
      
      <h4>Click to navigate to Microsoft.com:</h4>     
      
      <br />
        
      <asp:linkbutton id="LinkButton1"
       text="Open Web site"
       onclientclick="Navigate()"
       onclick="LinkButton1_Click"
       runat="Server" />
       
       <br /><br />
       
      <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>

Remarks

Use the OnClientClick property to specify additional client-side script that executes when the LinkButton control's Click event is raised. The script that you specify for this property is rendered in the LinkButton 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.

Applies to

See also