op.fullCollapse
| Syntax |
op.fullCollapse ()
|
| Params |
None required
|
| Action |
Collapses the entire outline to show only summit headings.
|
| Returns |
True unless the outline was fully collapsed before the verb was used, in which case it returns false.
|
| Examples |
In examples.Sample Outline 2, position the cursor anywhere you like and execute: op.fullCollapse ()
Notice that only the top summit is now visible. In the QuickScript window, execute op.fullExpand to return the window to its former state. |
| Errors |
An attempt to execute op.fullCollapse on a fully collapsed outline returns false but it is not an error.
|
| Notes |
op.fullCollapse works regardless of where the cursor is when it is invoked. After the execution of op.fullCollapse, the cursor is left on the top summit. You will notice that the display does not update in steps as you have sometimes seen with multiple-step outline rearrangement. This is because the Frontier script that carries out op.fullCollapse uses op.getDisplay and op.setDisplay to "freeze" the screen while all of the reorganization takes place.
|
| See Also |
op.fullExpand
|
