Class kartik\builder\ActiveFormEvent
| Inheritance | kartik\builder\ActiveFormEvent » yii\base\Event » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
ActiveFormEvent is the event class for kartik\form\ActiveForm. It encapsulates parameters that can be used as part of event handling to manipulate the behavior of builder widgets kartik\builder\Form and kartik\builder\TabularForm.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attribute | string | The model attribute name used in the form | kartik\builder\ActiveFormEvent |
| $data | mixed | The data that is passed to yii\base\Component::on() when attaching an event handler. | yii\base\Event |
| $eventData | array | Any additional event data that can be passed by the event handler as key value pairs. | kartik\builder\ActiveFormEvent |
| $handled | boolean | Whether the event is handled. | yii\base\Event |
| $index | integer | The row index of the attribute in the bootstrap grid layout. | kartik\builder\ActiveFormEvent |
| $name | string | The event name. | yii\base\Event |
| $sender | object|null | The sender of this event. | yii\base\Event |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\BaseObject |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of an object property. | yii\base\BaseObject |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
| __set() | Sets value of an object property. | yii\base\BaseObject |
| __unset() | Sets an object property to null. | yii\base\BaseObject |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| hasHandlers() | Returns a value indicating whether there is any handler attached to the specified class-level event. | yii\base\Event |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
| init() | Initializes the object. | yii\base\BaseObject |
| off() | Detaches an event handler from a class-level event. | yii\base\Event |
| offAll() | Detaches all registered class-level event handlers. | yii\base\Event |
| on() | Attaches an event handler to a class-level event. | yii\base\Event |
| trigger() | Triggers a class-level event. | yii\base\Event |
Property Details
The model attribute name used in the form
Any additional event data that can be passed by the event handler as key value pairs.
The row index of the attribute in the bootstrap grid layout.