Platforms to show: All Mac Windows Linux Cross-Platform
Back to DesktopScintillaControlMBS control.
DesktopScintillaControlMBS.Margin(index as Integer) as ScintillaMarginMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Index ranges from 0 to 5.
DesktopScintillaControlMBS.MarginStyle(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 |
The style to use for the margin.
(Read and Write computed property)
DesktopScintillaControlMBS.MarginStyles(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 |
The MemoryBlock contains an array of bytes with each byte setting the style of the corresponding text byte similar to style index.
(Read and Write computed property)
DesktopScintillaControlMBS.MarginText(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 |
Text margins are created with the type kMarginTypeText or kMarginTypeRText. A different string may be set for each line with MarginText(). The whole of the text margin on a line may be displayed in a particular style with MarginStyle() or each character may be individually styled with MarginStyles() which uses an array of bytes with each byte setting the style of the corresponding text byte similar to style index. Setting a text margin will cause a kModificationFlagsChangeMargin notification to be sent.
Only some style attributes are active in text margins: font, size/sizeFractional, bold/weight, italics, fore, back, and characterSet.
(Read and Write computed property)
DesktopScintillaControlMBS.MarginTextClearAll
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
DesktopScintillaControlMBS.Marker(index as Integer) as ScintillaMarkerMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Index ranges from 0 to 35.
DesktopScintillaControlMBS.MarkerAdd(Line as Integer, markerNumber 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 markerHandle argument is an identifier for a marker returned by MarkerAdd.
DesktopScintillaControlMBS.MarkerAddSet(line as Integer, markerSet 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 one or more markers to a line with a single call, specified in the same "one-bit-per-marker" 32-bit integer format returned by Marker() (and used by the mask-based marker search functions MarkerNext() and MarkerPrevious()). As with MarkerAdd, no check is made to see if any of the markers are already present on the targeted line.
DesktopScintillaControlMBS.MarkerDefineRGBAImage(markerNumber as Integer, Width as Integer, Height as Integer, ScalePercent as Integer = 100, Pixels as MemoryBlock)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 23.3 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Please pass the marker number, the size of the picture, it's scale in percent and the pixels memoryblock.
DesktopScintillaControlMBS.MarkerDelete(Line as Integer, markerNumber 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 you added the same marker more than once to the line, this will delete one copy each time it is used. If you pass in a marker number of -1, all markers are deleted from the line.
DesktopScintillaControlMBS.MarkerDeleteAll(markerNumber 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 markerNumber is -1, it deletes all markers from all lines.
DesktopScintillaControlMBS.MarkerDeleteHandle(markerHandle 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 markerHandle argument is an identifier for a marker returned by MarkerAdd.
This function searches the document for the marker with this handle and deletes the marker if it is found.
DesktopScintillaControlMBS.MarkerEnableHighlight(enabled as Boolean)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
(i.e. block that contains the caret)
DesktopScintillaControlMBS.MarkerGet(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 |
Bit 0 is set if marker 0 is present, bit 1 for marker 1 and so on.
DesktopScintillaControlMBS.MarkerHandleFromLine(line as Integer, which 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 |
Handles are returned by MarkerAdd. If which is greater or equal to the number of markers on a line, this returns -1;
DesktopScintillaControlMBS.MarkerLineFromHandle(markerHandle 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 markerHandle argument is an identifier for a marker returned by MarkerAdd.
DesktopScintillaControlMBS.MarkerNext(lineStart as Integer, markerMask 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 search starts at line number lineStart and continues forwards to the end of the file (MarkerNext) or backwards to the start of the file (MarkerPrevious).
The markerMask argument should have one bit set for each marker you wish to find. Set bit 0 to find marker 0, bit 1 for marker 1 and so on. The message returns the line number of the first line that contains one of the markers in markerMask or -1 if no marker is found.
DesktopScintillaControlMBS.MarkerNumberFromLine(line as Integer, which 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 |
Handles are returned by MarkerAdd. If which is greater or equal to the number of markers on a line, this returns -1;
DesktopScintillaControlMBS.MarkerPrevious(lineStart as Integer, markerMask 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 search starts at line number lineStart and continues forwards to the end of the file (MarkerNext) or backwards to the start of the file (MarkerPrevious).
The markerMask argument should have one bit set for each marker you wish to find. Set bit 0 to find marker 0, bit 1 for marker 1 and so on. The message returns the line number of the first line that contains one of the markers in markerMask or -1 if no marker is found.
DesktopScintillaControlMBS.MarkerSymbolDefined(markerNumber as Integer) as Integer New in 26.0
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 26.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Returns the symbol defined for a markerNumber with MarkerSymbolDefined or SC_MARK_PIXMAP if defined with kMarkerSymbolPixmap or kMarkerSymbolRgbaImage if defined with MarkerDefineRGBAImage.
DesktopScintillaControlMBS.MoveCaretInsideView
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Any selection is lost.
DesktopScintillaControlMBS.MoveSelectedLinesDown
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
The selection will be automatically extended to the beginning of the selection's first line and the end of the selection's last line. If nothing was selected, the line the cursor is currently at will be selected.
DesktopScintillaControlMBS.MoveSelectedLinesUp
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
The selection will be automatically extended to the beginning of the selection's first line and the end of the selection's last line. If nothing was selected, the line the cursor is currently at will be selected.
DesktopScintillaControlMBS.MultiEdgeAddLine(column as Integer, edgeColour 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 edge will be displayed at the given column number. The resulting edge position depends on the metric of a space character in STYLE_DEFAULT. All the edges can be cleared with MultiEdgeClearAll. MultiEdgeColumn returns the column of the Nth vertical edge (indexed from 0). If which is greater or equal to the number of vertical edges, this returns -1.
DesktopScintillaControlMBS.MultiEdgeClearAll
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
DesktopScintillaControlMBS.MultiEdgeColumn(which 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 |
If which is greater or equal to the number of vertical edges, this returns -1.
DesktopScintillaControlMBS.MultipleSelectAddEach
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
DesktopScintillaControlMBS.MultipleSelectAddNext
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
If the current selection is empty then select word around caret. The current searchFlags are used so the application may choose case sensitivity and word search options.
The items on this page are in the following plugins: MBS Scintilla Plugin.