Accusoft.ThumbnailXpress5.Net
AddItemsFromDirectory Method
See Also  Send Feedback
Accusoft.ThumbnailXpressSdk Namespace > ThumbnailItemCollection Class : AddItemsFromDirectory Method




directory
A string value which represents the directory used as the source of the images.
collectionIndex
An integer value which represents the index into the collection where the item should be added. -1 indicates to append to the end of the collection.

Glossary Item Box

Adds thumbnail items to the collection from the provided directory.

Syntax

 
Visual Basic
C#
Managed Extensions for C++
C++/CLI
 
 

Parameters

directory
A string value which represents the directory used as the source of the images.
collectionIndex
An integer value which represents the index into the collection where the item should be added. -1 indicates to append to the end of the collection.

Return Value

An integer which represents the number of images this method added to the collection.

Remarks

Only the first page of multi-page images are added.

This method does not wait for images to be generated before returning. The thumbnail images are generated in the background. This means a thumbnail's image data (for example, its bitmap) is likely not available immediately after this method returns. Use the ThumbnailXpress.ItemComplete event to determine when an item's image has completed being generated before attempting to programmatically access its image data.

Note: When a path is passed to this method without a final trailing slash, the parent of the path is used as the directory.

See Also

©2013. Accusoft Corporation. All Rights Reserved.