Sets up or finds a position mark.
Scope: File
Syntax
Parameters
Name |
A name identifying a named mark. The name is truncated if longer than 32 characters. The setting and comparison of this name is not case sensitive. | ||||||
Id |
An id number identifying an unnamed mark. | ||||||
set |
Assign the mark Name
or Id to
the specified position. If no position is specified, the
current position is used. If Name is already in use, it is reassigned to the current position. Specify Id only if that id already exists and you want to move a mark associated with a specific id number. Otherwise, issue the following command to create a new mark: mark set # The Editor will assign the next available id number to the new mark. You can get the id of the new mark by querying the markid parameter. |
||||||
find |
Set the current cursor position to the position recorded by the mark set Name or mark set #Id commands. The mark specified must exist in the current file. | ||||||
clear |
Cancel the specified mark. | ||||||
StartLine |
The starting line of the mark. This value must be an integer. | ||||||
StartColumn |
The starting column of the mark. This value must be an integer. | ||||||
EndLine |
The ending line of the mark. This value must be an integer . | ||||||
EndColumn |
The ending column of the mark. This value must be an integer. | ||||||
include |
Display lines associated with the
specified mark as follows:
|
||||||
exclude |
Display lines associated with the mark Name as follows:
|
||||||
setfont |
Display the specified mark in the character size and font specified by Font. If Font is not specified, the mark displays in the default editing window font. Font can be any valid font name as described in the help for the font parameter. |
Description
Marks function like a bookmark. Use the mark command to position new marks or relocate existing marks. Once set, you can use the mark command to quickly find marked locations in your document.
You can also use the mark command to highlight your marked locations, or to include or exclude marked locations from view.
When including or excluding marked areas for display, lines are displayed according to the following rules of precedence:
Examples
mark set undoref
The mark's name is undoref.
mark find undoref
mark set #
You can query the markid parameter to get the id number of the new mark,
mark find #276
mark setfont #276 M
set font M red/yellow mark setfont #276 M
mark setfont #276
mark include area1 on
mark exclude area1 on
API Return Codes
-1 |
The file is empty. |
-2 |
No name specified. |
-3 |
A parameter issued with the command was not valid. Check the command 's syntax requirements and then issue the command again using a valid parameter. |
-8 |
Insufficient storage to continue. |
1 |
Mark not found. The specified name is unknown. |
2 |
The specified name was already in use. It is now overridden. |
3 |
The mark refers to a line that has been deleted. |
![]()
font Parameter
mark Parameter
markexclude Parameter
markfont Parameter
markid Parameter
markinclude Parameter
show Parameter
shows Parameter
