schHiSnapToGrid

schHiSnapToGrid(
[ g_windowId ]
)
=> t / nil

Description

Places the objects on the grid in the given window. If the objects are already selected, the Snap To Grid command runs in the pre-select mode. If no object is selected in the given window, the command runs in the post-select mode.

Arguments

g_windowId

The window indicating the cellview in which you want to snap the objects to grid. If not specified, the current window is used. This is an optional argument.

Value Returned

t	Objects have been snapped to grid successfully.
nil	Snapping was unsuccessful.

Examples

The following example can be used for the current window.

schHiSnapToGrid()

Use this example to specify the specific window where you want to snap the objects to a grid.

schHiSnapToGrid( hiGetCurrentWindow() ) 

Related Topics

Snapping to Grid

Return to top