In This Topic ▼

DocumentAttachments Object

Summary

Represents a collection of DocumentAttachment objects.

Syntax

TypeScript

JavaScript

function lt.Document.DocumentAttachments 
   extends lt.Document.DocumentAttachments.LeadCollection

class lt.Document.DocumentAttachments 
   extends lt.Document.DocumentAttachments.LeadCollection

Remarks

The DocumentAttachments object manages the attachments of a document. Access it through the attachments collection of LEADDocument.

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

The DocumentAttachments object 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 by 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