Class: AttachmentFormCellProxy¶
AttachmentFormCellProxy is a developer-facing interface that provides access to a Attachment control and allows customizations. In addition it provides access to the IFormCellProxy interface.
Hierarchy¶
-
AttachmentFormCellProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Inherited Properties¶
Accessors¶
Class Accessors¶
Inherited Accessors¶
Methods¶
Class Methods¶
- getAllowedFileTypes
- getAttachmentActionType
- getAttachmentAddTitle
- getAttachmentCancelTitle
- getAttachmentTitle
- openAttachmentItem
- setAllowedFileTypes
- setAttachmentActionType
- setAttachmentAddTitle
- setAttachmentCancelTitle
- setAttachmentTitle
- setValueByIndex
Inherited Methods¶
Constructors¶
constructor¶
+ new AttachmentFormCellProxy(context: IContext): AttachmentFormCellProxy
Overrides FormCellControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
context |
IContext |
Returns: AttachmentFormCellProxy
Properties¶
Accessors¶
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]): void
Implementation of IAttachmentFormCellProxy
This method is for setting the attachment allowed file types, i.e. If no specified value for this the AllowedFileTypes property, it allow user select any type of file; this property can contain the values just like ["pdf","jpg", "..."].
Parameters:
| Name | Type | Description |
|---|---|---|
fileType |
[string] | value to set. |
Returns: void
setAttachmentActionType¶
▸ setAttachmentActionType(actionType: [string]): void
Implementation of IAttachmentFormCellProxy
This method is for setting the attachment action types, i.e. for changing the value of the AttachmentActionType property. Currently just the photo library and the camera are supported as attachment sources, so the value can contain just the values 'AddPhoto' and/or "TakePhoto" and/or "SelectFile".
Parameters:
| Name | Type |
|---|---|
actionType |
[string] |
Returns: void
setAttachmentAddTitle¶
▸ setAttachmentAddTitle(addTitle: string): void
Implementation of IAttachmentFormCellProxy
This method is for setting the title bar of the add attachment menu, i.e. for changing the value of the AttachmentAddTitle property. The default value is 'Add'.
Parameters:
| Name | Type | Description |
|---|---|---|
addTitle |
string | value to set. |
Returns: void
setAttachmentCancelTitle¶
▸ setAttachmentCancelTitle(cancelTitle: string): void
Implementation of IAttachmentFormCellProxy
This method is for setting the title of the cancel button on the add attachment menu, i.e. for changing the value of the AttachmentCancelTitle property. The default value is 'Cancel'.
Parameters:
| Name | Type | Description |
|---|---|---|
cancelTitle |
string | value to set. |
Returns: void
setAttachmentTitle¶
▸ setAttachmentTitle(title: string): void
Implementation of IAttachmentFormCellProxy
This method is for setting the title of the attachment container, i.e. for changing the value of the AttachmentTitle property. The default value is 'Attachments (%d)', where %d is substituted by the actual count of the attachments.
Parameters:
| Name | Type | Description |
|---|---|---|
title |
string | value to set. |
Returns: void
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