query command
set command
Default editor commands
The editor window is fully programmable through the use of an extensive command, action, and parameter set. You can use commands and parameters to customize the editor window, search for or change text in your document, and perform many other functions.
Select a parameter from the list below to display complete reference information for that parameter. Parameters can be set and queried unless noted otherwise.
| Parameter Name | Description |
|---|---|
|
|
|
| actionArgument | Sets or queries the general purpose argument that is used by editor actions. |
| actionClass | Defines a user-defined action for the current view. |
| actionKey | Returns the primary key that is assigned to a specified action. Query only. |
| actionKeyText | Obtains a translated text string for the primary key that is assigned to the specified action. Query only. |
| actionRepeat | Query a numeric interpretation of the actionArgument parameter. This value is used by many actions as a repeat count. |
| actions | Lists all actions defined for the current view. Query only. |
| autoCheck | Sets or queries if the editor is implicitly completing document changes when the cursor is moved off a changed line. |
| baseProfile | Returns the base profile that was used the last time the updateProfile command was issued. Query only. |
| beep | Determines if a beep is emitted when the screenShow command is issued. |
| block.bottomElement | Returns the element number of the last element in the block selection. Query only. |
| block.bottomPosition | Returns the column number of the last column of the last element in the block selection. Query only. |
| block.defaultType | Sets or queries the default block type. |
| block.inView | Indicates if the block selection is in the current view. Query only. |
| block.text | Returns the text that is currently selected. Query only. |
| block.topElement | Returns the element number of the first element in the block selection. Query only. |
| block.topPosition | Returns the column number of the first column of the first element in the block selection. Query only. |
| block.type | Returns the current block type. Query only. |
| changes | Returns the number of completed undoable changes made since the last save. Query only. |
| class | Registers or deregister element classes for the current view. |
| classes | Returns a list of all of the element classes that are currently registered for the current view. Query only. |
| commandClass | Defines a user-defined command for the current view. |
| commandLine | Sets or queries the visibility of the command line. |
| commands | Returns a list all of the commands defined for the current view. Query only. |
| compare.ignoreAllBlanks | Determines whether differences in the number of blanks in a line are significant when comparing files with the compare command. |
| compare.ignoreCase | Determines whether differences in character case are significant when comparing files with the compare command. |
| compare.ignoreLeadingBlanks | Determines whether differences in the number of blanks at the start of a line are significant when comparing files with the compare command. |
| compare.ignoreTrailingBlanks | Determines whether differences in the number of blanks at the end of a line are significant when comparing files with the compare command. |
| current | Returns the current setting of a parameter. Query only. |
| currentKey | Returns the key that was last issued. Query only. |
| cursorRow | Sets or queries the physical row of the line containing the cursor. |
| default | Sets the default setting of a parameter. |
| defaultProfile | Sets or queries the name of a java properties file used to specify default settings for the editor. |
| dirty | Indicates if there is an uncomplete change in the current document. Query only. |
| displayPosition | Sets or queries the cursor's display column position in the current element. |
| documentId | Returns a unique integer that can be used to identify the document. Query only. |
| element | Returns the ordinal number of the current element. Query only. |
| elementClasses | Sets or queries classes for the current element. |
| elements | Returns the total number of elements in the current document. Query only. |
| emphasisLength | Sets or queries the number of characters that are emphasized. |
| excludedClasses | Sets or queries the element classes that should be excluded from the current view. |
| expandHide | Set or queries the visibility of the expand/hide area. |
| expandHideAreaWidth | Returns the width in pixels of the expand/hide area. Query only. |
| expandTabs | Sets or queries the state of tab character expansion. |
| expanded | Sets or queries the visibility of hidden elements between the current element and the next visible element. |
| fields | Sets or queries the current editing fields. |
| findText.asis | Sets or queries case sensitivity setting for the findText command. |
| findText.block | Sets or queries if find operations are restricted to selected text. |
| findText.columns | Sets or queries if find operations are restricted to selected columns of text. |
| findText.emphasis | Sets or queries whether found text is emphasized. |
| findText.endColumn | Sets or queries the end column used if find operations are restricted to a column range. |
| findText.findText | Sets or queries text to be found by the findText command. |
| findText.mark | Sets or queries whether found text is selected. |
| findText.regularExpression | Sets or queries the regular expression setting for the findText command. |
| findText.replaceText | Sets or queries replacement text used by the findText command. |
| findText.startColumn | Sets or queries the start column used if find operations are restricted to a column range. |
| findText.wrap | Sets or queries the wrap setting for the findText command. |
| font | Sets or queries the current font used to display text in the edit window. |
| forceAllVisible | Sets or queries the forced visibility of all of document elements. |
| forceVisible | Sets or queries the forced visibility of the current element. |
| formatLine | Sets or queries the visibility of the format line. |
| formatLineText | Sets or queries the text displayed in the format line. |
| headerMark | Determine if the current element is a header element for an excluded mark. Query only. |
| help.configuration | Sets or queries the configuration file used by the help command. |
| help.homepage | Sets or queries the default help page that is displayed when no other help is available for a help request. |
| help.location | Sets or queries the location of properties files used to map help requests to the appropriate html pages. |
| hex | Returns the hexadecimal value of the character at the current cursor location. Query only. |
| hideSequenceNumbers | Sets or queries whether document sequence numbers should be visible or not. |
| includedClasses | Sets or queries the element classes that should be included in the current view. |
| inPrefix | Sets or queries the cursor location in the prefix or text area. |
| insertMode | Sets or queries the current insertion mode. |
| install | Returns the installation setting of a parameter. Query only. |
| installProfile | Sets or queries the name of a java properties file used to specify installation settings for the editor. |
| keyAction | Sets or queries the action assignment for a specified key. |
| keys | Lists all keys to which actions have been assigned. Query only. |
| length | Returns the length of the current element. Query only. |
| line | Returns the line number of the current element. Query only. |
| lines | Returns the total number of lines in the current document. Query only. |
| maintainSequenceNumbers | Sets or queries whether the editor is maintaining the current document's sequence numbers. |
| mark | Sets, queries, or removes a named mark. |
| markExcluded | Sets or queries the excluded attribute of a mark. |
| markExcludedHeader | Sets or queries whether a specified mark should have a header element when it is excluded. |
| markHighlight | Sets or queries whether a specified mark should be highlighted. |
| markId | Returns the id number of a specified mark. Query only. |
| markIncluded | Sets or queries the included attribute of a mark. |
| markProtect | Sets or queries the protect attribute of a mark. |
| markStyle | Sets or queries the style character associated with a mark. |
| messageLine | Sets or queries the visibility of the message line. |
| messageText | Sets or queries text displayed in the message line. |
| mouseAction | Sets or queries the action assignment for a specified mouse event. |
| mouseEvents | Lists all mouse events to which actions have been assigned. Query only. |
| name | Sets or queries the current document's file name. |
| palette | Returns the color palette in use the last time the updateProfile command was issued. Query only. |
| parser | Returns the name of the parser used by the current view. Query only. |
| pixelPosition | Returns the pixel offset of the current cursor position. Query only. |
| popup | Sets or queries the contents of the pop-up menu. |
| position | Sets or queries the cursor column position on the current element. |
| prefixArea | Sets or queries the visibility of the prefix area. |
| prefixAreaText | Sets or queries the text that is displayed in the prefix area. |
| prefixAreaWidth | Returns the width in pixels of the prefix area. Query only. |
| prefixPosition | Sets or queries the cursor column position in the prefix area. |
| prefixProtect | Sets or queries if the cursor can be moved into the prefix area. |
| prefixText | Sets or queries the current element's prefix text. |
| print.bottomMargin | Sets or queries the bottom margin used by the print command. |
| print.font | Sets or queries the font used by the print command. |
| print.leftMargin | Sets or queries the left margin used by the print command. |
| print.lineNumbers | Sets or queries if the print command prints line numbers at the start of each line. |
| print.rightMargin | Sets or queries the right margin used by the print command. |
| print.tokenized | Sets or queries if the print command prints tokenized attributes displayed by the parser. |
| print.topMargin | Sets or queries the top margin used by the print command. |
| readonly | Sets or queries if the document can be edited with the current view. |
| recording | Sets or queries if the editor is recording document changes. |
| rowHeight | Returns the height in pixels of a text row. Query only. |
| rows | Returns the number of rows of text that can be displayed in the text window. Query only. |
| save.textLimit | Sets or queries the maximum line length used by the save command. |
| save.trim | Sets or queries if the save command should trim trailing blanks from all of the lines in the document. |
| scroll | Sets or queries the number of pixels that the current view is scrolled to the right. |
| sequenceDefaultText | Sets or queries the sequence-numbers default text part. |
| sequenceNumber | Sets or queries the current element's sequence number. |
| sequenceNumbers | Sets or queries the starting column and width of the sequence numbers. |
| sequenceNumbersFormat | Sets or queries the format string used to display the sequence numbers area. |
| sequenceText | Sets or queries the current element's sequence-numbers text part. |
| shiftInCharacter | Sets or queries the character used to display emulated SI control characters. |
| shiftOutCharacter | Sets or queries the character used to display emulated SO control characters. |
| show | Determine if the current view's current element is a show element. Query only. |
| showSosi | Sets or queries if the editor displays emulated SO/SI control characters. |
| sourceEncoding | Sets or queries the character encoding of the file on its originating platform. |
| status | Sets or queries the command status. |
| statusLine | Sets or queries the visibility of the status line. |
| style | Sets or queries style characters that used to display the text on the current element. |
| styleAttributes | Sets or queries style attributes for a style character or for one of the built in styles. |
| tabs | Set or queries tab stops used by the nextTabStop and prevTabStop actions. |
| text | Sets or queries the current element's text. |
| textAreaWidth | Returns the width in pixels of the text area. Query only. |
| textWidth | Returns the width in pixels of the current element's text. |
| topExpanded | Sets or queries the visibility of hidden elements between the top of the document and the first visible element. |
| updateProfile.baseProfile | Sets or queries the base profile that will be used by the updateProfile command. |
| updateProfile.extensions | Lists all of file extensions that are associated with parsers. Query only. |
| updateProfile.noParser | Sets or queries if the updateProfile command should set a parser. |
| updateProfile.palette | Sets or queries the color palette that will be used by the updateProfile command. |
| updateProfile.paletteAttributes | Sets or queries style attributes used for a specified style and palette when the updateProfile command is issued. |
| updateProfile.palettes | Lists all color palettes available to the updateProfile command. Query only. |
| updateProfile.parser | Sets or queries the parser used by the updateProfile command. |
| updateProfile.parserAssociation | Sets or queries the parser associated with a file extension. |
| updateProfile.parserClass | Sets or queries the class name for a parser. |
| updateProfile.parsers | Lists all parsers that are available to the updateProfile command. Query only. |
| updateProfile.userActions | Sets or queries user actions used by the updateProfile command. |
| updateProfile.userCommands | Sets or queries user commands used by the updateProfile command. |
| updateProfile.userKeyActions | Sets or queries user key actions used by the updateProfile command. |
| updateProfile.userMouseActions | Sets or queries user mouse actions used by the updateProfile command. |
| updateProfile.userProfile | Sets or queries the user profile used by the updateProfile command. |
| useSourceColumns | Sets or queries whether the editor uses column characteristics of the file in its source character encoding. |
| version | Returns the version of the editor. Query only. |
| visible | Determine if the current view's current element is visible in the current view. Query only. |
query command
set command
Default editor commands
