Motif API
    Preparing search index...

    Interface BuiltinIconButtonUiAction

    interface BuiltinIconButtonUiAction {
        accessibleCaption: AccessibleCaption;
        accessKey: string;
        autoAcceptanceType: "Valid" | "Accepted" | "None";
        autoEchoCommit: boolean;
        autoInvalid: boolean;
        caption: string;
        command: Command;
        commitEventer: CommitEventHandler;
        commitOnAnyValidInput: boolean;
        definedValue: boolean;
        edited: boolean;
        editedChangeEventer: EditedChangeEventHandler;
        editedInvalidErrorText: string;
        editedValid: boolean;
        enabled: boolean;
        iconId:
            | "Blankest"
            | "PrimaryDitemFrame"
            | "SymbolLink"
            | "AccountGroupLink"
            | "SubWindowReturn"
            | "CopyToClipboard"
            | "Execute"
            | "BuyOrderPad"
            | "SellOrderPad"
            | "AmendOrderPad"
            | "CancelOrderPad"
            | "MoveOrderPad"
            | "SelectColumns"
            | "AutoSizeColumnWidths"
            | "RollUp"
            | "RollDown"
            | "Filter"
            | "Save"
            | "NewWatchlist"
            | "OpenWatchlist"
            | "SaveWatchlist"
            | "Lighten"
            | "Darken"
            | "Brighten"
            | "Complement"
            | "Saturate"
            | "Desaturate"
            | "SpinColor"
            | "CopyColor"
            | "ReturnOk"
            | "ReturnCancel"
            | "SearchNext"
            | "CancelSearch"
            | "MoveUp"
            | "MoveToTop"
            | "MoveDown"
            | "MoveToBottom"
            | "NotHistorical"
            | "Historical"
            | "HistoricalCompare"
            | "Details"
            | "ToggleSearchTermNotExchangedMarketProcessed"
            | "ExpandVertically"
            | "RestoreVertically"
            | "CollapseVertically"
            | "MarkAll"
            | "InsertIntoListFromLeft"
            | "RemoveFromListToLeft"
            | "RemoveSelectedFromList"
            | "EnlargeToTopLeft"
            | "Dot"
            | "Exclamation"
            | "Delete"
            | "Detach"
            | "Dropdown"
            | "Close";
        inputEventer: InputEventHandler;
        inputtedText: string;
        placeholder: string;
        required: boolean;
        signalEventer: SignalEventHandler;
        state: | "Error"
        | "Disabled"
        | "Readonly"
        | "Missing"
        | "Invalid"
        | "Valid"
        | "Accepted"
        | "Waiting"
        | "Warning";
        title: string;
        value: boolean;
        cancelEdit(): void;
        isValueOk(): boolean;
        pushAccepted(value?: boolean): void;
        pushAccessKey(accessKey: string): void;
        pushCaption(value: string): void;
        pushDisabled(disabledTitleText?: string): void;
        pushError(errorTitleText?: string): void;
        pushIcon(
            iconId:
                | "Blankest"
                | "PrimaryDitemFrame"
                | "SymbolLink"
                | "AccountGroupLink"
                | "SubWindowReturn"
                | "CopyToClipboard"
                | "Execute"
                | "BuyOrderPad"
                | "SellOrderPad"
                | "AmendOrderPad"
                | "CancelOrderPad"
                | "MoveOrderPad"
                | "SelectColumns"
                | "AutoSizeColumnWidths"
                | "RollUp"
                | "RollDown"
                | "Filter"
                | "Save"
                | "NewWatchlist"
                | "OpenWatchlist"
                | "SaveWatchlist"
                | "Lighten"
                | "Darken"
                | "Brighten"
                | "Complement"
                | "Saturate"
                | "Desaturate"
                | "SpinColor"
                | "CopyColor"
                | "ReturnOk"
                | "ReturnCancel"
                | "SearchNext"
                | "CancelSearch"
                | "MoveUp"
                | "MoveToTop"
                | "MoveDown"
                | "MoveToBottom"
                | "NotHistorical"
                | "Historical"
                | "HistoricalCompare"
                | "Details"
                | "ToggleSearchTermNotExchangedMarketProcessed"
                | "ExpandVertically"
                | "RestoreVertically"
                | "CollapseVertically"
                | "MarkAll"
                | "InsertIntoListFromLeft"
                | "RemoveFromListToLeft"
                | "RemoveSelectedFromList"
                | "EnlargeToTopLeft"
                | "Dot"
                | "Exclamation"
                | "Delete"
                | "Detach"
                | "Dropdown"
                | "Close",
        ): void;
        pushInvalid(invalidTitleText?: string): void;
        pushPlaceholder(value: string): void;
        pushReadonly(): void;
        pushSelected(): void;
        pushState(
            newState:
                | "Error"
                | "Disabled"
                | "Readonly"
                | "Missing"
                | "Invalid"
                | "Valid"
                | "Accepted"
                | "Waiting"
                | "Warning",
            stateTitleText?: string,
        ): void;
        pushTitle(value: string): void;
        pushUnselected(): void;
        pushValid(titleText?: string): void;
        pushValue(value: boolean): void;
        pushWaiting(waitingTitleText?: string): void;
        pushWarning(warningTitleText?: string): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accessibleCaption accessKey autoAcceptanceType autoEchoCommit autoInvalid caption command commitEventer commitOnAnyValidInput definedValue edited editedChangeEventer editedInvalidErrorText editedValid enabled iconId inputEventer inputtedText placeholder required signalEventer state title value

    Methods

    cancelEdit isValueOk pushAccepted pushAccessKey pushCaption pushDisabled pushError pushIcon pushInvalid pushPlaceholder pushReadonly pushSelected pushState pushTitle pushUnselected pushValid pushValue pushWaiting pushWarning

    Properties

    accessibleCaption: AccessibleCaption
    accessKey: string
    autoAcceptanceType: "Valid" | "Accepted" | "None"
    autoEchoCommit: boolean
    autoInvalid: boolean
    caption: string
    command: Command
    commitEventer: CommitEventHandler
    commitOnAnyValidInput: boolean
    definedValue: boolean
    edited: boolean
    editedChangeEventer: EditedChangeEventHandler
    editedInvalidErrorText: string
    editedValid: boolean
    enabled: boolean
    iconId:
        | "Blankest"
        | "PrimaryDitemFrame"
        | "SymbolLink"
        | "AccountGroupLink"
        | "SubWindowReturn"
        | "CopyToClipboard"
        | "Execute"
        | "BuyOrderPad"
        | "SellOrderPad"
        | "AmendOrderPad"
        | "CancelOrderPad"
        | "MoveOrderPad"
        | "SelectColumns"
        | "AutoSizeColumnWidths"
        | "RollUp"
        | "RollDown"
        | "Filter"
        | "Save"
        | "NewWatchlist"
        | "OpenWatchlist"
        | "SaveWatchlist"
        | "Lighten"
        | "Darken"
        | "Brighten"
        | "Complement"
        | "Saturate"
        | "Desaturate"
        | "SpinColor"
        | "CopyColor"
        | "ReturnOk"
        | "ReturnCancel"
        | "SearchNext"
        | "CancelSearch"
        | "MoveUp"
        | "MoveToTop"
        | "MoveDown"
        | "MoveToBottom"
        | "NotHistorical"
        | "Historical"
        | "HistoricalCompare"
        | "Details"
        | "ToggleSearchTermNotExchangedMarketProcessed"
        | "ExpandVertically"
        | "RestoreVertically"
        | "CollapseVertically"
        | "MarkAll"
        | "InsertIntoListFromLeft"
        | "RemoveFromListToLeft"
        | "RemoveSelectedFromList"
        | "EnlargeToTopLeft"
        | "Dot"
        | "Exclamation"
        | "Delete"
        | "Detach"
        | "Dropdown"
        | "Close"
    inputEventer: InputEventHandler
    inputtedText: string
    placeholder: string
    required: boolean
    signalEventer: SignalEventHandler
    state:
        | "Error"
        | "Disabled"
        | "Readonly"
        | "Missing"
        | "Invalid"
        | "Valid"
        | "Accepted"
        | "Waiting"
        | "Warning"
    title: string
    value: boolean

    Methods

    • Parameters

      • OptionaldisabledTitleText: string

      Returns void

    • Parameters

      • OptionalerrorTitleText: string

      Returns void

    • Parameters

      • iconId:
            | "Blankest"
            | "PrimaryDitemFrame"
            | "SymbolLink"
            | "AccountGroupLink"
            | "SubWindowReturn"
            | "CopyToClipboard"
            | "Execute"
            | "BuyOrderPad"
            | "SellOrderPad"
            | "AmendOrderPad"
            | "CancelOrderPad"
            | "MoveOrderPad"
            | "SelectColumns"
            | "AutoSizeColumnWidths"
            | "RollUp"
            | "RollDown"
            | "Filter"
            | "Save"
            | "NewWatchlist"
            | "OpenWatchlist"
            | "SaveWatchlist"
            | "Lighten"
            | "Darken"
            | "Brighten"
            | "Complement"
            | "Saturate"
            | "Desaturate"
            | "SpinColor"
            | "CopyColor"
            | "ReturnOk"
            | "ReturnCancel"
            | "SearchNext"
            | "CancelSearch"
            | "MoveUp"
            | "MoveToTop"
            | "MoveDown"
            | "MoveToBottom"
            | "NotHistorical"
            | "Historical"
            | "HistoricalCompare"
            | "Details"
            | "ToggleSearchTermNotExchangedMarketProcessed"
            | "ExpandVertically"
            | "RestoreVertically"
            | "CollapseVertically"
            | "MarkAll"
            | "InsertIntoListFromLeft"
            | "RemoveFromListToLeft"
            | "RemoveSelectedFromList"
            | "EnlargeToTopLeft"
            | "Dot"
            | "Exclamation"
            | "Delete"
            | "Detach"
            | "Dropdown"
            | "Close"

      Returns void

    • Parameters

      • OptionalinvalidTitleText: string

      Returns void

    • Parameters

      • newState:
            | "Error"
            | "Disabled"
            | "Readonly"
            | "Missing"
            | "Invalid"
            | "Valid"
            | "Accepted"
            | "Waiting"
            | "Warning"
      • OptionalstateTitleText: string

      Returns void

    • Parameters

      • OptionaltitleText: string

      Returns void

    • Parameters

      • OptionalwaitingTitleText: string

      Returns void

    • Parameters

      • OptionalwarningTitleText: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods