save command

The save command can be used to save the current document.

Syntax

save [ prompt
     | visible
     | trim
     | noTrim
     | textLimit n
     | asHtml [ block
              | lineNumbers
              ] [...]
     ] [...]
     [ "filename" ]

Parameters

prompt Use the optional parameter prompt to prompt the user for the name of the file under which this document should be saved.
visible Use the optional parameter visible to indicate that only the visible elements should be saved.
trim Use the optional parameter trim to indicate that all of the document's lines should be trimmed of any trailing spaces.  If you do not specify trim or noTrim, the option is taken from the current setting of the current.save.trim parameter.
noTrim Use the optional parameter noTrim to ensure that the document's lines are not trimmed.  If you do not specify trim or noTrim, the option is taken from the current setting of the current.save.trim parameter.
textLimit n Use the optional parameter textLimit to indicate the maximum line length.  n must be an integer that is greater than or equal to zero.  If n is zero, no maximum line length will be enforced. If there are lines in the document that are longer than n, those lines will be truncated.  If you do not specify textLimit, the setting is taken from the current.save.textLimit parameter.
asHtml Use the optional parameter asHtml to save the file in a format suitable for display in an HTML browser.
block Use the optional parameter block to indicate that only the selected text should be saved.
lineNumbers Use the optional parameter lineNumbers to indicate that line numbers should be displayed to the left of each line.
filename The filename parameter may be used to specify the file name under which this document should be saved.  If no filename is specified, the document is saved under the name in the name setting;  when using the asHtml parameter, the extension ".html" is added.
When saving under a different file name, or using the asHtml parameter, the trim and textLimit settings are not used.

Status

The status parameter will be set to one of the following:  

null Indicates that the save was successful.
save.failed Indicates that the save was unsuccessful.
save.cancelled Indicates that the save was cancelled by the user.

Examples

save
save "test.java"

Editor commands and parameters


length parameter
name parameter
save.textLimit parameter
save.trim parameter
visible parameter
save action
saveAs action
Default editor commands