iFrame interface

Hierarchy

Properties

Classes: string[]

Additional CSS classes to add to the control.

Enabled: boolean

Enabled state of the UI element. When the type supports this, the UI element will be disabled when set to false.

Id: string

The id of the UI element.

Name: string

Name of the UI element. For form fields that would be the name otherwise used for reference only.

OnLoad: ((iframe, event) => void)

Type declaration

    • (iframe, event): void
    • Registers a callback for the Load event called when the iFrame has been loaded.

      Parameters

      • iframe: MEUIIFrame

        The iFrame which was loaded.

      • event: "Load"

        The event name. Always "Load".

      Returns void

OnMessage: ((iframe, event, message) => void)

Type declaration

    • (iframe, event, message): void
    • Registers for the Message event when the iFrame sends data to the script.

      Parameters

      • iframe: MEUIIFrame

        The iFrame which sent the message.

      • event: "Message"

        The event name. Always "Message".

      • message: string

        The message received from the iframe.

      Returns void

ParentClasses: string[]

Additional CSS classes to add to the parent control when supported.

Size?: MEUISize

The size of the UI element.

Src: string

The source URL of the iFrame.

StandardClasses: string[]

The standard classes of the control. Modify this property only if you know what you are doing.

Tags: string[]

Tags for the UI element. Used for reference only.

TextDirection: TextFieldTextDirection

The text direction of the UI element. Defaults to Inherit, meaning it will use the editor default.

ToolTip?: string

Tooltip text of the UI element.

Type: "IFrame"

The type of the UI element. Always "IFrame".

Visible: boolean

Visibility flag of the UI element. When not visible it will be hidden from the UI.

Methods

  • Sends a message to the iFrame.

    Parameters

    • message: string

      The message to send

    Returns void

Generated using TypeDoc