Protected Readonly_Protected Optional_Protected Optional_Readonly_The parent entity that the new entity will be created under. Internal property. Use UMB_PARENT_ENTITY_CONTEXT to get the parent entity.
Readonly_The entity type that the new entity will be created under. Internal property. Use UMB_PARENT_ENTITY_CONTEXT to get the parent entity.
Readonly_The entity unique that the new entity will be created under. Internal property. Use UMB_PARENT_ENTITY_CONTEXT to get the parent entity.
Protected Readonly_Protected Readonly_ReadonlycollectionReadonlycontentReadonlycontentReadonlycontentReadonlydataReadonlyentityReadonlyforbiddenReadonlyIS_ReadonlyIS_ReadonlyisReadonlyloadingOptional ReadonlymodalReadonlyparentReadonlyparentReadonlypersistedReadonlypropertyReadonlypropertyReadonlyreadReadonlyroutesReadonlysplitReadonlystructureReadonlytemplateReadonlyuniqueProtectedvalidationThe base validation context for the workspace. This ensures that at least one validation context is always present.
ReadonlyvaluesReadonlyvariantReadonlyvariantsReadonlyvariesReadonlyvariesReadonlyvariesReadonlyviewReadonlyworkspaceProtected_Protected_Protected_Protected_Protected_OptionalexecutionOptions: UmbWorkspaceActionExecutionOptionsProtected_Gets the parent that a new entity will be created under.
The parent entity
Sets the parent that a new entity will be created under.
The parent entity
Protected_Protected_Protected_Protected_The data to process.
The processed data.
Protected_Protected_Protected_Protected_OptionalvariantIds: UmbVariantId[]Protected_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 | AddEventListenerOptionsAppends a validation context to the workspace.
Ask the server to validate the save data
The data to validate
The variant ids to validate
Get the data to save
The variant ids to save
{Promise
Callback 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.
OptionalblueprintUnique: stringCreate a data scaffold
The arguments to create the scaffold.
Optionalpreset?: UmbDeepPartialObject<DetailModelType>The data of the scaffold.
Deletes the entity.
The unique identifier of the entity to delete.
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
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.
Get the entity type
The entity type
Check if there are unpersisted changes.
true if there are unpersisted changes.
Get the name of a variant
OptionalvariantId: UmbVariantIdThe variant id. If not provided, returns the name of the first active variant.
Get the current value of the property with the given alias and variantId.
The alias of the property
OptionalvariantId: UmbVariantIdThe variant id of the property
The value or undefined if not set or found.
Get the values of the content
Get the variant by the given variantId
The variant id
ProtectedinvalidOptionalreason: anyProtectedloadRequests the latest persisted version of the entity from the server WITHOUT applying it to the workspace state, and returns the processed data.
The latest persisted data.
Get an observable for the name of a variant
OptionalvariantId: UmbVariantIdThe variant id. If not provided, observes the name of the first active variant.
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.
Perform the create or update of the content
The variant ids to save
The data to save
OptionalpersistenceMethod: UmbContentWorkspaceCreateOrUpdatePersistMethods<UmbDocumentDetailModel>Optional custom persistence logic.
Observe the property type
The id of the property
FunctionpropertyValueByAlias
The alias of the property
OptionalvariantId: UmbVariantIdThe variant
The API instance to be exposed.
Reference to the created Context Provider Controller instance
Reload the workspace data
The promise of the reload
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
Optionaloptions: boolean | EventListenerOptionsRequest a save of the workspace, in the case of Document Workspaces the validation does not need to be valid for this to be saved.
Optionaloptions: UmbWorkspaceActionExecutionOptionsOptional execution options (e.g. onActionStarting invoked after any save-variant modal closes).
A promise which resolves once it has been completed.
Request a submit of the workspace, in the case of Document Workspaces the validation does not need to be valid for this to be submitted.
a promise which resolves once it has been completed.
Run the mandatory validation for the save data
The data to validate
OptionalurlProviderAlias: stringGet the current data
New data of this workspace.
ProtectedsetSet the name of a variant
The name of the variant
OptionalvariantId: UmbVariantIdThe variant id
Set the value of the property with the given alias and variantId.
The alias of the property
The value to set
OptionalvariantId: UmbVariantIdThe variant id of the property
If a Workspace has multiple validation contexts, then this method can be overwritten to return the correct one.
Promise that resolves to void when the validation is complete.
Get the variant by the given variantId
The variant id
The data supplier for a Element Property Dataset