ASP.NET MVC Controls
Menu Class
File
wijmo.input.js
Module
wijmo.input
Base Class
ComboBox

The Menu control shows a text element with a drop-down list of commands that the user can invoke by click or touch.

The Menu control inherits from ComboBox, so you populate and style it in the same way that you do the itemsSource property).

The itemClicked event that fires when the user selects an item from the menu. The event handler can inspect the Menu control to determine which item was clicked. For example:

var menu = new wijmo.input.Menu(hostElement);
menu.header = 'Main Menu';
menu.itemsSource = ['option 1', 'option 2', 'option 3'];
menu.itemClicked.addHandler(function(sender, args) {
var menu = sender;
  alert('Thanks for selecting item ' + menu.selectedIndex + ' from menu ' + menu.header + '!');
});

The example below illustrates how you can create value pickers, command-based menus, and menus that respond to the itemClicked event. The menus in this example are based on HTML <select;> and <option;> elements.

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(element: any, options?): Menu

Initializes a new instance of the Menu class.

Parameters
Returns
Menu

Properties

autoExpandSelection

Gets or sets a value that indicates whether the control should automatically expand the selection to whole words/numbers when the control is clicked.

Inherited From
DropDown
Type
boolean

collectionView

Gets the ICollectionView object used as the item source.

Inherited From
ComboBox
Type
ICollectionView

command

Gets or sets the command to execute when an item is clicked.

Commands are objects that implement two methods:

  • executeCommand(parameter) This method executes the command.
  • canExecuteCommand(parameter) This method returns a Boolean value that determines whether the controller can execute the command. If this method returns false, the menu option is disabled.

You can also set commands on individual items using the commandPath property.

Type
any

commandParameterPath

Gets or sets the name of the property that contains a parameter to use with the command specified by the commandPath property.

Type
string

commandPath

Gets or sets the name of the property that contains the command to execute when the user clicks an item.

Commands are objects that implement two methods:

  • executeCommand(parameter) This method executes the command.
  • canExecuteCommand(parameter) This method returns a Boolean value that determines whether the controller can execute the command. If this method returns false, the menu option is disabled.

Type
string

Static controlTemplate

Gets or sets the template used to instantiate DropDown controls.

Inherited From
DropDown
Type
any

displayMemberPath

Gets or sets the name of the property to use as the visual representation of the items.

Inherited From
ComboBox
Type
string

formatItem

Event that fires when items in the drop-down list are created.

You can use this event to modify the HTML in the list items. For details, see the formatItem event.

Inherited From
ComboBox
Type
Event

headerPath

Gets or sets the name of a property to use for getting the value displayed in the control's input element.

The default value for this property is null, which causes the control to display the same content in the input element as in the selected item of the drop-down list.

Use this property if you want to de-couple the value shown in the input element from the values shown in the drop-down list. For example, the input element could show an item's name and the drop-down list could show additional detail.

Inherited From
ComboBox
Type
string

hostElement

Gets the DOM element that is hosting the control.

Inherited From
Control
Type
HTMLElement

inputElement

Gets the HTML input element hosted by the control.

Use this property in situations where you want to customize the attributes of the input element.

Inherited From
DropDown
Type
HTMLInputElement

isAnimated

Gets or sets a value that indicates whether the control should use a fade-in animation when displaying the drop-down.

Inherited From
DropDown
Type
boolean

isButton

Gets or sets a value that determines whether this Menu should act as a split button instead of a regular menu.

The difference between regular menus and split buttons is what happens when the user clicks the menu header. In regular menus, clicking the header shows or hides the menu options. In split buttons, clicking the header raises the itemClicked event and/or invokes the command associated with the last option selected by the user as if the user had picked the item from the drop-down list.

If you want to differentiate between clicks on menu items and the button part of a split button, check the value of the isDroppedDown property of the event sender. If that is true, then a menu item was clicked; if it is false, then the button was clicked.

For example, the code below implements a split button that uses the drop-down list only to change the default item/command, and triggers actions only when the button is clicked:

<-- view -->
<wj-menu is-button="true" header="Run" value="browser"
  item-clicked="itemClicked(s, e)">
  <wj-menu-item value="'Internet Explorer'">Internet Explorer</wj-menu-item>
  <wj-menu-item value="'Chrome'">Chrome</wj-menu-item>
  <wj-menu-item value="'Firefox'">Firefox</wj-menu-item>
  <wj-menu-item value="'Safari'">Safari</wj-menu-item>
  <wj-menu-item value="'Opera'">Opera</wj-menu-item>
</wj-menu>

// controller
$scope.browser = 'Internet Explorer';
$scope.itemClicked = function (s, e) {

  // if not dropped down, click was on the button
  if (!s.isDroppedDown) {
    alert('running ' + $scope.browser);
  }
}
Type
boolean

isContentHtml

Gets or sets a value indicating whether the drop-down list displays items as plain text or as HTML.

Inherited From
ComboBox
Type
boolean

isDisabled

Gets or sets a value that determines whether the control is disabled.

Disabled controls cannot get mouse or keyboard events.

Inherited From
Control
Type
boolean

isDroppedDown

Gets or sets a value that indicates whether the drop down is currently visible.

Inherited From
DropDown
Type
boolean

isEditable

Gets or sets a value that enables or disables editing of the text in the input element of the ComboBox (defaults to false).

Inherited From
ComboBox
Type
boolean

isReadOnly

Gets or sets a value that indicates whether the user can modify the control value using the mouse and keyboard.

Inherited From
DropDown
Type
boolean

isRequired

Gets or sets a value that determines whether the control value must be set to a non-null value or whether it can be set to null (by deleting the content of the control).

Inherited From
DropDown
Type
boolean

isTouching

Gets a value that indicates whether the control is currently handling a touch event.

Inherited From
Control
Type
boolean

isUpdating

Gets a value that indicates whether the control is currently being updated.

Inherited From
Control
Type
boolean

itemFormatter

Gets or sets a function used to customize the values shown in the drop-down list. The function takes two arguments, the item index and the default text or html, and returns the new text or html to display.

If the formatting function needs a scope (i.e. a meaningful 'this' value), then remember to set the filter using the 'bind' function to specify the 'this' object. For example:

comboBox.itemFormatter = customItemFormatter.bind(this);
  function customItemFormatter(index, content) {
    if (this.makeItemBold(index)) {
      content = '<b>' + content + '</b>';
    }
    return content;
  }
Inherited From
ComboBox
Type
Function

itemsSource

Gets or sets the array or ICollectionView object that contains the items to select from.

Inherited From
ComboBox
Type
any

listBox

Gets the ListBox control shown in the drop-down.

Inherited From
ComboBox
Type
ListBox

maxDropDownHeight

Gets or sets the maximum height of the drop-down list.

Inherited From
ComboBox
Type
number

maxDropDownWidth

Gets or sets the maximum width of the drop-down list.

The width of the drop-down list is also limited by the width of the control itself (that value represents the drop-down's minimum width).

Inherited From
ComboBox
Type
number

owner

Gets or sets the element that owns this Menu.

This variable is set by the wj-context-menu directive in case a single menu is used as a context menu for several different elements.

Type
HTMLElement

placeholder

Gets or sets the string shown as a hint when the control is empty.

Inherited From
DropDown
Type
string

rightToLeft

Gets a value indicating whether the control is hosted in an element with right-to-left layout.

Inherited From
Control
Type
boolean

selectedIndex

Gets or sets the index of the currently selected item in the drop-down list.

Inherited From
ComboBox
Type
number

selectedItem

Gets or sets the item that is currently selected in the drop-down list.

Inherited From
ComboBox
Type
any

selectedValue

Gets or sets the value of the selectedItem, obtained using the selectedValuePath.

Inherited From
ComboBox
Type
any

selectedValuePath

Gets or sets the name of the property used to get the selectedValue from the selectedItem.

Inherited From
ComboBox
Type
string

showDropDownButton

Gets or sets a value that indicates whether the control should display a drop-down button.

Inherited From
DropDown
Type
boolean

text

Gets or sets the text shown on the control.

Inherited From
DropDown
Type
string

Methods

addEventListener

addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean): void

Adds an event listener to an element owned by this Control.

The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener method).

Failing to remove event listeners may cause memory leaks.

Parameters
  • target: EventTarget

    Target element for the event.

  • type: string

    String that specifies the event.

  • fn: any

    Function to execute when the event occurs.

  • capture: boolean Optional

    Whether the listener is capturing.

Inherited From
Control
Returns
void

applyTemplate

applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement

Applies the template to a new instance of a control, and returns the root element.

This method should be called by constructors of templated controls. It is responsible for binding the template parts to the corresponding control members.

For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.

this.applyTemplate('wj-control wj-inputnumber', template, {
  _tbx: 'input',
  _btnUp: 'btn-inc',
  _btnDn: 'btn-dec'
}, 'input');
Parameters
  • classNames: string

    Names of classes to add to the control's host element.

  • template: string

    An HTML string that defines the control template.

  • parts: Object

    A dictionary of part variables and their names.

  • namePart: string Optional

    Name of the part to be named after the host element. This determines how the control submits data when used in forms.

Inherited From
Control
Returns
HTMLElement

beginUpdate

beginUpdate(): void

Suspends notifications until the next call to endUpdate.

Inherited From
Control
Returns
void

containsFocus

containsFocus(): boolean

Checks whether this control contains the focused element.

Inherited From
Control
Returns
boolean

deferUpdate

deferUpdate(fn: Function): void

Executes a function within a beginUpdate/endUpdate block.

The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.

Parameters
Inherited From
Control
Returns
void

dispose

dispose(): void

Disposes of the control by removing its association with the host element.

The dispose method automatically removes any event listeners added with the addEventListener method.

Calling the dispose method is important in applications that create and remove controls dynamically. Failing to dispose of the controls may cause memory leaks.

Inherited From
Control
Returns
void

Static disposeAll

disposeAll(e?: HTMLElement): void

Disposes of all Wijmo controls contained in an HTML element.

Parameters
Inherited From
Control
Returns
void

endUpdate

endUpdate(): void

Resumes notifications suspended by calls to beginUpdate.

Inherited From
Control
Returns
void

focus

focus(): void

Sets the focus to this control.

Inherited From
Control
Returns
void

Static getControl

getControl(element: any): Control

Gets the control that is hosted in a given DOM element.

Parameters
  • element: any

    The DOM element that is hosting the control, or a selector for the host element (e.g. '#theCtrl').

Inherited From
Control
Returns
Control

getDisplayText

getDisplayText(index?: number): string

Gets the string displayed in the input element for the item at a given index (always plain text).

Parameters
  • index: number Optional

    The index of the item to retrieve the text for.

Inherited From
ComboBox
Returns
string

getTemplate

getTemplate(): string

Gets the HTML template used to create instances of the control.

This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, it will override the template defined by the DropDown base class.

Inherited From
Control
Returns
string

hide

hide(): void

Hides the menu.

This method is useful if you want to hide a context menu displayed with the show method.

Returns
void

indexOf

indexOf(text: string, fullMatch: boolean): number

Gets the index of the first item that matches a given string.

Parameters
  • text: string

    The text to search for.

  • fullMatch: boolean

    Whether to look for a full match or just the start of the string.

Inherited From
ComboBox
Returns
number

initialize

initialize(options: any): void

Initializes the control by copying the properties from a given object.

This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.

For example:

grid.initialize({
  itemsSource: myList,
  autoGenerateColumns: false,
  columns: [
    { binding: 'id', header: 'Code', width: 130 },
    { binding: 'name', header: 'Name', width: 60 } 
  ]
});

// is equivalent to
grid.itemsSource = myList;
grid.autoGenerateColumns = false;

// etc.

The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.

Parameters
  • options: any

    Object that contains the initialization data.

Inherited From
Control
Returns
void

invalidate

invalidate(fullUpdate?: boolean): void

Invalidates the control causing an asynchronous refresh.

Parameters
  • fullUpdate: boolean Optional

    Whether to update the control layout as well as the content.

Inherited From
Control
Returns
void

Static invalidateAll

invalidateAll(e?: HTMLElement): void

Invalidates all Wijmo controls contained in an HTML element.

Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.

If this happens, you must handle the appropriate event in the dynamic container and call the invalidateAll method so the contained Wijmo controls will update their layout information properly.

Parameters
  • e: HTMLElement Optional

    Container element. If set to null, all Wijmo controls on the page will be invalidated.

Inherited From
Control
Returns
void

onGotFocus

onGotFocus(e?: EventArgs): void

Raises the gotFocus event.

Parameters
Inherited From
Control
Returns
void

onIsDroppedDownChanged

onIsDroppedDownChanged(e?: EventArgs): void

Raises the isDroppedDownChanged event.

Parameters
Inherited From
DropDown
Returns
void

onIsDroppedDownChanging

onIsDroppedDownChanging(e: CancelEventArgs): boolean

Raises the isDroppedDownChanging event.

Parameters
Inherited From
DropDown
Returns
boolean

onItemClicked

onItemClicked(e?: EventArgs): void

Raises the itemClicked event.

Parameters
Returns
void

onLostFocus

onLostFocus(e?: EventArgs): void

Raises the lostFocus event.

Parameters
Inherited From
Control
Returns
void

onSelectedIndexChanged

onSelectedIndexChanged(e?: EventArgs): void

Raises the selectedIndexChanged event.

Parameters
Inherited From
ComboBox
Returns
void

onTextChanged

onTextChanged(e?: EventArgs): void

Raises the textChanged event.

Parameters
Inherited From
DropDown
Returns
void

refresh

refresh(fullUpdate?: boolean): void

Refreshes the control.

Parameters
  • fullUpdate: boolean Optional

    Whether to update the control layout as well as the content.

Inherited From
Control
Returns
void

Static refreshAll

refreshAll(e?: HTMLElement): void

Refreshes all Wijmo controls contained in an HTML element.

This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.

Parameters
  • e: HTMLElement Optional

    Container element. If set to null, all Wijmo controls on the page will be invalidated.

Inherited From
Control
Returns
void

removeEventListener

removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

Removes one or more event listeners attached to elements owned by this Control.

Parameters
  • target: EventTarget Optional

    Target element for the event. If null, removes listeners attached to all targets.

  • type: string Optional

    String that specifies the event. If null, removes listeners attached to all events.

  • fn: any Optional

    Handler to remove. If null, removes all handlers.

  • capture: boolean Optional

    Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

Inherited From
Control
Returns
number

selectAll

selectAll(): void

Sets the focus to the control and selects all its content.

Inherited From
DropDown
Returns
void

show

show(position?: any): void

Shows the menu at a given location.

This method is useful if you want to use the menu as a context menu, attached to one or more elements on the page. For example:

// create menu
var div = document.createElement('div');
var menu = new wijmo.input.Menu(div, {
    itemsSource: 'New,Open,Save,Exit'.split(','),
    itemClicked: function (s, e) {
        alert('thanks for picking ' + menu.selectedIndex);
    }
});

// use it as a context menu for one or more elements
var element = document.getElementById('btn');
element.addEventListener('contextmenu', function (e) {
    e.preventDefault();
    menu.show(e);
});
Parameters
  • position: any Optional

    An optional MouseEvent or reference element that determines the position where the menu should be displayed. If not provided, the menu is displayed at the center of the screen.

Returns
void

Events

gotFocus

Occurs when the control gets the focus.

Inherited From
Control
Arguments
EventArgs

isDroppedDownChanged

Occurs after the drop down is shown or hidden.

Inherited From
DropDown
Arguments
EventArgs

isDroppedDownChanging

Occurs before the drop down is shown or hidden.

Inherited From
DropDown
Arguments
CancelEventArgs

itemClicked

Occurs when the user picks an item from the menu.

The handler can determine which item was picked by reading the event sender's selectedIndex property.

Arguments
EventArgs

lostFocus

Occurs when the control loses the focus.

Inherited From
Control
Arguments
EventArgs

selectedIndexChanged

Occurs when the value of the selectedIndex property changes.

Inherited From
ComboBox
Arguments
EventArgs

textChanged

Occurs when the value of the text property changes.

Inherited From
DropDown
Arguments
EventArgs

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback