Draggable Button interface

Hierarchy

Properties

ButtonText: string

The button label text.

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.

OnClick: ((button) => void)

Type declaration

    • (button): void
    • The click event of the draggable button.

      Parameters

      Returns void

OnDragged: ((button, event, position) => void)

Type declaration

    • (button, event, position): void
    • Registers a callback when the button has been dropped. The callback will be called with the button and the position where it was dropped.

      Parameters

      • button: MEUIDraggableButton

        The button which was dragged

      • event: "Dragged"

        The event which was triggered. Always "Dragged"

      • position: Point

        The position where the button was dropped on the canvas.

      Returns void

ParentClasses: string[]

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

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.

Target: DropTarget

The potential drop target. Defaults to pages.

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: "DraggableButton"

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

Visible: boolean

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

Generated using TypeDoc