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

Normally, the client and server portions of a PageView 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 PageView.openPage function, you must create an object of this type in order to specify the page to open and how you want it to be initially displayed.
• If you call the PageView.get_currentState function, it will return an object of this type.
• The PageView.pageOpening, PageView.pageOpened, and PageView.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 PageView 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 PageView.openPage function, you can specify either value (or set them both to reference the same document identifier).

Object
   ImageGear.Web.UI.PageViewState

Reference

ImageGear.Web.UI Namespace