Forces the generation or regeneration of the specified image's thumbnail representation.
Image Thumbnail control
object.GenerateThumb Option, PageNumber
Parameter | Data Type | Description |
Option | Integer | Indicates when the Thumbnail of a specified page should be generated. Allowable values are: |
|
Setting |
Description |
0 | Generates a thumbnail if one has not already been obtained. Not specifying a PageNumber, or specifying a PageNumber of 0 causes all pages that have not been obtained to be generated. | ||
1 | Causes the thumbnail to be generated immediately. If the thumbnail was previously generated, a new one will be obtained. Not specifying a PageNumber, or specifying a PageNumber of 0 causes all pages that have not been obtained to be generated. |
PageNumber | Long | Optional. The number of the page for which a Thumbnail will be generated. If a value is not specified, a default value of 0, to indicate that ALL pages are to be generated, is used. |
This method should be called to reflect any changes made to the image file after a previous thumbnail was generated.
It is not always necessary to obtain new thumbnails (Option=1). Thumbnail images that have been generated during the current session remain buffered, even though they may not be displayed.
Use caution when using a PageNumber of 0. Resulting operations can be lengthy.