Namespace WebViewerInterface

The functions that WebViewer uses to interface with ReaderControl

Namespace Summary
Constructor Attributes	Constructor Name and Description
	WebViewerInterface These functions should be overridden in a ReaderControl so that WebViewer can interact with it

Method Summary
Method Attributes	Method Name and Description
	fitHeight() Controls if the document's Zoom property will be adjusted so that the height of the current page or panel will exactly fit into the available space.
	fitPage() Controls if the document's Zoom property will be adjusted so that the width and height of the current page or panel will fit into the available space.
	fitWidth() Controls if the document's Zoom property will be adjusted so that the width of the current page or panel will exactly fit into the available space.
	fitZoom() Sets the FitMode to Zoom, where the zoom level is free from pre-defined fit modes.
	getCurrentPageNumber() Gets the current page number
	getFitMode() Gets the current fit mode
	getLayoutMode() Gets the layout mode of the document.
	getPageCount() Gets the total page count of the loaded document
	getShowSideWindow() Gets the value whether the side window is visible or not.
	getToolMode() Gets the current tool mode
	getZoomLevel() Gets the current zoom level
	goToFirstPage() Navigates to the first page of the document
	goToLastPage() Navigates to the last page of the document
	goToNextPage() Navigates to the next page of the document.
	goToPrevPage() Navigates to the previous page of the document.
	loadDocument(url) Loads a document into the WebViewer.
	rotateClockwise() Rotates the document viewer's orientation by 90 degrees clockwise.
	rotateCounterClockwise() Rotates the document viewer's orientation by 90 degrees counter clockwise.
	searchText(pattern, searchMode) Searches the loaded document finding for the matching pattern.
	setCurrentPageNumber(pageNumber) Sets the current page number and navigates to the specified page in the viewer.
	setFitMode(fitMode) Sets the fit mode
	setLayoutMode(layout) Sets the layout mode of the document.
[deprecated]	setOnPageChangeCallback(callback) Registers a callback when the document's page number is changed.
[deprecated]	setOnPageZoomCallback(callback) Registers a callback when the document's zoom level is changed.
	setShowSideWindow(value) Sets the value whether the side window is visible or not.
	setToolMode(toolMode) Sets the tool mode
	setZoomLevel(zoomLevel) Sets the current zoom level

Namespace Detail

WebViewerInterface

These functions should be overridden in a ReaderControl so that WebViewer can interact with it

Method Detail

fitHeight()

Controls if the document's Zoom property will be adjusted so that the height of the current page or panel will exactly fit into the available space. Not supported by HTML5 viewers.

fitPage()

Controls if the document's Zoom property will be adjusted so that the width and height of the current page or panel will fit into the available space. Not supported for mobile viewer.

fitWidth()

Controls if the document's Zoom property will be adjusted so that the width of the current page or panel will exactly fit into the available space. Not supported for mobile viewer.

fitZoom()

Sets the FitMode to Zoom, where the zoom level is free from pre-defined fit modes.

{integer} getCurrentPageNumber()

Gets the current page number

Returns:: {integer} the current page number

{object} getFitMode()

Gets the current fit mode

Returns:: {object} the current fit mode

getLayoutMode()

Gets the layout mode of the document. Not supported for mobile viewer.

Returns:: the layout mode of the document

{integer} getPageCount()

Gets the total page count of the loaded document

Returns:: {integer} the total page count of the loaded document

getShowSideWindow()

Gets the value whether the side window is visible or not. Not supported for mobile viewer.

Returns:: true if the side window is shown

{object} getToolMode()

Gets the current tool mode

Returns:: {object} the current tool mode

{number} getZoomLevel()

Gets the current zoom level

Returns:: {number} the current zoom level in float, where 1.0 is 100%.

goToFirstPage()

Navigates to the first page of the document

goToLastPage()

Navigates to the last page of the document

goToNextPage()

Navigates to the next page of the document. This method will increment the current page number by 1, regardless of display modes (where more than 1 page is displayed at a time).

goToPrevPage()

Navigates to the previous page of the document. This method will decrement the current page number by 1, regardless of display modes (where more than 1 page is displayed at a time).

loadDocument(url)

Loads a document into the WebViewer.

Parameters:
url: url of the document to be loaded (relative urls may not work, it is recommended to use absolute urls)

rotateClockwise()

Rotates the document viewer's orientation by 90 degrees clockwise.

rotateCounterClockwise()

Rotates the document viewer's orientation by 90 degrees counter clockwise.

searchText(pattern, searchMode)

Searches the loaded document finding for the matching pattern. Search mode includes:

None
CaseSensitive
WholeWord
SearchUp
PageStop
ProvideQuads
AmbientString

Parameters:
pattern: the pattern to look for
searchMode: must one or a combination of the above search modes. To combine search modes, simply pass them as comma separated values in one string. i.e. "CaseSensitive,WholeWord"

setCurrentPageNumber(pageNumber)

Sets the current page number and navigates to the specified page in the viewer.

Parameters:
{integer} pageNumber: the new page number

setFitMode(fitMode)

Sets the fit mode

Parameters:
{object} fitMode: the object representing the fit mode

setLayoutMode(layout)

Sets the layout mode of the document. Not supported for mobile viewer.

Parameters:
layout: the layout mode to set

setOnPageChangeCallback(callback)

Registers a callback when the document's page number is changed. (Silverlight only)

Parameters:
callback: the JavaScript function to invoke when the document page number is changed

Deprecated:
Deprecated since 1.3.2

setOnPageZoomCallback(callback)

Registers a callback when the document's zoom level is changed. (Silverlight only)

Parameters:
callback: the JavaScript function to invoke when the document zoom level is changed

Deprecated:
Deprecated since 1.3.2

setShowSideWindow(value)

Sets the value whether the side window is visible or not. Not supported for mobile viewer.

Parameters:
value: true to show the side window

setToolMode(toolMode)

Sets the tool mode

Parameters:
{object} toolMode: the object representing the tool mode

setZoomLevel(zoomLevel)

Sets the current zoom level

Parameters:
{number} zoomLevel: the new zoom level, where 1.0 is 100%.

WebViewer HTML5 API Reference v1.8.2.30296

Classes

Namespace WebViewerInterface