schHiAlign

schHiAlign(
s_justify 
[ g_windowId ]
)
=> t / nil

Description

Aligns the objects on the canvas. If the objects are already selected on the canvas, the pre-select mode is used; otherwise, the post-select mode is used for aligning the objects.

Arguments

s_justify	The direction in which the objects need to be aligned. Possible values are left, right, top, bottom, vertical, and horizontal.
g_windowId	The window indicating the cellview where you want to start aligning. If not specified, the current window is used. This is an optional argument.

Value Returned

t	Objects were aligned successfully.
nil	Objects could not be aligned.

Examples

schHiAlign( 'left )

schHiAlign( 'right hiGetCurrentWindow() )

schHiAlign( 'top window(3) )

Related Topics

Aligning

Return to top