DefineGuide
DefineGuide [/W=winName ] newGuideName = {[guideName1, val [, guideName2 ]]} [, ...]
The DefineGuide operation creates or overwrites a user-defined guide line in the target or named window or subwindow. Guide lines help with the positioning of subwindows in a host window.
Parameters
newGuideName is the name for the newly created guide. When it is the name of an existing user-defined guide, the guide will be moved to the new position.
guideName1, guideName2, etc., must be the names of existing guides.
The meaning of val depends on the form of the command syntax. When using only one guide name, val is an offset relative to the guide. The directionality of val is to the right or below the guide for positive values. The units of measure are points except in panels where they are control panel units. When using two guide names, val is the fractional distance between the two guides.
Flags
| /W=winName | Affects guides in the named window or subwindow. When omitted, action will affect the active window or subwindow. | |
| When identifying a subwindow with winName, see Subwindow Syntax for details on forming the window hierarchy. | ||
Details
The names for the built-in guides are as defined in the following table:
| Guide Names | Left | Right | Top | Bottom |
|---|---|---|---|---|
| Subwindow Frame | FL | FR | FT | FB |
| Outer Graph Rectangle | GL | GR | GT | GB |
| Inner Plot Rectangle | PL | PR | PT | PB |
| Layout Margin Rectangle | ML | MR | MT | MB |
The frame guides apply to all window and subwindow types. The graph rectangle and plot rectangle guide types apply only to graph windows and subwindows. The layout margin rectangle guide types only apply to layout windows.
To delete a guide, use GuideName={}.