Accusoft.ThumbnailXpress6.Net
AddItemsFromDirectory Method




A string value which represents the directory used as the source of the images.
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.
Adds thumbnail items to the collection from the provided directory.
Syntax
'Declaration
 
Public Function AddItemsFromDirectory( _
   ByVal directory As String, _
   ByVal collectionIndex As Integer _
) As Integer
'Usage
 
Dim instance As ThumbnailItemCollection
Dim directory As String
Dim collectionIndex As Integer
Dim value As Integer
 
value = instance.AddItemsFromDirectory(directory, collectionIndex)
public int AddItemsFromDirectory( 
   string directory,
   int collectionIndex
)
public: int AddItemsFromDirectory( 
   string* directory,
   int collectionIndex
) 
public:
int AddItemsFromDirectory( 
   String^ directory,
   int collectionIndex
) 

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.

PDF support is deprecated in ImagXpress, please use PDF Xpress instead for PDF support via the Licensing.UsePdfXpressForPDFsOnly property.

See Also

Reference

ThumbnailItemCollection Class
ThumbnailItemCollection Members

 

 


©2015. Accusoft Corporation. All Rights Reserved.

Send Feedback