Interface: ISideDrawerControlProxy

A designer-facing interface that provides access to side drawer.

It is passed to rules to provide access to the side drawer for application specific customizations.

In addition it provides access to the IControlProxy interface.

Hierarchy

• IControlProxy

• ISideDrawerControlProxy

Implemented by

• SideDrawerControlProxy

Summary

Properties

Class Properties

• menuItems
• sections

Inherited Properties

• actionResults

• binding

• currentPage

• filterTypeEnum

Methods

Class Methods

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

Inherited Methods

• 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

• getIconTextImage

• getLanguage

• getLogger

• getMobileServiceAppId

• getMobileServiceEndpointUrl

• getName

• getODataCacheImagePath

• getODataProvider

• getPageDefinition

• getPageProxy

• getPasscodeSource

• getPendingDownload

• getReadLink

• getRegion

• getRegions

• getSAPPassportHeaderValue

• getSupportedLanguages

• getTheme

• getType

• getValue

• getVersionInfo

• initializeLogger

• isAppInMultiUserMode

• isContainer

• isCurrentPage

• isDemoMode

• isMediaLocal

• localizeText

• read

• redraw

• sendMobileServiceRequest

• sendRequest

• setApplicationIconBadgeNumber

• setDebugSettings

• setEditable

• setLanguage

• setRegion

• setStyle

• setTheme

• setValidationProperty

• setValue

• setVisible

• showActivityIndicator

• updateProgressBanner

Properties

menuItems

• menuItems: Array‹ISideDrawerMenuItemProxy[]›

returns list of items in the side drawer control

---

sections

• sections: string[]

returns 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[]

Get menu items at section index for side drawer control

Parameters:

Name	Type
sectionIndex	number

Returns: ISideDrawerMenuItemProxy[]

---

getSelectedMenuItemIndexPath

▸ getSelectedMenuItemIndexPath(): [number, number]

Returns: [number, number]

selected menu item indexPath

---

getSelectedMenuItemName

▸ getSelectedMenuItemName(): string

Returns: string

selected menu item name

---

setSectionVisibilityAtIndex

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

Get menu items at section index for side drawer control

Parameters:

Name	Type
sectionIndex	number
visibility	boolean

Returns: any

---

setSelectedMenuItemByIndexPath

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

Set selected menu item by indexPath for side drawer control

Parameters:

Name	Type
indexPath	[number, number]

Returns: any

---

setSelectedMenuItemByName

▸ setSelectedMenuItemByName(name: string): any

Set selected menu item by name for side drawer control

Parameters:

Name	Type
name	string

Returns: any

---

setSideDrawerButton

▸ setSideDrawerButton(iconPath: string): any

Set side drawer icon

Parameters:

Name	Type
iconPath	string

Returns: any

---