useGrids Property (DocumentViewerThumbnails)
Summary
Indicates whether to use the thumbnails grid.
Syntax
JavaScript Syntax
Object.defineProperty(DocumentViewerThumbnails.prototype, 'useGrids',get: function(),set: function(value))
TypeScript Syntax
useGrids: boolean;Property Value
true to use the thumbnails grid; otherwise, false. Default value is true.
Remarks
When the value of UseGrids is true, then this class loads the thumbnail of the pages using a grid (through the use of DocumentImages.GetThumbnailsGrid and DocumentViewerOperation.GetThumbnail operation will not contain the thumbnail image data in the DocumentViewerOperationEventArgs.Data1 member.
When the value of UseGrids is false (the default), then this class loads the thumbnail of the pages one at a time (through the use of DocumentPage.GetThumbnailImage and DocumentViewerOperation.GetThumbnail operation will contain the thumbnail image data in the DocumentViewerOperationEventArgs.Data1 member.
Using the thumbnail grids will increase the efficiency of obtaining the thumbnails if the "connection" with the document server is slow. For example, if the viewer is connecting to a web services like in the case of the JavaScript version of this library. If the document has 1000 pages, then the viewer will contact the server 1000 times to get all the thumbnail images if a thumbnail grid is not used. When a grid is used, the viewer will obtain multiple thumbnail images with one call and this can increase the performance of the viewer over all. On the flip side, using a grid might cause a group of the thumbnails to appear to "pop" all at once.
The number of thumbnails to obtain depends on the size of the grid stored in GridPixelSize. The library uses this value as well as the default thumbnail size to calculate the number of thumbnail images that fit in a single grid.
Note that if the value of UseGrids is true, then WorkerCount is not used (assumed to be 1 always).
Note that UseGrids is ignored if the document is not read-only since pages from various documents can be added in any order and the grid technique will have no advantage in this case.
Requirements
