Get if this context is valid. Notice this does not verify the validity.
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 | AddEventListenerOptionsAdd a path translator to this validation context.
Add a validator to this context. This validator will have to be valid for the context to be valid. If the context is in validation mode, the validator will be validated immediately.
{ UmbValidator } - The validator to add to this context.
Continuously synchronize the messages from this context to the parent context.
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.
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
Focus the first invalid element that this context can find.
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.
Returns the variant ID that this validator is scoped to, if any.
Inherit from a parent validation context, notice you should only use this method if you have the validation context at hand. Otherwise use setDataPath which uses Context-API to retrieve the right parent.
The parent validation context to inherit from.
The data path to bind this validation context to.
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.
Provide this validation context to a specific controller host. This can be used to Host a validation context in a Workspace, but provide it on a certain scope, like a specific Workspace View.
The controller host to provide this validation context to.
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. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Optionaloptions: boolean | EventListenerOptionsRemove a path translator from this validation context.
The translator to remove.
Remove a validator from this context.
{UmbValidator} - The validator to remove from this context.
Perform a one time transfer of the messages from this context to the parent context.
Reset the validation state of this context.
Define a specific data path for this validation context. This will turn this validation context into a sub-context of the parent validation context. And thereby make this context inherit the messages from the parent validation context.
The data path to bind this validation context to.
report() to propagate changes to the parent context.autoReport() to continuously synchronize changes to the parent context.messages and data will be scoped accordingly to the given data path.
const validationContext = new UmbValidationContext(this);
validationContext.setDataPath("$.values[?(@.alias == 'my-property')].value");
A message with the path: '$.values[?(@.alias == 'my-property')].value.innerProperty', will for above example become '$.innerProperty' for the local Validation Context.
Validate this context, all the validators of this context will be validated. Notice its a recursive check meaning sub validation contexts also validates their validators.
succeed {Promise
Validate this context, by a given set of VariantIDs. Notice its a recursive check meaning sub validation contexts also validates their validators, but only for validators matching the given variantIds.
The variantIds to validate by.
Validation Context is the core of Validation. It hosts Validators that has to validate for the context to be valid. It can also be used as a Validator as part of a parent Validation Context.