Function
|
Prototype and Description
|
abs()
|
int abs(int n)
Returns the absolute value of 'n'.
|
acos()
|
float acos(float x)
Returns the arc cosine of 'x' in radians. 'x' must be in the range -1 to 1.
|
ActiveClipboard
|
int ActiveClipboard
Returns the number of the active clipboard. The Windows Clipboard is number 0; private clipboards are numbered 1 to 8.
|
ActiveSpellChecking()
|
int ActiveSpellCheck(int mode)
Enables or disables Active Spell Checking according to 'mode'.
|
AlignCenter
|
Issues the Align Center command
|
AlignLeft
|
Issues the Align Left command
|
AlignRight
|
Issues the Align Right command
|
AlignSmooth
|
Issues the Align Smooth command
|
ANSIChart
|
Issues the ANSI Chart command
|
ANSItoOEM
|
Issues the ANSI to OEM command
|
Append
|
Append
Append the selected text to the current clipboard. If no text is selected, the current line is appended to the clipboard.
|
AppendToClipboard()
|
int AppendToClipboard(string str, int n)
Appends string 'str' to Clipboard 'n'. Returns the total length of the text on the clipboard, or -1 for error. The Windows Clipboard is number 0; private clipboards are numbered 1 to 8.
See also PutClipboardText().
|
ArrangeIcons
|
Issues the Arrange Icons command
|
ASCIItoEBCDIC
|
Issues the ASCII to EBCDIC command
|
asin()
|
float asin(float x)
Returns the arc sine of 'x' in radians. 'x' must be in the range -1 to 1.
|
atan()
|
float atan(float x)
Returns the arc tangent of 'x' in radians.
|
atof()
|
float atof(string str)
Returns the floating point value of the number described by string 'str'.
|
atoi()
|
int atoi(string str)
Returns the integer value of the decimal number described by string 'str'.
|
AutoNumber
|
Issues the Auto-Number command
|
Backspace
|
Issues the Backspace command
|
Backtab
|
Issues the Backtab command
|
Beep()
|
Beep(int freq, int duration)
Makes a sound through the PC speaker using the supplied values for frequency and duration. Frequency is in Hz and duration is in milliseconds. Beep(1000, 300) produces a standard beep.
|
BookmarkManager
|
Issues the Bookmark Manager command
|
BottomOfPage
|
Issues the Bottom of Page command
|
BringUserListsToTop
|
Issues the Bring User Lists to Top command
|
ByteCount
|
int ByteCount
Returns the number of characters in the current file.
|
Calculator
|
Issues the Calculator command
|
Calendar
|
Issues the Calendar command
|
Cascade
|
Issues the Cascade command
|
CascadeHorizontal
|
Issues the Cascade Horizontal command
|
CascadeVertical
|
Issues the Cascade Vertical command
|
CaseInvert
|
Issues the Case Invert command
|
CaseLower
|
Issues the Case Lower command
|
CaseSentences
|
Issues the Case Sentences command
|
CaseTitle
|
Issues the Case Title command
|
CaseUpper
|
Issues the Case Upper command
|
CaseWords
|
Issues the Case Words command
|
ceil()
|
float ceil(float x)
Returns (as a float) the smallest integer not less than 'x'. Example: ceil(1.5) returns 2.0.
|
ChangeString()
|
int ChangeString(string str1, str2, str3)
Searches 'str1' and changes all occurrences of 'str2' to the string 'str3'. Returns the number of changes made or -1 for error. The search is case sensitive. Regular expressions are not recognized. If 'str3' is an empty string, the effect will be to delete all occurrences of 'str2' within 'str1'.
|
ChangeStringi()
|
int ChangeStringi(string str1, str2, str3)
Searches 'str1' and changes all occurrences of 'str2' to the string 'str3'. Returns the number of changes made or -1 for error. The search is case insensitive. Regular expressions are not recognized. If 'str3' is an empty string, the effect will be to delete all occurrences of 'str2' within 'str1'.
|
ChangeStringRE()
|
int ChangeStringRE(string str1, str2, str3)
Searches 'str1' and changes all instances matching 'str2' to the string 'str3'. Returns the number of changes made or -1 for error. The search is case sensitive. Regular expressions ARE recognized in 'str2'. If 'str3' is an empty string, the effect will be to delete all occurrences of 'str2' within 'str1'.
|
ChangeStringREi()
|
int ChangeStringREi(string str1, str2, str3)
Searches 'str1' and changes all instances matching 'str2' to the string 'str3'. Returns the number of changes made or -1 for error. The search is case insensitive. Regular expressions ARE recognized in 'str2'. If 'str3' is an empty string, the effect will be to delete all occurrences of 'str2' within 'str1'.
|
CheckWord
|
Issues the Check Word command
|
ClearAllBookmarks
|
Issues the Clear All Bookmarks command
|
ClearAllClipboards
|
Issues the Clear All Clipboards command
|
ClearClipboard()
|
ClearClipboard(int n)
Clears the content of Clipboard 'n'. The Windows Clipboard is number 0; private clipboards are numbered 1 to 8.
|
ClearRecentFilesList
|
Issues the Clear Recent Files List command
|
ClearRecentProjectsList
|
Issues the Clear Recent Projects List command
|
ClearUndo
|
Issues the Clear Undo command
|
Close
|
Issues the Close command
|
CloseAll
|
Issues the Close All command
|
CloseAllButActive
|
Issues the Close All But Active command
|
ColorChart
|
Issues the HTML Color Chart command
|
Column
|
int Column
Returns the current column number in the current file or -1 for error.
|
Comment
|
Issues the Comment command
|
ConfigureColors
|
Issues the Configure Colors command
|
ConfigureKeyboard
|
Issues the Configure Keyboard command
|
ConfigurePreferences
|
Issues the Configure Preferences command
|
ConfigurePrinterFont
|
Issues the Configure Printer Font command
|
ConfigureScreenFont
|
Issues the Configure Screen Font command
|
ConfigureSyntaxHighlighting
|
Issues the Configure Syntax Highlighting command
|
ConfigureTemplates
|
Issues the Configure Templates command
|
ConfigureTextHighlighting
|
Issues the Configure Text Highlighting command
|
ConfigureToolbar
|
Issues the Configure Toolbar command
|
ConfigureUserTools
|
Issues the Configure User Tools command
|
Copy
|
Copy
Copy the selected text to the current clipboard. If text is not selected, the current line is copied to the clipboard.
|
CopyFile()
|
int CopyFile(string oldname, string newname)
Copies the file 'oldname' to the file 'newname', overwriting the output file if it already exists. Returns 1 for success or -1 for error.
|
CopyFilename
|
Issues the Copy Filename command
|
cos()
|
float cos(float x)
Returns the cosine of 'x'. The angle 'x' must be in radians.
|
cosh()
|
float cosh(float x)
Returns the hyperbolic cosine of 'x'. The angle 'x' must be in radians.
|
CreateDirectory()
|
int CreateDirectory(string dir)
Creates a new directory according to the fully qualified filepath in 'dir'. Returns 1 for success or -1 for error.
|
Cut
|
Cut
Cut the selected text to the current clipboard. If text is not selected, the current line is cut to the clipboard.
|
Cut Append
|
CutAppend
Cut the selected text and append it to the current clipboard. If text is not selected, the current line is cut and appended to the clipboard.
|
Decrement()
|
int Decrement(int n)
Subtracts 'n' from the value at the text cursor and places the result in the text file. Returns the result of the operation or -1 for error. If 'n' is not supplied the Decrement dialog will appear when the macro is run.
|
Delete
|
Delete
Deletes the character at the text cursor, or the selected text.
|
DeleteBlankLines
|
Issues the Delete Blank Lines command
|
DeleteBookmarkedLines
|
Issues the Delete Bookmarked Lines command
|
DeleteDuplicateLines
|
Issues the Delete Duplicate Lines command
|
DeleteFile()
|
int DeleteFile(string name)
Deletes the fully qualified filepath 'name' from the disk, without requesting confirmation. Returns 1 for success or -1 for error.
|
DeleteLine
|
int DeleteLine(int n)
Deletes line 'n' in the current file. Returns 1 for success or -1 for error. If 'n' is not supplied, the current line is deleted.
|
DeleteLinesThatBeginWith
|
int DeleteLinesThatBeginWith(string str)
Delete lines that begin with the string 'str'. Returns 1 for success or -1 for error. If 'str' is not supplied a dialog will appear when the macro is run.
|
DeleteLinesThatContain
|
int DeleteLinesThatContain(string str)
Delete lines that contain the string 'str'. Returns 1 for success or -1 for error. If 'str' is not supplied a dialog will appear when the macro is run.
|
DeleteLinesThatDoNotBeginWith
|
int DeleteLinesThatDoNotBeginWith(string str)
Delete lines that do not begin with the string 'str'. Returns 1 for success or -1 for error. If 'str' is not supplied a dialog will appear when the macro is run.
|
DeleteLinesThatDoNotContain
|
int DeleteLinesThatDoNotContain(string str)
Delete lines that do not contain the string 'str'. Returns 1 for success or -1 for error. If 'str' is not supplied a dialog will appear when the macro is run.
|
DeleteLinesThatDoNotEndWith
|
int DeleteLinesThatDoNotEndWith(string str)
Delete lines that do not end with the string 'str'. Returns 1 for success or -1 for error. If 'str' is not supplied a dialog will appear when the macro is run.
|
DeleteLinesThatEndWith
|
int DeleteLinesThatEndWith(string str)
Delete lines that end with the string 'str'. Returns 1 for success or -1 for error. If 'str' is not supplied a dialog will appear when the macro is run.
|
DeleteNextWord
|
Issues the Delete Next Word command
|
DeletePreviousWord
|
Issues the Delete Previous Word command
|
DeleteToEndOfLine
|
Issues the Delete to End of Line command
|
DeleteToStartOfLine
|
Issues the Delete to Start of Line command
|
Deselect()
|
Deselect(int mode)
Releases the text selection, if one exists. If 'mode' is 0, the text cursor is placed at the beginning of the selection. If 'mode' is 1, the text cursor is placed at the end of the selection. If 'mode' is 2, the current position of the text cursor is maintained. Returns 1 for success or -1 for error.
|
Divide()
|
int Multiply(int n)
Divides the value at the text cursor by 'n' and places the result in the text file. Returns the result of the operation or -1 for error. If 'n' is not supplied the Divide dialog will appear when the macro is run.
|
Down
|
int Down(int n)
Issues the Down command 'n' times. Returns the number of commands performed or -1 for error. The argument 'n' is optional; if it is not provided a single command is performed.
|
DuplicateAndIncrement
|
Issues the Duplicate and Increment command
|
DuplicateLine
|
Issues the Duplicate Line command
|
e
|
float e
Returns the value of Euler's number 'e', which is approximately 2.7182818285.
|
EBCDICtoASCII
|
Issues the EBCDIC to ASCII command
|
EditClipboard()
|
EditClipboard(int n)
Opens Clipboard 'n' in a window for editing. The Windows Clipboard is number 0; private clipboards are numbered 1 to 8.
|
EndOfFile
|
Issues the End of File command
|
EndOfLine
|
Issues the End of Line command
|
Enter
|
Issues the Enter command
|
EraseValue()
|
int EraseValue(string name)
Erases the variable 'name' from the macro variable storage area. Returns 1 for success or -1 for error.
See also ReadValue(), WriteValue().
|
ErrorChart
|
Issues the Error Chart command
|
Exit
|
Exit
Issues the File|Exit command to close the editor. If one or more files have not been saved a prompt will appear when the macro is run.
|
exp()
|
float exp(float x)
Returns the value 'e' raised to the 'x'.
|
ExtractDrive()
|
int ExtractDrive(string str)
Converts the string 'str' so that it contains only the drive designation portion of itself (eg 'C:'). Returns the length of 'str' or -1 for error.
|
ExtractFileExt()
|
int ExtractFileExt(string str)
Converts the string 'str' so that it contains only the file extension portion of itself. The leading '.' is retained in the resulting string. Returns the length of 'str' or -1 for error.
|
ExtractFileNameAndExt()
|
int ExtractFileNameAndExt(string str)
Converts the string 'str' so that it contains the filename.ext portion of itself. Returns the length of 'str' or -1 for error.
|
ExtractFileNameOnly()
|
int ExtractFileNameOnly(string str)
Converts the string 'str' so that it contains only the filename portion of itself. Returns the length of 'str' or -1 for error.
|
ExtractFilePath()
|
int ExtractFilePath(string str)
Converts the string 'str' so that it contains only the filepath portion of itself. The trailing backslash is retained in the resulting string. Returns the length of 'str' or -1 for error.
|
fabs()
|
float fabs(float x)
Returns the absolute value of 'x'.
|
factorial()
|
int factorial(int x)
Returns the value of x factorial, also known as x! Returns -1 for error or overflow.
|
FastFrame()
|
int FastFrame(int style)
Surrounds the columnar selection with a frame according to 'style'. When 'style' is in the range 1 to 11, a corresponding line style from the Fast Frame dialog is used. If 'style' is not supplied the Fast Frame dialog will appear when the macro runs. Returns 1 for success or -1 for error.
|
FileCount
|
int FileCount
Returns the number of files currently open in the editor.
|
FileExists()
|
int FileExists(string filepath)
Returns 1 if 'filepath' exists, 0 if it does not exists, or -1 for error.
|
FileName
|
int FileName(string fn)
Fills 'fn' with the full path of the current file. Returns the length of the filepath or -1 for error.
|
FileProperties
|
Issues the File Properties command
|
FileTabsBottom
|
Issues the File Tabs Bottom command
|
FileTabsTop
|
Issues the File Tabs Top command
|
FillWithString()
|
int FillWithString(string str)
Fills the selected region with 'str'. Returns 1 for success or -1 for error. If 'str' is not supplied the Fill with String dialog will appear when the macro is run.
|
Find()
|
int Find(string str)
Searches for string 'str'. Returns TRUE if found, FALSE if not found, -1 for error. If 'str' is not supplied the Find dialog will appear when the macro is run. Find() will use the current settings on the Find dialog, but it will force the Perl Regular Expressions option OFF, and the Match Case option ON.
See also Findi(), FindRE() and FindREi().
|
FindADiskFile
|
Issues the Find a Disk File command
|
FindAndCount()
|
int FindAndCount(string str)
Searches for occurrences of 'str' and returns the number found. If 'str' is not supplied the Find and Count dialog will appear when the macro is run.
|
FindDifferingLines
|
int FindDifferingLines()
Issues the Find Differing Lines command and returns 1 if a mismatch is found, or 0 if no additional mismatches exist.
|
FindDistinctLines
|
Issues the Find Distinct Lines command
|
FindDuplicateLines
|
Issues the Find Duplicate Lines command
|
FindFast
|
Issues the Find Fast command
|
Findi()
|
int Findi(string str)
Searches for string 'str'. Returns TRUE if found, FALSE if not found, -1 for error. If 'str' is not supplied the Find dialog will appear when the macro is run. Findi() will use the current settings on the Find dialog, but it will force the Perl Regular Expressions option OFF, and the Match Case option OFF.
See also Find(), FindRE() and FindREi().
|
FindMate
|
int FindMate
search for a mate to the parenthetical sequence at the text cursor. Returns TRUE if found, FALSE if not found.
|
FindNext
|
int FindNext
Returns 1 if the string is found, 0 if not found, -1 for error.
|
FindPrevious
|
int FindPrevious
Returns 1 if the string is found, 0 if not found, -1 for error.
|
FindRE()
|
int FindRE(string str)
Searches for string 'str'. Returns TRUE if found, FALSE if not found, -1 for error. If 'str' is not supplied the Find dialog will appear when the macro is run. FindRE() will use the current settings on the Find dialog, but it will force the Perl Regular Expressions option ON, and the Match Case option ON.
See also Find(), Findi() and FindREi().
|
FindREi()
|
int FindREi(string str)
Searches for string 'str'. Returns TRUE if found, FALSE if not found, -1 for error. If 'str' is not supplied the Find dialog will appear when the macro is run. FindREi() will use the current settings on the Find dialog, but it will force the Perl Regular Expressions option ON, and the Match Case option OFF.
See also Find(), Findi() and FindRE().
|
FindTextInDiskFiles
|
Issues the Find Text in Disk Files command
|
FindUniqueLines
|
Issues the Find Unique Lines command
|
FlipCase
|
Issues the Flip Case command
|
floor()
|
float floor(float x)
Returns (as a float) the largest integer not greater than 'x'. Example: floor(1.5) returns 1.0.
|
Formfeed
|
Issues the Formfeed command
|
GetChar()
|
int GetChar(string prompt, char c)
Displays a message box with 'prompt' and fills 'c' with the character entered by the user. Returns 1 for success or -1 for error.
See also PressChar().
|
GetClipboardText()
|
int GetClipboardText(string str, int n)
Fills 'str' with the text of Clipboard 'n'. Returns the length of the text installed or -1 for error. The Windows Clipboard is number 0; private clipboards are numbered 1 to 8.
|
GetCurrentDirectory()
|
int GetCurrentDirectory(string str)
Retrieves the current directory for the active process and places it in 'str'. Returns 1 for success or -1 for error.
See also SetCurrentDirectory().
|
GetDate()
|
int GetDate(int y, int m, int d)
Gets the current date and fills 'y', 'm' and 'd' with the year, month and date, respectively. Returns 1 for success or -1 for error.
|
GetDayName()
|
int GetDayName(string str, int n)
Fills 'str' with the 3-character name of weekday number 'n' (1-7). The string returned is sensitive to the local language. Returns 1 for success or -1 for error.
|
GetEditMode()
|
int GetEditMode()
Returns the edit mode of the current file. Returns 0 if the edit mode is Insert, or 1 if the edit mode is Typeover. Returns -1 if a file is not open.
|
GetEnv()
|
int GetEnv(string str1, string str2)
Fills 'str1' with the content of the environment variable named in 'str2'. Returns 1 for success or -1 for error.
|
GetFloat()
|
int GetFloat(string prompt, float x)
Displays a message box with 'prompt' and fills 'x' with the value entered by the user. Returns 1 for success or -1 for error.
|
GetGMTDateTime()
|
int GetGMTDateTime(int y, int m, int d, int hh, int, mm, int ss)
Gets the current date and time at GMT (Greenwich Mean Time) and fills 'y', 'm', 'd', 'hh', 'mm' and 'ss' with year/month/day/hour/minute/second, respectively. Hours will be in 24-hour format. Returns 1 for success or -1 for error.
|
GetInt()
|
int GetInt(string prompt, int n)
Displays a message box with 'prompt' and fills 'n' with the value entered by the user. Returns 1 for success or -1 for error.
|
GetLineText()
|
int GetLineText(int n, string str)
Fills 'str' with the text of line 'n'. Returns the length of line 'n' or -1 for error.
|
GetMonName()
|
int GetMonName(string str, int n)
Fills 'str' with the 3-character name of month number 'n' (1-12). The string returned is sensitive to the local language. Returns 1 for success or -1 for error.
|
GetMonthName()
|
int GetMonthName(string str, int n)
Fills 'str' with the full name of month number 'n' (1-12). The string returned is sensitive to the local language. Returns 1 for success or -1 for error.
|
GetReadOnly
|
int GetReadOnly
Returns the read-only state of the current file. Returns 1 if the file is read-only, 0 if the file is not read-only, or -1 for error.
See also: ToggleReadOnly()
|
GetSelection()
|
int GetSelection(string str)
Fills 'str' with the currently selected text. Returns the length of the selection or -1 for error.
See also: ActiveClipboard
|
GetSelectionMode()
|
int GetSelectionMode()
Returns 0 if the current selection mode is Stream, 1 if the current selection mode is Columnar
|
GetSelectionSize
|
int GetSelectionSize
Returns the number of character currently selected, 0 if a selection is not present, or -1 for error.
|
GetString()
|
int GetString(string prompt, string result)
Displays a message box with 'prompt' and fills 'result' with the string entered by the user. Returns the length of 'result' or -1 for error.
|
GetTextWidth
|
int GetTextWidth
Returns the current Text Width value.
|
GetTime12()
|
int GetTime12(int h, int m, int s, int pm)
Gets the current time and fills 'h', 'm' and 's' with hours, minutes and seconds, respectively. Hours will be in 12-hour format. If the time is PM, 'pm' is set to 1, else it is set to 0. Returns 1 for success or -1 for error.
|
GetTime24()
|
int GetTime24(int h, int m, int s)
Gets the current time and fills 'h', 'm' and 's' with hours, minutes and seconds, respectively. Hours will be in 24-hour format. Returns 1 for success or -1 for error.
|
GetWeekday()
|
int GetWeekday(int y, int m, int d)
Returns the number of the weekday associated with the date 'y', 'm', 'd'. Returns 1-7 for success or -1 for error.
|
GetWeekdayName()
|
int GetWeekdayName(string str, int n)
Fills 'str' with the full name of weekday number 'n' (1-7). The string returned is sensitive to the local language. Returns 1 for success or -1 for error.
|
GetWindowNumber()
|
int GetWindowNumber(string fn)
Returns the window number that holds the file 'fn'. Returns -1 for error, 0 if the named file is not open, or a postive value if the file's window is located.
See also Filename(), SwitchToWindow().
|
GetWord()
|
int GetWord(string str)
Fills 'str' with the word at the text cursor. Returns the length of the word found or -1 for error.
See also SelectWord().
|
GetWordDelimiters()
|
int GetWordDelimiters(string str)
Fills 'str' with a string that contains the characters considered to be word delimiters for the current file. Returns 1 for success or -1 for error.
|
GetYesNo()
|
int GetYesNo(string title, string query)
Gets a Yes or No reply from the user. Displays a message box with title 'title' and message 'query'. Returns 1 if the user clicks Yes, 0 if the user clicks No.
|
GoToByteOffset()
|
int GoToByteOffset(int n)
Go to offset 'n' in the current file. Returns 1 for success or -1 for error. If 'n' is not provided the Go to Byte Offset dialog will appear when the macro is run.
|
GoToColumn()
|
int GoToColumn(int n)
Go to column 'n' in the current file. Returns 1 for success or -1 for error. If 'n' is not provided the Go to Column dialog will appear when the macro is run.
|
GoToLine()
|
int GoToLine(int n)
Go to line 'n' in the current file. Returns 1 for success or -1 for error. If 'n' is not provided the Go to Line dialog will appear when the macro is run.
|
Increment()
|
int Increment(int n)
Adds 'n' to the value at the text cursor and places the result in the text file. Returns the result of the operation or -1 for error. If 'n' is not supplied the Increment dialog will appear when the macro is run.
|
IndentOneSpace
|
Issues the Indent One Space command
|
IndentOneTabstop
|
Issues the Indent One Tabstop command
|
IndentWithString()
|
int IndentWithString(string str)
Indents the selected lines with 'str'. Returns 1 for success or -1 for error. If 'str' is not supplied the Indent with String dialog will appear when the macro is run.
|
InsertCharacter()
|
int InsertCharacter(char ch)
Inserts character 'ch' into the edited text. Returns the ASCII value of 'ch' or -1 for error. (This command is identical to PutChar.)
|
InsertFile()
|
int InsertFile(string str)
Insert file 'str' into the current file. Returns 1 for success or -1 for error. If 'str' is not provided the Insert File dialog will appear when the macro is run.
|
InsertFilename
|
Issues the Insert Filename command
|
InsertLineAbove
|
Issues the Insert Line Above command
|
InsertLineBelow
|
Issues the Insert Line Below command
|
InsertLongDate
|
Issues the Insert Long Date command
|
InsertLongTime
|
Issues the Insert Long Time command
|
InsertMode
|
InsertMode
Switches the edit mode to Insert in the current file.
See also ToggleEditMode().
|
InsertShortDate
|
Issues the Insert Short Date command
|
InsertShortTime
|
Issues the Insert Short Time command
|
InvertLines
|
Issues the Invert Lines command
|
isalnum()
|
int isalnum(char c)
Returns non-zero if character 'c' is alphanumeric.
|
isalpha()
|
int isalpha(char c)
Returns non-zero if character 'c' is alphabetic.
|
isascii()
|
int isascii(char c)
Returns non-zero if character 'c' is in the range 0-127.
|
iscntrl()
|
int iscntrl(char c)
Returns non-zero if character 'c' is a control character (0-31 or 127).
|
isdigit()
|
int isdigit(char c)
Returns non-zero if character 'c' is a digit.
|
islower()
|
int islower(char c)
Returns non-zero if character 'c' is lowercase.
|
ispunct()
|
int ispunct(char c)
Returns non-zero if character 'c' is punctuation.
|
isspace()
|
int isspace(char c)
Returns non-zero if character 'c' is whitespace (space, tab, newline, etc.).
|
isupper()
|
int isupper(char c)
Returns non-zero if character 'c' is uppercase.
|
isxdigit()
|
int isxdigit(char c)
Returns non-zero if character 'c' is a hex digit (A-F, a-f, 0-9).
|
JustificationStyle()
|
int JustificationStyle(int n)
Sets the current text justification style according to 'n': 1=Left, 2=Center, 3=Right, 4=Smooth. If 'n' is not supplied the Justification Style dialog will appear when the macro runs. Returns 1 for success or -1 for error.
|
LastCharacter()
|
int LastCharacter(string str)
Returns the last character in 'str' or 0 if 'str' is an empty string.
|
Left
|
int Left(int n)
Issues the Left command 'n' times. Returns the number of commands performed or -1 for error. The argument 'n' is optional; if it is not provided a single command is performed.
|
LeftWindowEdge
|
Issues the Left Window Edge command
|
LineContains()
|
int LineContains(int n, string str)
Returns the number of occurrences of 'str' that appear in line 'n'. The search performed is case sensitive. Regular expressions are not recognized.
|
LineContainsi()
|
int LineContainsi(int n, string str)
Returns the number of occurrences of 'str' that appear in line 'n'. The search performed is case insensitive. Regular expressions are not recognized.
|
LineContainsRE()
|
int LineContainsRE(int n, string str)
Returns the number of matches to 'str' that appear in line 'n'. The search performed is case sensitive. Regular expressions ARE recognized.
|
LineContainsREi()
|
int LineContainsREi(int n, string str)
Returns the number of matches to 'str' that appear in line 'n'. The search performed is case insensitive. Regular expressions ARE recognized.
|
LineCount
|
int LineCount
Returns the number of lines in the current file.
|
LineDrawing()
|
int LineDrawing(int style)
Initiates or terminates Line Drawing mode. If 'style' is 1 to 11, a corresponding line style from the Line Drawing dialog is activated. The Up, Down, Left and Right commands can then be used to draw lines and boxes. When 'style' is 0, Line Drawing mode is terminated. If 'style' is not supplied the Line Drawing dialog will appear when the macro runs. Returns 1 for success or -1 for error.
|
LineIsEmpty()
|
int LineIsEmpty(int n)
Returns TRUE if line 'n' is empty. Note: a line containing only whitespace is considered empty.
|
LineLength()
|
int LineLength(int n)
Returns the number of characters in line 'n'.
|
LineNumber
|
int LineNumber
Returns the current line number in the current file or -1 for error.
|
log()
|
float log(float x)
Returns the natural log of 'x'. 'x' must be a positive value greater than 0.
|
log10()
|
float log(float x)
Returns the base 10 log of 'x'. 'x' must be a positive value greater than 0.
|
MakeLineBottom
|
Issues the Make Line Bottom command
|
MakeLineTop
|
Issues the Make Line Top command
|
max()
|
int max(int n1, int n2)
Returns the greater of 'n1' and 'n2'.
|
Maximize
|
Maximize the current editing window.
|
MaximizeAll
|
Issues the Maximize All command
|
Message()
|
Message(string str, ...)
Displays a pop-up message box with title 'str' and a message that is built from all arguments that follow. Example:
Message(\"Results\", n, \" removed;\", m, \" remain.\");
|
min()
|
int min(int n1, int n2)
Returns the lesser of 'n1' and 'n2'.
|
Minimize
|
Minimize the current editing window.
|
MinimizeAll
|
Issues the Minimize All command
|
Modified
|
int Modified
Returns 1 if the current file has been modified, else 0. Returns -1 for error.
See also SetModified().
|
Multiply()
|
int Multiply(int n)
Multiplies the value at the text cursor by 'n' and places the result in the text file. Returns the result of the operation or -1 for error. If 'n' is not supplied the Multiply dialog will appear when the macro is run.
|
New
|
Issues the New command
|
NextBookmark
|
Issues the Next Bookmark command
|
OEMChart
|
Issues the OEM Chart command
|
OEMtoANSI
|
Issues the OEM to ANSI command
|
Open()
|
int Open(string fn)
Opens the file 'fn' for editing. Returns 1 for success or -1 for error. Remember: \\ must be used to denote \ within 'fn'.
|
OpenEmail()
|
int OpenEmail(string str)
Initiates an email message to the address in 'str' using the default email client. Returns 1 for success or -1 for error.
See also OpenEmailAtCursor.
|
OpenEmailAtCursor
|
Issues the Open Email at Cursor command
|
OpenFileInBrowser
|
Issues the Open File in Browser command
|
OpenFilenameAtCursor
|
Issues the Open Filename at Cursor command
|
OpenHeaderFile
|
Issues the Open Header File command
|
OpenHexMode()
|
int OpenHexMode(string fn)
Opens the file 'fn' for hex mode viewing. Returns 1 for success or -1 for error. Remember: \\ must be used to denote \ within 'fn'.
|
OpenProgramAtCursor
|
Issues the Open Program at Cursor command
|
OpenRecentFile()
|
OpenRecentFile(int n)
Opens recent file number 'n'. When a sufficient file history exists, 'n' can range from 1 to 24.
|
OpenRecentProject()
|
OpenRecentProject(int n)
Opens recent project number 'n'. When a sufficient project history exists, 'n' can range from 1 to 16.
|
OpenSystemFiles
|
Issues the Open System Files command
|
OpenURL()
|
int OpenURL(string str)
Opens the URL described in 'str' in the default internet browser. Returns 1 for succes or -1 for error.
See also OpenURLAtCursor.
|
OpenURLAtCursor
|
Issues the Open URL at Cursor command
|
PageDown
|
Issues the Page Down command
|
PageLeft
|
Issues the Page Left command
|
PageRight
|
Issues the Page Right command
|
PageSetup
|
Issues the Page Setup command
|
PageUp
|
Issues the Page Up command
|
Paste
|
Issues the Paste command
|
PasteAs
|
Issues the Paste As command
|
PasteClipboard()
|
PasteClipboard(int n)
Pastes the content of Clipboard 'n' into the current file. The Windows Clipboard is number 0; private clipboards are numbered 1 to 8.
|
Pause
|
Pause
Pauses macro execution by displaying a message box and waiting for it to be closed.
|
pi
|
float pi
Returns the value of pi, which is approximately 3.1415926536.
|
PlaySound()
|
int PlaySound(string filepath)
Plays the .WAV file described in 'filepath'. Returns 1 for success or -1 for error.
|
pow()
|
float pow(float x, float y)
Returns the value of 'x' raised to the power 'y'.
|
PressChar()
|
int PressChar(string prompt, char c)
Displays the message 'prompt' on the status bar and fills 'c' with the next character pressed by the user. A popup dialog does NOT appear. Returns 1 for success or -1 for error.
Note: PressChar will not wait for a character when run in Debug mode.
See also GetChar().
|
PreviousBookmark
|
Issues the Previous Bookmark command
|
Print
|
Issues the Print command
|
PrintAll
|
Issues the Print All command
|
PrintAllColor
|
Issues the Print All Color command
|
PrintAllMonochrome
|
Issues the Print All Monochrome command
|
PrintColor
|
Issues the Print Color command
|
printf()
|
int printf(string format, ...)
Processes 'format' and inserts a string into the edited text, in accordance with the formatting commands used in 'C'. Returns the number of characters inserted. See the online help for more information.
|
PrintMonochrome
|
Issues the Print Monochrome command
|
PrintPreview
|
Issues the Print Preview command
|
PrintPreviewColor
|
Issues the Print Preview Color command
|
PrintPreviewMonochrome
|
Issues the Print Preview Monochrome command
|
PrintSetup
|
Issues the Print Setup command
|
ProjectAddAll
|
Issues the Project Add All command
|
ProjectAddOne
|
Issues the Project Add One command
|
ProjectClose
|
Issues the Project Close command
|
ProjectDelete()
|
int ProjectDelete(string name)
Deletes the project file described by 'name'. A confirmation prompt will be presented. Returns 1 for success or -1 for error.
|
ProjectEditActive
|
Issues the Project Edit Active command
|
ProjectEditOther()
|
int ProjectEditOther(string name)
Opens the project file described by 'name' for editing. If 'name' does not exist an empty file will be opened. Returns 1 for success or -1 for error.
|
ProjectNew
|
Issues the Project New command
|
ProjectOpen()
|
int ProjectOpen(string name)
Open the project file described by 'name'. Returns 1 for success or -1 for error.
|
ProjectRemove
|
Issues the Project Remove command
|
PutChar()
|
int PutChar(char ch)
Inserts character 'ch' into the edited text. Returns 1 for success or -1 for error.
|
PutClipboardText()
|
int PutClipboardText(string str, int n)
Fills Clipboard 'n' with string 'str'. Returns the length of the text installed or -1 for error. The Windows Clipboard is number 0; private clipboards are numbered 1 to 8.
See also AppendToClipboard().
|
PutFloat()
|
int PutFloat(float x)
Inserts the value of 'x' into the edited text. Two decimal places will be used. Returns 1 for success or -1 for error. Use printf() if special formatting is required.
|
PutInt()
|
int PutInt(int n)
Inserts the value of 'n' into the edited text. Returns 1 for success or -1 for error.
|
PutLineText()
|
int PutLineText(int n, string str)
Replaces the text of line 'n' with 'str'. Returns the length of 'str' or -1 for error.
|
PutMany()
|
int PutMany(...)
Inserts the supplied argument(s) into the edited text. Example:
PutMany(5, \" is a number\", '\\n');
|
PutSelection()
|
int PutSelection(string str)
Inserts string 'str' into the edited text. Returns the length of 'str' or -1 for error. PutSelection() is the complement to GetSelection(), and it should be used instead of PutString to ensure proper insertion of column-selected text.
|
PutString()
|
int PutString(string str)
Inserts string 'str' into the edited text. Returns the length of 'str' or -1 for error.
|
PutWordDelimiters()
|
int PutWordDelimiters(string str)
Sets the word delimiters for the current file to the characters contained in 'str'. Returns 1 for success or -1 for error.
|
QuoteAndReformat
|
Issues the Quote and Reformat command
|
Random()
|
int Random(int n)
Returns a random number between 0 and n-1 or -1 for error.
|
ReadValue()
|
int ReadValue(string name, char/int/string/float val)
Reads a value from the macro variable storage area named 'name' and places it into variable 'val'. The type of 'val' must agree with the type used when the value was written using WriteValue(). Returns 1 for success or -1 for error.
See also WriteValue(), EraseValue().
|
Redo
|
Issues the Redo command
|
RedoAll
|
Issues the Redo All command
|
Reformat
|
Issues the Reformat command
|
ReloadFile
|
Issues the Reload File command
|
RenameFile()
|
int RenameFile(string oldname, string newname)
Renames the file or directory named 'oldname' to 'newname'. Files can be renamed across drives; directories must be on the same drive. The target 'newname' must not exist. Returns 1 for success or -1 for error.
|
Replace()
|
int Replace(string str1, string str2)
Searches for 'str1' and replaces it with 'str2'. Returns the number of replacements made or -1 for error. The user will be prompted to confirm replacements. If 'str1' and 'str2' are not supplied the Replace dialog will appear when the macro is run. Replace() will use the current settings on the Replace dialog, but it will force the Perl Regular Expressions option OFF, and the Match Case option ON.
See also Replacei().
|
ReplaceAgain
|
Issues the Replace Again command
|
ReplaceAll()
|
int ReplaceAll(string str1, string str2)
Searches for 'str1' and replaces it with 'str2'. Returns the number of replacements made or -1 for error. The user will NOT be prompted to confirm replacements. ReplaceAll() will use the current settings on the Replace dialog, but it will force the Perl Regular Expressions option OFF, and the Match Case option ON.
See also ReplaceAlli().
|
ReplaceAlli()
|
int ReplaceAlli(string str1, string str2)
Searches for 'str1' and replaces it with 'str2'. Returns the number of replacements made or -1 for error. The user will NOT be prompted to confirm replacements. ReplaceAlli() will use the current settings on the Replace dialog, but it will force the Perl Regular Expressions option OFF, and the the Match Case option OFF.
See also ReplaceAll().
|
ReplaceAllRE()
|
int ReplaceAllRE(string str1, string str2)
Searches for 'str1' and replaces it with 'str2'. Returns the number of replacements made or -1 for error. The user will be prompted to confirm replacements. If 'str1' and 'str2' are not supplied the Replace dialog will appear when the macro is run. ReplaceAllRE() will use the current settings on the Replace dialog, but it will force the Perl Regular Expressions option to ON, and the Match Case option ON.
See also ReplaceAll(), ReplaceAlli and ReplaceAllREi().
|
ReplaceAllREi()
|
int ReplaceAllREi(string str1, string str2)
Searches for 'str1' and replaces it with 'str2'. Returns the number of replacements made or -1 for error. The user will be prompted to confirm replacements. If 'str1' and 'str2' are not supplied the Replace dialog will appear when the macro is run. ReplaceAllREi() will use the current settings on the Replace dialog, but it will force the Perl Regular Expressions option to ON, and the Match Case option OFF.
See also ReplaceAll(), ReplaceAlli and ReplaceAllRE().
|
Replacei()
|
int Replacei(string str1, string str2)
Searches for 'str1' and replaces it with 'str2'. Returns the number of replacements made or -1 for error. The user will be prompted to confirm replacements. If 'str1' and 'str2' are not supplied the Replace dialog will appear when the macro is run. Replacei() will use the current settings on the Replace dialog, but it will force the Perl Regular Expressions option OFF, and the Match Case option OFF.
See also Replace().
|
ReplaceLineEnders()
|
int ReplaceLineEnders(string str1, string str2)
Searches for 'str1' and replaces it with 'str2'. 'str1' and 'str2' may use the sequence \\n (if within a quoted string) to represent a line ender. Returns the number of replacements made or -1 for error. The user will be NOT prompted to confirm replacements. If 'str1' and 'str2' are not supplied the Replace Line Enders dialog will appear when the macro is run. ReplaceLineEnders() will use the current settings on the Replace Line Enders dialog.
|
ReplaceRE()
|
int ReplaceRE(string str1, string str2)
Searches for 'str1' and replaces it with 'str2'. Returns the number of replacements made or -1 for error. The user will be prompted to confirm replacements. If 'str1' and 'str2' are not supplied the Replace dialog will appear when the macro is run. ReplaceRE() will use the current settings on the Replace dialog, but it will force the Perl Regular Expressions option to ON, and the Match Case option ON.
See also Replace(), Replacei() and ReplaceREi().
|
ReplaceREi()
|
int ReplaceREi(string str1, string str2)
Searches for 'str1' and replaces it with 'str2'. Returns the number of replacements made or -1 for error. The user will be prompted to confirm replacements. If 'str1' and 'str2' are not supplied the Replace dialog will appear when the macro is run. ReplaceREi() will use the current settings on the Replace dialog, but it will force the Perl Regular Expressions option to ON, and the Match Case option OFF.
See also Replace(), Replacei() and ReplaceRE().
|
Restore
|
Restore the current window from a minimized or maximized state.
|
RestoreAll
|
Issues the Restore All command
|
RestoreSettings
|
RestoreSettings
Restores a variety of editor settings which were earlier noted using SaveSettings(). These functions can be used to ensure that a macro does not alter the editor's settings. The following settings are restored: Wordrwrap, Text Width, Justification Style, Edit Mode, Tab Display Size, Selection Mode, Active Clipboard and Word Delimiters.
|
Right
|
int Right(int n)
Issues the Right command 'n' times. Returns the number of commands performed or -1 for error. The argument 'n' is optional; if it is not provided a single command is performed.
|
RightWindowEdge
|
Issues the Right Window Edge command
|
Round()
|
float Round(float x, int n)
Returns the value of 'x' rounded to 'n' decimal places.
|
RunProgram()
|
int RunProgram(string fn, string params, string workdir, int wait)
Runs the named program, document or folder in 'fn' by passing it to the ShellExecuteEx Windows API call. Command line parameters can be passed in 'params'. The program's working directory can be passed in 'workdir'. If 'wait' is 1, macro execution will be suspended until the program has been closed. Returns the completion code of ShellExecuteEx: non-zero for success, zero for error.
See also OpenProgramAtCursor().
|
Save
|
Issues the Save command
|
SaveACopyAs()
|
int SaveACopyAs(string fn)
Saves a copy of the current file to the file 'fn'. The name of the current file is not changed. Returns 1 for success or -1 for error. Remember: \\ must be used to denote \ within 'fn'.
|
SaveAll
|
Issues the Save All command
|
SaveAs()
|
int SaveAs(string fn)
Saves the current file to the file 'fn'. The name of the current file is changed to 'fn'. Returns 1 for success or -1 for error. Remember: \\ must be used to denote \ within 'fn'.
|
SaveSelectionAs()
|
int SaveSelectionAs(string fn)
Saves the current selection to the file 'fn'. Returns 1 for success or -1 for error. Remember: \\ must be used to denote \ within 'fn'.
|
SaveSettings
|
SaveSettings
Records a variety of editor settings for later restoration using RestoreSettings(). These functions can be used to ensure that a macro does not alter the editor's settings. The following settings are saved: Wordrwrap, Text Width, Justification Style, Edit Mode, Tab Display Size, Selection Mode, Active Clipboard and Word Delimiters.
|
ScrollDown
|
Issues the Scroll Down command
|
ScrollLeft
|
Issues the Scroll Left command
|
ScrollRight
|
Issues the Scroll Right command
|
ScrollUp
|
Issues the Scroll Up command
|
SelectAllText
|
Issues the Select All Text command
|
SelectColumnar
|
Issues the Select Columnar command
|
SelectDown
|
Issues the Select Down command
|
SelectLeft
|
Issues the Select Left command
|
SelectPageDown
|
Issues the Select Page Down command
|
SelectPageLeft
|
Issues the Select Page Left command
|
SelectPageRight
|
Issues the Select Page Right command
|
SelectPageUp
|
Issues the Select Page Up command
|
SelectRight
|
Issues the Select Right command
|
SelectStream
|
Issues the Select Stream command
|
SelectToBottomOfPage
|
Issues the Select to Bottom of Page command
|
SelectToEndOfFile
|
Issues the Select to End of File command
|
SelectToEndOfLine
|
Issues the Select to End of Line command
|
SelectToStartOfFile
|
Issues the Select to Start of File command
|
SelectToStartOfLine
|
Issues the Select to Start of Line command
|
SelectToTopOfPage
|
Issues the Select to Top of Page command
|
SelectUp
|
Issues the Select Up command
|
SelectWithoutShift
|
Issues the Select without Shift command
|
SelectWord
|
int SelectWord(string str)
Selects the word at the text cursor and places it in 'str'. Returns the length of the word selected or 0 if no word could be found to select.
See also GetWord().
|
SelectWordLeft
|
Issues the Select Word Left command
|
SelectWordRight
|
Issues the Select Word Right command
|
SetClipboard()
|
SetClipboard(int n)
Sets the active clipboard to Clipboard 'n'. The Windows Clipboard is number 0; private clipboards are numbered 1 to 8.
|
SetClipboardNext
|
Issues the Set Clipboard Next command
|
SetClipboardPrevious
|
Issues the Set Clipboard Previous command
|
SetCurrentDirectory
|
int SetCurrentDirectory(string str)
Sets the current directory for the active process to 'str'. Returns 1 for success or -1 for error.
See also GetCurrentDirectory().
|
SetModified
|
SetModified
Sets the modifed state of the current to true. This might be used to force a Save operation even when a file has not been modified. Returns 1 for success or -1 for error.
See also Modified().
|
ShadedTabZones()
|
int ShadedTabZones(int mode)
Enables or disables the Shaded Tab Zones display mode according to 'mode'.
|
sin()
|
float sin(float x)
Returns the sine of 'x'. The angle 'x' must be in radians.
|
sinh()
|
float sinh(float x)
Returns the hyperbolic sine of 'x'. The angle 'x' must be in radians.
|
SortFileTabsByExt()
|
int SortFileTabsByExt(int mode)
Enables or disables the sorting of File Tabs by extension according to 'mode'. If 'mode' is 1 the feature is enabled. If 'mode' is 0 the feature is disabled.
|
SortFileTabsByName()
|
int SortFileTabsByName(int mode)
Enables or disables the sorting of File Tabs by name according to 'mode'. If 'mode' is 1 the feature is enabled. If 'mode' is 0 the feature is disabled.
|
SortFileTabsByUse()
|
int SortFileTabsByUse(int mode)
Enables or disables the sorting of File Tabs by name according to 'mode'. If 'mode' is 1 the feature is enabled. If 'mode' is 0 the feature is disabled.
|
SortLines
|
Issues the Sort Lines command
|
Space
|
Issues the Space command. If a range of lines is selected, the range will be indented.
|
SpacesToTabs
|
Issues the Spaces to Tabs command
|
SpellChecker
|
Issues the Spell Checker command
|
SplitHorizontal
|
Issues the Split Horizontal command
|
SplitVertical
|
Issues the Split Vertical command
|
sprintf()
|
int sprintf(string str1, string format, ...)
Processes 'format' and builds an output string in 'str1', in accordance with the formatting commands used in 'C'. Returns the length of 'str1' or -1 for error. See the online help for more information.
|
sqrt()
|
float sqrt(float x)
Returns the positive square root of 'x'.
|
StartOfFile
|
Issues the Start of File command
|
StartOfLine
|
Issues the Start of Line command
|
StatusMessage()
|
StatusMessage(...)
Displays a message in the status bar that is built from all arguments that follow. Example:
StatusMessage(n, \" were removed;\", m, \" remain.\");
|
strcat()
|
int strcat(string str1, string str2)
Concatenates 'str2' to 'str1'. Returns the length of 'str1' or -1 for error.
|
strchr()
|
int strchr(string str, char c)
Returns the offset at which the character 'c' appears in 'str' or -1 if 'c' does not appear.
See also strrchr().
|
strcmp()
|
int strcmp(string str1, string str2)
Compares 'str1' to 'str2' with case sensitivity. Returns 0 if the strings are equal. Returns < 0 if 'str1' is less than 'str2'. Returns > 0 if 'str1' is greater than 'str2'.
|
strcmpi()
|
int strcmpi(string str1, string str2)
Compares 'str1' to 'str2' without case sensitivity. Returns 0 if the strings are equal. Returns < 0 if 'str1' is less than 'str2'. Returns > 0 if 'str1' is greater than 'str2'.
|
strcpy()
|
int strcpy(string str1, string str2)
Copies 'str2' to 'str1'. Returns the length of 'str1' or -1 for error.
|
StripHTMLTags
|
Issues the Strip HTML Tags command
|
StripLeadingSpaces
|
Issues the Strip Leading Spaces command
|
StripTrailingSpaces
|
Issues the Strip Trailing Spaces command
|
strlen()
|
int strlen(string str)
Returns the length of 'str'.
|
strlwr()
|
int strlwr(string str)
Converts the string 'str' to lowercase. Returns the length of 'str'.
|
strncat()
|
int strncat(string str1, string str2, int n)
Concatenates up to 'n' characters from 'str2' to 'str1'. Returns the length of 'str1' or -1 for error. A NULL byte is added after the characters added.
|
strncmp()
|
int strncmp(string str1, string str2, int n)
Compares up to 'n' characters in 'str1' to 'str2' with case sensitivity. Returns 0 if the strings are equal. Returns < 0 if 'str1' is less than 'str2'. Returns > 0 if 'str1' is greater than 'str2'.
|
strncmpi()
|
int strncmpi(string str1, string str2, int n)
Compares up to 'n' characters in 'str1' to 'str2' without case sensitivity. Returns 0 if the strings are equal. Returns < 0 if 'str1' is less than 'str2'. Returns > 0 if 'str1' is greater than 'str2'.
|
strncpy()
|
int strncpy(string str1, string str2, int n)
Copies up to 'n' characters from 'str2' to 'str1'. Returns the length of 'str1' or -1 for error. A NULL byte is added after the characters copied.
|
strrchr()
|
int strrchr(string str, char c)
Returns the offset at which the character 'c' last appears in 'str' or -1 if 'c' does not appear.
See also strchr().
|
strrev()
|
int strrev(string str)
Reverses the string 'str' in place. Example:
The string 'Boxer' would be converted to 'rexoB'.
|
strstr()
|
int strstr(string str1, string str2)
Searches string 'str1' for the substring 'str2' with case sensitivity. Returns the offset at which 'str2' is found or -1 if not found.
|
strstri()
|
int strstri(string str1, string str2)
Searches string 'str1' for the substring 'str2' without case sensitivity. Returns the offset at which 'str2' is found or -1 if not found.
|
strupr()
|
int strupr(string str)
Converts the string 'str' to uppercase. Returns the length of 'str'.
|
SubString()
|
int SubString(string str1, string str2, int index, int len)
Fills 'str1' with up to 'len' characters from 'str2', starting at offset 'index'. The first character in a string is referred to by offset 0. Returns the new length of 'str1' or -1 for error.
If 'index' is negative, and 'len' is positive, 'str1' will be filled with 'len' characters starting 'index' characters in from the end of 'str2'.
If 'len' is negative, the value of 'index' is ignored, and 'str1' is filled with the rightmost 'len' characters from 'str2'.
|
SwapLines
|
Issues the Swap Lines command
|
SwapWords
|
Issues the Swap Words command
|
SwitchToWindow()
|
SwitchToWindow(int n)
Makes window 'n' active. Windows are numbered from 1 to the number of open files.
See also FileCount.
See also GetWindowNumber().
|
SyntaxHighlightAs
|
Issues the Syntax Highlight As command
|
Tab
|
Issues the Tab command. If a range of lines is selected, the range will be indented.
|
TabDisplaySize()
|
int TabDisplaySize(string str)
Sets the Tab Display Size for the current file according to 'str'. If a single value appears in 'str', tabs are set to fixed width with the value in 'str'. If a series of comma-separated values are found in 'str', variable width tab stops will be used. Returns TRUE for success, -1 for error. If 'str' is not supplied the Tab Display Size dialog will appear when the macro is run.
|
TabsToSpaces
|
Issues the Tabs to Spaces command
|
tan()
|
float tan(float x)
Returns the tangent of 'x'. The angle 'x' must be in radians.
|
tanh()
|
float tanh(float x)
Returns the hyperbolic tangent of 'x'. The angle 'x' must be in radians.
|
Templates
|
Issues the Templates command
|
TextIsSelected
|
int TextIsSelected
Returns 1 if a stream selection is present, 2 if a columnar selection is present, or 0 if no selection is present. Returns -1 for error.
|
TextWidth()
|
int TextWidth(int n)
Sets the Text Width to 'n'. Returns TRUE for success or -1 for error. If 'n' is not supplied the Text Width dialog will appear when the macro is run.
|
TileAcross
|
Issues the Tile Across command
|
TileDown
|
Issues the Tile Down command
|
ToggleBookmark()
|
int ToggleBookmark(int n, int state)
Sets bookmark 'n' according to 'state'. Returns TRUE for success, -1 for error. If 'state' is ON, bookmark 'n' is placed on the current line. If 'state' is OFF bookmark 'n' is cleared, where ever it is.
|
ToggleEditMode()
|
ToggleEditMode(int state)
Toggles the edit mode according to 'state'. If 'state' is 1, Insert mode is used. If 'state' is 0, Typeover mode is used.
See also the functions InsertMode() and TypeoverMode().
|
ToggleReadOnly()
|
ToggleReadOnly(int state)
Toggle read-only mode according to 'state'. If 'state' is 1, read-only mode is set. If 'state' is 0, read-only mode is released.
|
tolower()
|
int tolower(char c)
Returns the lowercase mate to character 'c'.
|
ToolbarBottom
|
Issues the Toolbar Bottom command
|
ToolbarLeft
|
Issues the Toolbar Left command
|
ToolbarRight
|
Issues the Toolbar Right command
|
ToolbarTop
|
Issues the Toolbar Top command
|
TopLine
|
int TopLine
Returns the line number of the first line in the editor window. Returns -1 for error.
|
TopOfPage
|
Issues the Top of Page command
|
TotalAndAverage
|
Issues the Total and Average command
|
TouchFile()
|
int TouchFile(string name)
Touch (ie, update the timestamp of) the file named 'name'. Returns 1 for success or -1 for error.
|
toupper()
|
int toupper(char c)
Returns the uppercase mate to character 'c'.
|
Trim()
|
int Trim(string str)
Removes leading and trailing blanks from 'str'. Returns the new length of 'str'.
|
TrimLeft()
|
int TrimLeft(string str)
Removes leading blanks from 'str'. Returns the new length of 'str'.
|
TrimRight()
|
int TrimRight(string str)
Removes trailing blanks from 'str'. Returns the new length of 'str'.
|
TypeoverMode
|
TypeoverMode
Switches the edit mode to Typeover in the current file.
See also ToggleEditMode().
|
Uncomment
|
Issues the Uncomment command
|
Undo
|
Issues the Undo command
|
UndoAll
|
Issues the Undo All command
|
Unformat
|
Issues the Unformat command
|
Unindent
|
Issues the Unindent command
|
Up
|
int Up(int n)
Issues the Up command 'n' times. Returns the number of commands performed or -1 for error. The argument 'n' is optional; if it is not provided a single command is performed.
|
UserList()
|
UserList(int n)
Opens User List window 'n'.
|
UserTool()
|
UserTool(int n)
Runs User Tool number 'n'.
|
UserToolWait()
|
UserTool(int n)
Runs User Tool number 'n' and waits for it to complete execution.
|
ValueAtCursor
|
int ValueAtCursor
Returns the ASCII value of the character at the cursor, or -1 if a character is not available at the cursor.
|
ViewBookmarks()
|
int ViewBookmarks(int mode)
Enables or disables the viewing of Bookmarks according to 'mode'.
|
ViewColumnRuler()
|
int ViewColumnRuler(int mode)
Enables or disables the viewing of the Column Ruler according to 'mode'.
|
ViewFileTabs()
|
int ViewFileTabs(int mode)
Enables or disables the viewing of File Tabs according to 'mode'.
|
ViewHexMode()
|
int ViewHexMode(int mode)
Enables or disables read-only hex mode viewing according to 'mode'.
|
ViewHScrollBar()
|
int ViewHScrollBar(int mode)
Enables or disables the viewing of Horizontal Scroll Bars according to 'mode'.
|
ViewLineNumbers()
|
int ViewLineNumbers(int mode)
Enables or disables the viewing of Line Numbers according to 'mode'.
|
ViewRightMarginRule()
|
int ViewRightMarginRule(int mode)
Enables or disables the viewing of the Right Margin Rule according to 'mode'.
|
ViewStatusBar()
|
int ViewStatusBar(int mode)
Enables or disables the viewing of the Status Bar according to 'mode'.
|
ViewSyntaxHighlighting()
|
int ViewSyntaxHighlighting(int mode)
Enables or disables the Syntax Highlighting feature according to 'mode'.
|
ViewTextHighlighting()
|
int ViewTextHighlighting(int mode)
Enables or disables the Text Highlighting feature according to 'mode'.
|
ViewToolbar()
|
int ViewToolbar(int mode)
Enables or disables the viewing of the Toolbar according to 'mode'.
|
ViewVisibleSpaces()
|
int ViewVisibleSpaces(int mode)
Enables or disables the viewing of Visible Spaces according to 'mode'.
|
ViewVScrollBar()
|
int ViewVScrollBar(int mode)
Enables or disables the viewing of Vertical Scroll Bars according to 'mode'.
|
Wait()
|
int Wait(int n)
Delays macro execution for 'n' milliseconds. 1000 milliseconds equals 1 second. Returns 1 for success or -1 for error.
|
WindowHeight
|
int WindowHeight
Returns the number of lines that can be displayed in the current window.
|
WindowList
|
Issues the Window List command
|
WindowNext
|
Issues the Window Next command
|
WindowPrevious
|
Issues the Window Previous command
|
WindowSkip
|
int WindowSkip(int mode)
If 'mode' is 1, sets the skip status for the current window to on. If mode is 0, skip status is turned off. Returns 1 for success or -1 for error.
|
WindowWidth
|
int WindowWidth
Returns the number of columns that can be displayed in the current window.
|
WordCount()
|
int WordCount(int lines, int words, int chars)
Fills the supplied variables with the count of lines, words and characters, respectively. Returns 1 for success or -1 for error.
|
WordLeft
|
int WordLeft(int n)
Issues the Word Left command 'n' times. Returns the number of commands performed or -1 for error. The argument 'n' is optional; if it is not provided a single command is performed.
|
WordRight
|
int WordRight(int n)
Issues the Word Right command 'n' times. Returns the number of commands performed or -1 for error. The argument 'n' is optional; if it is not provided a single command is performed.
|
WordWrap()
|
int Wordwrap(int mode)
Enables or disables Word Wrap according to 'mode'.
|
WriteValue()
|
int WriteValue(string name, char/int/string/float val)
Writes 'val' to the macro variable storage area named 'name'. 'name' will be visible to other macros, so be careful to choose a unique identifier. Returns 1 for success or -1 for error.
See also ReadValue(), EraseValue().
|
xtoi()
|
int xtoi(string str)
Returns the integer value of the hexadecimal number described by string 'str'. Returns -1 for error.
|
