Platforms to show: All Mac Windows Linux Cross-Platform
Back to DesktopScintillaControlMBS control.
DesktopScintillaControlMBS.SetFoldMarginHighlightColor(useSetting as boolean, value as Color)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Defaults to system color for this.
The FoldMarginColor and the FoldMarginHighlightColor colors are used together to draw the chequerboard pattern in the folder margin.
DesktopScintillaControlMBS.SetHotspotActiveBackColor(useSetting as boolean, value as Color)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
While the cursor hovers over text in a style with the hotspot attribute set, the default colouring can be modified and an underline drawn with these settings.
DesktopScintillaControlMBS.SetHotspotActiveForeColor(useSetting as boolean, value as Color)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
While the cursor hovers over text in a style with the hotspot attribute set, the default colouring can be modified and an underline drawn with these settings.
DesktopScintillaControlMBS.SetSavePoint
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
This is usually done when the file is saved or loaded, hence the name "save point". As Scintilla performs undo and redo operations, it notifies the container that it has entered or left the save point with SavePointReached and SavePointLeft events, allowing the container to know if the file should be considered dirty or not.
See also: EmptyUndoBuffer or Modify property.
DesktopScintillaControlMBS.SetSel(anchor as Integer, caret 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 caret is negative, it means the end of the document. If anchor is negative, it means remove any selection (i.e. set the anchor to the same position as caret). The caret is scrolled into view after this operation.
DesktopScintillaControlMBS.SetSelBackColor(useSetting as boolean, value as Color)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
With the method, the colour you provide is used if you set useSetting to true. If it is set to false, the default styled colouring is used and the fore or back argument has no effect.
DesktopScintillaControlMBS.SetSelection(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 |
DesktopScintillaControlMBS.SetSelForeColor(useSetting as boolean, value as Color)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
With the method, the colour you provide is used if you set useSetting to true. If it is set to false, the default styled colouring is used and the fore or back argument has no effect.
DesktopScintillaControlMBS.setStatusText(Text as String)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop only |
DesktopScintillaControlMBS.SetStyling(length as Integer, style as ScintillaStyleMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
StartStyling should be called before the first call to this.
See also:
DesktopScintillaControlMBS.SetStyling(start as Integer, length as Integer, style as ScintillaStyleMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
StartStyling should be called before the first call to this.
See also:
DesktopScintillaControlMBS.SetStylingEx(Styles as MemoryBlock)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
As an alternative to SetStyling, which applies the same style to each byte, you can use this method which specifies the styles for each of length bytes from the styling position and then increases the styling position by length, ready for the next call. StartStyling should be called before the first call to this.
DesktopScintillaControlMBS.SetTargetRange(start as Integer, ende as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
DesktopScintillaControlMBS.SetVisiblePolicy(visiblePolicy as Integer, visibleSlop as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
It takes kVisiblePolicySlop and kVisiblePolicyStrict flags for the visiblePolicy parameter. It is similar in operation to SetYCaretPolicy.
DesktopScintillaControlMBS.SetWhitespaceBackColor(useSetting as boolean, value as Color)
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 colour of visible white space is determined by the lexer in use. The foreground and/or background colour of all visible white space can be set globally, overriding the lexer's colours.
DesktopScintillaControlMBS.SetWhitespaceForeColor(useSetting as boolean, value as Color)
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 colour of visible white space is determined by the lexer in use. The foreground and/or background colour of all visible white space can be set globally, overriding the lexer's colours.
DesktopScintillaControlMBS.SetXCaretPolicy(caretPolicy as Integer, caretSlop as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
See kCaretPolicy* constants.
slop | strict | jumps | even | Caret can go to the margin | "On reaching limit (going out of visibility |
0 | 0 | 0 | 0 | Yes | moved to put caret on top/on right |
0 | 0 | 0 | 1 | Yes | moved by one position |
0 | 0 | 1 | 0 | Yes | moved to put caret on top/on right |
0 | 0 | 1 | 1 | Yes | centred on the caret |
0 | 1 | - | 0 | Caret is always on top/on right of display | - |
0 | 1 | - | 1 | No, caret is always centred | - |
1 | 0 | 0 | 0 | Yes | moved to put caret out of the asymmetrical UZ |
1 | 0 | 0 | 1 | Yes | moved to put caret out of the UZ |
1 | 0 | 1 | 0 | Yes | moved to put caret at 3UZ of the top or right margin |
1 | 0 | 1 | 1 | Yes | moved to put caret at 3UZ of the margin |
1 | 1 | - | 0 | Caret is always at UZ of top/right margin | - |
1 | 1 | 0 | 1 | No, kept out of UZ | moved by one position |
1 | 1 | 1 | 0 | No, kept out of UZ | moved to put caret at 3UZ of the margin |
DesktopScintillaControlMBS.SetYCaretPolicy(caretPolicy as Integer, caretSlop as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
See kCaretPolicy* constants.
slop | strict | jumps | even | Caret can go to the margin | "On reaching limit (going out of visibility |
0 | 0 | 0 | 0 | Yes | moved to put caret on top/on right |
0 | 0 | 0 | 1 | Yes | moved by one position |
0 | 0 | 1 | 0 | Yes | moved to put caret on top/on right |
0 | 0 | 1 | 1 | Yes | centred on the caret |
0 | 1 | - | 0 | Caret is always on top/on right of display | - |
0 | 1 | - | 1 | No, caret is always centred | - |
1 | 0 | 0 | 0 | Yes | moved to put caret out of the asymmetrical UZ |
1 | 0 | 0 | 1 | Yes | moved to put caret out of the UZ |
1 | 0 | 1 | 0 | Yes | moved to put caret at 3UZ of the top or right margin |
1 | 0 | 1 | 1 | Yes | moved to put caret at 3UZ of the margin |
1 | 1 | - | 0 | Caret is always at UZ of top/right margin | - |
1 | 1 | 0 | 1 | No, kept out of UZ | moved by one position |
1 | 1 | 1 | 0 | No, kept out of UZ | moved to put caret at 3UZ of the margin |
DesktopScintillaControlMBS.ShowLines(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 |
DesktopScintillaControlMBS.StartRecord
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
DesktopScintillaControlMBS.StartStyling(start as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
After StartStyling, send multiple SetStyling messages for each lexical entity to style or send SetStylingEX to style in blocks.
DesktopScintillaControlMBS.StopRecord
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
DesktopScintillaControlMBS.StringOfSpan(Span as ScintillaSpanMBS) as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
DesktopScintillaControlMBS.StutteredPageDown
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.
DesktopScintillaControlMBS.StutteredPageDownExtend
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
This action extends the selection.
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
DesktopScintillaControlMBS.StutteredPageUp
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.
DesktopScintillaControlMBS.StutteredPageUpExtend
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
This action extends the selection.
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
DesktopScintillaControlMBS.Style(index as Integer) as ScintillaStyleMBS
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 255.
DesktopScintillaControlMBS.StyleAt(position as Integer) as ScintillaStyleMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
DesktopScintillaControlMBS.StyleClearAll
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
If you are setting up Scintilla for syntax colouring, it is likely that the lexical styles you set will be very similar. One way to set the styles is to:
1. Set kStylesCommonDefault to the common features of all styles.
2. Use StyleClearAll to copy this to all styles.
3. Set the style attributes that make your lexical styles different.
The items on this page are in the following plugins: MBS Scintilla Plugin.