Interface: IAttachmentEntryProxy

A designer-facing interface that provides access to an item of attachmen control.

Hierarchy

• IElementProxy

• IAttachmentEntryProxy

Implemented by

• AttachmentEntryProxy

Summary

Properties

Class Properties

Currently none in this class.

Inherited Properties

• actionResults

• binding

• currentPage

• filterTypeEnum

Methods

Class Methods

• createAttachmentEntry
• getIndex
• getPageProxy
• getParent
• getValue
• open
• setValue

Inherited Methods

• base64StringToBinary

• binaryToBase64String

• callFunction

• 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

• getIconTextImage

• getLanguage

• getLogger

• getMobileServiceAppId

• getMobileServiceEndpointUrl

• getName

• getODataCacheImagePath

• getODataProvider

• getPageDefinition

• getPasscodeSource

• getPendingDownload

• getReadLink

• getRegion

• getRegions

• getSAPPassportHeaderValue

• getSupportedLanguages

• getTheme

• getType

• getVersionInfo

• initializeLogger

• isAppInMultiUserMode

• isCurrentPage

• isDemoMode

• isMediaLocal

• localizeText

• read

• sendMobileServiceRequest

• sendRequest

• setApplicationIconBadgeNumber

• setDebugSettings

• setLanguage

• setRegion

• setTheme

• showActivityIndicator

• updateProgressBanner

Methods

createAttachmentEntry

▸ createAttachmentEntry(attachmentPath: string, entitySet: string, property: string, readLink: string, service: string, encodeURI: boolean): any

Create an object for attachment entry Note: This function is for iOS & Android only

Parameters:

Name	Type	Default	Description
attachmentPath	string	-	the path for the attachment file
entitySet	string	-	entity set name
property	string	-	the property of the entity set
readLink	string	-	readlink string
service	string	-	service name
encodeURI	boolean	true	whether the URI need to be encoded, default value is true

Returns: any

an object with all information for the attachment entry or undefined if the attachment is invalid

---

getIndex

▸ getIndex(): number

Overrides IElementProxy.getIndex

Get index

Returns: number

---

getPageProxy

▸ getPageProxy(): IPageProxy

Overrides IElementProxy.getPageProxy

Returns: IPageProxy

the Page, which the control belongs to

---

getParent

▸ getParent(): IAttachmentFormCellProxy

Overrides IElementProxy.getParent

This method returns AttachmentFormCell proxy

Returns: IAttachmentFormCellProxy

---

getValue

▸ getValue(): any

Get item value (Read-Only). The value is in accordance with the interface IAttachment definition.

Returns: any

the value of the item

---

open

▸ open(): void

Open the item of the specified attachment

Returns: void

---

setValue

▸ setValue(value: any, notify?: boolean): any

Set the new value in the item. The value should be generated from: FormCellControlProxy.createAttachmentEntry() or AttachmentEntryProxy.createAttachmentEntry()

Parameters:

Name	Type	Description
value	any	value to be set
notify?	boolean	whether to send the notification

Returns: any

this - allows chaining

---