Class: ActionBarProxy

Hierarchy

• ControlProxy

• ActionBarProxy

Implements

• IClientAPI
• IControlProxy
• IActionBarProxy

Summary

Constructors

• constructor

Properties

Class Properties

Currently none in this class.

Inherited Properties

• _context

• _control

Accessors

Class Accessors

Currently none in this class.

Inherited Accessors

• actionResults

• binding

• currentPage

• filterTypeEnum

• mdkWindows

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

• createLinkSpecifierProxy

• deleteODataCacheImages

• dismissActivityIndicator

• downloadInProgressForPage

• downloadInProgressForReadLink

• evaluateTargetPath

• evaluateTargetPathForAPI

• executeAction

• formatBase64String

• formatCurrency

• formatDate

• formatDatetime

• formatNumber

• formatPercentage

• formatScientific

• formatTime

• getActionResult

• getAppClientData

• getAppEventData

• getAppName

• getAppearanceMode

• getAvailableThemes

• getBindingObject

• getCircularImage

• getClientData

• getDefinitionValue

• 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

• isCurrentPage

• isDemoMode

• isDeviceCompliant

• isMediaLocal

• localizeText

• read

• redraw

• sendMobileServiceRequest

• sendRequest

• setApplicationIconBadgeNumber

• setDebugSettings

• setEditable

• setLanguage

• setRegion

• setStyle

• setTheme

• setUseInAppCamera

• setValidationProperty

• setValue

• setVisible

• showActivityIndicator

• updateProgressBanner

• Create

• setMdkWindows

Constructors

constructor

+ new ActionBarProxy(context: IContext): ActionBarProxy

Overrides ControlProxy.constructor

Parameters:

Name	Type
context	IContext

Returns: ActionBarProxy

Methods

getCaption

▸ getCaption(): string

Implementation of IActionBarProxy

Overrides ControlProxy.getCaption

Returns: string

---

getCaptionAlignment

▸ getCaptionAlignment(): string

Implementation of IActionBarProxy

Returns: string

---

getDataSubscriptions

▸ getDataSubscriptions(): string[]

Implementation of IActionBarProxy

Returns: string[]

---

getItem

▸ getItem(itemName: string): IActionBarItemProxy

Implementation of IActionBarProxy

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

Implementation of IActionBarProxy

Returns: IActionBarItemProxy[]

The actionbar items controls for this container

---

getLogo

▸ getLogo(): string

Implementation of IActionBarProxy

Returns: string

---

getOverflowIcon

▸ getOverflowIcon(): string

Implementation of IActionBarProxy

Returns: string

---

getPreferredCaptionSize

▸ getPreferredCaptionSize(): string | null

Implementation of IActionBarProxy

Returns: string | null

---

getPrefersLargeCaption

▸ getPrefersLargeCaption(): boolean

Implementation of IActionBarProxy

Returns: boolean

---

getStyle

▸ getStyle(): any

Implementation of IActionBarProxy

Returns: any

---

getSubhead

▸ getSubhead(): string

Implementation of IActionBarProxy

Returns: string

---

isContainer

▸ isContainer(): boolean

Implementation of IActionBarProxy

Overrides ControlProxy.isContainer

Returns: boolean

true/false.

---

reset

▸ reset(): Promise‹any›

Implementation of IActionBarProxy

Returns: Promise‹any›

---

setCaption

▸ setCaption(caption: string): void

Implementation of IActionBarProxy

Parameters:

Name	Type	Description
caption	string	value to set.

Returns: void

---

setCaptionAlignment

▸ setCaptionAlignment(captionAlignment: string): void

Implementation of IActionBarProxy

Parameters:

Name	Type	Description
captionAlignment	string	value to set.

Returns: void

---

setDataSubscriptions

▸ setDataSubscriptions(dataSubscriptions: string[]): void

Implementation of IActionBarProxy

Parameters:

Name	Type	Description
dataSubscriptions	string[]	value to set.

Returns: void

---

setLogo

▸ setLogo(logo: string): void

Implementation of IActionBarProxy

Parameters:

Name	Type	Description
logo	string	value to set.

Returns: void

---

setOverflowIcon

▸ setOverflowIcon(overflowIcon: string): void

Implementation of IActionBarProxy

Parameters:

Name	Type	Description
overflowIcon	string	value to set.

Returns: void

---

setPreferredCaptionSize

▸ setPreferredCaptionSize(preferredCaptionSize: string): void

Implementation of IActionBarProxy

Parameters:

Name	Type	Description
preferredCaptionSize	string	large/medium/null value to set.

Returns: void

---

setPrefersLargeCaption

▸ setPrefersLargeCaption(prefersLargeCaption: boolean): void

Implementation of IActionBarProxy

Parameters:

Name	Type	Description
prefersLargeCaption	boolean	value to set.

Returns: void

---

setSubhead

▸ setSubhead(subhead: string): void

Implementation of IActionBarProxy

Parameters:

Name	Type	Description
subhead	string	value to set.

Returns: void

---