Class: ActionBarProxy¶
ActionBarProxy is a developer-facing class that provides access to an actionbar control for application specific customizations.
Hierarchy¶
-
ActionBarProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Currently none in this class.
Inherited Accessors¶
Methods¶
Class Methods¶
- getCaption
- getCaptionAlignment
- getDataSubscriptions
- getItem
- getItems
- getLogo
- getOverflowIcon
- getPreferredCaptionSize
- getPrefersLargeCaption
- getStyle
- getSubhead
- isContainer
- reset
- setCaption
- setCaptionAlignment
- setDataSubscriptions
- setLogo
- setOverflowIcon
- setPreferredCaptionSize
- setPrefersLargeCaption
- setSubhead
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 ActionBarProxy(context: IContext): ActionBarProxy
Overrides ControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: ActionBarProxy
Methods¶
getCaption¶
▸ getCaption(): string
Returns the Caption property value defined for the actionbar control.
Implementation of IActionBarProxy.getCaption Overrides ControlProxy.getCaption
Returns: string
getCaptionAlignment¶
▸ getCaptionAlignment(): string
Returns the CaptionAlignment property value defined for the actionbar control. Note: CaptionAlignment is only visually applied on Android, but this method returns the value on all platforms.
Implementation of IActionBarProxy.getCaptionAlignment
Returns: string
getDataSubscriptions¶
▸ getDataSubscriptions(): string[]
Returns the DataSubscriptions property value defined for the actionbar control.
Implementation of IActionBarProxy.getDataSubscriptions
Returns: string[]
getItem¶
▸ getItem(itemName: string): IActionBarItemProxy
Implementation of IActionBarProxy.getItem
Parameters:
| Name | Type | Description |
|---|---|---|
| itemName | string | takes in _Name property of the actionbar item |
Returns: IActionBarItemProxy
returns the ActionBarItemProxy instance of the item by the name
getItems¶
▸ getItems(): IActionBarItemProxy[]
This method returns the top-level controls of actionbar items for this container
Implementation of IActionBarProxy.getItems
Returns: IActionBarItemProxy[]
The actionbar items controls for this container
getLogo¶
▸ getLogo(): string
Returns the Logo property value defined for the actionbar control.
Implementation of IActionBarProxy.getLogo
Returns: string
getOverflowIcon¶
▸ getOverflowIcon(): string
Returns the OverflowIcon property value defined for the actionbar control. Note: OverflowIcon is only visually displayed on iOS, but this method returns the value on all platforms.
Implementation of IActionBarProxy.getOverflowIcon
Returns: string
getPreferredCaptionSize¶
▸ getPreferredCaptionSize(): string | null
Returns the PreferredCaptionSize property value defined for the actionbar control.
Implementation of IActionBarProxy.getPreferredCaptionSize
Returns: string | null
getPrefersLargeCaption()¶
▸ getPrefersLargeCaption(): boolean
Returns the PrefersLargeCaption property value defined for the actionbar control.
Returns: boolean
Deprecated¶
- use the [setPreferredCaptionSize] instead
Implementation of IActionBarProxy.getPrefersLargeCaption
getStyle¶
▸ getStyle(): any
Returns the Style property value defined for the actionbar control.
Implementation of IActionBarProxy.getStyle
Returns: any
getSubhead¶
▸ getSubhead(): string
Returns the Subhead property value defined for the actionbar control.
Implementation of IActionBarProxy.getSubhead
Returns: string
isContainer¶
▸ isContainer(): boolean
Determine if the actionbar control is a container.
Implementation of IActionBarProxy.isContainer Overrides ControlProxy.isContainer
Returns: boolean
true/false.
reset¶
▸ reset(): Promise<any>
Reset actionbar and its items. The actionbar is then redrawn to reflect the reset state.
Implementation of IActionBarProxy.reset
Returns: Promise<any>
setCaption¶
▸ setCaption(caption: string): void
Sets the Caption property of the actionbar control.
Implementation of IActionBarProxy.setCaption
Parameters:
| Name | Type | Description |
|---|---|---|
| caption | string | value to set. |
Returns: void
setCaptionAlignment¶
▸ setCaptionAlignment(captionAlignment: string): void
Sets the CaptionAlignment property of the actionbar control. Accepted values are: "Left", "Center". Note: CaptionAlignment is only visually applied on Android, but this method sets the value on all platforms.
Implementation of IActionBarProxy.setCaptionAlignment
Parameters:
| Name | Type | Description |
|---|---|---|
| captionAlignment | string | value to set. |
Returns: void
setDataSubscriptions¶
▸ setDataSubscriptions(dataSubscriptions: string[]): void
Sets the DataSubscriptions property of the actionbar control.
Implementation of IActionBarProxy.setDataSubscriptions
Parameters:
| Name | Type | Description |
|---|---|---|
| dataSubscriptions | string[] | value to set. |
Returns: void
setLogo¶
▸ setLogo(logo: string): void
Sets the Logo property value of the actionbar control.
Implementation of IActionBarProxy.setLogo
Parameters:
| Name | Type | Description |
|---|---|---|
| logo | string | value to set. |
Returns: void
setOverflowIcon¶
▸ setOverflowIcon(overflowIcon: string): void
Sets the OverflowIcon property of the actionbar control. Note: OverflowIcon is only visually displayed on iOS, but this method sets the value on all platforms.
Implementation of IActionBarProxy.setOverflowIcon
Parameters:
| Name | Type | Description |
|---|---|---|
| overflowIcon | string | value to set. |
Returns: void
setPreferredCaptionSize¶
▸ setPreferredCaptionSize(preferredCaptionSize: string): void
Sets the PreferredCaptionSize property of the actionbar control.
Implementation of IActionBarProxy.setPreferredCaptionSize
Parameters:
| Name | Type | Description |
|---|---|---|
| preferredCaptionSize | string | large/medium/null value to set. |
Returns: void
setPrefersLargeCaption()¶
▸ setPrefersLargeCaption(prefersLargeCaption: boolean): void
Sets the PrefersLargeCaption property of the actionbar control.
Parameters:
| Name | Type | Description |
|---|---|---|
| prefersLargeCaption | boolean | value to set. |
Returns: void
Deprecated¶
- use the [getPreferredCaptionSize] instead
Implementation of IActionBarProxy.setPrefersLargeCaption
setSubhead¶
▸ setSubhead(subhead: string): void
Sets the Subhead property of the actionbar control. Note: When a Subhead is set, the PrefersLargeCaption property will be ignored.
Implementation of IActionBarProxy.setSubhead
Parameters:
| Name | Type | Description |
|---|---|---|
| subhead | string | value to set. |
Returns: void