RemoveLayoutObjects
RemoveLayoutObjects [/PAGE=page /W=winName /Z] objectSpec [, objectSpec ]
The RemoveLayoutObjects operation removes the specified object or objects from the top page layout, or from the layout specified by the /W flag. It targets the active page or the page specified by the /PAGE flag.
Unlike the RemoveFromLayout operation, RemoveLayoutObjects can be used in user-defined functions. Therefore, RemoveLayoutObjects should be used in new programming instead of RemoveFromLayout.
Parameters
objectSpec is either an object name (e.g., Graph0) or an objectName with an instance (e.g., Graph0#1). An instance is needed only if the same object appears in the layout more than one time. Graph0 is equivalent to Graph0#0 and Graph0#1 refers to the second instance of Graph0 in the layout.
Flags
| /PAGE=page | Removes the object from the specified page. | |
| Page numbers start from 1. To target to the active page, omit /PAGE or use page=0. | ||
| The /PAGE flag was added in Igor Pro 7.00. | ||
| /W=winName | winName is the name of the page layout window from which the object is to be removed. If /W is omitted or if winName is $"", the top page layout is used. | |
| /Z | No error reporting if the specified layout object does not exist. | |
See Also
NewLayout, AppendLayoutObject, ModifyLayout, LayoutPageAction