GetLayoutOptions()
Summary
Get the current option settings for a layout.
Syntax
options = GetLayoutOptions(string layout)
| Argument | Contents |
|---|---|
| Layout | The name of the layout, or null for the current layout |
Returns
The following list of options pairs (not in the order listed):
| Option | Type | Contents |
|---|---|---|
| Cut Lines | Boolean | Whether to display page cut lines and page numbers on multiple page layouts |
| Grid Display | Boolean | Whether to display the grid |
| Grid Settings | Array | {string unit, integer resolution divisor, integer minor interval, integer major interval}. See notes below |
| Grid Snap | Boolean | Whether to snap new annotations to the grid |
| Rulers | Boolean | Whether to display rulers |
| Title | String | The layout title |
Notes
-
The grid resolution divisor indicates what division of the units is used as the snap grid resolution. For example, 8 would indicate 1/8 of a unit.
-
The grid intervals specify the number of grid resolution units between each light (minor) or bold (major) display grid tick. For example {"inch", 8, 2, 4} would specify a grid with light ticks every 1/4 inch and a bold tick every 1/2 inch.
Example
// Before running the example, open any layout.
options = GetLayoutOptions()
ShowArray(options)Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The specified layout does not exist |
See Also
| Function | Summary |
|---|---|
| CreateLayout() | Create a new layout window |
| OpenLayout() | Creates a layout from a file |
| SetLayoutOptions() | Changes the options for a layout |