@umbraco-cms/backoffice
    Preparing search index...

    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.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Accessors

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • 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.

      Parameters

      • dataPath: string

        The data path to bind this validation context to.

      Returns void

      • report Call report() to propagate changes to the parent context.
      • autoReport Call 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.