Aware Controls | JavaScript (ES5) Dialog Documentation

Interface representing the Dialog class.

Properties

allowDragging Boolean

Specifies whether the dialog is allowed to be dragged by the user by using the dialog header.

Default: false

allowResize Boolean

Specifies whether the dialog is allowed to be resized by the user by using the resize handles.

Default: false

animationSettings AnimationSettingsModel

Specifies the animation settings that are applied when opening and closing the dialog.

Default: { effect: 'Fade', duration: 400, delay:0 }

buttons ButtonPropsModel

Specifies the action buttons properties that should be included on the dialog.

Default: { }

closeOnEscape Boolean

Specifies whether the dialog can be closed when pressing the escape key.

Default: true

content String HTMLElement Function

Specifies the content that will be displayed in the dialog's content area.

Default: ""

cssClass String

Specifies CSS classes to customize the appearance of the control.

Default: ""

enableHtmlSanitizer Boolean

Specifies whether to allow the rendering of untrusted HTML and JavaScript values withing the control. When true, any untrusted strings or scripts will be remote before rendering.

Default: false

enableRtl Boolean

Specifies whether to render the control in right to left direction.

Default: false

enableState Boolean

Specifies whether to persist the state of the control between page loads.

The following properties will be saved to state.

height
width
position

Default: false

footerTemplate String HTMLElement Function

Specifies a template to customize the dialog's footer. When a footer template if set the buttons will not be rendered.

Default: ""

Specifies the dialog title or a template to be rendered in the dialogs header.

Default: ""

height String Number

Specifies the height of the dialog.

Default: auto

isModal Boolean

Specifies whether the dialog will be displayed as modal or a non-modal.

Default: false

locale String

Specifies the culture and localization value for this control, overriding the globally defined value.

Default: en-US

minHeight String Number

Specify the minimum height of the dialog.

Default: ""

position PositionDataModel

Specifies the position of the dialog within the target element.

Default: { X: 'center', Y: 'center' }

resizeHandles ResizeDirections[]

Specifies the directions the that dialog can be resized in.

Default: { X: 'center', Y: 'center' }

showCloseIcon Boolean

Specifies whether the close icon should be included in the upper right corner of the header.

Default: true

soundPath String

Specifies the path to the sound file that will be played when the toast notification is opened.

Default: null

target String HTMLElement

Specifies the target container where the dialog will be displayed. The default container when not set if the document.body.

Default: null

visible Boolean

Specifies whether the dialog should be visible or not.

Default: true

width String Number

Specifies the width of the control. By default, the width of the control is determined by its parent container. Value can be expressed in percent or pixels.

Default: 100%