allowUserZoom Method

Gets or sets whether the user can scale the display of the component using the Ctrl key and the mouse wheel.

Syntax

var instance = new GcSpread.Sheets.Spread(host, options);
var returnValue; // Type: Object
returnValue = instance.allowUserZoom(value);

function allowUserZoom( 
   value : boolean
) : Object;

value: Whether to zoom the display by scrolling the mouse wheel while pressing the Ctrl key.

true if the user can zoom the display by scrolling the mouse wheel while pressing the Ctrl key; otherwise, false.

Example

This example zooms the sheet.

spread.allowUserZoom = false;
sheet.zoom(3);

This example prevents the user from zooming the sheet, but changes the zoom setting in code.

spread.allowUserZoom = false;
sheet.zoom(3);

Remarks

The default value is true.