DesktopScintillaControlMBS.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.

DesktopScintillaControlMBS.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.

DesktopScintillaControlMBS.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.

DesktopScintillaControlMBS.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

DesktopScintillaControlMBS.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.

DesktopScintillaControlMBS.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.

DesktopScintillaControlMBS.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.

DesktopScintillaControlMBS.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.

DesktopScintillaControlMBS.GetLineSelEndPosition(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

Retrieve the position of the end of the selection at the given line with -1 returned if no selection on this line.

DesktopScintillaControlMBS.GetLineSelStartPosition(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

Retrieve the position of the start of the selection at the given line with -1 returned if no selection on this line.

DesktopScintillaControlMBS.GetNextTabStop(line as Integer, x 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

Gets the next explicit tabstop position set after the given x position, or zero if there aren't any.

DesktopScintillaControlMBS.GetStyledText(RangeStart as Integer, RangeEnd as Integer, byref Styledtext as MemoryBlock) 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 collects styled text into a buffer using two bytes for each cell, with the character at the lower address of each pair and the style byte at the upper address.

Characters between the positions RangeStart and RangeEnd are copied to new MemoryBlock and put into Styledtext.
Positions outside the document return character codes and style bytes of 0.

DesktopScintillaControlMBS.GetTextRange(RangeStart as Integer, RangeEnd as Integer, byref Text as String) 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 collects the text between the positions RangeStart and RangeEnd and returns it in Text parameter.

If RangeEnd is -1, text is returned to the end of the document.
The return value is the length of the returned text.

DesktopScintillaControlMBS.GotoLine(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

This removes any selection and sets the caret at the start of line number line and scrolls the view (if needed) to make it visible.

The anchor position is set the same as the current position. If line is outside the lines in the document (first line is 0), the line set is the first or last.

DesktopScintillaControlMBS.GotoPos(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

This removes any selection, sets the caret at caret and scrolls the view to make the caret visible, if necessary.

It is equivalent to SetSel(caret, caret). The anchor position is set the same as the current position.

DesktopScintillaControlMBS.GrabFocus

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

Scintilla can be told to grab the focus with GrabFocus.

This is needed more on GTK where focus handling is more complicated than on Windows.

DesktopScintillaControlMBS.HideLines(lineStart as Integer, lineEnd as Integer)

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

Marks a range of lines as invisible and then redraw the display.

If kElementHiddenLine is set then a horizontal line is drawn in that colour to indicate that there are hidden lines.
A fold line drawn in that position overrides the hidden line indicator.

DesktopScintillaControlMBS.HideSelection(hide as Boolean)

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

The normal state is to make the selection visible by drawing it as set by SetSelForeColor and SetSelBackColor.

However, if you hide the selection, it is drawn as normal text.

DesktopScintillaControlMBS.Home

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.

DesktopScintillaControlMBS.HomeDisplay

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.

DesktopScintillaControlMBS.HomeDisplayExtend

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.

DesktopScintillaControlMBS.HomeExtend

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.

DesktopScintillaControlMBS.HomeRectExtend

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.

DesktopScintillaControlMBS.HomeWrap

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.

DesktopScintillaControlMBS.HomeWrapExtend

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.

DesktopScintillaControlMBS.IndexPositionFromLine(line as Integer, lineCharacterIndex 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

Queries position from line via index.

The document line of a particular character or code unit may be found by calling LineFromIndexPosition with one of kLineCharacterIndexTypeUtf32 (1) or kLineCharacterIndexTypeUtf16 (2). The inverse action, finds the starting position of a document line either in characters or code units from the document start by calling IndexPositionFromLine with the same lineCharacterIndex argument.

DesktopScintillaControlMBS.Indicator(index as Integer) as ScintillaIndicatorMBS

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

Queries indicator with given index.

Index is from 0 to 35.

DesktopScintillaControlMBS.IndicatorAllOnFor(pos 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

Retrieve a bitmap value representing which indicators are non-zero at a position.

Only the first 32 indicators are represented in the result so no IME indicators are included.

DesktopScintillaControlMBS.IndicatorClearRange(start as Integer, lengthClear as Integer)

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

Clears a range for the current indicator.

DesktopScintillaControlMBS.IndicatorFillRange(start as Integer, lengthFill as Integer)

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

Fills a range with the current indicator.

See IndicatorValue property.

DesktopScintillaControlMBS.InitializeLexer(Lexer as String)

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

Initializes the lexer.

To style files in different languages, different 'lexers' are used. These are objects that are called by Scintilla with a range of text and some context information and which then set styles and folding information for that range. Lexers for Scintilla are now provided by the Lexilla project.

Current list of buit-in lexers is:

a68k, abaqus, ada, apdl, as, asm, asn1, asy, au3, ave, avs, baan, bash, batch, bib, blitzbasic, bullant, caml, cil, clarion, clarionnocase, cmake, COBOL, coffeescript, conf, cpp, cppnocase, csound, css, d, dataflex, diff, DMAP, DMIS, ecl, edifact, eiffel, eiffelkw, erlang, errorlist, escript, f77, flagship, forth, fortran, freebasic, fsharp, gap, gui4cli, haskell, hollywood, hypertext, ihex, indent, inno, json, julia, kix, kvirc, latex, lisp, literatehaskell, lot, lout, lua, magiksf, makefile, markdown, matlab, maxima, metapost, mmixal, modula, mssql, mysql, nim, nimrod, nncrontab, nsis, null, octave, opal, oscript, pascal, powerbasic, perl, phpscript, PL/M, po, pov, powerpro, powershell, abl, props, ps, purebasic, python, r, raku, rebol, registry, ruby, rust, sas, scriptol, smalltalk, SML, sorcins, specman, spice, sql, srec, stata, fcST, TACL, tads3, TAL, tcl, tcmd, tehex, tex, txt2tags, vb, vbscript, verilog, vhdl, visualprolog, x12, xml, yaml, xojo

DesktopScintillaControlMBS.InsertText(Text as String, atPosition as Integer = -1)

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 text string at position pos or at the current position if pos is -1.

If the current position is after the insertion point then it is moved along with its surrounding text but no scrolling is performed.

DesktopScintillaControlMBS.IsRangeWord(start as Integer, ende as Integer) as Boolean

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

Is the range start..end a word or set of words?

This message checks that start is at a word start transition and that end is at a word end transition. It does not check whether there are any spaces inside the range.

DesktopScintillaControlMBS.KeyWords(keyWordSet 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

The keyword list.

You can set up to 9 lists of keywords for use by the current lexer. keyWordSet can be 0 to 8 (actually 0 to KEYWORDSET_MAX) and selects which keyword list to replace. keyWords is a list of keywords separated by spaces, tabs, "\n" or "\r" or any combination of these. It is expected that the keywords will be composed of standard ASCII printing characters, but there is nothing to stop you using any non-separator character codes from 1 to 255 (except common sense).
How these keywords are used is entirely up to the lexer. Some languages, such as HTML may contain embedded languages, VBScript and JavaScript are common for HTML. For HTML, key word set 0 is for HTML, 1 is for JavaScript and 2 is for VBScript, 3 is for Python, 4 is for PHP and 5 is for SGML and DTD keywords. Review the lexer code to see examples of keyword list. A fully conforming lexer sets the fourth argument of the LexerModule constructor to be a list of strings that describe the uses of the keyword lists.
Alternatively, you might use set 0 for general keywords, set 1 for keywords that cause indentation and set 2 for keywords that cause unindentation. Yet again, you might have a simple lexer that colours keywords and you could change languages by changing the keywords in set 0. There is nothing to stop you building your own keyword lists into the lexer, but this means that the lexer must be rebuilt if more keywords are added.
(Read and Write computed property)

DesktopScintillaControlMBS.NewLine

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.

DesktopScintillaControlMBS.Tab

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.

DesktopScintillaControlMBS.Tag(tagNumber 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

Discover what text was matched by tagged expressions in a regular expression search.

This is useful if the application wants to interpret the replacement string itself.

DesktopScintillaControlMBS.TargetFromSelection

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

Set the target start and end to the start and end positions of the selection.

DesktopScintillaControlMBS.TargetWholeDocument

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

Set the target start to the start of the document and target end to the end of the document.

DesktopScintillaControlMBS.TextHeight(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

This returns the height in pixels of a particular line.

Currently all lines are the same height.

DesktopScintillaControlMBS.ToggleCaretSticky

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

These method set, get or toggle the caretSticky setting which controls when the last position of the caret on the line is saved.

When set to kCaretStickyOff (0), the sticky flag is off; all text changes (and all caret position changes) will remember the caret's new horizontal position when moving to different lines. This is the default.
When set to kCaretStickyOn (1), the sticky flag is on, and the only thing which will cause the editor to remember the horizontal caret position is moving the caret with mouse or keyboard (left/right arrow keys, home/end keys, etc).
When set to kCaretStickyWhiteSpace (2), the caret acts like mode 0 (sticky off) except under one special case; when space or tab characters are inserted. (Including pasting only space/tabs -- undo, redo, etc. do not exhibit this behaviour..).
ToggleCaretSticky switches from kCaretStickyOn and kCaretStickyWhiteSpace to kCaretStickyOff and from kCaretStickyOff to kCaretStickyOn.

DesktopScintillaControlMBS.ToggleFold(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

Toggle a folder at the given line.

Each fold point may be either expanded, displaying all its child lines, or contracted, hiding all the child lines. This method toggle the folding state of the given line as long as it has the kFoldLevelHeaderFlag set. This method take care of folding or expanding all the lines that depend on the line. The display updates after this method.

DesktopScintillaControlMBS.ToggleFoldShowText(Line as Integer, 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

Toggle a folder at the given line with hsowing text.

Each fold point may be either expanded, displaying all its child lines, or contracted, hiding all the child lines. This method toggle the folding state of the given line as long as it has the kFoldLevelHeaderFlag set. This method take care of folding or expanding all the lines that depend on the line. The display updates after this method.

An optional text tag may be shown to the right of the folded text with the text argument to ToggleFoldShowText. The default text for all header lines can be set with DefaultFoldDisplayText. The text is drawn with the kStylesCommonFoldDisplayText style.

DesktopScintillaControlMBS.Undo

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

Undoes one action.

Or if the undo buffer has reached a EndUndoAction point, all the actions back to the corresponding BeginUndoAction.

Scintilla has multiple level undo and redo. It will continue to collect undoable actions until memory runs out. Scintilla saves actions that change the document. Scintilla does not save caret and selection movements, view scrolling and the like. Sequences of typing or deleting are compressed into single transactions to make it easier to undo and redo at a sensible level of detail. Sequences of actions can be combined into transactions that are undone as a unit. These sequences occur between BeginUndoAction and EndUndoAction messages. These transactions can be nested and only the top-level sequences are undone as units.

DesktopScintillaControlMBS.UndoActionPosition(action as Integer) as Integer

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

Get or set the position of an undo action.

DesktopScintillaControlMBS.UndoActionText(action as Integer) as String

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

Queries the type of the actioon.

Should be called with indices from 0 to one less than the result of UndoActions. The actions should only be iterated in the positive direction and should start from 0.

DesktopScintillaControlMBS.UndoActionType(action as Integer) as Integer

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

Queries the type of the action.

DesktopScintillaControlMBS.UpperCase

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.

DesktopScintillaControlMBS.UsePopUp(popUpMode as Integer)

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

Clicking the wrong button on the mouse pops up a short default editing menu.

This may be turned off with UsePopup(kPopUpNever). If you turn it off, context menu commands (in Windows, WM_CONTEXTMENU) will not be handled by Scintilla, so the parent of the Scintilla window will have the opportunity to handle the message.