Skip to content

Interface: ISideDrawerMenuItemProxy

A designer-facing interface that provides access to a menu item.

It is passed to rules to provide access to a menu item for application specific customizations.

In addition it provides access to the IClientAPI interface.

Hierarchy

Implemented by

Summary

Properties

Class Properties

None in this class.

Inherited Properties

Methods

Class Methods

Inherited Methods

Methods

getTitle

getTitle(): string

Returns: string

the caption of the menu item


reset

reset(): Promise‹PageProxy

Reset the SideDrawerMenuItem's navigation stack. If the selected sideDrawer menu item is active, it navigates to the initial page configured in the PageToOpen attribute.

Example:

sideDrawerMenuItemProxy.reset().then((currentPageProxy) => { var currentPageCaption = currentPageProxy.getCaption(); ... });

Returns: Promise‹PageProxy

the pageProxy of the current page after reset


setTitle

setTitle(title: string): any

Set menu item caption

Parameters:

Name Type
title string

Returns: any


setVisibility

setVisibility(visibility: boolean): any

Set menu item visibility

Parameters:

Name Type
visibility boolean

Returns: any