Platforms to show: All Mac Windows Linux Cross-Platform
Back to ScintillaControlMBS control.
ScintillaControlMBS.CharRightExtend
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.CharRightRectExtend
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.ChooseCaretX
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
This message sets the current x position of the caret as the remembered value.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.ClearAllCmdKeys
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.ClearAllRepresentations
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.ClearCmdKey(keyDefinition as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.ClearDocumentStyle
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.ClearRegisteredImages
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.ClearRepresentation(encodedCharacter as String)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.ClearSelections
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.ClearTabStops(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 |
Changing tab stops produces a ChangeTabStops event.
ScintillaControlMBS.Colourise(start as Integer, ende 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 |
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.
ScintillaControlMBS.ColouriseAll
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
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.
ScintillaControlMBS.Column(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 |
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.
ScintillaControlMBS.ContractedFoldNext(lineStart 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 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.
ScintillaControlMBS.ConvertEOLs(EndOfLineMode as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.CopyAllowLine
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
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.
ScintillaControlMBS.CopyRange(RangeStart as Integer, RangeEnd as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.CopyText(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 |
ScintillaControlMBS.CountCharacters(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 |
ScintillaControlMBS.CountCodeUnits(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 |
This counts in UTF-16 code units.
ScintillaControlMBS.CreateLoader(bytes as Integer = 1000000, documentOptions as Integer = 0) as ScintillaLoaderMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.DeleteBack
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DeleteBackNotLine
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DeleteRange(start as Integer, lengthDelete as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.DelLineLeft
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DelLineRight
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DelWordLeft
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DelWordRight
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DelWordRightEnd
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
The *End methods move between word ends instead of word starts.
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DescribeProperty(Key as String) as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.DocLineFromVisible(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 method returns the document line number that corresponds to a display line (counting the display line of the first line in the document as 0). If displayLine is less than or equal to 0, the result is 0. If displayLine is greater than or equal to the number of displayed lines, the result is the number of lines in the document.
ScintillaControlMBS.DocumentEnd
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DocumentEndExtend
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DocumentStart
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DocumentStartExtend
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.DropSelectionN(selection as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
If this was the main selection then make the previous selection the main and if it was the first then the last selection becomes main. If there is only one selection, or there is no selection selection, then there is no effect.
ScintillaControlMBS.EditToggleOvertype
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.ElementAllowsTranslucent(element 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 |
This may change based on circumstances - different platforms or graphics technologies may implement translucency and newer versions of Scintilla may implement translucency for elements that did not previously support it.
ScintillaControlMBS.ElementBaseColour(element as Integer) as Color
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
This may be a value defined by Scintilla or it may be derived from the operating system or platform. Which values are set from the operating system may differ between operating systems and operating system versions. When undefined the return value is 0 which is equivalent to completely transparent black. These colours may be useful when defining styles with similarities such as synthesizing dark mode styles that use the same colours as the system.
On Win32, autocompletion list colours like kElementList are currently provided by the platform layer and on Cocoa, selection background colours like kElementSelectionBack are provided.
ScintillaControlMBS.ElementColour(element as Integer) as Color
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
If the element supports translucency, then the alpha portion of the value is used. An opaque alpha value (&hff) should always be included when an opaque colour is desired as the value 0 is completely transparent and thus invisible.
(Read and Write computed property)
ScintillaControlMBS.ElementIsSet(element 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 |
When false indicates that a default colour or set of colours is displayed.
ScintillaControlMBS.EmptyUndoBuffer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
It also sets the save point to the start of the undo buffer, so the document will appear to be unmodified. This does not cause the SavePointReached event to be sent to the container.
ScintillaControlMBS.EndStyled as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Scintilla keeps a record of the last character that is likely to be styled correctly. This is moved forwards when characters after it are styled and moved backwards if changes are made to the text of the document before it. Before drawing text, this position is checked to see if any styling is needed and, if so, a StyleNeeded event is sent to the container. The container can send EndStyled to work out where it needs to start styling. Scintilla will always ask to style whole lines.
ScintillaControlMBS.EndUndoAction
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
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.EnsureVisible(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 |
Both these message travels up the fold hierarchy, expanding any contracted folds until they reach the top level. The line will then be visible. If you use EnsureVisibleEnforcePolicy(), the vertical caret policy set by VisiblePolicy() is then applied.
The items on this page are in the following plugins: MBS Scintilla Plugin.