ThumbnailViewState class

The control state of a ThumbnailView control.

Syntax

ASP.NET Ajax Javascript (Specification)
ImageGear.Web.UI.ThumbnailViewState = function() {};

ASP.NET Ajax Javascript (Usage)
var instanceVar = new ImageGear.Web.UI.ThumbnailViewState();

Remarks

This object represents the state of a ThumbnailView control. In some cases it will represent an actual state of a ThumbnailView control and in other cases it will represent a target state of a ThumbnailView control.

Normally, the client and server portions of a ThumbnailView control will use this object to manage the control's state without any assistance, but there are a few cases where you must use this object yourself.

If you call the ImageGear.Web.UI.ThumbnailView.openPage function, you must create an object of this type in order to specify the image to open and how you want it to be initially displayed.
If you call the ImageGear.Web.UI.ThumbnailView.get_currentState function, it will return an object of this type.
The ImageGear.Web.UI.ThumbnailView.pageOpening, ImageGear.Web.UI.ThumbnailView.pageOpened, and ImageGear.Web.UI.ThumbnailView.pageClosed events all use an object of this type to hold the event arguments.

Most of the values in this object are fairly easy to understand, but the documentIdentifier and encodedDocumentIdentifier may be a little confusing. Because the ImageGear product allows you to use any characters (including symbols and unicode characters) in document identifiers, it uses base64 encoding to ensure they are suitable for use in a URL. Unfortunately, there are use cases where you will want to use an encoded document identifier and cases where you will want to use an unencoded document identifier. To support both types of use cases, the ImageGear product gives you read access to both forms of the document identifier and allows you to specify either type when you open a page. For example, when an ThumbnailView returns an object of this type, it will set both the documentIdentifier value to the unencoded document identifier and the encodedDocumentIdentifier to an encoded version of the same document identifier. When you provide an instance of this object to the ImageGear.Web.UI.ThumbnailView.openPage function, you can specify either value (or set them both to reference the same document identifier).

Inheritance Hierarchy

Object
ImageGear.Web.UI.ThumbnailViewState

Reference

ThumbnailViewState Members
ImageGear.Web.UI Namespace