Skip to content

onClick.md

Latest commit

 

History

History
35 lines (28 loc) · 1.46 KB

onClick.md

File metadata and controls

35 lines (28 loc) · 1.46 KB
id dxButton.Options.onClick
type function(e)
default
shortDescription

A function that is executed when the Button is clicked or tapped.

param(e): ui/button:ClickEvent

Information about the event.

field(e.component): {WidgetName}

The UI component's instance.

field(e.element): DxElement

#include common-ref-elementparam with { element: "UI component" }

field(e.event): event

#include common-ref-eventparam

field(e.validationGroup): Object

The validation group to which the button is related.

To validate the editors that are related to the validation group specified for this button, use the validationGroup field of the object passed as the event handler's parameter. The validationGroup object has the following structure.

  • group
    The name or object of the validation group that is assigned to the button's validationGroup property.
  • validators
    An array of Validator UI components that are included to the validation group.
  • validate()
    The method that allows you to validate the UI components included in the validation group.
  • validated
    The event that occurs after the group is validated. You can attach/detach a handler using the on(eventName, eventHandler)/off(eventName) methods of the group.