API:PageWindowClearPageBreaks

UI Lua API · PageWindow functions
Version: WAR 1.4.8

Removes all windows from a PageWindow's list of page breaks.

PageWindowClearPageBreaks(pageWindowName)

Arguments

pageWindowName

string – Name of the PageWindow.

Returns

Nothing.

Details

• Empties the list that PageWindowAddPageBreak fills. The windows themselves are not changed.
• The pages are not laid out again; call PageWindowUpdatePages afterwards.
• The stock UI never calls this function.

Errors

• Error in function call 'PageWindowClearPageBreaks': Window %s does not exist
• Error in function call 'PageWindowClearPageBreaks': Window %s is not a PageWindow

Example

A minimal example built from the signature:

PageWindowClearPageBreaks( "MyBookPageWindow" )
PageWindowUpdatePages( "MyBookPageWindow" )

See also

• PageWindowAddPageBreak
• PageWindowRemovePageBreak
• PageWindowUpdatePages