Server Name |
JavaScript Syntax : Return value |
Description |
ClientID |
ID() : string |
Gets the server control identifier generated by
ASP.NET. |
N/A |
Form() : object |
Gets the form object that the Web server control is on. |
AntialiasDisplay |
getAntialiasDisplay() :
int
setAntialiasDisplay(value :
int) |
Gets or sets the quality of the scaled image.
Expected
input: AntialiasDisplayMode
or int from 0-3, 0:None 1:ScaleToGray 2:ReductionOnly
3:Full |
AutoZoom |
getAutoZoom() :
int
setAutoZoom(value :
int) |
Gets or sets a value indicating how the image should be zoomed as
the control is resized or the image size changes. This will override setZoom.
For a one time zoom, see setZoomMode.
Expected input: AutoZoomMode
or int from 0-5, 0:None 1:BestFit 2:BestFitShrinkOnly
3:FitToWidth 4:FitToHeight 5:FitToImage |
BackColor |
getBackColor() :
string
setBackColor(value :
string) |
Gets or sets the background color of the Web server
control.
Expected input: string representing a hex value
or exact color name: '#ACFF00' |
BorderColor |
getBorderColor() :
string
setBorderColor(value :
string) |
Gets or sets the border color of the Web server
control.
Expected input: string representing a hex value
or exact color name: '#ACFF00' |
BorderStyle |
getBorderStyle() :
string
setBorderStyle(value :
string) |
Gets or sets the border style used for this Web server
control.
Expected input: string representing Style: '1px
solid #FF9900' |
BorderWidth |
getBorderWidth() :
int
setBorderWidth(value :
int) |
Gets or sets the border width of the Web server control in
pixels. |
BrowserFormat |
getBrowserFormat() :
int |
Gets the format of the images created for browser
output.
Returns an int: 0:Jpeg 1:Png 2:Gif
3:Auto |
CachePath |
getCachePath() :
string |
Gets the file path used for the file cache as specified in the Web.config
file. |
Caption |
getCaption() :
string
setCaption(value :
string) |
Gets or sets a string used for creating a
caption under the Web server control. HTML syntax is allowed.
Note: This property is tied to a hidden input tag, so
changing this value to HTML in JavaScript could cause problems if the page needs
to PostBack. |
Centered |
getCentered() :
bool
setCentered(value :
bool) |
Gets or sets a value indicating if the image is centered when the
image is smaller than the Web server control. |
N/A |
getDisplayImageUrl() :
string |
Gets a url that will return the current viewable
portion of the image. Often used for printing the current area of the
image. |
Font |
getFont() :
string
setFont(value :
string) |
Gets or sets the font name associated with the Web server
control.
Expected input: string representing font name:
'Verdana' |
ForeColor |
getForeColor() :
string
setForeColor(value :
string) |
Gets or sets the foreground color (typically the color of the
text) of the Web server control.
Expected input: string
representing a hex value or exact color name: '#ACFF00' |
N/A |
getFrameIndex() :
int |
Gets the index value used to open the current
image.
Note: If the image has been
modified with a server side ApplyCommand, or has been opened from a method other
than OpenUrl or a linked WebThumbnailViewer, this will always return
0. |
Height |
getHeight() :
string
setHeight(value : string) |
Gets or sets the CSS height style property of the server
control.
Expected input: string representing style
height: '320px' |
ImageDisplayOrder |
getImageDisplayOrder() : int |
Gets the order that tiles are loaded.
Returns an
int: 0:Sequential 1:VisibleFirst 2:OnDemand |
Image.Size |
getImageSize() : atalaSize |
Gets the size, in pixels, of the current image. |
N/A |
getImageUrl() : string |
Gets the currently loaded image url. |
MouseTool |
getMouseToolLeft() :
int
getMouseToolRight() :
int
setMouseTool(left:
int, right: int) |
Gets or sets the behavior of the mouse when interacting with the
viewable area.
Expected input: MouseToolType
or int from 0-7, 0:None 1:Center 2:Selection 3:ZoomIn 4:ZoomOut
5:ZoomArea 6:Pan 7:PassThrough |
MouseTool.Cursor |
getMouseToolCursor() :
int
setMouseToolCursor(value :
int) |
Gets or sets the cursor used with the mouse
tool.
Expected input: MouseToolCursor
or int from 0-8, 0:Auto 1:Arrow 2:Crosshair 3:Grab 4:Hand
5:Move 6:ZoomIn 7:ZoomOut 8:Custom
Note:
Currently, Grab is a CSS Extension supported by Mozilla based browsers
only. |
MouseTool.CustomCursor |
getMouseToolCustomCursor() :
string
setMouseToolCustomCursor(value :
string) |
Gets or sets a value that represents the custom
CSS style used for the MouseTool.
Expected input: string
representing Style: 'wait' or 'url(MyCursor.cur)'
Note: Url based CSS cursor styles may not work in all
browsers. |
PathToResources |
getPathToResources() :
string |
Gets the virtual path to where the image, script, and cursor
files are located. |
N/A |
getReturnValue() : var |
Gets the return value populated by the last successful
RemoteInvoke. |
ImagePosition |
getScrollPosition() :
atalaPoint
setScrollPosition(value
: atalaPoint) |
Gets or sets the upper left image position in
relation to the upper left corner of the Web server control. Negative values are
expected.
Expected input: atalaPoint |
ScrollBarVisibility |
getScrollBarVisibility() :
int |
Gets the visibility of the scrollbars.
Returns
an int: 0:Dynamic 1:None 2:Always |
Selection |
getSelection() : Selection |
Gets the Selection
object of this Web server control. |
TileSize |
getTileSize() : atalaSize |
Gets the height and width of the tiles in pixels. |
TitleBar |
getTitleBar() :
string
setTitleBar(value :
string) |
Gets or sets a string used for a creating a title bar above the
Web server control. HTML syntax is allowed.
Note: This property is tied to a hidden input tag, so
changing this value to HTML in JavaScript could cause problems if the page needs
to PostBack. |
ViewPortSize |
getViewPortSize() : atalaSize |
Gets the size of the viewable area, excluding scroll
bars. |
Visibility |
getVisibility() :
string
setVisibility(value :
string) |
Gets or sets a value that indicates whether the Web server
control is hidden or visible on the page.
Expected input:
string that is either 'hidden', 'visible', or
'inherit'.
Note: 'inherit' will return
VisibilityStyle.Visible on the server side. |
Width |
getWidth() :
string
setWidth(value :
string) |
Gets or sets the CSS width style property of the server
control.
Expected input: string representing style
width: '200px' |
Zoom |
getZoom() :
float
setZoom(value :
float) |
Gets or sets the zoom level of the image in this Web server
control. |
ZoomInOutPercentage |
getZoomInOutPercentage() :
int
setZoomInOutPercentage(value :
int) |
Gets or sets the percentage used to increase or decrease the zoom
level when the zoom MouseTools are used. |