outsystems-ui - v2.30.0
    Preparing search index...

    Interface IWizard

    Defines the interface for OutSystemsUI Wizard Pattern

    interface IWizard {
        build(): void;
        dispose(): void;
        beNotifiedByChild(childItem: IChild, notifiedTo: string): void;
        isBuilt: boolean;
        selfElement: HTMLElement;
        uniqueId: string;
        widgetId: string;
        changeProperty(propertyName: string, propertyValue: unknown): void;
        registerCallback(eventName: string, callback: OSGeneric): void;
        equalsToID(id: string): boolean;
        configs: WizardConfig;
        addWizardItem(wizardItem: IWizardItem): void;
        removeWizardItem(uniqueId: string): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    isBuilt selfElement uniqueId widgetId configs
    build dispose beNotifiedByChild changeProperty registerCallback equalsToID addWizardItem removeWizardItem
    isBuilt: boolean

    Indicates if the instance of the pattern is built.

    OSFramework.Interface.IPattern

    selfElement: HTMLElement

    Pattern HTML element

    OSFramework.Interface.IPattern

    uniqueId: string

    Internal Id of the instance of the pattern.

    OSFramework.Interface.IPattern

    widgetId: string

    External Id of the instance of the pattern

    OSFramework.Interface.IPattern

    configs: WizardConfig

    Configuration object

    • Method used to be notified by a given dropdownOptionId about a given action and act accordingly

      Parameters

      • childItem: IChild

        Child Item to be stored

      • notifiedTo: string

        triggered notification type name

      Returns void

      OSFramework.Interface.IParent

    • Method signature to change the properties/configs of the pattern.

      Parameters

      • propertyName: string
      • propertyValue: unknown

      Returns void

      OSFramework.Interface.IPattern

    Settings
    Member Visibility

    On This Page
    Properties
    Methods