The requested page is not available for the requested platform. You are viewing the content for Default platform.

ASPxClientNavBar.HeaderClick Event

Fires when a group header is clicked.

Declaration

HeaderClick: ASPxClientEvent<ASPxClientNavBarGroupClickEventHandler<ASPxClientNavBar>>

Event Data

The HeaderClick event handler receives an argument of the ASPxClientNavBarGroupClickEventArgs type. 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.
group Gets the group object related to the event.
htmlElement Gets the HTML object that contains the processed group.
htmlEvent Gets a DHTML event object that relates to the processed event.
processOnServer Gets or sets a value that specifies whether the event should be finally processed on the server side.

Remarks

Write a HeaderClick event handler to perform specific actions on the client side each time a group's header is clicked within the navbar 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 header, the event doesn't fire. You can use the event parameter's properties to identify the group whose header is being clicked, 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 expansion state of the related group is not changed). If the command execution is not canceled (the cancel property is set to the default false value), the further event processing depends upon the processOnServer property setting.

If the processOnServer property is set to false, the HeaderClick event is completely handled on the client side using the assigned JScript handler without a postback to the server. Setting the HeaderClick property to true indicates that the final processing of the event should be performed on the server side and so a round trip to the server is required. During such a round trip the corresponding server-side ASPxNavBar.HeaderClick event is fired which when handled allows any desired server-side action to be performed.

See Also