op.deHoist
| Syntax |
op.deHoist ()
|
| Params |
None required
|
| Action |
Reverses the effect of the last op.hoist command, returning the most recently hoisted heading to the display along with all of its subheads.
|
| Returns |
True unless there are no hoist operations to be reversed, in which case it returns false.
|
| Examples |
In examples.Sample Outline 2, position the bar cursor on "Subhead 1.1." Now execute the following line three times: op.hoist ()
Notice the outline window's display. Now execute:
As you can see, the last op.hoist operation, which made "Subhead 1.1.1.1.1" the only heading in the window, is undone. Execute the same line again:
The second hoist operation has now been undone. One last execution of the line:
and the outline should now be back to its original display. Now execute:
|
| Errors |
Attempting to de-hoist a heading when no hoist operation is pending returns a result of false, but it is not an error.
|
| Notes |
If you have multiple hoist operations in the queue, you can reverse all of them with a single call to op.deHoistAll. op.deHoist undoes hoists in the reverse order in which they were carried out.
|
| See Also |
op.hoist
|
