Skip to content

Class: AttachmentEntryProxy

AttachmentEntryProxy is a developer-facing interface that provides access to an item of the Attachment control in the OnPress event. In addition, it provides access to the IAttachmentEntryProxy interface.

Hierarchy

Implements

Summary

Constructors

Properties

Class Properties

Inherited Properties

Accessors

Class Accessors

Currently none in this class.

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

Constructor

+ new AttachmentEntryProxy(context: IContext): AttachmentEntryProxy

Overrides ElementProxy.constructor

Parameters:

Name Type
context IContext

Returns: AttachmentEntryProxy

Properties

Protected _row

_row: any

Methods

createAttachmentEntry

createAttachmentEntry(attachmentPath: string, entitySet: string, property: string, readLink: string, service: string, encodeURI?: boolean = true): any

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

Implementation of IAttachmentEntryProxy.createAttachmentEntry

Parameters:

Name Type 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 to prefix the path with 'file://' if it is not already using another URI protocol, default value is true

Returns: any

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


getParent

getParent(): IAttachmentFormCellProxy

This method returns AttachmentFormCell proxy

Implementation of IAttachmentEntryProxy.getParent Overrides ElementProxy.getParent

Returns: IAttachmentFormCellProxy


getValue

getValue(): any

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

Implementation of IAttachmentEntryProxy.getValue

Returns: any

the value of the item


open

open(): any

Open the attachment

Implementation of IAttachmentEntryProxy.open

Returns: any


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()

Implementation of IAttachmentEntryProxy.setValue

Parameters:

Name Type Description
value any value to be set
notify? boolean whether to triggers the OnValueChange event on the parent control

Returns: any

this - allows chaining