Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.12.21
WebImagePanViewer JavaScript Client Class

WebImagePanViewer Client Object

The LEADTOOLS WebImagePanViewer control includes a client-side Javascript class to update the server control without posting the entire page back to the server. Most of the WebImagePanViewer server properties can be accessed through the Javascript class. You can access the LEADTOOLS WebImagePanViewer control on the client-side by using the ASP.NET generated ClientID on the WebForm.

Client Naming

The client-side version of the control uses the same naming convention as the server control version for easier coding. All LEADTOOLS public class definitions in the WebImageViewer.js and Utilities.js files contain the prefix "ltwf" to avoid conflicts with any other components on the page.

Client Public Methods/Properties

All server side object properties can be accessed on the client by using two methods: "GetServerPropertyName", and "SetServerPropertyName", where “ServerPropertyName” is replaced with the name of the property to be accessed or set.

The following table lists the Server properties and the mapped client methods:

Property\Method Name(Server) Method Name(Client) Description Input Type
N/A ID Gets the web control identifier generated by ASP.NET. -
BackColor

getBackColor():string

setBackColor(value:String)

Gets or sets the background color of the control.

String representing the CSS background color.
BorderColor

getBorderColor():string

setBorderColor(value:String)

Gets or sets the border color of the control.

String representing the CSS border color.
BorderStyle

getBorderStyle():string

setBorderStyle(value:String)

Gets or sets the border style of the control.

String representing the CSS border style.
BorderWidth

getBorderWidth():int

setBorderWidth(value:Int32)

Gets or sets the border width of the web control.

Int32 representing the border width of the web control.
Width

getWidth():int

setWidth(value:Int32)

Gets or sets the width of the web control in pixels.

Int32 representing the width of the web control.
Height

getHeight():int

setHeight(value:Int32)

Gets or sets the height of the web control in pixels.

Int32 representing the height of the web control.
RectangleColor

getRectangleColor():ImageViewerAlignMode

setRectangleColor(value:String)

Gets or sets the color used to draw the Pan Rectangle.

String representing the CSS Pan Rectangle color.
HorizontalAlignMode

getHorizontalAlignMode():ImageViewerAlignMode

setHorizontalAlignMode(value:ImageViewerAlignMode)

Gets or sets the horizontal alignment used when displaying the image.

ImageViewerAlignMode representing the horizontal alignment used when displaying the image.

(0-2), 0:Near, 1:Center, 2:Far
Tooltip

getTooltip():string

setTooltip(value:String)

Gets the text displayed when the mouse hovers over the web control.

String representing the text displayed when the mouse hovers over the web control.

VerticalAlignMode

getVerticalAlignMode():ImageViewerAlignMode

setVerticalAlignMode(value:ImageViewerAlignMode)

Gets or sets the vertical alignment to display the image.

ImageViewerAlignMode (0-2), 0:Near, 1:Center, 2:Far.

ViewerID

getViewerID():string

setViewerID():string

Gets the ID of the WebImageViewer control currently assigned for panning process by the control.

-
Visible

getVisible():bool

setVisible(value:Boolean)

Gets or sets whether show/hide the control on the web page.

String representing whether to show/hide the control.

true to show the control; false to hide it.

Client Public Events

All public client-side Leadtools events can be overridden with your own function. The following example displays a Javascript alert whenever the ImageUrl property is changed on the WebImagePanViewer client object.


WebImagePanViewer1.BorderColorChanged = myBorderColorChanged;
function myBorderColorChanged()
{
  alert("BorderColor Changed!");
}

The following table lists the Client side events that can be overridden:

Event Name(Server) Event Name(Client) Raised when

N/A

BackColorChanged

BackColor property is changed.

N/A

BorderColorChanged

BorderColor property is changed.

N/A

BorderStyleChanged

BorderStyle property is changed.

N/A

BorderWidthChanged

BorderWidth property is changed.

PropertyChanged

RectangleColorChanged

RectangleColor property is changed.

PropertyChanged

HorizontalAlignModeChanged

HorizontalAlignMode property is changed.

PropertyChanged

VerticalAlignModeChanged

VerticalAlignMode property is changed.

N/A

VisibileChanged

Visibile property is changed.