LoadDocumentAttachment Method

Summary

Loads an attachment as a LEADDocument object.

Syntax

C++

public static LEADDocument LoadDocumentAttachment( 
   LoadFromCacheOptions loadOptions, 
   LoadAttachmentOptions attachmentsOptions 
)

Public Shared Function LoadDocumentAttachment( 
   ByVal loadOptions As LoadFromCacheOptions, 
   ByVal attachmentsOptions As LoadAttachmentOptions 
) As LEADDocument

public:  
   static LEADDocument^ LoadDocumentAttachment( 
      LoadFromCacheOptions^ loadOptions, 
      LoadAttachmentOptions^ attachmentsOptions 
   )

Parameters

loadOptions

Options to identify the owner document. This value cannot be null.

attachmentsOptions

Options to identify the attachment. This value cannot be null.

Return Value

The attachment document as a LEADDocument object if successful; otherwise, null.

Remarks

Use LEADDocument.LoadDocumentAttachment to load an attachment if the owner document is already loaded as a LEADDocument object. The remarks in this section regarding loadOptions is not used, since the owner document is already loaded. However, the remarks regarding attachmentOptions applies.

Use DocumentFactory.LoadDocumentAttachment to load an attachment if the owner document is not loaded and only its ID is available.

This method works as follows:

The owner document is loaded from the cache using the options set in loadOptions using LoadFromCache. If not successful, then null is returned.
The corresponding DocumentAttachment object for LoadAttachmentOptions.AttachmentNumber of attachmentOptions is obtained.

If not successful, then an exception is thrown.

If the value of DocumentAttachment.DocumentId is not null, then it is assumed that the attachment document is already in the cache and therefore is loaded using the options set in LoadDocumentOptions.LoadAttachmentsMode using LoadFromCache, and returned.

If this value is null or loading from cache fails, then the workflow continues to the next section.

If the attachment is not embedded (the value of DocumentAttachment.IsEmbedded is false), then null is returned.
If the attachment is embedded (the value of DocumentAttachment.IsEmbedded is true), then the attachment data is obtained through DocumentAttachments.CreateAttachmentStream; and if successful, a LEADDocument object is created using LoadFromStream and returned.

For more information, refer to Document Attachments.

Example

For an example, refer to DocumentAttachment and DocumentAttachment.DocumentId.

Requirements

Target Platforms

Reference

DocumentFactory Class

DocumentFactory Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 21.0.2021.7.2