ScintillaControlMBS.AddSelection(caret as Integer, anchor as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Add a new selection from anchor to caret as the main selection retaining all other selections as additional selections.

Since there is always at least one selection, to set a list of selections, the first selection should be added with SetSelection() and later selections added with AddSelection().

ScintillaControlMBS.AddStyledText(StyledText as MemoryBlock)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This behaves just like AddText, but inserts styled text.

See GetStyledText function.

ScintillaControlMBS.AddTabStop(line as Integer, x as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Adds an explicit tabstop at the specified distance from the left (in pixels).

Changing tab stops produces a ChangeTabStops event.

ScintillaControlMBS.AddText(Text as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This inserts the first length characters from the string text at the current position.

This will include any 0's in the string that you might have expected to stop the insert operation. The current position is set at the end of the inserted text, but it is not scrolled into view.

ScintillaControlMBS.AddUndoAction(token as Integer, UndoFlags as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Adds an undo action.

The container can add its own actions into the undo stack by calling AddUndoAction and an Modify event will be sent to the container with the KModificationFlagsContainer flag when it is time to undo (PerformedUndo) or redo (PerformedRedo) the action. The token argument supplied is returned in the token field of the notification.
For example, if the container wanted to allow undo and redo of a 'toggle bookmark' command then it could call AddUndoAction(line, 0) each time the command is performed. Then when it receives a notification to undo or redo it toggles a bookmark on the line given by the token field. If there are different types of commands or parameters that need to be stored into the undo stack then the container should maintain a stack of its own for the document and use the current position in that stack as the argument to AddUndoAction(line). AddUndoAction commands are not combined together into a single undo transaction unless grouped with BeginUndoAction and EndUndoAction.

The flags argument can be KUndoFlagsMayCoalesce (1) if the container action may be coalesced along with any insertion and deletion actions into a single compound action, otherwise kUndoFlagsNone (0). Coalescing treats coalescible container actions as transparent so will still only group together insertions that look like typing or deletions that look like multiple uses of the Backspace or Delete keys.

ScintillaControlMBS.AllocateBytes(bytes as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Allocate a document buffer large enough to store a given number of bytes.

The document will not be made smaller than its current contents.

ScintillaControlMBS.AllocateLineCharacterIndex(lineCharacterIndex as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Allocate one or more indexes.

Most Scintilla APIs use byte positions but some applications want to use positions based on counting (UTF-32) characters or (UTF-16) code units or need to communicate with other code written in terms of characters or code units. With only byte positions, this may require examining many bytes to count characters or code units in the document but this may be sped up in some cases by indexing the line starts by character or code unit.

Different aspects of an application may need indexes for different periods and should allocate for those periods. Indexes use additional memory so releasing them can help minimize memory but they also take time to recalculate. Scintilla may also allocate indexes to support features like accessibility or input method editors. Only one index of each type is created for a document at a time.

ScintillaControlMBS.AllocateLines(line as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Allocate line indices to match the lines argument.

This is an optimization that can prevent multiple reallocations of the indices as text is inserted if the application can estimate the number of lines in the document. The number of lines will not be reduced by this call.

ScintillaControlMBS.AnnotationClearAll

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Clears all annotations.

All the lines can be cleared of annotations with AnnotationClearAll which is equivalent to clearing each line (setting to "") and then deleting other memory used for this feature.

ScintillaControlMBS.AnnotationLines(line as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The number of lines annotating a line can be retrieved with AnnotationLines.

ScintillaControlMBS.AnnotationStyle(line as Integer) as ScintillaStyleMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Sets styles for a line.

The whole of the text annotation on a line may be displayed in a particular style with AnnotationStyle or each character may be individually styled with AnnotationStyles which uses an array of bytes with each byte setting the style of the corresponding text byte similar to SetStylingEx. The text must be set first as it specifies how long the annotation is so how many bytes of styling to read. Setting an annotation will cause a ChangeAnnotation event to be sent.

Only some style attributes are active in annotations: font, size/sizeFractional, bold/weight, italics, fore, back, and characterSet.
(Read and Write computed property)

ScintillaControlMBS.AnnotationStyles(line as Integer) as MemoryBlock

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Sets styles for a line.

The whole of the text annotation on a line may be displayed in a particular style with AnnotationStyle or each character may be individually styled with AnnotationStyles which uses an array of bytes with each byte setting the style of the corresponding text byte similar to SetStylingEX. The text must be set first as it specifies how long the annotation is so how many bytes of styling to read. Setting an annotation will cause a ChangeAnnotation event to be sent.

Only some style attributes are active in annotations: font, size/sizeFractional, bold/weight, italics, fore, back, and characterSet.
(Read and Write computed property)

ScintillaControlMBS.AnnotationText(line as Integer) as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

A different string may be set for each line with AnnotationText.

Set to empty string to clear it.
(Read and Write computed property)

ScintillaControlMBS.AppendText(Text as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This adds the text to the end of the document.

This will include any 0's in the string that you might have expected to stop the operation. The current selection is not changed and the new text is not scrolled into view.

ScintillaControlMBS.AssignCmdKey(keyDefinition as Integer, sciCommand as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This assigns the given key definition to a Scintilla command identified by sciCommand.

sciCommand can be any SCI_* command that has no arguments.

There is a default binding of keys to commands that is defined in the Scintilla library. You can change the mapping to suit your own requirements.

keyDefinition
: a key definition contains the key code in the low 16-bits and the key modifiers in the high 16-bits. To combine keyCode and keyMod set:



keyDefinition = keyCode + Bitwise.ShiftLeft(keyMod, 16)

The key code is a visible or control character or a key from the kKeys* enumeration, which contains:

kKeysAdd, kKeysBack, kKeysDelete, kKeysDivide, kKeysDown, kKeysEnd, kKeysEscape, kKeysHome, kKeysInsert, kKeysLeft, kKeysMenu, kKeysNext (Page Down), kKeysPrior (Page Up), kKeysReturn, kKeysRight, kKeysRWin, kKeysSubtract, kKeysTab, kKeysUp, and kKeysWin.

The modifiers are a combination of zero or more of kKeyModAlt, kKeyModCtrl, kKeyModShift, kKeyModMeta, and kKeyModSuper. On OS X, the Command key is mapped to kKeyModCtrl and the Control key to kKeyModMeta. kKeyModSuper is only available on GTK which is commonly the Windows key. If you are building a table, you might want to use kKeyModNorm, which has the value 0, to mean no modifiers.

On Win32, the numeric keypad with Alt pressed can be used to enter characters by number. This can produce unexpected results in non-numlock mode when function keys are assigned so potentially problematic keys are ignored. For example, setting kKeyModAlt, kKeysUP will only be active for the Up key on the main cursor keys, not the numeric keypad.

ScintillaControlMBS.AutoComplete

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This method triggers autocompletion.

This has the same effect as the tab key.

ScintillaControlMBS.AutoCompleteCancel

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Cancels any displayed auto completion list.

When in auto completion mode, the list should disappear when the user types a character that can not be part of the auto completion, such as '.', '(' or '[' when typing an identifier. A set of characters that will cancel autocompletion can be specified with AutoCompleteStops.

ScintillaControlMBS.AutoCompletePosStart as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This returns the value of the current position when AutoCompleteShow started display of the list.

ScintillaControlMBS.AutoCompleteSelect(Value as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This method selects an item in the autocompletion list.

It searches the list of words for the first that matches select. By default, comparisons are case sensitive, but you can change this with AutoCIgnoreCase. The match is character by character for the length of the select string. That is, if select is "Fred" it will match "Frederick" if this is the first item in the list that begins with "Fred". If an item is found, it is selected. If the item is not found, the autocompletion list closes if auto-hide is true (see AutoCAutoHide).
The current selection index can be retrieved with AutoCompleteCurrent.

ScintillaControlMBS.AutoCompleteSetFillUps(characterSet as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

If a fillup character is typed with an auto completion list active, the currently selected item in the list is added into the document, then the fillup character is added.

Common fillup characters are '(', '[' and '.' but others are possible depending on the language. By default, no fillup characters are set.

ScintillaControlMBS.AutoCompleteShow(lengthEntered as Integer, itemList as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This method causes a list to be displayed.

lengthEntered is the number of characters of the word already entered and itemList is the list of words separated by separator characters. The initial separator character is a space but this can be set or got with AutoCompleteSeparator property.

With default settings, the list of words should be in sorted order. If set to ignore case mode with AutoCompleteIgnoreCase, then strings are matched after being converted to upper case. One result of this is that the list should be sorted with the punctuation characters '[', '\', ']', '^', '_', and '`' sorted after letters. Alternative handling of list order may be specified with AutoCompleteOrder property.

ScintillaControlMBS.AutoCompleteStops(characterSet as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The characterSet argument is a string containing a list of characters that will automatically cancel the auto completion list.

When you start the editor, this list is empty.

ScintillaControlMBS.BackTab

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The method to perform the action when this key is pressed.

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

ScintillaControlMBS.BeginUndoAction

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Starts a composed undo action.

Call BeginUndoAction to mark the beginning and EndUndoAction to end of a set of operations that you want to undo all as one operation but that you have to generate as several operations. Alternatively, you can use these to mark a set of operations that you do not want to have combined with the preceding or following operations if they are undone.

ScintillaControlMBS.BraceBadLight(pos as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Shows bad brace highlight.

If there is no matching brace then the brace badlighting style, style kStylesCommonBraceBad (35), can be used to show the brace that is unmatched. Using a position of kInvalidPosition (-1) removes the highlight.

ScintillaControlMBS.BraceBadLightIndicator(useSetting as Boolean, indicator as ScintillaIndicatorMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Use specified indicator to highlight non matching brace instead of changing its style

ScintillaControlMBS.BraceHighlight(posA as Integer, posB as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Up to two characters can be highlighted in a 'brace highlighting style', which is defined as style number BraceHighlight (34).

If you have enabled indent guides, you may also wish to highlight the indent that corresponds with the brace. You can locate the column with Column() and highlight the indent with HighlightGuide.

ScintillaControlMBS.BraceHighlightIndicator(useSetting as Boolean, indicator as ScintillaIndicatorMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Use specified indicator to highlight matching braces instead of changing their style.

ScintillaControlMBS.BraceMatch(pos as Integer, maxReStyle as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The BraceMatch method finds a corresponding matching brace given pos, the position of one brace.

The brace characters handled are '(', ')', '[', ']', '{', '}', '<', and '>'. The search is forwards from an opening brace and backwards from a closing brace. If the character at position is not a brace character, or a matching brace cannot be found, the return value is -1. Otherwise, the return value is the position of the matching brace.
A match only occurs if the style of the matching brace is the same as the starting brace or the matching brace is beyond the end of styling. Nested braces are handled correctly. The maxReStyle parameter must currently be 0 - it may be used in the future to limit the length of brace searches.

ScintillaControlMBS.BraceMatchNext(pos as Integer, startPos as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Similar to BraceMatch, but matching starts at the explicit start position startPos instead of the implicitly next position pos ± 1.

ScintillaControlMBS.CallTipCancel

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This method cancels any displayed call tip.

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.

ScintillaControlMBS.CallTipSetBackColor(backColor as Color)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The background colour of call tips can be set with this property;

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.

ScintillaControlMBS.CallTipSetForeColor(foreColor as Color)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The colour of call tip text can be set with this method.

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

ScintillaControlMBS.CallTipSetForeColorHighlight(foreColor as Color)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The colour of highlighted call tip text can be set with this method.

The default colour is dark blue.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This sets the region of the call tips text to display in a highlighted style.

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.

ScintillaControlMBS.CallTipSetPosition(above as Boolean)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

By default the calltip is displayed below the text, setting above to true will display it above the text.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This method starts the process by displaying the call tip window.

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.

ScintillaControlMBS.CallTipUseStyle(tabSize as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This method changes the style used for call tips from KStylesCommonDefault to KStylesCommoCallTip and sets a tab size in screen pixels.

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.

ScintillaControlMBS.Cancel

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Cancels autocompletion and calltip display and drops any additional selections.

ScintillaControlMBS.ChangeInsertion(text as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Changes insert.

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

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.

ScintillaControlMBS.Character(position as Integer) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This returns the character at pos in the document or 0 if pos is negative or past the end of the document.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

This queries character at given position.

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.

ScintillaControlMBS.CharLeft

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The method to perform the action when this key is pressed.

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

ScintillaControlMBS.CharLeftExtend

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The method to perform the action when this key is pressed.

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

ScintillaControlMBS.CharLeftRectExtend

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The method to perform the action when this key is pressed.

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

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Finds the closest character to a point.

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

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

Finds the closest character to a point.

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.

ScintillaControlMBS.CharRight

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Scintilla	MBS Scintilla Plugin	22.0	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop only

The method to perform the action when this key is pressed.

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