getZoom()

Description

Gets the zoom factor for the current document editor.

Syntax

DocumentEditorObject.ui.getZoom();

Parameters

None

Return value

<float>

If it fails to get the zoom factor, it returns null.

Remarks

The zoom value is expressed as a percentage. The valid range is from 2 to 6500 percent (Value: 0.02 ~ 65.0); the default value is 100 percent (value: 1.0). A zoom value can be specified before or after a document is displayed. When the zoom value is changed, the displayed document will refresh automatically.

When an error occurs, check getErrorCode() or getErrorString() for error information.

Example

if (DCSObject)
{
    var documenteditor = DCSObject.getDocumentEditor("DocumentEditorContainer");  // Gets a specified document editor
    documenteditor.ui.getZoom();
}

See also

.ui.setZoom()