Class: AttachmentFormCellProxy

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

Hierarchy

• FormCellControlProxy

• AttachmentFormCellProxy

Implements

• IClientAPI
• IControlProxy
• IFormCellProxy
• IAttachmentFormCellProxy

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

• getAllowedFileTypes
• getAttachmentActionType
• getAttachmentAddTitle
• getAttachmentCancelTitle
• getAttachmentTitle
• openAttachmentItem
• setAllowedFileTypes
• setAttachmentActionType
• setAttachmentAddTitle
• setAttachmentCancelTitle
• setAttachmentTitle
• setValueByIndex

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

• getSAPPassportHeaderValue

• getSupportedLanguages

• getTargetSpecifier

• getTheme

• getType

• getValidation

• getValue

• getVersionInfo

• getVisible

• initializeLogger

• isAppInMultiUserMode

• isContainer

• isCurrentPage

• isDemoMode

• isMediaLocal

• localizeText

• read

• redraw

• reset

• sendMobileServiceRequest

• sendRequest

• setApplicationIconBadgeNumber

• setCaption

• setDebugSettings

• setEditable

• setEnable

• setEnabled

• setFocus

• setHelperText

• setLanguage

• setRegion

• setStyle

• setTargetSpecifier

• setTheme

• setValidationProperty

• setValue

• setVisible

• showActivityIndicator

• updateProgressBanner

• Create

• setMdkWindows

Constructors

constructor

+ new AttachmentFormCellProxy(context: IContext): AttachmentFormCellProxy

Overrides FormCellControlProxy.constructor

Parameters:

Name	Type
context	IContext

Returns: AttachmentFormCellProxy

Methods

getAllowedFileTypes

▸ getAllowedFileTypes(): string[]

Implementation of IAttachmentFormCellProxy

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

Returns: string[]

---

getAttachmentActionType

▸ getAttachmentActionType(): string[]

Implementation of IAttachmentFormCellProxy

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

Returns: string[]

---

getAttachmentAddTitle

▸ getAttachmentAddTitle(): string

Implementation of IAttachmentFormCellProxy

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

Returns: string

---

getAttachmentCancelTitle

▸ getAttachmentCancelTitle(): string

Implementation of IAttachmentFormCellProxy

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

Returns: string

---

getAttachmentTitle

▸ getAttachmentTitle(): string

Implementation of IAttachmentFormCellProxy

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

Returns: string

---

openAttachmentItem

▸ openAttachmentItem(index: number): void

Implementation of IAttachmentFormCellProxy

Open the item of the specified attachment at given index

Parameters:

Name	Type	Description
index	number	The index of the item

Returns: void

---

setAllowedFileTypes

▸ setAllowedFileTypes(fileType: [string]): Promise‹any›

Implementation of IAttachmentFormCellProxy

This method is used for setting the allowed file types for attachments. If no value is specified for the AllowedFileTypes property, users are allowed to select any type of file. This property can contain values in the form of an array, such as ["pdf", "jpg", "..."].

Parameters:

Name	Type	Description
fileType	[string]	value to set.

Returns: Promise‹any›

---

setAttachmentActionType

▸ setAttachmentActionType(actionType: [string]): Promise‹any›

Implementation of IAttachmentFormCellProxy

This method is used for setting the attachment action types, specifically for changing the value of the AttachmentActionType property. The Value is an array that can contain 'AddPhoto' and/or 'TakePhoto' and/or 'SelectFile'.

Parameters:

Name	Type
actionType	[string]

Returns: Promise‹any›

---

setAttachmentAddTitle

▸ setAttachmentAddTitle(addTitle: string): Promise‹any›

Implementation of IAttachmentFormCellProxy

This method is used to set the title bar of the add attachment menu, specifically for changing the value of the AttachmentAddTitle property. The default value is 'Add'.

Parameters:

Name	Type	Description
addTitle	string	value to set.

Returns: Promise‹any›

---

setAttachmentCancelTitle

▸ setAttachmentCancelTitle(cancelTitle: string): Promise‹any›

Implementation of IAttachmentFormCellProxy

This method is used to set the title of the cancel button on the add attachment menu, specifically for changing the value of the AttachmentCancelTitle property. The default value is 'Cancel'.

Parameters:

Name	Type	Description
cancelTitle	string	value to set.

Returns: Promise‹any›

---

setAttachmentTitle

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

Implementation of IAttachmentFormCellProxy

This method is used to set the title of the attachment container, specifically for changing the value of the AttachmentTitle property. The default value is 'Attachments (%d)', where %d is substituted with the actual count of the attachments.

Parameters:

Name	Type	Description
title	string	value to set.

Returns: Promise‹any›

---

setValueByIndex

▸ setValueByIndex(value: any, index: number, notify?: boolean): this

Implementation of IAttachmentFormCellProxy

Set the item's value in the attachment control. The value should be generated from: FormCellControlProxy.createAttachmentEntry() or AttachmentEntryProxy.createAttachmentEntry()

Parameters:

Name	Type	Description
value	any	value to be set
index	number	The index of the item
notify?	boolean	whether to send the notification

Returns: this

this - allows chaining

---