DefineElementInnerHtmlEvent
- Type
- Class
- Namespace
- craft\events
- Inherits
- craft\events\DefineElementInnerHtmlEvent » yii\base\Event (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 4.0.0
DefineElementInnerHtmlEvent class.
View source (opens new window)
# Public Properties
Property | Description |
---|---|
context | string (opens new window) – The context the element is going to be shown in (index , field , etc. |
data (opens new window) | mixed – The data that is passed to yii\base\Component::on() (opens new window) when attaching an event handler. |
element | craft\base\ElementInterface – The element being rendered via \craft\helpers\Cp::elementHtml() . |
handled (opens new window) | boolean (opens new window) – Whether the event is handled. |
innerHtml | string (opens new window) – The element’s pre-rendered inner HTML. |
name (opens new window) | string (opens new window) – The event name. |
sender (opens new window) | object (opens new window), null (opens new window) – The sender of this event. |
showDraftName | boolean (opens new window) – Whether to show the draft name beside the label if the element is a draft of a published element. |
showLabel | boolean (opens new window) – Whether the element label should be shown. |
showStatus | boolean (opens new window) – Whether the element status should be shown (if the element type has statuses). |
showThumb | boolean (opens new window) – Whether the element thumb should be shown (if the element has one). |
size | string (opens new window) – The size of the element (small or large ). |
# context
- Type
- string (opens new window)
- Default value
null
The context the element is going to be shown in (index
, field
, etc.).
View source (opens new window)
# element
- Type
- craft\base\ElementInterface
- Default value
null
The element being rendered via \craft\helpers\Cp::elementHtml()
.
View source (opens new window)
# innerHtml
- Type
- string (opens new window)
- Default value
null
The element’s pre-rendered inner HTML.
View source (opens new window)
# showDraftName
- Type
- boolean (opens new window)
- Default value
null
Whether to show the draft name beside the label if the element is a draft of a published element.
View source (opens new window)
# showLabel
- Type
- boolean (opens new window)
- Default value
null
Whether the element label should be shown.
View source (opens new window)
# showStatus
- Type
- boolean (opens new window)
- Default value
null
Whether the element status should be shown (if the element type has statuses).
View source (opens new window)
# showThumb
- Type
- boolean (opens new window)
- Default value
null
Whether the element thumb should be shown (if the element has one).
View source (opens new window)
# size
- Type
- string (opens new window)
- Default value
null
The size of the element (small
or large
).
View source (opens new window)
# Public Methods
Method | Description |
---|---|
__call() (opens new window) | Calls the named method which is not a class method. |
__construct() (opens new window) | Constructor. |
__get() (opens new window) | Returns the value of an object property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__set() (opens new window) | Sets value of an object property. |
__unset() (opens new window) | Sets an object property to null. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
hasHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the specified class-level event. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
init() (opens new window) | Initializes the object. |
off() (opens new window) | Detaches an event handler from a class-level event. |
offAll() (opens new window) | Detaches all registered class-level event handlers. |
on() (opens new window) | Attaches an event handler to a class-level event. |
trigger() (opens new window) | Triggers a class-level event. |