GUI Command Methods

GUI Command Methods

The GUI command methods correspond to the node in the editor tree. The editor tree is displayed in, for example, the section in the window for a button object in the Application Builder.


Name	Syntax	Description
clearAllMeshes	clearAllMeshes()	Clears all meshes.
clearAllSolutions	clearAllSolutions()	Clears all solutions.
clearSelection	clearSelection(String graphics) clearSelection(FormObject graphics)	Clears the selection in the given graphics object.
exit	exit()	Exits the application.
fileOpen	fileOpen(String name)	Opens a file with the associated program on the client.
fileSaveAs	boolean fileSaveAs(String file)	Downloads a file to the client. See also the section “Example code”. The method returns a boolean that indicates if the operation was successful or not.
printGraphics	printGraphics(String graphicsName) printGraphics(FormObject graphics)	Prints the given graphics object.
saveApplication	saveApplication(boolean confirm)	Saves the application. The boolean argument determines if the user is prompted with a confirmation dialog before saving.
saveApplicationAs	boolean saveApplication()	Saves the application under a different name. If the return value is false then the user canceled the operation and the application was not saved.
saveApplicationOnServer	saveApplicationOnServer(boolean confirm)	Saves the application on server. The boolean argument determines if the user is prompted with a confirmation dialog before saving.
saveApplicationOnServerAs	boolean saveApplicationOnServerAs()	Saves the application on server under a different name. (Or as an MPH file.) If the return value is false then the user canceled the operation and the application was not saved.
scenelight	sceneLight(String graphicsName) sceneLight(FormObject graphics)	Toggles scene light in the given graphics object.
selectAll	selectAll(String graphics) selectAll(FormObject graphics)	Sets the selection to all entities in the given graphics object.
transparency	transparency(String graphicsName) transparency(FormObject graphics)	Toggles transparency in the given graphics object.
zoomExtents	zoomExtents(String graphicsName) zoomExtents(FormObject graphics)	Makes the entire model visible within the extent of the given graphics object.

For examples of how to use fileSaveAs, see the Introduction to Application Builder. This method is frequently needed for saving files in general.

You can create an application that saves and exits automatically by running the following lines of code, for example, after solving:

saveModel(model,"C:\\COMSOL\\file.mph");

saveModel(model, "common:///file.mph");

This is useful in a COMSOL Server setting since using exit() in this way will free up any licenses that are checked out.