LinkButton.OnClientClick Property (System.Web.UI.WebControls)

OnClientClick Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

.NET Framework Class Library

LinkButton.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 LinkButton control's Click event is raised

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

Syntax

Visual Basic (Declaration)

<ThemeableAttribute(False)> _
Public Overridable Property OnClientClick As String

Visual Basic (Usage)

Dim instance As LinkButton
Dim value As String

value = instance.OnClientClick

instance.OnClientClick = value

[ThemeableAttribute(false)] 
public virtual string OnClientClick { get; set; }

C++

[ThemeableAttribute(false)] 
public:
virtual property String^ OnClientClick {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_OnClientClick ()

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

JScript

public function get OnClientClick () : String

public function set OnClientClick (value : String)

Property Value

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

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 Overview.

Example

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.

Visual Basic

<%@ page language="VB"%>
<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>
<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 language=javascript>
      function Navigate()
      {
        javascript:window.open("http://www.microsoft.com");
      }    
      
    </script>
</body>
</html>

<%@ page language="C#"%>
<script runat="server">
  
void LinkButton1_Click (object sender, EventArgs e)
  {
    Label1.Text = "Thank you for visiting our site.";
  }
  
</script>
<html>
<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 language=javascript>
      function Navigate()
      {
        javascript:window.open("http://www.microsoft.com");
      }    
      
    </script>
</body>
</html>

Platforms

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.

Version Information