op.getSubOutline

Syntax op.getSubOutline (flindent=true)
Params flindent is an optional boolean parameter that determines whether the resulting string will be indented with tabs to match the outline structure. The default is true.
Action Obtains the text of the current heading and all its subheadings as a string.
Returns The text of the current heading and its subheadings as a string.
Examples In examples.Sample Outline 1, with the cursor positioned at the summit heading, execute:

op.getSubOutline ()

   » "Sample Outline 1, Summit 1\r"

In examples.Sample Outline 1, position the cursor on Summit 2 and execute the following:

op.getSubOutline ()

   » "Summit 2\r\tSubhead1, Summit 2\r\tSubhead 2, Summit 2\r\tSubhead 3, Summit 2\r\tSubhead 4, Summit2\r"

op.getSubOutline (flindent:false)

   » "Summit 2\rSubhead1, Summit 2\rSubhead 2, Summit 2\rSubhead 3, Summit 2\rSubhead 4, Summit2\r"
Note This kernel verb was added in Frontier 6.2a6.
See Also op.getLineText

Discuss