AbstractProtected_Protected_Protected Readonly_Protected Optional_Protected_Protected Optional_Protected Readonly_Protected Readonly_ReadonlyactionsReadonlyblockReadonlycontentReadonlycontentReadonlycontentReadonlycontentReadonlycontentReadonlycontentReadonlycreateReadonlycreateReadonlyhasReadonlyindexReadonlylabelReadonlylayoutProtected ReadonlylocalizeReadonlynameObservable of the block's resolved label text (UFM rendered as plain text).
ReadonlyreadReadonlysettingsReadonlysettingsAbstract ReadonlyshowReadonlyuniqueReadonlyunsupportedReadonlyworkspaceReadonlyworkspaceReadonlyworkspaceProtected Abstract_Protected Abstract_Protected Abstract_Protected_Whether this context should run its own hidden UmbUfmVirtualRenderController as the
source of getName(). Subclasses whose entry element owns a canonical <umb-ufm-render>
(and pushes text via setName) should override this to return false.
true to create the legacy hidden renderer; false to skip it.
Scheduled for removal in Umbraco 19. Subclasses must own their own
<umb-ufm-render> and push resolved text via setName — the hidden virtual
renderer fallback will be removed entirely.
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Optionaloptions: boolean | AddEventListenerOptionsCallback method called with the resolved context instance or undefined.
Reference to the created Context Consumer Controller instance
Subscribe to a context. The callback fires when the context resolves, again if the context is replaced, and can also be invoked with undefined if the context is unprovided or the host disconnects. Use this whenever a controller or element needs the context at setup time — both for ongoing observation and for reading values immediately on resolve. This is the default choice; prefer it over getContext unless the context is only needed inside a later user action.
Copy the block entry to the clipboard. Subclasses must override this method with editor-specific clipboard logic.
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
Get the alias of the content element type.
Get the icon of the content element type.
Get the name of the content element type.
Optionaloptions: UmbClassGetContextOptionsOptions for resolving the context once, including timeout-related behavior such as preventTimeout.
A Promise resolving to the Context API instance when available, or undefined when applicable.
Retrieve a context once as a Promise. Use this only when the context is first needed inside a user action or event handler that runs later (for example a button click, a property action, or an entity action execute()). For setup-time access — including a single immediate read — use consumeContext instead so the controller lifecycle handles resolution and cleanup. The returned Promise may reject if the context is not found before the default timeout; callers should handle rejection and/or pass preventTimeout in the options when waiting longer is expected.
FunctionGet the current value of this Blocks label. getName
An Observable to observe from.
Optionalcallback: ObserverCallback<UmbObserverValueType<ObservableType>>Callback method called when data is changed.
OptionalcontrollerAlias: UmbControllerAlias | nullDefine an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Reference to the created Observer Controller instance.
The API instance to be exposed.
Reference to the created Context Provider Controller instance
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
Optionaloptions: boolean | EventListenerOptionsFunctionSet the contentKey of this entry. setContentKey
the entry content key.
Set the resolved name text. Intended to be called by the block entry element
when its canonical <umb-ufm-render> reports updated text via umb-ufm-resolved.
the resolved text.
This base provides the necessary for a class to become a context-api controller.