Skip to content

Class: SideDrawerMenuItemProxy

SideDrawerMenuItemProxy is a developer-facing class that provides access to a menu item control of sideDrawer for application specific customizations.

Hierarchy

Implements

Summary

Constructors

Properties

Class Properties

Inherited Properties

Accessors

Class Accessors

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

constructor

+ new SideDrawerMenuItemProxy(indexPath: [number, number], container: SideDrawer, context: IContext): SideDrawerMenuItemProxy

Overrides ClientAPI.constructor

Parameters:

Name Type
indexPath [number, number]
container SideDrawer
context IContext

Returns: SideDrawerMenuItemProxy

Properties

Accessors

Methods

getTitle

getTitle(): string

Implementation of ISideDrawerMenuItemProxy

Returns: string

the caption of the menu item


reset

reset(): Promise‹PageProxy

Implementation of ISideDrawerMenuItemProxy

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): void

Implementation of ISideDrawerMenuItemProxy

Set menu item caption

Parameters:

Name Type
title string

Returns: void


setVisibility

setVisibility(visibility: boolean): void

Implementation of ISideDrawerMenuItemProxy

Set menu item visibility

Parameters:

Name Type
visibility boolean

Returns: void