Class: SideDrawerControlProxy¶
SideDrawerControlProxy is a developer-facing class that provides access to a side drawer control for application specific customizations.
Hierarchy¶
-
SideDrawerControlProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Inherited Accessors¶
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
- createFilterSelection
- createLinkSpecifierProxy
- createSorterSelection
- deleteODataCacheImages
- dismissActivityIndicator
- downloadInProgressForPage
- downloadInProgressForReadLink
- evaluateTargetPath
- evaluateTargetPathForAPI
- executeAction
- formatBase64String
- formatCurrency
- formatDate
- formatDatetime
- formatNumber
- formatPercentage
- formatScientific
- formatTime
- getActionResult
- getAppClientData
- getAppearanceMode
- getAppEventData
- getAppName
- getAvailableThemes
- getBindingObject
- getCaption
- getCircularImage
- getClientData
- getDefinitionValue
- getEventData
- getGlobalDefinition
- getGlobalSideDrawerControlProxy
- getIconTextImage
- getLanguage
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- getParent
- getPasscodeSource
- getPendingDownload
- getReadLink
- getRegion
- getRegions
- getSAPPassportHeaderValue
- getSupportedLanguages
- getTheme
- getType
- getUseInAppCamera
- getValue
- getVersionInfo
- initializeLogger
- isAppInMultiUserMode
- isContainer
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- localizeText
- read
- redraw
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setDebugSettings
- setEditable
- setLanguage
- setMdkWindows
- setRegion
- setStyle
- setTheme
- setUseInAppCamera
- setValidationProperty
- setValue
- setVisible
- showActivityIndicator
- updateProgressBanner
Constructors¶
Constructor¶
+ new SideDrawerControlProxy(context: IContext): SideDrawerControlProxy
Overrides ControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: SideDrawerControlProxy
Accessors¶
menuItems¶
Get Signature¶
▸ getter
Returns¶
list of sections of menu items in the side drawer control
Implementation of ISideDrawerControlProxy.menuItems
sections¶
Get Signature¶
▸ getter
Returns¶
string[]
list of section captions in the side drawer control
Implementation of ISideDrawerControlProxy.sections
Methods¶
getMenuItem¶
▸ getMenuItem(name: string): ISideDrawerMenuItemProxy
Implementation of ISideDrawerControlProxy.getMenuItem
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
Implementation of ISideDrawerControlProxy.getMenuItemsAtSection
Parameters:
| Name | Type |
|---|---|
| sectionIndex | number |
Returns: ISideDrawerMenuItemProxy[]
getSelectedMenuItemIndexPath¶
▸ getSelectedMenuItemIndexPath(): [number, number]
Implementation of ISideDrawerControlProxy.getSelectedMenuItemIndexPath
Returns: [number, number]
selected menu item indexPath
getSelectedMenuItemName¶
▸ getSelectedMenuItemName(): string
Implementation of ISideDrawerControlProxy.getSelectedMenuItemName
Returns: string
selected menu item name
isContainer¶
▸ isContainer(): boolean
Determine if the side drawer control is a container.
Implementation of ISideDrawerControlProxy.isContainer Overrides ControlProxy.isContainer
Returns: boolean
setSectionVisibilityAtIndex¶
▸ setSectionVisibilityAtIndex(sectionIndex: number, visibility: boolean): void
Get menu items at section index for side drawer control
Implementation of ISideDrawerControlProxy.setSectionVisibilityAtIndex
Parameters:
| Name | Type |
|---|---|
| sectionIndex | number |
| visibility | boolean |
Returns: void
setSelectedMenuItemByIndexPath¶
▸ setSelectedMenuItemByIndexPath(indexPath: [number, number]): void
Set selected menu item by indexPath for side drawer control
Implementation of ISideDrawerControlProxy.setSelectedMenuItemByIndexPath
Parameters:
| Name | Type |
|---|---|
| indexPath | [number, number] |
Returns: void
setSelectedMenuItemByName¶
▸ setSelectedMenuItemByName(name: string): void
Set selected menu item by name for side drawer control
Implementation of ISideDrawerControlProxy.setSelectedMenuItemByName
Parameters:
| Name | Type |
|---|---|
| name | string |
Returns: void
setSideDrawerButton¶
▸ setSideDrawerButton(iconPath: string): any
Set side drawer icon
Implementation of ISideDrawerControlProxy.setSideDrawerButton
Parameters:
| Name | Type | Description |
|---|---|---|
| iconPath | string | Path of the icon |
Returns: any