DesktopScintillaControlMBS.CallTipCancel

Scintilla will also cancel call tips for you if you use any keyboard commands that are not compatible with editing the argument list of a function. Call tips are cancelled if you delete back past the position where the caret was when the tip was triggered.

DesktopScintillaControlMBS.CallTipSetBackColor(backColor as Color)

The default colour is white. It is not a good idea to set a dark colour as the background as the default colour for normal calltip text is mid grey and the default colour for highlighted text is dark blue. This also sets the background colour of kStylesCommonCallTip.

DesktopScintillaControlMBS.CallTipSetForeColor(foreColor as Color)

The default colour is mid grey.
This also sets the foreground colour of kStylesCommonCallTip.

DesktopScintillaControlMBS.CallTipSetForeColorHighlight(foreColor as Color)

The default colour is dark blue.

DesktopScintillaControlMBS.CallTipSetHighlight(highlightStart as Integer, highlightEnd as Integer)

highlightStart is the zero-based index into the string of the first character to highlight and highlightEnd is the index of the first character after the highlight. highlightEnd must be greater than highlightStart; highlightEnd-highlightStart is the number of characters to highlight. Highlights can extend over line ends if this is required.
Unhighlighted text is drawn in a mid grey. Selected text is drawn in a dark blue. The background is white. These can be changed with CallTipSetBackColor, CallTipSetForeColor, and CallTipSetForeColorHighlight.

DesktopScintillaControlMBS.CallTipSetPosition(above as Boolean)

DesktopScintillaControlMBS.CallTipShow(pos as Integer, definition as String)

If a call tip is already active, this has no effect.

pos is the position in the document at which to align the call tip. The call tip text is aligned to start 1 line below this character unless you have included up and/or down arrows in the call tip text in which case the tip is aligned to the right-hand edge of the rightmost arrow. The assumption is that you will start the text with something like "\001 1 of 3 \002".

definition is the call tip text. This can contain multiple lines separated by '\n' (Line Feed, ASCII code 10) characters. Do not include Carriage Return (ASCII code 13), as this will most likely print as an empty box. Tab (ASCII code 9) is supported if you set a tabsize with CallTipUseStyle.

The position of the caret is remembered here so that the call tip can be cancelled automatically if subsequent deletion moves the caret before this position.


Call tips are small windows displaying the arguments to a function and are displayed after the user has typed the name of the function. They normally display characters using the font facename, size and character set defined by kStylesCommonDefault. You can choose to use kStylesCommonCallTip to define the facename, size, foreground and background colours and character set with CallTipUseStyle. This also enables support for Tab characters. There is some interaction between call tips and autocompletion lists in that showing a call tip cancels any active autocompletion list, and vice versa.

Call tips can highlight part of the text within them. You could use this to highlight the current argument to a function by counting the number of commas (or whatever separator your language uses).

The mouse may be clicked on call tips and this causes a CallTipClick event to be sent to the container. Small up and down arrows may be displayed within a call tip by, respectively, including the characters '\001', or '\002'. This is useful for showing that there are overloaded variants of one function name and that the user can click on the arrows to cycle through the overloads.
Alternatively, call tips can be displayed when you leave the mouse pointer for a while over a word in response to the DWellStart event and cancelled in response to DWellEnd. This method could be used in a debugger to give the value of a variable, or during editing to give information about the word under the pointer.

DesktopScintillaControlMBS.CallTipUseStyle(tabSize as Integer)

If tabsize is less than 1, Tab characters are not treated specially. Once this call has been used, the call tip foreground and background colours are also taken from the style.

DesktopScintillaControlMBS.Cancel

DesktopScintillaControlMBS.ChangeInsertion(text as String)

This may only be called from a kModificationFlagsInsertCheck in Modify event handler and will change the text being inserted to that provided.

DesktopScintillaControlMBS.ChangeLastUndoActionText(action as Integer, text as String)

DesktopScintillaControlMBS.ChangeLexerState(start as Integer, ende as Integer) as Integer

DesktopScintillaControlMBS.ChangeSelectionMode(SelectionMode as Integer)

Can be stream (kSelectionModeStream=0) or rectangular (kSelectionModeRectangle=1) or by lines (kSelectionModeLines=2) or thin rectangular (kSelectionModeThin=3). When set in these modes, regular caret moves will extend or reduce the selection, until the mode is cancelled by a call with same value or with Cancel. The get function returns the current mode even if the selection was made by mouse or with regular extended moves. SC_SEL_THIN is the mode after a rectangular selection has been typed into and ensures that no characters are selected.

DesktopScintillaControlMBS.Character(position as Integer) as Integer

DesktopScintillaControlMBS.CharacterString(position as Integer, byref Length as Integer) as String

If the position has a multi byte UTF-8 character, we take multiple characters and return length in bytes via Length parameter.
Otherwise character is returned for 1 byte and then length is set to 1.

See also Character() to get individual bytes.

DesktopScintillaControlMBS.CharLeft

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

DesktopScintillaControlMBS.CharLeftExtend

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

DesktopScintillaControlMBS.CharLeftRectExtend

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

DesktopScintillaControlMBS.CharPositionFromPoint(x as Integer, y as Integer) as Integer

DesktopScintillaControlMBS.CharPositionFromPointClose(x as Integer, y as Integer) as Integer

Returns -1 if the point is outside the window or not close to any characters. This is similar to the previous CharPositionFromPoint method but finds characters rather than inter-character positions.

DesktopScintillaControlMBS.CharRight

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

DesktopScintillaControlMBS.CharRightExtend

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

DesktopScintillaControlMBS.CharRightRectExtend

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

DesktopScintillaControlMBS.ChooseCaretX

This message sets the current x position of the caret as the remembered value.

DesktopScintillaControlMBS.Clear

DesktopScintillaControlMBS.ClearAll

DesktopScintillaControlMBS.ClearAllCmdKeys

DesktopScintillaControlMBS.ClearAllRepresentations

DesktopScintillaControlMBS.ClearCmdKey(keyDefinition as Integer)

Var c as DesktopScintillaControlMBS
// disable tab key for editor
c.ClearCmdKey c.kKeysTab

DesktopScintillaControlMBS.ClearDocumentStyle

DesktopScintillaControlMBS.ClearRegisteredImages

DesktopScintillaControlMBS.ClearRepresentation(encodedCharacter as String)

DesktopScintillaControlMBS.ClearSelections

DesktopScintillaControlMBS.ClearTabStops(line as Integer)

Changing tab stops produces a ChangeTabStops event.

DesktopScintillaControlMBS.Colourise(start as Integer, ende as Integer = -1)

If end is -1, the document is styled from start to the end. If the "fold" property is set to "1" and your lexer or container supports folding, fold levels are also set. This method causes a redraw.

DesktopScintillaControlMBS.ColouriseAll

If the "fold" property is set to "1" and your lexer or container supports folding, fold levels are also set. This method causes a redraw.

DesktopScintillaControlMBS.Column(pos as Integer) as Integer

This returns the column number of the last tab on the line before pos, plus the number of characters between the last tab and pos. If there are no tab characters on the line, the return value is the number of characters up to the position on the line. In both cases, double byte characters count as a single character. This is probably only useful with monospaced fonts.

DesktopScintillaControlMBS.ContractedFoldNext(lineStart as Integer) as Integer

This is useful when saving the user's folding when switching documents or saving folding with a file. The search starts at line number lineStart and continues forwards to the end of the file. lineStart is returned if it is a contracted fold header otherwise the next contracted fold header is returned. If there are no more contracted fold headers then -1 is returned.

DesktopScintillaControlMBS.ConvertEOLs(EndOfLineMode as Integer)

Scintilla can handle the major line end conventions and, depending on settings and the current lexer also support additional Unicode line ends.
Scintilla can interpret any of the Macintosh (CR), Unix (LF) and Windows (CR+LF) line ends. When the user presses the Enter key, one of these line end strings is inserted into the buffer. The default is CRL+LF in Windows and LF in Unix, but this can be changed with the EOLMode proeprty. You can also convert the entire document to one of these line endings with ConvertEOLs. Finally, you can choose to display the line endings with ViewEOL.

For the UTF-8 encoding, three additional Unicode line ends, Next Line (NEL=U+0085), Line Separator (LS=U+2028), and Paragraph Separator (PS=U+2029) may optionally be interpreted when Unicode line ends is turned on and the current lexer also supports Unicode line ends.

DesktopScintillaControlMBS.Copy

DesktopScintillaControlMBS.CopyAllowLine

On Windows, an extra "MSDEVLineSelect" marker is added to the clipboard which is then used in SCI_PASTE to paste the whole line before the current line.

DesktopScintillaControlMBS.CopyRange(RangeStart as Integer, RangeEnd as Integer)

DesktopScintillaControlMBS.CopyText(Text as String)

DesktopScintillaControlMBS.CountCharacters(start as Integer, ende as Integer) as Integer

DesktopScintillaControlMBS.CountCodeUnits(start as Integer, ende as Integer) as Integer

This counts in UTF-16 code units.

DesktopScintillaControlMBS.CreateLoader(bytes as Integer = 1000000, documentOptions as Integer = 0) as ScintillaLoaderMBS

An application can load all of a file into a buffer it allocates on a background thread and then add the data in that buffer into a Scintilla document on the user interface thread. That technique uses extra memory to store a complete copy of the file and also means that the time that Scintilla takes to perform initial line end discovery blocks the user interface.

To avoid these issues, a loader object may be created and used to load the file.
Returns an object that supports the ScintillaLoaderMBS interface which can be used to load data and then be turned into a Scintilla document object for attachment to a view object. The bytes argument determines the initial memory allocation for the document as it is more efficient to allocate once rather than rely on the buffer growing as data is added. If CreateLoader fails then nil is returned.

See kDocumentOption* constants.

DesktopScintillaControlMBS.Cut

DesktopScintillaControlMBS.CutAllowLine

On Windows, an extra "MSDEVLineSelect" marker is added to the clipboard which is then used in Paste to paste the whole line before the current line.