Google Apps Script

Class MenuItem

An entry in a MenuBar.

Menu items can either fire an event handler when they are clicked, or open a cascading sub-menu.

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

Methods

MethodReturn typeBrief description
addStyleDependentName(styleName)MenuItemSets the dependent style name of this MenuItem.
addStyleName(styleName)MenuItemAdds a style name to this MenuItem.
getId()StringReturns the id that has been assigned to this object.
getTag()StringGets the text tag of this MenuItem.
getType()StringGets the type of this object.
setCommand(handler)MenuItemSets the handler to execute when the menu is clicked.
setHTML(html)MenuItemSets the HTML content of this MenuItem.
setHeight(height)MenuItemSets the height of this MenuItem.
setId(id)MenuItemSets the id of this MenuItem.
setPixelSize(width, height)MenuItemSets the size of this MenuItem in pixels.
setSize(width, height)MenuItemSets the size of this MenuItem.
setStyleAttribute(attribute, value)MenuItemSets one of this MenuItem's style attributes to a new value.
setStyleAttributes(attributes)MenuItemSets this MenuItem's style attributes.
setStyleName(styleName)MenuItemSets the style name of this MenuItem.
setStylePrimaryName(styleName)MenuItemSets the primary style name of this MenuItem.
setSubMenu(subMenu)MenuItemSets the sub-menu to show when the menu is clicked.
setTag(tag)MenuItemSets the text tag of this MenuItem.
setText(text)MenuItemSet the display text of this MenuItem.
setTitle(title)MenuItemSets the hover title of this MenuItem.
setVisible(visible)MenuItemSets whether this MenuItem is visible.
setWidth(width)MenuItemSets the width of this MenuItem.

Detailed documentation

addStyleDependentName(styleName)

Sets the dependent style name of this MenuItem.

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

Parameters

NameTypeDescription
styleNameStringthe new style name.

Return

MenuItem — the MenuItem itself, useful for chaining.


addStyleName(styleName)

Adds a style name to this MenuItem.

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

Parameters

NameTypeDescription
styleNameStringthe new style name.

Return

MenuItem — the MenuItem itself, useful for chaining.


getId()

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()

Gets the text tag of this MenuItem.

Return

String — the text tag.


getType()

Gets the type of this object.

Return

String — the object type


setCommand(handler)

Sets the handler to execute when the menu is clicked.

Parameters

NameTypeDescription
handlerHandlerthe ClientHandler or ServerHandler to execute when the menu is clicked.

Return

MenuItem — the MenuItem itself, useful for chaining.


setHTML(html)

Sets the HTML content of this MenuItem.

Parameters

NameTypeDescription
htmlStringthe new HTML

Return

MenuItem — the MenuItem itself, useful for chaining.


setHeight(height)

Sets the height of this MenuItem.

Parameters

NameTypeDescription
heightStringthe new height in any CSS unit such as "10px" or "50%".

Return

MenuItem — the MenuItem itself, useful for chaining.


setId(id)

Sets the id of this MenuItem.

Parameters

NameTypeDescription
idStringthe new id, which can be used to retrieve the MenuItem from app.getElementById(id).

Return

MenuItem — the MenuItem itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this MenuItem in pixels.

Parameters

NameTypeDescription
widthIntegerthe new width in pixels.
heightIntegerthe new height in pixels.

Return

MenuItem — the MenuItem itself, useful for chaining.


setSize(width, height)

Sets the size of this MenuItem.

Parameters

NameTypeDescription
widthStringthe new width in any CSS unit such as "10px" or "50%".
heightStringthe new height in any CSS unit such as "10px" or "50%".

Return

MenuItem — the MenuItem itself, useful for chaining.


setStyleAttribute(attribute, value)

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

NameTypeDescription
attributeStringthe CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here
valueStringthe CSS value

Return

MenuItem — the MenuItem itself, useful for chaining.


setStyleAttributes(attributes)

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

NameTypeDescription
attributesObjectan object of key/value pairs for the CSS attributes and values to set; valid attributes are listed here

Return

MenuItem — the MenuItem itself, useful for chaining.


setStyleName(styleName)

Sets the style name of this MenuItem.

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

Parameters

NameTypeDescription
styleNameStringthe new style name.

Return

MenuItem — the MenuItem itself, useful for chaining.


setStylePrimaryName(styleName)

Sets the primary style name of this MenuItem.

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

Parameters

NameTypeDescription
styleNameStringthe new style name.

Return

MenuItem — the MenuItem itself, useful for chaining.


setSubMenu(subMenu)

Sets the sub-menu to show when the menu is clicked.

Parameters

NameTypeDescription
subMenuMenuBarthe sub-menu to show when the menu is clicked.

Return

MenuItem — the MenuItem itself, useful for chaining.


setTag(tag)

Sets the text tag of this MenuItem.

Parameters

NameTypeDescription
tagStringthe new text tag, which can be anything you wish to store with the widget.

Return

MenuItem — the MenuItem itself, useful for chaining.


setText(text)

Set the display text of this MenuItem.

Parameters

NameTypeDescription
textStringthe new text.

Return

MenuItem — the MenuItem itself, useful for chaining.


setTitle(title)

Sets the hover title of this MenuItem.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

MenuItem — the MenuItem itself, useful for chaining.


setVisible(visible)

Sets whether this MenuItem is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this MenuItem should be visible or not.

Return

MenuItem — the MenuItem itself, useful for chaining.


setWidth(width)

Sets the width of this MenuItem.

Parameters

NameTypeDescription
widthStringthe new width in any CSS unit such as "10px" or "50%".

Return

MenuItem — the MenuItem itself, useful for chaining.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.