Accusoft.ThumbnailXpress6.Net
AddItemsFromFile Method




The name and path of the image file. Note that the path may specify an internet address such as "http://www.somesite.com/test.jpg" or "ftp://..../test.jpg" with two limitations. PDF Xpress (if used) cannot access internet resident files and internet resident multi-page files of any type cannot be expanded
The index into the collection where the item(s) should be added/inserted. -1 indicates to append to the end of the collection.
Flag indicating whether to use all pages in a multi-page image or not.
Adds a thumbnail item from a single-page image or optionally multiple items (one per page) from a multi-page image to the collection from the provided image file.
Syntax
'Declaration
 
Public Function AddItemsFromFile( _
   ByVal filename As String, _
   ByVal collectionIndex As Integer, _
   ByVal expandMultiPage As Boolean _
) As Integer
'Usage
 
Dim instance As ThumbnailItemCollection
Dim filename As String
Dim collectionIndex As Integer
Dim expandMultiPage As Boolean
Dim value As Integer
 
value = instance.AddItemsFromFile(filename, collectionIndex, expandMultiPage)
public int AddItemsFromFile( 
   string filename,
   int collectionIndex,
   bool expandMultiPage
)
public: int AddItemsFromFile( 
   string* filename,
   int collectionIndex,
   bool expandMultiPage
) 
public:
int AddItemsFromFile( 
   String^ filename,
   int collectionIndex,
   bool expandMultiPage
) 

Parameters

filename
The name and path of the image file. Note that the path may specify an internet address such as "http://www.somesite.com/test.jpg" or "ftp://..../test.jpg" with two limitations. PDF Xpress (if used) cannot access internet resident files and internet resident multi-page files of any type cannot be expanded
collectionIndex
The index into the collection where the item(s) should be added/inserted. -1 indicates to append to the end of the collection.
expandMultiPage
Flag indicating whether to use all pages in a multi-page image or not.

Return Value

The number of items this method added to the collection.
Remarks

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

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

 

 


©2018. Accusoft Corporation. All Rights Reserved.

Send Feedback