A2v10 Platform documentation
UK


Dialog Layout Element

All containers

Represents a container that contains other controls or other containers. Always used as the root markup element.

Inherits: RootContainer : Container : UIElement : UIElementBase

Content property: Children

Properties

Name Type Description
Title String The title of the dialog box.
HelpUrl String The path to the help page. If specified, a hyperlink to the help page will appear in the title of the dialog box.
TitleInfo UIElementBase Additional element in the header. Displayed after the title text.
Buttons UIElementCollection The content of the button bar. Usually a set of control buttons.
Taskpad UIElementBase Dialog taskbar. Most often this is the Taskpad element.
Width Length The width of the dialog box. By default, it is determined by the content.
Height Length The height of the dialog box. By default, it is determined by the content.
MinWidth Length The window minimum width.
Size DialogSize The size of the dialog box. Possible values:
  • Default - by default.
  • Small - small.
  • Medium - regular.
  • Large - large.
  • Max - Expanded to full screen. Equivalent to Maximize="True"
The specific size values depend on the user interface theme. If the Width property is specified, then this property is ignored.
Maximize Boolean The maximum possible size of the dialogue. Will vary depending on the size of the browser window.
ButtonOnTop Boolean Place the button bar at the top of the dialog box.
ShowWaitCursor Boolean If the property is set to True, then when making requests to the server, the dialog box will be grayed out and a progress bar will be displayed.
TestId String Window identifier. Used for testing.
AlwaysOk Boolean If the property is set to True, then when the dialog is closed in any way, it will be considered that the returned result is true.
CanCloseDelegate String The name of the delegate that will be called upon an attempt to close the window (in any way).
Background BackgroundStyle Dialogue background color.
Overflow Boolean Whether a scroll bar can appear in the dialogue. Set this property if you want popups (such as DatePicker) to be able to extend beyond the bounds of the element. In this case, you need to be careful to ensure that the main content does not go beyond the boundaries. The scroll bar will not be displayed.
Base item properties

CanCloseDelegate delegate format

canClose(this:IRoot): any | Promise

Parameters:

  • this - data model root.

Returned value:

  • Promise - If Promise Promise returns a truthy value, then the dialog will close with this result.
  • any - If the value is truthy, then the dialog will close with this result.

Note: truthy is any value that is considered to be true.