Class SuggestBox | Apps Script

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

A SuggestBox is a text box or text area which displays a pre-configured set of selections that match the user's input.

This widget is not currently functional.

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 SuggestBox documentation here.

Deprecated methods

Method	Return type	Brief description
`addKeyDownHandler(handler)`	`SuggestBox`	Add a handler for key down events.
`addKeyPressHandler(handler)`	`SuggestBox`	Add a handler for key press events.
`addKeyUpHandler(handler)`	`SuggestBox`	Add a handler for key up events.
`addSelectionHandler(handler)`	`SuggestBox`	Add a handler for selection events.
`addStyleDependentName(styleName)`	`SuggestBox`	Sets the dependent style name of this `SuggestBox`.
`addStyleName(styleName)`	`SuggestBox`	Adds a style name to this `SuggestBox`.
`addValueChangeHandler(handler)`	`SuggestBox`	Add a handler for value change events.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `SuggestBox`.
`getType()`	`String`	Gets the type of this object.
`setAccessKey(accessKey)`	`SuggestBox`	Sets the widget's 'access key'.
`setAnimationEnabled(animationEnabled)`	`SuggestBox`	Sets whether opening and closing the `SuggestBox` is animated.
`setAutoSelectEnabled(autoSelectEnabled)`	`SuggestBox`	Sets the auto-select behavior.
`setFocus(focus)`	`SuggestBox`	Explicitly focus/unfocus this `SuggestBox`.
`setHeight(height)`	`SuggestBox`	Sets the height of this `SuggestBox`.
`setId(id)`	`SuggestBox`	Sets the id of this `SuggestBox`.
`setLayoutData(layout)`	`SuggestBox`	Set the layout for this `SuggestBox`.
`setLimit(limit)`	`SuggestBox`	Sets the suggest limit.
`setPixelSize(width, height)`	`SuggestBox`	Sets the size of this `SuggestBox` in pixels.
`setPopupStyleName(styleName)`	`SuggestBox`	Sets the popup style name.
`setSize(width, height)`	`SuggestBox`	Sets the size of this `SuggestBox`.
`setStyleAttribute(attribute, value)`	`SuggestBox`	Sets one of this `SuggestBox`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`SuggestBox`	Sets this `SuggestBox`'s style attributes.
`setStyleName(styleName)`	`SuggestBox`	Sets the style name of this `SuggestBox`.
`setStylePrimaryName(styleName)`	`SuggestBox`	Sets the primary style name of this `SuggestBox`.
`setTabIndex(index)`	`SuggestBox`	Sets the `SuggestBox`'s position in the tab index.
`setTag(tag)`	`SuggestBox`	Sets the text tag of this `SuggestBox`.
`setText(text)`	`SuggestBox`	Set the display text of this `SuggestBox`.
`setTitle(title)`	`SuggestBox`	Sets the hover title of this `SuggestBox`.
`setValue(value)`	`SuggestBox`	Sets the value of this `SuggestBox`.
`setValue(value, fireEvents)`	`SuggestBox`	Sets the `SuggestBox`'s value.
`setVisible(visible)`	`SuggestBox`	Sets whether this `SuggestBox` is visible.
`setWidth(width)`	`SuggestBox`	Sets the width of this `SuggestBox`.

Deprecated methods

`addKeyDownHandler(handler)`

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

Add a handler for key down 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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addKeyDownHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "keydown".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // what key was pressed. See below for a link explaining what these values mean.
  var charCode = parameter.charCode;
  var keyCode = parameter.keyCode;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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.

For an explanation of charCode and keyCode, including what to expect on different browsers, look here.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`addKeyPressHandler(handler)`

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

Add a handler for key press events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addKeyPressHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "keypress".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // what key was pressed. See below for a link explaining what these values mean.
  var charCode = parameter.charCode;
  var keyCode = parameter.keyCode;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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.

For an explanation of charCode and keyCode, including what to expect on different browsers, look here.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`addKeyUpHandler(handler)`

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

Add a handler for key up events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addKeyUpHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "keyup".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // what key was pressed. See below for a link explaining what these values mean.
  var charCode = parameter.charCode;
  var keyCode = parameter.keyCode;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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.

For an explanation of charCode and keyCode, including what to expect on different browsers, look here.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`addSelectionHandler(handler)`

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

Add a handler for selection events.

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.addSelectionHandler(handler)
  app.add(tree);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "selection".
  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

SuggestBox — the SuggestBox 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 SuggestBox.

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

SuggestBox — the SuggestBox 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 SuggestBox.

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

SuggestBox — the SuggestBox itself, useful for chaining.

`addValueChangeHandler(handler)`

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

Add a handler for value change events.

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 textBox = app.createTextBox();
  var handler = app.createServerHandler("handlerFunction");
  textBox.addValueChangeHandler(handler);
  app.add(textBox);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "valueChange".
  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

SuggestBox — the SuggestBox 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 SuggestBox.

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

`setAccessKey(accessKey)`

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

Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.

Parameters

Name	Type	Description
`accessKey`	`Char`	the character to use for focus

Return

SuggestBox — the SuggestBox 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 SuggestBox is animated.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`setAutoSelectEnabled(autoSelectEnabled)`

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

Sets the auto-select behavior.

Parameters

Name	Type	Description
`autoSelectEnabled`	`Boolean`	Whether auto-select is enabled.

Return

SuggestBox — The SuggestBox itself, useful for chaining.

`setFocus(focus)`

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

Explicitly focus/unfocus this SuggestBox.

Only one widget can have focus at a time, and the widget that does will receive all keyboard events.

Parameters

Name	Type	Description
`focus`	`Boolean`	whether the `SuggestBox` should have the current focus.

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`setHeight(height)`

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

Sets the height of this SuggestBox.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`setId(id)`

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

Sets the id of this SuggestBox.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`setLayoutData(layout)`

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

Set the layout for this SuggestBox.

This is not currently functional.

Parameters

Name	Type	Description
`layout`	`Object`

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`setLimit(limit)`

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

Sets the suggest limit.

Parameters

Name	Type	Description
`limit`	`Integer`	Max number of suggestions.

Return

SuggestBox — The SuggestBox 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 SuggestBox in pixels.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`setPopupStyleName(styleName)`

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

Sets the popup style name. This function is deprecated and should not be used in new scripts.

Parameters

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

Return

SuggestBox — The SuggestBox 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 SuggestBox.

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

SuggestBox — the SuggestBox itself, useful for chaining.

`setStyleAttribute(attribute, value)`

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

Sets one of this SuggestBox'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

SuggestBox — the SuggestBox itself, useful for chaining.

`setStyleAttributes(attributes)`

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

Sets this SuggestBox'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

SuggestBox — the SuggestBox 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 SuggestBox.

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

SuggestBox — the SuggestBox 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 SuggestBox.

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

SuggestBox — the SuggestBox itself, useful for chaining.

`setTabIndex(index)`

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

Sets the SuggestBox's position in the tab index.

If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to -1 will cause this widget to be removed from the tab order.

Parameters

Name	Type	Description
`index`	`Integer`	the new tab index.

Return

SuggestBox — the SuggestBox 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 SuggestBox.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`setText(text)`

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

Set the display text of this SuggestBox.

Parameters

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

Return

SuggestBox — the SuggestBox 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 SuggestBox.

Not all browsers will show this.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`setValue(value)`

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

Sets the value of this SuggestBox.

Parameters

Name	Type	Description
`value`	`String`	the new value.

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`setValue(value, fireEvents)`

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

Sets the SuggestBox's value.

Parameters

Name	Type	Description
`value`	`String`	The new value.
`fireEvents`	`Boolean`	Whether to fire change events.

Return

SuggestBox — The SuggestBox itself, useful for chaining.

`setVisible(visible)`

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

Sets whether this SuggestBox is visible.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.

`setWidth(width)`

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

Sets the width of this SuggestBox.

Parameters

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

Return

SuggestBox — the SuggestBox itself, useful for chaining.