In This Topic ▼

attachments Property

Summary

Gets the Object that manages the attachments of the document.

Syntax

TypeScript

JavaScript

Object.defineProperty(LEADDocument.prototype, 'attachments', 
   get: function() 
)

readonly attachments: DocumentAttachments;

Property Value

The DocumentAttachments object that manages the attachments of this LEADDocument.

Remarks

DocumentAttachments derives from LeadCollection. Use any of the collection methods to add, remove, insert, get, set, and iterate through the attachments.

DocumentAttachments contains a collection of DocumentAttachment objects, each containing the data for a single attachment in the document. The embedded attachments of a document can be read and populated when setting the LoadDocumentOptions.loadAttachmentsMode property to DocumentLoadAttachmentsMode.asAttachments during the loading of this document.

DocumentAttachments can also be manually populated by an application program to add or remove attachments to a document.

For more information, refer to Document Attachments.

Example

For an example, refer to DocumentAttachment or DocumentAttachment.documentId.

Requirements

Target Platforms