ASPxClientTabControlBase.TabClick Event
Fires when a tab is clicked.
Declaration
TabClick: ASPxClientEvent<ASPxClientTabControlTabClickEventHandler<ASPxClientTabControlBase>>
Event Data
The TabClick event's data class is ASPxClientTabControlTabClickEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
cancel | Gets or sets a value indicating whether the action which raised the event should be canceled. Inherited from ASPxClientProcessingModeCancelEventArgs. |
htmlElement | Gets the HTML object that contains the processed tab. |
htmlEvent | Gets a DHTML event object that relates to the processed event. |
processOnServer | Specifies whether or not to process the event on the server. Inherited from ASPxClientProcessingModeEventArgs. |
reloadContentOnCallback | Gets or sets a value specifying whether a callback should be sent to the server to reload the content of the page being activated. Inherited from ASPxClientTabControlTabCancelEventArgs. |
tab | Gets the tab object related to the event. Inherited from ASPxClientTabControlTabCancelEventArgs. |
Remarks
Write a TabClick event handler to perform specific actions on the client side each time a tab is clicked within a tabbed control. Note that this event fires immediately after the left mouse button is released. If the button is released when the mouse pointer is not over a tab, the event doesn’t fire. You can use the event parameter’s properties to identify the clicked tab, specify whether a postback should be generated to pass the event processing to the server side and cancel the execution of the command, if necessary.
Note that if the cancel property is set to true
in the event’s handler, the execution of the current command is canceled on the client side and no further processing is performed (i.e. the active tab is not changed). If the command execution is not canceled (the cancel property is set to the default false
value), further event processing depends upon the processOnServer property setting.
If the processOnServer property is set to false
, the TabClick event is completely handled on the client side using the assigned JScript handler without a postback to the server. Setting the processOnServer property to true
indicates that final processing of the event should be performed on the server side, so a round trip to the server is required. During such a round trip the corresponding server-side ASPxTabControlBase.TabClick event is fired, which when handled, allows any desired server-side action to be performed.