Utils

Atalasoft. Utils

Members

(static, constant) MouseToolType :number

Specifies the behavior of the mouse from within the WebDocumentViewer.

Properties:
Name Type Description
None number

Specify no mouse behavior at all.
Pan number

Clicking and dragging the mouse will scroll the image.
ZoomIn number

Clicking will zoom in.
ZoomOut number

Clicking will zoom out.
ContextMenu number

Shows a context menu for the clicked object (where applicable).
PassThrough number

Allows mouse events to pass through the DOM without any handling.
Selection number

Mouse will be set to crosshairs and can be used to drag and modify a selection rectangle on the image. This tool requires that the WebDocumentViewerConfig.showselecttools flag was set.
ZoomArea number

Zoom in on a specified area defined by dragging a rectangle onto the image. This tool requires that the WebDocumentViewerConfig.showselecttools flag was set.
Text number

Input actions are interpreted as text selection This tool requires that the WebDocumentViewerConfig.showselecttools flag was set.

(static, constant) Browser :Atalasoft.Utils.BrowserMetadata

The current browser metadata.

(static, constant) Fitting :number

Specifies the fitting options.

Properties:
Name Type Description
None number

No fitting will be applied to the image
Best number

Finds the best option between width or height based fitting.
Width number

Fits the image to the available width.
Height number

Fits the image to the available height.

(static, constant) LocalizationAnnotationStrings :string

Annotations related strings.

Properties:
Name Type Description
menuDeleteButton string

Delete button title for annotation context menu.
menuPropertiesButton string

Properties button title for annotation context menu.
dialogButtonOk string

OK button title for annotation property dialog.
dialogButtonReset string

Reset button title for annotation property dialog.
dialogButtonCancel string

Cancel button title for annotation property dialog.
rectangleDialogTitle string

Rectangle annotation properties dialog title.
textDialogTitle string

Text annotation properties dialog title.
ellipseDialogTitle string

Ellipse annotation properties dialog title.
lineDialogTitle string

Line annotation properties dialog title.
linesDialogTitle string

Lines annotation properties dialog title.
freehandDialogTitle string

Freehand annotation properties dialog title.
polygonDialogTitle string

Polygon annotation properties dialog title.
labelFillColor string

Title for Fill Color annotation property.
labelFillOpacity string

Title for Fill Opacity annotation property.
labelRotation string

Title for Rotation annotation property.
labelOutlineColor string

Title for Outline Color annotation property.
labelOutlineOpacity string

Title for Outline Opacity annotation property.
labelOutlineWidth string

Title for Outline Width annotation property.
labelOutlineStartcapWidth string

Title for Outline Startcap Width annotation property.
labelOutlineStartcapHeight string

Title for Outline Startcap Height annotation property.
labelOutlineStartcapStyle string

Title for Outline Startcap Style annotation property.
labelOutlineEndcapWidth string

Title for Outline Endcap Width annotation property.
labelOutlineEndcapHeight string

Title for Outline Endcap Height annotation property.
labelOutlineEndcapStyle string

Title for Outline Endcap Style annotation property.
labelFontBold string

Title for Font Bold annotation property.
labelFontItalic string

Title for Font Italic annotation property.
labelFontColor string

Title for Font Color annotation property.
labelFontFamily string

Title for Font Family annotation property.
labelFontSize string

Title for Font Size annotation property.
radioButtonTrue string

Title for True radio button.
radioButtonFalse string

Title for False radio button.
valueStyleNone string

Startcap/Endcap style "None".
valueStyleOpen string

Startcap/Endcap style "None".
valueStyleBlock string

Startcap/Endcap style "Filled Arrow".
valueStyleOval string

Startcap/Endcap style "Filles Ellipse".
valueStyleDiamond string

Startcap/Endcap style "Filled Diamond".
valueWidthMedium string

Startcap/Endcap width "medium".
valueWidthWide string

Startcap/Endcap width "wide".
valueWidthNarrow string

Startcap/Endcap width "narrow".
valueHeightMedium string

Startcap/Endcap height "medium".
valueHeightLong string

Startcap/Endcap height "long".
valueHeightShort string

Startcap/Endcap height "short".

(static, constant) LocalizationStrings

Represents strings for WebDocumentViewer localization.

Properties:
Name Type Description
annotations LocalizationAnnotationStrings

Contains a translation table for annotations specific strings.

(static, constant) MouseToolCursor :number

Specifies the cursor used with the mouse tool.

Properties:
Name Type Description
Auto number

Automatically determined by the browser.
Arrow number

An arrow pointer.
Crosshair number

A crosshair usually used in drawing a box.
Grab number

A grabbing cursor. Usually changes to gabbed while the mouse button is down.
Hand number

A hand with a finger pointing. Usually what the browser uses for clicking hyperlinks.
Move number

A crosshair pointer with arrowheads on the ends indicating movement.
ZoomIn number

A magnifying glass with a plus sign in it.
ZoomOut number

A magnifying glass with a minus sign in it.
Text number

A selection editing cursor.
VerticalText number

A vertical text editing cursor.
Wait number

A wait cursor.
Custom number

A custom CSS cursor string provided by the user.

(static, constant) FileUploadRejectReason :number

Represents a reason why a file has been rejected by WDV from upload.

Properties:
Name Type Description
None number

File is not rejected from upload
Size number

File is bigger than allowed by allowedmaxfilesize property.
Type number

File type or extensions is not allowed by allowedfiletypes property.
Name number

File with the same name has already added to the upload queue.

(static, constant) PageSelection :number

Specifies the page selection method.

Properties:
Name Type Description
TopLeft number

Selects the page under the top left corner of the viewer
MiddleLeft number

Selects the page under the middle left of the viewer
BottomLeft number

Selects the page under the bottom left corner of the viewer
Center number

Selects the page under the center location of viewer

(static, constant) ScrollArea :number

Specifies the size of the viewport area that triggers document scroll when text selection enters it.

Properties:
Name Type Description
None number

Text selection scrolling is disabled
Normal number

Normal scroll area. Around 10% of the corresponding viewport dimension
Large number

Normal scroll area. Around 20% of the corresponding viewport dimension

(static, constant) ScrollDirection :number

Specifies the direction of the scrolling.

Properties:
Name Type Description
Horizontal number

Scrolls horizontally.
Vertical number

Scrolls vertically.

(static, constant) SelectedItemsOrder :number

Defines the order in which selected thumbnails are ordered

Properties:
Name Type Description
ItemIndexOrder number

Items are sorted in their index order.
SelectedOrder number

Items are sorted in the order they were selected.

(static, constant) SelectionMode :number

Defines Web Document Thumbnailer selection mode.

Properties:
Name Type Description
SingleSelect number

Only one thumbnail can be selected
MultiSelect number

Multiple thumbnails can be selected

Type Definitions

BrowserMetadata

Represents the current browser metadata.

Properties:
Name Type Description
Explorer boolean

Indicates whether current browser is Internet Explorer.
Firefox boolean

Indicates whether current browser is Firefox.
Safari boolean

Indicates whether current browser is Safari.
Opera boolean

Indicates whether current browser is Opera.
Chrome boolean

Indicates whether current browser is Google Chrome.
Mobile Object

Represents mobile browser indicators.

Properties
Name Type Description
iOS boolean

Indicates that current device runs on iOS device.
Android boolean

Indicates that current device runs on Android device.
IEMobile boolean

Indicates that current device runs on mobile internet explorer.
Any function

Checks whether current platform is mobile device.