Class DialogBox | Apps Script | Google Developers

Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.

A form of popup that has a caption area at the top and can be dragged by the user. Unlike a PopupPanel, calls to setWidth(width) and setHeight(height) will set the width and height of the dialog box itself, even if a widget has not been added as yet.

In general it's not recommended to add this panel as a child of another widget or of the app as that will make it behave like any other inline panel and not act as a popup. Instead, create the popup and then use its show() and hide() methods to show and hide it. See the example below.

Internally, UiApp widgets are built on top of the Google Web Toolkit, and it can sometimes be helpful to look at the GWT documentation directly. You can find the DialogBox documentation here.

Here is an example showing how to use the dialog box widget:

 

 function doGet() {
   var app = UiApp.createApplication();
   // Create a dialog box.
   var dialog = app.createDialogBox();
   // Set the position and dimensions.
   dialog.setPopupPosition(100, 100).setSize(500, 500);
   // Show the dialog. Note that it does not have to be "added" to the UiInstance.
   dialog.show();
   return app;
 }

Deprecated methods

Method	Return type	Brief description
`add(widget)`	`DialogBox`	Add a widget to the `DialogBox`.
`addAutoHidePartner(partner)`	`DialogBox`	Set the partner widget for auto-hiding.
`addCloseHandler(handler)`	`DialogBox`	Add a handler for close events.
`addStyleDependentName(styleName)`	`DialogBox`	Sets the dependent style name of this `DialogBox`.
`addStyleName(styleName)`	`DialogBox`	Adds a style name to this `DialogBox`.
`clear()`	`DialogBox`	Remove all widgets from the `DialogBox`.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `DialogBox`.
`getType()`	`String`	Gets the type of this object.
`hide()`	`DialogBox`	Hides the popup.
`setAnimationEnabled(animationEnabled)`	`DialogBox`	Sets whether opening and closing the `DialogBox` is animated.
`setAutoHideEnabled(enabled)`	`DialogBox`	Enable or disable the autoHide feature.
`setGlassEnabled(enabled)`	`DialogBox`	Enable or disable a "glass" pane.
`setGlassStyleName(styleName)`	`DialogBox`	Set the style name of the glass panel.
`setHTML(html)`	`DialogBox`	Sets the HTML content of this `DialogBox`.
`setHeight(height)`	`DialogBox`	Sets the height of this `DialogBox`.
`setId(id)`	`DialogBox`	Sets the id of this `DialogBox`.
`setLayoutData(layout)`	`DialogBox`	Set the layout for this `DialogBox`.
`setModal(modal)`	`DialogBox`	Sets whether this `DialogBox` is in "modal" mode.
`setPixelSize(width, height)`	`DialogBox`	Sets the size of this `DialogBox` in pixels.
`setPopupPosition(left, top)`	`DialogBox`	Sets the popup's position relative to the browser's client area.
`setPopupPositionAndShow(a)`	`DialogBox`	Set the popup position.
`setPreviewingAllNativeEvents(previewing)`	`DialogBox`	When enabled, the `DialogBox` will preview all native events, even if another popup was opened after this one.
`setSize(width, height)`	`DialogBox`	Sets the size of this `DialogBox`.
`setStyleAttribute(attribute, value)`	`DialogBox`	Sets one of this `DialogBox`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`DialogBox`	Sets this `DialogBox`'s style attributes.
`setStyleName(styleName)`	`DialogBox`	Sets the style name of this `DialogBox`.
`setStylePrimaryName(styleName)`	`DialogBox`	Sets the primary style name of this `DialogBox`.
`setTag(tag)`	`DialogBox`	Sets the text tag of this `DialogBox`.
`setText(text)`	`DialogBox`	Sets the text inside the caption.
`setTitle(title)`	`DialogBox`	Sets the hover title of this `DialogBox`.
`setVisible(visible)`	`DialogBox`	Sets whether this `DialogBox` is visible.
`setWidget(widget)`	`DialogBox`	Sets the widget inside this `DialogBox`, removing anything previously there.
`setWidth(width)`	`DialogBox`	Sets the width of this `DialogBox`.
`show()`	`DialogBox`	Shows the popup.

Deprecated methods

`add(widget)`

Deprecated. This function is deprecated and should not be used in new scripts.

Add a widget to the DialogBox.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to add.

Return

DialogBox — the DialogBox itself, useful for chaining.

`addAutoHidePartner(partner)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the partner widget for auto-hiding.

This is not currently functional.

Parameters

Name	Type	Description
`partner`	`Component`	the partner widget.

Return

DialogBox — the DialogBox itself, useful for chaining.

`addCloseHandler(handler)`

Deprecated. This function is deprecated and should not be used in new scripts.

Add a handler for close events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 

 function doGet() {
   var app = UiApp.createApplication();
   var item1 = app.createTreeItem("item1");
   item1.addItem(app.createTreeItem("item2"));
   var tree = app.createTree();
   tree.addItem(item1);
   var handler = app.createServerHandler("handlerFunction");
   tree.addCloseHandler(handler)
   app.add(tree);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "close".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
 }

In addition, the values of certain widgets can be sent up with the event as well as "callback elements." See the documentation of ServerHandler for more information.

Parameters

Name	Type	Description
`handler`	`Handler`	the handler to execute when the event occurs. This can be a `ClientHandler` or a `ServerHandler`.

Return

DialogBox — the DialogBox itself, useful for chaining.

`addStyleDependentName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the dependent style name of this DialogBox.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

DialogBox — the DialogBox itself, useful for chaining.

`addStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Adds a style name to this DialogBox.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

DialogBox — the DialogBox itself, useful for chaining.

`clear()`

Deprecated. This function is deprecated and should not be used in new scripts.

Remove all widgets from the DialogBox.

Return

DialogBox — the DialogBox itself, useful for chaining.

`getId()`

Deprecated. This function is deprecated and should not be used in new scripts.

Returns the id that has been assigned to this object.

This can be used in conjunction with app.getElementById() to retrieve a reference to this object.

Return

String — the id that has been assigned to this object

`getTag()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the text tag of this DialogBox.

Return

String — the text tag.

`getType()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the type of this object.

Return

String — the object type

`hide()`

Deprecated. This function is deprecated and should not be used in new scripts.

Hides the popup.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setAnimationEnabled(animationEnabled)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether opening and closing the DialogBox is animated.

Parameters

Name	Type	Description
`animationEnabled`	`Boolean`	whether to animate opening and closing.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setAutoHideEnabled(enabled)`

Deprecated. This function is deprecated and should not be used in new scripts.

Enable or disable the autoHide feature.

When enabled, the DialogBox will be automatically hidden when the user clicks outside of it.

Parameters

Name	Type	Description
`enabled`	`Boolean`	whether auto-hiding should be enabled.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setGlassEnabled(enabled)`

Deprecated. This function is deprecated and should not be used in new scripts.

Enable or disable a "glass" pane.

When enabled, the background will be blocked with a semi-transparent pane the next time it is shown. If the DialogBox is already visible, the glass will not be displayed until it is hidden and shown again.

Parameters

Name	Type	Description
`enabled`	`Boolean`	whether the glass panel should be enabled.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setGlassStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the style name of the glass panel.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setHTML(html)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the HTML content of this DialogBox.

Parameters

Name	Type	Description
`html`	`String`	the new HTML

Return

DialogBox — the DialogBox itself, useful for chaining.

`setHeight(height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the height of this DialogBox.

Parameters

Name	Type	Description
`height`	`String`	the new height in any CSS unit such as "10px" or "50%".

Return

DialogBox — the DialogBox itself, useful for chaining.

`setId(id)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the id of this DialogBox.

Parameters

Name	Type	Description
`id`	`String`	the new id, which can be used to retrieve the `DialogBox` from app.getElementById(id).

Return

DialogBox — the DialogBox itself, useful for chaining.

`setLayoutData(layout)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the layout for this DialogBox.

This is not currently functional.

Parameters

Name	Type	Description
`layout`	`Object`

Return

DialogBox — the DialogBox itself, useful for chaining.

`setModal(modal)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether this DialogBox is in "modal" mode.

When the DialogBox is modal, keyboard or mouse events that do not target the PopupPanel or its children will be ignored.

Parameters

Name	Type	Description
`modal`	`Boolean`	whether the `DialogBox` should be modal.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setPixelSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this DialogBox in pixels.

Parameters

Name	Type	Description
`width`	`Integer`	the new width in pixels.
`height`	`Integer`	the new height in pixels.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setPopupPosition(left, top)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the popup's position relative to the browser's client area.

The popup's position may be set before calling show().

Parameters

Name	Type	Description
`left`	`Integer`	the popup's left, in pixels.
`top`	`Integer`	the popup's top, in pixels.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setPopupPositionAndShow(a)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the popup position.

This is not currently functional.

Parameters

Name	Type	Description
`a`	`Component`

Return

DialogBox — the DialogBox itself, useful for chaining.

`setPreviewingAllNativeEvents(previewing)`

Deprecated. This function is deprecated and should not be used in new scripts.

When enabled, the DialogBox will preview all native events, even if another popup was opened after this one.

What this practically means is that if autoHide is enabled, enabling this feature will cause the DialogBox to autoHide even if another non-modal popup was shown after it. If this feature is disabled, the DialogBox will only autoHide if it was the last popup opened.

Parameters

Name	Type	Description
`previewing`	`Boolean`	whether to preview all native events.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this DialogBox.

Parameters

Name	Type	Description
`width`	`String`	the new width in any CSS unit such as "10px" or "50%".
`height`	`String`	the new height in any CSS unit such as "10px" or "50%".

Return

DialogBox — the DialogBox itself, useful for chaining.

`setStyleAttribute(attribute, value)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets one of this DialogBox's style attributes to a new value. Valid attributes are listed here; the values for each attribute are the same as those available in CSS style sheets.

 

 // Change the widget's background to black and text color to green.
 widget.setStyleAttribute("background", "black")
     .setStyleAttribute("color", "green");

Parameters

Name	Type	Description
`attribute`	`String`	the CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here
`value`	`String`	the CSS value

Return

DialogBox — the DialogBox itself, useful for chaining.

`setStyleAttributes(attributes)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets this DialogBox's style attributes. This is a convenience method that is equivalent to calling setStyleAttribute with every key/value pair in the attributes object. Valid attributes are listed here; the values for each attribute are the same as those available in CSS style sheets.

 

 // Change the widget's background to black and text color to green.
 widget.setStyleAttributes({background: "black", color: "green"});

Parameters

Name	Type	Description
`attributes`	`Object`	an object of key/value pairs for the CSS attributes and values to set; valid attributes are listed here

Return

DialogBox — the DialogBox itself, useful for chaining.

`setStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the style name of this DialogBox.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setStylePrimaryName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the primary style name of this DialogBox.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setTag(tag)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text tag of this DialogBox.

Parameters

Name	Type	Description
`tag`	`String`	the new text tag, which can be anything you wish to store with the widget.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setText(text)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text inside the caption.

Parameters

Name	Type	Description
`text`	`String`	the new caption text.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setTitle(title)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the hover title of this DialogBox.

Not all browsers will show this.

Parameters

Name	Type	Description
`title`	`String`	the hover title.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setVisible(visible)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether this DialogBox is visible.

Parameters

Name	Type	Description
`visible`	`Boolean`	whether this `DialogBox` should be visible or not.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setWidget(widget)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the widget inside this DialogBox, removing anything previously there.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to put in this `DialogBox`.

Return

DialogBox — the DialogBox itself, useful for chaining.

`setWidth(width)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the width of this DialogBox.

Parameters

Name	Type	Description
`width`	`String`	the new width in any CSS unit such as "10px" or "50%".

Return

DialogBox — the DialogBox itself, useful for chaining.

`show()`

Deprecated. This function is deprecated and should not be used in new scripts.

Shows the popup.

Return

DialogBox — the DialogBox itself, useful for chaining.