Interface IDropdown

Defines the interface for OutSystemsUI Dropdown Pattern

Hierarchy-Diagram

UML class diagram of IDropdown
Legend
icon for an abstract class in the UML class diagram abstract class
icon for an interface in the UML class diagram interface
icon for a public property in the UML class diagram public property
icon for a protected property in the UML class diagram protected property
icon for a public method in the UML class diagram public method
icon for a protected method in the UML class diagram protected method
italic abstract property/method

Hierarchy

Implemented by

Methods

build dispose changeProperty registerCallback equalsToID clear close disable enable getSelectedValues open setProviderConfigs setProviderEvent unsetProviderEvent validation

Properties

isBuilt selfElement uniqueId widgetId

Methods

build

dispose

changeProperty

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

    Memberof

    OSFramework.Interface.IPattern

    Parameters

    • propertyName: string
    • propertyValue: unknown

    Returns void

registerCallback

equalsToID

clear

close

disable

enable

getSelectedValues

open

setProviderConfigs

  • Method used to set the extensibility configs based on provider

    Memberof

    OSFramework.Patterns.Dropdown.IDropdown

    Parameters

    • providerConfigs: any

    Returns void

setProviderEvent

  • Method used to set the extensibility events based on provider

    Memberof

    OSFramework.Patterns.Dropdown.IDropdown

    Parameters

    • eventName: string
    • callback: Generic
    • uniqueId: string

    Returns void

unsetProviderEvent

  • Method used to unset the extensibility events that was previously added

    Memberof

    OSFramework.Patterns.Dropdown.IDropdown

    Parameters

    • eventId: string

    Returns void

validation

  • Method used to set the validation status, and also pass the message to show

    Memberof

    OSFramework.Patterns.Dropdown.IDropdown

    Parameters

    • isValid: boolean
    • validationMessage: string

    Returns void

Properties

isBuilt

isBuilt: boolean

Indicates if the instance of the pattern is built.

Memberof

OSFramework.Interface.IPattern

selfElement

selfElement: HTMLElement

Pattern HTML element

Memberof

OSFramework.Interface.IPattern

uniqueId

uniqueId: string

Internal Id of the instance of the pattern.

Memberof

OSFramework.Interface.IPattern

widgetId

widgetId: string

External Id of the instance of the pattern

Memberof

OSFramework.Interface.IPattern

Settings

Member Visibility

Theme