Skip to content

Interface: IAttachmentEntryProxy

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

Hierarchy

Implemented by

Summary

Properties

Class Properties

None in this class.

Inherited Properties

Methods

Class Methods

Inherited Methods

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

Get index

Returns: number


getPageProxy

getPageProxy(): IPageProxy

Returns: IPageProxy

the Page, which the control belongs to


getParent

getParent(): IAttachmentFormCellProxy

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