Skip to content

DefineHtmlEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\DefineHtmlEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Extended by
craft\events\DefineElementEditorHtmlEvent, craft\events\DefineFieldHtmlEvent
Since
3.7.0

DefineHtmlEvent is used to define the HTML for a UI component.

View source

Public Properties

PropertyDescription
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
htmlstring – The UI component’s HTML
namestring – The event name.
senderobject, null – The sender of this event.
staticboolean – Whether the HTML should be static (non-interactive)

html

Type
string
Default value
''

The UI component’s HTML

View source

static

Type
boolean
Default value
false
Since
4.0.0

Whether the HTML should be static (non-interactive)

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
hasHandlers()Returns a value indicating whether there is any handler attached to the specified class-level event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
off()Detaches an event handler from a class-level event.
offAll()Detaches all registered class-level event handlers.
on()Attaches an event handler to a class-level event.
trigger()Triggers a class-level event.