Parameters Summary

The Source view and the Editor window are fully programmable through the use of an extensive Editor command and parameter set. You can use commands and parameters to customize the Source view and the Editor window, search for or change text in your document, or perform many other functions.

Select the appropriate parameter from the list below to display complete description (including an example).

Note: All parameters are valid when working in the Source view or the Editor window, unless noted otherwise in their descriptions.

 

Parameter Name Description

accelerator  Sets the accelerator for a given menu item 
action  Attaches an action to a logical key. 
actionbar  Modifies the contents of the Editor window menu-bar and pull-down menus.
actionbarid Returns the id of a menu-bar pull-down item. (Query only)
actionbarlist Lists user-defined pull-down menus. (Query only)
actionlist Lists the logical keys to which commands have been assigned. (Query only)
actionprefix  Attaches a prefix action to a logical key. 
actionprefixlist Used to get a list of all prefix commands defined for the current document. (Query only)
actions  Enables action keys. 
alarm  Sounds the alarm on next screen refresh. 
autochanges  Sets the number of changes since last save or autosave.
autocheck  Enables automatic checkpointing.
autocount  Sets the number of changes required before autosave.
autoname  Sets the name for the autosave file.
autonext Gives the time in seconds before next autosave. (Query only)
autoparse  Resumes parsing.
autoprefix  Maintains the prefix data while a file is being edited.
autosymbols Causes symbol substitution to occur automatically.
autotime  Sets the time in minutes before the next autosave.
background  Sets the background character.
basefont  Sets the default font for a line (Query only)
beep  Sets the alarm.
beeplength  Sets the duration for the alarm.
beeptone  Sets the frequency for the alarm. 
blockdefaulttype  Changes the block type favoured by the block selection commands.
blockdoc Gives the number of the file that contains the marked block. (Query only)
blockend Gives end position of block. (Query only)
blocklength Gives the number of characters or lines in a block. (Query only)
blockshow  Sets the way a block is shown on the screen.
blockstart Gives the start position of a block. (Query only)
blocktype Gives the type of block currently set. (Query only)
blockview Gives the number of the view that contains the marked block. (Query only)
browse  Prevents overwritting of a file.
changes  Sets the number of changes made to the file.
class  Sets the class to which the current line belongs.
classes  Sets the number and names of classes for the current file.
color  Sets RGB color values for the Editor.
commandcheck  Associates a command with the issuing of a command with the Issue edit command dialog.
commandline  Displays an Editor command entry area at the bottom of the Source view or the Editor window. 
content  Sets the data content of a line.
creating  Exits when creating a line.
cursorcol  Sets the window column containing the cursor.
cursorpos  Sets the column in a line containing the cursor.
cursorrow  Sets the window row containing the cursor.
default  Sets a default value for a parameter.
deleting  Associates a command with the deletion of a line.
directory  Changes the directory used by the Editor processes. 
dirty Gives the setting of the dirty flag. (Query only)
dispdepth  Sets the depth of the Source view or the Editor window.
dispwidth  Sets the width of the Source view or the Editor window.
doccontent  Stores the result of the last text import operation in the file 
doclist Lists current file numbers. (Query only)
docnum Gives the unique number identifying a file. (Query only)
doctype  Sets the file type; used for xxx.LXS save macro 
documents Gives the number of files currently open. (Query only)
docvar  Sets the value of a variable global to all file views of the current document 
docvarlist Lists names of variables global to all file views of the current document. (Query only)
drive Sets the drive used by the Editor processes.
element  Gives the number of current line.
elementchangeexit  Specifies an Editor command to be performed whenever the current element changes.
elements  Gives the number of lines in the current file.
emphasis  Creates an emphasis box, starting from the current cursor position and surrounding the number of characters given by the parameter value. 
environment Obtains information about the system environment. (Query only)
exclude  Sets the classes to exclude from the display.
expandtabs  Expands tab characters to spaces for display purposes.
filedialog  Sets the default settings used by the Open, Get & Save As dialogs.
fill  Sets the fill character.
filter  Sets options for the filter operation.
find  Specifies default options for both the find command and the Editor - find and replace window. 
findhistory  Sets the number of search occurrences to remember.
flow Controls the automatic flowing of elements (Query only)
focus  Sets the focus lines for the Editor.
font  Sets the attributes for a given font.
fontlist Lists the symbolic fonts that are currently set (Query only)
fonts  Sets the character font for the current line.
fontsize  Sets the character size for the current line.
format  Specifies format controls for the current element.
formatter  Enables line wrapping.
formwidth  Sets the formatting width of the current document.
fullparse  Defines the parser to be used for a full parse.
global  Sets the value of a variable global to all documents in the Editor.
globallist Lists names of variables global to all documents in the Editor. (Query only)
group  Specifies the conditions by which a menu item will be enabled or disabled (Query only)
help  Specifies the help information associated with a user-defined menu item (Query only)
hex Returns the hexadecimal ASCII code of the character at the current cursor position. (Query only)
highlight  Sets the classes to be highlighted.
horizscroll  Sets the increment for the horizontal scroll.
hoverhelp  Enable or disable hoverhelp for the toolbar buttons.
idletime  Sets the idle seconds required before autosave.
impmacro  Processes unknown commands as macros.
impset  Processes unknown commands as set or query commands.
include  Specifies the list of classes for which member lines are to be displayed in a file view.
indent  Sets the indent factor.
inserting  Sets the cursor to either insert or replace mode.
key  Maps a logical key to a physical key.
keylist Lists current remapped keys. (Query only)
lastfind  Sets the default parameter string for the find command.
lastkey Displays the last key obtained by keyread or lineread. (Query only)
lastline Displays the last line obtained by lineread. (Query only)
length Displays the length of the current line. (Query only)
level Specifies the level of the current element. (Query only)
limiterror  Specifies how a text length limit error is handled.
linebreak  Sets the mode for ending lines in a file.
linenumber Gives the line number of the current line. (Query only)
lineread  Sets the title or prompt for the next lineread.
lines  Returns the number of non-show lines in the file. (Query only)
linked Lists external commands linked to the Editor. (Query only)
list Lists details about items such as files, keys, and views. (Query only)
loadedmacros Lists the preloaded REXX macros. (Query only)
mark Returns position of specified mark within a line. (Query only)
markdeleteexit  Defines the mark removal exit routine for the current file.
markdirtyexit  Defines the mark changed exit routine for the current file.
markexclude Gives the exclude setting of a mark. (Query only)
markfont Gives the font setting of a mark. (Query only)
markid Gives the id value of a mark. (Query only)
markinclude Gives the include setting of a mark. (Query only)
marklist Displays a list of mark names set in the current file. (Query only)
markrange Returns starting and ending positions of the specified mark. (Query only)
menuactive  Enables or disables a menu-bar item, pull-down menu choice, or pop-up menu item. 
menucheck  Sets or unsets the checkmark for a menu choice. 
messageline  Controls the display of messages.
messages  Enables the display of messages.
modes Displays the character modes for the current line. (Query only)
name  Sets the file name of a file view.
noblanks  Saves the file without trailing blanks.
nosave  Enables save to be on.
oldline  Set the OLDLINE value for the current line.
overfont  Defines the font for overlay lines.
overhang  Sets the overhang for formatting flowed lines.
overlay  Sets the overlay text for the Editor window.
pad  Sets the pad character.
parent  Sets the parent window for the Editor window.
parser  Defines command for live parsing.
pending  Sets line pending live parsing.
popupinit  Specifies a callback routine to be called when the pop-up menu is raised.
popuplink  Add menu items already defined on the menu bar to the pop-up menu.
popupmenu  Sets the contents of the pop-up menu and associated pull-down menu items.
popupmenuid Queries the menu id of a pop-up menu item. (Query only)
popupmenulist Lists user-defined pop-up menus. (Query only)
position  Sets the cursor position in the line.
prefix  Specifies the value of the prefix data associated with the current line 
prefixdefaulttext  Sets the text to be used for the text part of the prefix data when lines are inserted or changed and the autoprefix parameter is on.
prefixdisplayformat  Specifies a format string used to display the prefix area.
prefixentry  Sets the text in the prefix entry field of the current line. 
prefixformat  Defines the size and type of prefix data for the current file.
prefixprotect  Enables or disables text entry in a displayed prefix data area. 
prefixshow  Controls the display of the prefix area in the current edit view.
profiles  Sets the profiles to be used.
protect  Sets the classes to protect from overtyping.
rawtext Displays the data content of a line without symbol substitution. (Query only)
readonly Protects view from changes.
recall  Sets command recall options.
recentfilecmd  Specifies the Editor command processed when a file name is selected from the recently-accessed file list.
recentmenushow  Specifies how the recently-accessed file list is displayed.
recentpathshow  Enables or disables the display of complete file paths in the recently-accessed file list.
recentsize  Specifies how many file names are maintained in the recently-accessed file list.
recording  Enables recording of changes made to a document. 
resolve Displays a message describing the command to be run. (Query only)
rexx  Enables the use of REXX.
ring  Set the default ring assignment mode for new views. 
ringlist Queries ring numbers active in the Editor. (Query only)
ringnum  Specifies the ring number to which to move the current view. 
rings Queries the number of rings active in the Editor. (Query only)
ringselector  Sets the display state of the ring selector. 
ruler  Controls the display of the format line in the edit window.
rulertext  Specifies the content of the format line.
screen Gives the number of rows and columns and pels in the screen. (Query only)
seconds Gives the number of elapsed seconds since the start of the Editor session. (Query only)
show  Turns a line into a show line.
showcurrent  Enables display of the current line.
shows  Enables display of show lines.
sidescroll  Sets the offset of the leftmost visible column.
space  Sets the space character.
spill  Sets the formatting width for elements to spill over to a new line.
split  Sets the default orientation of split-window borders in the Editor window only.
statusline  Controls the display of the status line.
submenuinit  Specifies a callback routine to be called when a specified menu-bar item or sub-item is selected.
symbol  Assigns a special character to a symbol.
symbollist Returns list of current symbols. (Query only)
synonym  Sets the value of a synonym.
synonymlist Lists current synonyms. (Query only)
tabcursorpos  Sets the column, allowing for expanded tab characters, in a line containing the cursor.
tabs  Sets tab positions.
textlimit  Sets the byte limit on the size of lines.
timeout  Number of minutes before the Editor closes down after the last Editor window is closed. 
toolbar  Creates new tool-bar items.
toolbarlist Lists items in the toolbar menu. (Query only)
toolshow  Displays or hides the tool-bar.
toolview  Determines whether text, graphics, or both are displayed on a tool-bar button.
trigpos  Sets the position used after trigger processing.
unprotect  Unprotects a line with listed classes. 
version Identifies the Editor version. (Query only)
view Displays the name of a specific view. (Query only)
viewlist Lists current view numbers. (Query only)
viewname  Sets the name of the current view. 
viewnum Displays the number identifying the view. (Query only)
window  Changes the visibility of the current Source view or Editor window.
windowid Displays a unique number which identifies a window to the operating system. (Query only)
windowpos  Sets the position and size of a view (window). 
windowshow  Sets the prerequisites for displaying a window.
wordchars  Defines the valid characters for an Editor word.
wrap  Enables or disables wrapping of elements for the display.


Commands Summary