Class: ActionBarItemProxy¶
ActionBarItemProxy is a developer-facing class that provides access to an actionbar item control for application specific customizations.
Hierarchy¶
-
ActionBarItemProxy
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
- getEnabled
- getIcon
- getIconText
- getIsIconCircular
- getPageProxy
- getParent
- getPosition
- getStyle
- getSystemItem
- getVisible
- getWidth
- reset
- setCaption
- setEnabled
- setIcon
- setIconText
- setIsIconCircular
- setPosition
- setSystemItem
- setWidth
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 ActionBarItemProxy(context: IContext): ActionBarItemProxy
Inherited from ControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: ActionBarItemProxy
Methods¶
getCaption¶
▸ getCaption(): string
Returns the Caption property value defined for the control.
Implementation of IActionBarItemProxy.getCaption Overrides ControlProxy.getCaption
Returns: string
getEnabled¶
▸ getEnabled(): boolean
Returns the Enabled property value defined for the control.
Implementation of IActionBarItemProxy.getEnabled
Returns: boolean
getIcon¶
▸ getIcon(): string
Returns the Icon property value defined for the control.
Implementation of IActionBarItemProxy.getIcon
Returns: string
getIconText¶
▸ getIconText(): string
Returns the IconText property value defined for the control.
Implementation of IActionBarItemProxy.getIconText
Returns: string
getIsIconCircular¶
▸ getIsIconCircular(): boolean
Returns the IsIconCircular property value defined for the control.
Implementation of IActionBarItemProxy.getIsIconCircular
Returns: boolean
getPageProxy¶
▸ getPageProxy(): IPageProxy
Gets the page that contains this actionbar item's parent actionbar.
Implementation of IActionBarItemProxy.getPageProxy Overrides ControlProxy.getPageProxy
Returns: IPageProxy
the page, which the element belongs to
getParent¶
▸ getParent(): IActionBarProxy
Gets the parent actionbar control that contains this actionbar item.
Implementation of IActionBarItemProxy.getParent Overrides ControlProxy.getParent
Returns: IActionBarProxy
The control of the actionbar container that contains this item
getPosition¶
▸ getPosition(): string
Returns the Position property value defined for the control.
Implementation of IActionBarItemProxy.getPosition
Returns: string
getStyle¶
▸ getStyle(): any
Returns the Style property value defined for the control.
Implementation of IActionBarItemProxy.getStyle
Returns: any
getSystemItem¶
▸ getSystemItem(): string
Returns the SystemItem property value defined for the control.
Implementation of IActionBarItemProxy.getSystemItem
Returns: string
getVisible¶
▸ getVisible(): boolean
Gets the control's visible state.
Implementation of IActionBarItemProxy.getVisible
Returns: boolean
returns true if the control is visible otherwise false.
getWidth¶
▸ getWidth(): number
Returns the Width property value defined for the control.
Implementation of IActionBarItemProxy.getWidth
Returns: number
reset¶
▸ reset(): Promise<any>
Reset ActionBar item to its original (metadata-defined) state. It is then redrawn to reflect the reset state.
Implementation of IActionBarItemProxy.reset
Returns: Promise<any>
setCaption¶
▸ setCaption(caption: string): void
Sets the Caption property of the control.
Implementation of IActionBarItemProxy.setCaption
Parameters:
| Name | Type | Description |
|---|---|---|
| caption | string | value to set. |
Returns: void
setEnabled¶
▸ setEnabled(isEnabled: boolean): void
Sets the Enabled property of the control.
Implementation of IActionBarItemProxy.setEnabled
Parameters:
| Name | Type | Description |
|---|---|---|
| isEnabled | boolean | true enables and false disables. |
Returns: void
setIcon¶
▸ setIcon(icon: string): void
Sets the Icon property of the control.
Implementation of IActionBarItemProxy.setIcon
Parameters:
| Name | Type | Description |
|---|---|---|
| icon | string | value to set. |
Returns: void
setIconText¶
▸ setIconText(iconText: string): void
Sets the IconText property of the control.
Implementation of IActionBarItemProxy.setIconText
Parameters:
| Name | Type | Description |
|---|---|---|
| iconText | string | value to set. |
Returns: void
setIsIconCircular¶
▸ setIsIconCircular(isIconCircular: boolean): void
Sets the IsIconCircular property of the control.
Implementation of IActionBarItemProxy.setIsIconCircular
Parameters:
| Name | Type | Description |
|---|---|---|
| isIconCircular | boolean | value to set. |
Returns: void
setPosition¶
▸ setPosition(position: string): void
Sets the Position property of the control.
Implementation of IActionBarItemProxy.setPosition
Parameters:
| Name | Type | Description |
|---|---|---|
| position | string | value to set. |
Returns: void
setSystemItem¶
▸ setSystemItem(systemItem: string): void
Sets the SystemItem property of the control.
Implementation of IActionBarItemProxy.setSystemItem
Parameters:
| Name | Type | Description |
|---|---|---|
| systemItem | string | value to set. |
Returns: void
setWidth¶
▸ setWidth(width: number): void
Sets the width property of the control.
Implementation of IActionBarItemProxy.setWidth
Parameters:
| Name | Type | Description |
|---|---|---|
| width | number | value to set. |
Returns: void