Interface IDocumentSelectionEdit

Inherited Members

Assembly: Estrelica.Interfaces.dll

Syntax

[StayPublic]
[DoNotObfuscateType]
public interface IDocumentSelectionEdit : IFieldValueEdit<IEnumerable<IArcherDocument>>, IEditableField, IEditable, IClearable, IObjectValue

Methods

Add(int)

Adds an existing Archer attachment that was uploaded separately (e.g. via a call to IAPIFacade.PostAttachment) to the associated Attachment or Image field of the current record, based on the Archer uploadedDocumentId of the file.

Declaration

bool Add(int uploadedDocumentId)

Parameters

int uploadedDocumentId

The Archer uploadedDocumentId of the file

Returns

bool

Remove(int)

Removes a document from the associated Attachment or Image field of the current record, based on the Archer documentId of the file.

Declaration

bool Remove(int documentId)

Parameters

int documentId

The Archer documentId to be removed

Returns

bool

True if the removal was successful.

Remove(string)

Removes a document from the associated Attachment or Image field of the current record, based on the filename of the file.

Declaration

bool Remove(string filename)

Parameters

string filename

Returns

bool

Upload(string, string, bool)

Uploads a file to Archer and links the result to the associated Attachment or Image field of the current record.

Declaration

IArcherDocument Upload(string sourceFilename, string displayName = null, bool encrypt = false)

Parameters

string sourceFilename

The name of the file to be uploaded. If a relative path is provided, the full path will be resolved from the current executing directory.

string displayName

The filename to be displayed for this file in the Archer UI. If null, the filename will be the same as sourceFilename (stripped of any path info). Regardless of how this value is determined, it must have an extension acceptable to the target Archer instance (see "File Creation Restriction" in the Archer Control Panel).

bool encrypt

Indicates whether the file's contents should be encrypted at rest in the Archer instance repository.