GetLayoutSaveFlag()

Summary

Determines whether a layout has changed since it was last saved to a file.

 

Syntax

flag = GetLayoutSaveFlag(string layout_name)

 

Argument	Contents
layout_name	The name of the layout, or null for the current layout

 

Returns

The string "True" if the layout has changed and needs to be saved; the string "False" if it has not changed since it was last loaded from or saved to a file.

 

Notes

• The save flag is set automatically whenever the layout is changed, but the user is not prompted automatically when the layout is closed. Use GetLayoutSaveFlag() to determine whether or not to prompt the user about saving the layout.

• GetLayoutSaveFlag() does not track whether the printer has been changed since the last save.

Example

if GetLayoutSaveFlag() = "False" then goto ok_to_quit

// Prompt the user to save the contents before quitting...

 

Error Codes

Error Type	Meaning
NotFound	The specified layout window does not exist

 

See Also

Function	Summary
GetMapSaveFlag()	Determines whether a map has changed since it was last saved to a file
GetEditorSaveFlag()	Determines whether an editor has changed since it was last saved to a file
SaveLayout()	Saves a layout to a file
OpenLayout()	Creates a layout from a file