Interface: IActionBarItemProxy¶
A designer-facing interface that provides access to an actionbar item control.
It is passed to rules to provide access to an actionbar item control for application specific customizations.
In addition it provides access to the IControlProxy interface.
Hierarchy¶
-
IActionBarItemProxy
Summary¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
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¶
- 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
- getAppearanceMode
- getAppEventData
- getAppName
- getAvailableThemes
- getBindingObject
- getCaption
- getCircularImage
- getClientData
- getDefinitionValue
- getEventData
- getGlobalDefinition
- getIconTextImage
- getLanguage
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- 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
- setRegion
- setStyle
- setTheme
- setUseInAppCamera
- setValidationProperty
- setValue
- setVisible
- showActivityIndicator
- updateProgressBanner
Methods¶
getCaption¶
▸ getCaption(): string
Returns the Caption property value defined for the control.
Overrides IControlProxy.getCaption
Returns: string
getEnabled¶
▸ getEnabled(): boolean
Returns the Enabled property value defined for the control.
Returns: boolean
getIcon¶
▸ getIcon(): string
Returns the Icon property value defined for the control.
Returns: string
getIconText¶
▸ getIconText(): string
Returns the IconText property value defined for the control.
Returns: string
getIsIconCircular¶
▸ getIsIconCircular(): boolean
Returns the IsIconCircular property value defined for the control.
Returns: boolean
getPageProxy¶
▸ getPageProxy(): IPageProxy
Gets the page that contains this actionbar item's parent actionbar.
Overrides IControlProxy.getPageProxy
Returns: IPageProxy
the page, which the element belongs to
getParent¶
▸ getParent(): IActionBarProxy
Gets the parent actionbar control that contains this actionbar item.
Returns: IActionBarProxy
The control of the actionbar container that contains this item
getPosition¶
▸ getPosition(): string
Returns the Position property value defined for the control.
Returns: string
getStyle¶
▸ getStyle(): string
Returns the Style property value defined for the control.
Returns: string
getSystemItem¶
▸ getSystemItem(): string
Returns the SystemItem property value defined for the control.
Returns: string
getVisible¶
▸ getVisible(): boolean
Gets the control's visible state.
Returns: boolean
returns true if the control is visible otherwise false.
getWidth¶
▸ getWidth(): number
Returns the Width property value defined for the control.
Returns: number
reset¶
▸ reset(): Promise<any>
Reset ActionBar item to its original (metadata-defined) state. It is then redrawn to reflect the reset state.
Returns: Promise<any>
setCaption¶
▸ setCaption(caption: string): void
Sets the Caption property of the control.
Parameters:
| Name | Type | Description |
|---|---|---|
| caption | string | value to set. |
Returns: void
setEnabled¶
▸ setEnabled(isEnabled: boolean): void
Sets the Enabled property of the control.
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.
Parameters:
| Name | Type | Description |
|---|---|---|
| icon | string | value to set. |
Returns: void
setIconText¶
▸ setIconText(iconText: string): void
Sets the IconText property of the control.
Parameters:
| Name | Type | Description |
|---|---|---|
| iconText | string | value to set. |
Returns: void
setIsIconCircular¶
▸ setIsIconCircular(isIconCircular: boolean): void
Sets the IsIconCircular property of the control.
Parameters:
| Name | Type | Description |
|---|---|---|
| isIconCircular | boolean | value to set. |
Returns: void
setPosition¶
▸ setPosition(position: string): void
Sets the Position property of the control.
Parameters:
| Name | Type | Description |
|---|---|---|
| position | string | value to set. |
Returns: void
setSystemItem¶
▸ setSystemItem(systemItem: string): void
Sets the SystemItem property of the control.
Parameters:
| Name | Type | Description |
|---|---|---|
| systemItem | string | value to set. |
Returns: void
setWidth¶
▸ setWidth(width: number): void
Sets the Width property of the control.
Parameters:
| Name | Type | Description |
|---|---|---|
| width | number | value to set. |
Returns: void