Class: SideDrawerControlProxy

SideDrawerControlProxy is a developer-facing class that provides access to a side drawer control for application specific customizations.

Hierarchy

• ControlProxy

• SideDrawerControlProxy

Implements

• IClientAPI
• IControlProxy
• ISideDrawerControlProxy

Summary

Constructors

• constructor

Properties

Class Properties

Currently none in this class.

Inherited Properties

• _context

• _control

Accessors

Class Accessors

• menuItems
• sections

Inherited Accessors

• actionResults

• binding

• currentPage

• filterTypeEnum

• mdkWindows

Methods

Class Methods

• getMenuItem
• getMenuItemsAtSection
• getSelectedMenuItemIndexPath
• getSelectedMenuItemName
• isContainer
• setSectionVisibilityAtIndex
• setSelectedMenuItemByIndexPath
• setSelectedMenuItemByName
• setSideDrawerButton

Inherited Methods

• _clientAPIProps

• _getExecuteSource

• applyValidation

• base64StringToBinary

• binaryToBase64String

• callFunction

• clearValidation

• clearValidationOnValueChange

• convertFilterCriteriaArrayToJSONString

• convertJSONStringToFilterCriteriaArray

• count

• create

• createFilterCriteria

• createLinkSpecifierProxy

• deleteODataCacheImages

• dismissActivityIndicator

• downloadInProgressForPage

• downloadInProgressForReadLink

• evaluateTargetPath

• evaluateTargetPathForAPI

• executeAction

• formatBase64String

• formatCurrency

• formatDate

• formatDatetime

• formatNumber

• formatPercentage

• formatScientific

• formatTime

• getActionResult

• getAppClientData

• getAppEventData

• getAppName

• getAppearanceMode

• getAvailableThemes

• getBindingObject

• getCaption

• getCircularImage

• getClientData

• getDefinitionValue

• getGlobalDefinition

• getGlobalSideDrawerControlProxy

• getIconTextImage

• getLanguage

• getLogger

• getMobileServiceAppId

• getMobileServiceEndpointUrl

• getName

• getODataCacheImagePath

• getODataProvider

• getPageDefinition

• getPageProxy

• getParent

• getPasscodeSource

• getPendingDownload

• getReadLink

• getRegion

• getRegions

• getSAPPassportHeaderValue

• getSupportedLanguages

• getTheme

• getType

• getValue

• getVersionInfo

• initializeLogger

• isAppInMultiUserMode

• isCurrentPage

• isDemoMode

• isMediaLocal

• localizeText

• read

• redraw

• sendMobileServiceRequest

• sendRequest

• setApplicationIconBadgeNumber

• setDebugSettings

• setEditable

• setLanguage

• setRegion

• setStyle

• setTheme

• setValidationProperty

• setValue

• setVisible

• showActivityIndicator

• updateProgressBanner

• Create

• setMdkWindows

Constructors

constructor

+ new SideDrawerControlProxy(context: IContext): SideDrawerControlProxy

Overrides ControlProxy.constructor

Parameters:

Name	Type
context	IContext

Returns: SideDrawerControlProxy

Accessors

menuItems

• getter

Returns: Array‹ISideDrawerMenuItemProxy[]›

list of sections of menu items in the side drawer control

---

sections

• getter

Returns: string[]

list of section captions in the side drawer control

Methods

getMenuItem

▸ getMenuItem(name: string): ISideDrawerMenuItemProxy

Parameters:

Name	Type
name	string

Returns: ISideDrawerMenuItemProxy

a single SideDrawerMenuItemProxy instance of the menu item that's identified by the provided name (which is based on the _Name property)

---

getMenuItemsAtSection

▸ getMenuItemsAtSection(sectionIndex: number): ISideDrawerMenuItemProxy[]

Implementation of ISideDrawerControlProxy

Get menu items at section index for side drawer control

Parameters:

Name	Type
sectionIndex	number

Returns: ISideDrawerMenuItemProxy[]

---

getSelectedMenuItemIndexPath

▸ getSelectedMenuItemIndexPath(): [number, number]

Implementation of ISideDrawerControlProxy

Returns: [number, number]

selected menu item indexPath

---

getSelectedMenuItemName

▸ getSelectedMenuItemName(): string

Implementation of ISideDrawerControlProxy

Returns: string

selected menu item name

---

isContainer

▸ isContainer(): boolean

Implementation of ISideDrawerControlProxy

Overrides ControlProxy.isContainer

Determine if the side drawer control is a container.

Returns: boolean

---

setSectionVisibilityAtIndex

▸ setSectionVisibilityAtIndex(sectionIndex: number, visibility: boolean): void

Implementation of ISideDrawerControlProxy

Get menu items at section index for side drawer control

Parameters:

Name	Type
sectionIndex	number
visibility	boolean

Returns: void

---

setSelectedMenuItemByIndexPath

▸ setSelectedMenuItemByIndexPath(indexPath: [number, number]): void

Implementation of ISideDrawerControlProxy

Set selected menu item by indexPath for side drawer control

Parameters:

Name	Type
indexPath	[number, number]

Returns: void

---

setSelectedMenuItemByName

▸ setSelectedMenuItemByName(name: string): void

Implementation of ISideDrawerControlProxy

Set selected menu item by name for side drawer control

Parameters:

Name	Type
name	string

Returns: void

---

setSideDrawerButton

▸ setSideDrawerButton(iconPath: string): any

Implementation of ISideDrawerControlProxy

Set side drawer icon

Parameters:

Name	Type	Description
iconPath	string	Path of the icon

Returns: any

---