Class: ButtonFormCellControlProxy

ButtonFormCellControlProxy is a developer-facing interface that provides access to a button control and allows customizations. In addition, it provides access to the IFormCellProxy interface.

Hierarchy

• FormCellControlProxy

• ButtonFormCellControlProxy

Implements

• IClientAPI
• IControlProxy
• IFormCellProxy
• IButtonFormCellProxy

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

• searchString

• visible

Methods

Class Methods

• getAlignment
• getButtonType
• getImage
• getImagePosition
• getImageSize
• getSemantic
• getTextAlignment
• getTitle
• setAlignment
• setButtonType
• setImage
• setImagePosition
• setImageSize
• setSemantic
• setTextAlignment
• setTitle

Inherited Methods

• _clientAPIProps

• _getExecuteSource

• applyValidation

• base64StringToBinary

• binaryToBase64String

• callFunction

• clearFocus

• clearValidation

• clearValidationOnValueChange

• convertFilterCriteriaArrayToJSONString

• convertJSONStringToFilterCriteriaArray

• count

• create

• createAttachmentEntry

• createFilterCriteria

• createLinkSpecifierProxy

• dataQueryBuilder

• deleteODataCacheImages

• dismissActivityIndicator

• downloadInProgressForPage

• downloadInProgressForReadLink

• evaluateTargetPath

• evaluateTargetPathForAPI

• executeAction

• formatBase64String

• formatCurrency

• formatDate

• formatDatetime

• formatNumber

• formatPercentage

• formatScientific

• formatTime

• getActionResult

• getAppClientData

• getAppEventData

• getAppName

• getAppearanceMode

• getAvailableThemes

• getBindingObject

• getCaption

• getCircularImage

• getClientData

• getCollection

• getDefinitionValue

• getEditable

• getEnable

• getEnabled

• getGlobalDefinition

• getGlobalSideDrawerControlProxy

• getHelperText

• getIconTextImage

• getLanguage

• getLogger

• getMobileServiceAppId

• getMobileServiceEndpointUrl

• getName

• getODataCacheImagePath

• getODataProvider

• getPageDefinition

• getPageProxy

• getParent

• getPasscodeSource

• getPendingDownload

• getReadLink

• getRegion

• getRegions

• getRequiredIndicator

• getRequiredIndicatorStyle

• getSAPPassportHeaderValue

• getSupportedLanguages

• getTargetSpecifier

• getTheme

• getType

• getValidation

• getValue

• getVersionInfo

• getVisible

• initializeLogger

• isAppInMultiUserMode

• isContainer

• isCurrentPage

• isDemoMode

• isDeviceCompliant

• isMediaLocal

• localizeText

• read

• redraw

• reset

• sendMobileServiceRequest

• sendRequest

• setApplicationIconBadgeNumber

• setCaption

• setDebugSettings

• setEditable

• setEnable

• setEnabled

• setFocus

• setHelperText

• setLanguage

• setRegion

• setRequiredIndicator

• setRequiredIndicatorStyle

• setStyle

• setTargetSpecifier

• setTheme

• setValidationProperty

• setValue

• setVisible

• showActivityIndicator

• updateProgressBanner

• Create

• setMdkWindows

Constructors

constructor

+ new ButtonFormCellControlProxy(context: IContext): ButtonFormCellControlProxy

Overrides FormCellControlProxy.constructor

Parameters:

Name	Type
context	IContext

Returns: ButtonFormCellControlProxy

Methods

getAlignment

▸ getAlignment(): string

Returns the Alignment property value defined for the FormCell's control.

Returns: string

---

getButtonType

▸ getButtonType(): string

Implementation of IButtonFormCellProxy

Returns the ButtonType property value defined for the FormCell's control.

Returns: string

---

getImage

▸ getImage(): string

Implementation of IButtonFormCellProxy

Returns the Image property value defined for the FormCell's control.

Returns: string

---

getImagePosition

▸ getImagePosition(): string

Implementation of IButtonFormCellProxy

Returns the ImagePosition property value defined for the Button FormCell's control.

Returns: string

---

getImageSize

▸ getImageSize(): Object

Implementation of IButtonFormCellProxy

Returns the ImageSize property value defined for the Button FormCell's control.

Returns: Object

---

getSemantic

▸ getSemantic(): string

Implementation of IButtonFormCellProxy

Returns the Semantic property value defined for the Button FormCell's control.

Returns: string

---

getTextAlignment

▸ getTextAlignment(): string

Implementation of IButtonFormCellProxy

Returns the TextAlignment property value defined for the FormCell's control.

deprecated - use getAlignment() instead.

Returns: string

---

getTitle

▸ getTitle(): string

Implementation of IButtonFormCellProxy

Returns the Title property value defined for the FormCell's control.

Returns: string

---

setAlignment

▸ setAlignment(alignment: string): Promise‹any›

Sets the Alignment property of the FormCell's control. Accepted values are: "left", "right", "center".

Parameters:

Name	Type	Description
alignment	string	value to set.

Returns: Promise‹any›

---

setButtonType

▸ setButtonType(type: string): Promise‹any›

Implementation of IButtonFormCellProxy

Sets the ButtonType property of the FormCell's control. Accepted values are: "Button", "Normal".

Parameters:

Name	Type	Description
type	string	value to set.

Returns: Promise‹any›

---

setImage

▸ setImage(image: string): Promise‹any›

Implementation of IButtonFormCellProxy

Sets the Image property of the Button FormCell's control.

Parameters:

Name	Type	Description
image	string	value to set.

Returns: Promise‹any›

---

setImagePosition

▸ setImagePosition(imagePosition: string): Promise‹any›

Implementation of IButtonFormCellProxy

Sets the ImagePosition property of the Button FormCell's control.

Parameters:

Name	Type	Description
imagePosition	string	value to set.

Returns: Promise‹any›

---

setImageSize

▸ setImageSize(imageSize: Object): Promise‹any›

Implementation of IButtonFormCellProxy

Sets the ImageSize property of the Button FormCell's control.

Parameters:

Name	Type	Description
imageSize	Object	value to set.

Returns: Promise‹any›

---

setSemantic

▸ setSemantic(semantic: string): Promise‹any›

Implementation of IButtonFormCellProxy

Sets the Semantic property of the Button FormCell's control.

Parameters:

Name	Type	Description
semantic	string	value to set.

Returns: Promise‹any›

---

setTextAlignment

▸ setTextAlignment(alignment: string): Promise‹any›

Implementation of IButtonFormCellProxy

Sets the TextAlignment property of the FormCell's control. Accepted values are: "left", "right", "center".

deprecated - use setAlignment(alignment: string) instead.

Parameters:

Name	Type	Description
alignment	string	value to set.

Returns: Promise‹any›

---

setTitle

▸ setTitle(title: string): Promise‹any›

Implementation of IButtonFormCellProxy

Sets the Title property of the Button FormCell's control.

Parameters:

Name	Type	Description
title	string	value to set.

Returns: Promise‹any›

---