op.hoist

Syntax op.hoist ()
Params None required
Action Causes all immediate subheads of the current heading to appear to become summits in the outline, changing the display to show only those subheads and their subheads. This has the practical effect of limiting all editing to those subheads.
Returns True unless current heading has no subheads, in which case it returns false.
Examples In examples.Sample Outline 2, place the bar cursor on "Subhead 1.1.1" and then execute:
op.hoist ()


   » true

The display changes and you see only "Subhead 1.1.1.1" and "Subhead 1.1.1.1.1."

Repeat Example 1, but after you have executed the op.hoist verb, move the bar cursor to the second line of the abbreviated outline and then enter the following line in the QuickScript window:
op.firstSummit ()


   » true

Notice that the bar cursor is now positioned over the first heading ("Subhead 1.1.1.1"). When you hoist a heading's subheads, the first of its subheads becomes the first summit in the outline from Frontier's viewpoint. The original first summit has not,
of course, been deleted, but for the moment, this is the first summit heading in the outline.

Errors Attempting to hoist a heading which has no subheads results in Frontier returning false, but it is not an error.
Notes Up to five hoists are supported within a single outline. Attempting to do additional hoists will yield a return value of false.
See Also op.deHoist

op.deHoistAll

Discuss