SetLayoutScale()

Summary

Sets the scale of a layout window.

Syntax

SetLayoutScale(string layout_name, real ratio)

Argument Contents
layout_name The name of the layout, or null for the current layout
ratio The ratio of screen units to units on the output page

Notes

  • If the ratio is 1.0, one inch on the screen will represent one inch on the output page.

Example

// This layout window is shown at half of the actual size
SetLayoutScale(null, 0.50)
// This layout window is shown at twice the actual size
SetLayoutScale("My Layout", 2.00)

Error Codes

Error Type Meaning
Error The ratio is less than or equal to zero
NotFound There is no layout of the given name, or layout_name is null and there is no layout window

See Also

Function Summary
GetLayoutScale() Gets the scale of a layout window