Ajax Control Toolkit ConfirmButton

Modified on 2010/04/16 00:06 by Stephen Walther — Categorized as: Uncategorized

ConfirmButton is an extender that catches clicks on a button (or on any instance of a type that is derived from Button) and displays a message to the user. If the user clicks OK, the button or link functions normally. If the user does not click OK, the click event is trapped and the button does not perform its default submit behavior. Optionally, you can specify client script to execute when the buttons are clicked in the confirm dialog box. This is useful if you use the ConfirmButton extender with a button that performs a delete operation or another task that might require confirmation from the user.

ConfirmButton Server Reference

The properties in italics are optional.

<ajaxToolkit:ConfirmButtonExtender ID="cbe" runat="server"
    TargetControlID="LinkButton1"
    ConfirmText="Are you sure you want to click this?"
    OnClientCancel="CancelClick" />

TargetControlID - The ID of the Button control to extend.
ConfirmText - The confirmation text to display. HTML entities can be used, such as 
 for a newline character.
OnClientCancel - The client script to execute when the Cancel button is clicked in the confirm dialog box.
ConfirmOnFormSubmit - true if the confirm dialog box should not be displayed until just before the form is submitted. This is useful if the page contains ASP.NET validator controls and the confirm dialog box should be displayed only after all validation checks pass.
DisplayModalPopupID - Specifies the ID of a ModalPopup control to use to display the confirm dialog box instead of the default window.confirm window. When you use the DisplayModalPopupID property, the following conditions must be met:
- The ModalPopup control must be configured with the same TargetControlID value as the ConfirmButton extender. (It will work properly if the ConfirmButton extender is disabled.)
- The ModalPopup control must specify the OkControlID or the CancelControlID properties in order to identify the buttons that correspond to the the OK and Cancel buttons in the confirm dialog box.
- The ModalPopup must not specify a OnOkScript or OnCancelScript property.

ConfirmButton Client Reference

Sys.Extended.UI.ConfirmButtonBehavior Class

Events

showing(handler) - Adds or removes an event handler for the showing event.
- Parameters - A function that represents the event handler.
hidden(handler) - Adds or removes an event handler for the hidden event.
- Parameters - A function that represents the event handler.

Methods

initialize() - Initializes the ConfirmButton behavior.
dipose() - Disposes the ConfirmButton behavior.
raiseShowing(eventArgs) - Raises the showing event.
- Parameters - A Sys.EventArgs object that represents event arguments for the showing event.
raiseHidden(eventArgs) - Raises the hidden event.
- Parameters - A Sys.EventArgs object that represents event arguments for the hidden event.

Properties

OnClientCancel - Gets or sets a string that contains client script that executes when the Cancel button is clicked in the confirm dialog box.
ConfirmText - Gets or sets the confirmation text to display.
- Remarks - HTML entities can be used, such as 
   for a newline character.
ConfirmOnFormSubmit - Gets or sets a Boolean value that specifies that the confirm dialog box should not be displayed until just before the form is submitted. This is useful if the page contains ASP.NET validator controls and the confirm dialog box should be displayed only after all validation checks pass.
displayModalPopupID - Gets or sets a string that contains the ID of a ModalPopupBehavior control to use instead of the default window.confirm dialog box.
postBackScript - Gets or sets a string that contains script to run in order to initiate a postback.

Sys.Extended.UI.ConfirmButtonHiddenEventArgs Class

Summary - Defines arguments for the hidden event.
Parameters - Boolean confirmed

Properties

confirmed - Gets a Boolean value that indicates whether the user clicked OK.