OnClientClicking
OnClientClicking (clicking client-side event)
The clicking event occurs when the RadButton control is clicked, immediately after the mouse button is released. The event is fired after the client-side validation occurs, and can be canceled.
The event handler receives two parameters:
-
The instance of the clicked RadButton control
-
An eventArgs parameter of type Telerik.Web.UI.RadButtonCancelEventArgs, containing the following properties and methods:
-
IsSplitButtonClick() - returns a bool value that indicates whether the split button or the main button is clicked. True means the split button was clicked.
-
get_cancel() - returns a bool value that indicates whether the event was canceled. True means the event is canceled.
-
set_cancel(shouldCancel) - sets a bool value that indicates whether the event will be canceled. Setting true means the event will be canceled.
-
get_commandName() - returns the value assigned to the RadButton's CommandName property
-
get_commandArgument() - returns the value assigned to the RadButton's CommandArgument property
-
This event comes handy in scenarios when the user wants to cancel the page submission, or prevent execution of the other client-side events based on a certain condition. One such scenario is confirming the submission of the page to the server. We ask the user if she wants to submit the page, and if a negative answer is received, we cancel the clicking event. Here is the code:
<script type="text/javascript">
function Clicking(sender, args)
{
args.set_cancel(!window.confirm("Are you sure you want to submit the page?"));
}
</script>
<telerik:RadButton RenderMode="Lightweight" ID="RadButton1" runat="server" Text="Submit" OnClientClicking="Clicking" OnClick="RadButton1_Click">
</telerik:RadButton>
protected void RadButton1_Click(object sender, System.EventArgs e)
{
RadButton1.Text = "RadButton was clicked at: " + DateTime.Now.ToString();
}
Since Q2 2012 the event OnClientClicking is raised after the ASP.NET client-side validation on the page takes place. This will handle the problem described in the help article RadButton Validation And Client-side Event Handlers.