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¶
-
ButtonFormCellControlProxy
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¶
- 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
- createFilterSelection
- createLinkSpecifierProxy
- createSorterSelection
- dataQueryBuilder
- 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
- getCollection
- getDefinitionValue
- getEditable
- getEnable
- getEnabled
- getEventData
- 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
- getUseInAppCamera
- 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
- setMdkWindows
- setRegion
- setRequiredIndicator
- setRequiredIndicatorStyle
- setStyle
- setTargetSpecifier
- setTheme
- setUseInAppCamera
- setValidationProperty
- setValue
- setVisible
- showActivityIndicator
- updateProgressBanner
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.
Implementation of IButtonFormCellProxy.getAlignment
Returns: string
getButtonType¶
▸ getButtonType(): string
Returns the ButtonType property value defined for the FormCell's control.
Implementation of IButtonFormCellProxy.getButtonType
Returns: string
getImage¶
▸ getImage(): string
Returns the Image property value defined for the FormCell's control.
Implementation of IButtonFormCellProxy.getImage
Returns: string
getImagePosition¶
▸ getImagePosition(): string
Returns the ImagePosition property value defined for the Button FormCell's control.
Implementation of IButtonFormCellProxy.getImagePosition
Returns: string
getImageSize¶
▸ getImageSize(): Object
Returns the ImageSize property value defined for the Button FormCell's control.
Implementation of IButtonFormCellProxy.getImageSize
Returns: Object
getSemantic¶
▸ getSemantic(): string
Returns the Semantic property value defined for the Button FormCell's control.
Implementation of IButtonFormCellProxy.getSemantic
Returns: string
getTextAlignment()¶
▸ getTextAlignment(): string
Returns the TextAlignment property value defined for the FormCell's control.
Returns: string
Deprecated¶
- use getAlignment() instead.
Implementation of IButtonFormCellProxy.getTextAlignment
getTitle¶
▸ getTitle(): string
Returns the Title property value defined for the FormCell's control.
Implementation of IButtonFormCellProxy.getTitle
Returns: string
setAlignment¶
▸ setAlignment(alignment: string): Promise<any>
Sets the Alignment property of the FormCell's control. Accepted values are: "Left", "Right", "Center".
Implementation of IButtonFormCellProxy.setAlignment
Parameters:
| Name | Type | Description |
|---|---|---|
| alignment | string | value to set. |
Returns: Promise<any>
setButtonType¶
▸ setButtonType(type: string): Promise<any>
Sets the ButtonType property of the FormCell's control. Accepted values are: "Primary", "Secondary", "Text".
Implementation of IButtonFormCellProxy.setButtonType
Parameters:
| Name | Type | Description |
|---|---|---|
| type | string | value to set. |
Returns: Promise<any>
setImage¶
▸ setImage(image: string): Promise<any>
Sets the Image property of the Button FormCell's control.
Implementation of IButtonFormCellProxy.setImage
Parameters:
| Name | Type | Description |
|---|---|---|
| image | string | value to set. |
Returns: Promise<any>
setImagePosition¶
▸ setImagePosition(imagePosition: string): Promise<any>
Sets the ImagePosition property of the Button FormCell's control.
Implementation of IButtonFormCellProxy.setImagePosition
Parameters:
| Name | Type | Description |
|---|---|---|
| imagePosition | string | value to set. |
Returns: Promise<any>
setImageSize¶
▸ setImageSize(imageSize: Object): Promise<any>
Sets the ImageSize property of the Button FormCell's control.
Implementation of IButtonFormCellProxy.setImageSize
Parameters:
| Name | Type | Description |
|---|---|---|
| imageSize | Object | value to set. |
Returns: Promise<any>
setSemantic¶
▸ setSemantic(semantic: string): Promise<any>
Sets the Semantic property of the Button FormCell's control.
Implementation of IButtonFormCellProxy.setSemantic
Parameters:
| Name | Type | Description |
|---|---|---|
| semantic | string | value to set. |
Returns: Promise<any>
setTextAlignment()¶
▸ setTextAlignment(alignment: string): Promise<any>
Sets the TextAlignment property of the FormCell's control. Accepted values are: "Left", "Right", "Center".
Parameters:
| Name | Type | Description |
|---|---|---|
| alignment | string | value to set. |
Returns: Promise<any>
Deprecated¶
- use setAlignment(alignment: string) instead.
Implementation of IButtonFormCellProxy.setTextAlignment
setTitle¶
▸ setTitle(title: string): Promise<any>
Sets the Title property of the Button FormCell's control.
Implementation of IButtonFormCellProxy.setTitle
Parameters:
| Name | Type | Description |
|---|---|---|
| title | string | value to set. |
Returns: Promise<any>