Platforms to show: All Mac Windows Linux Cross-Platform
Back to ScintillaControlMBS control.
ScintillaControlMBS.SetFoldMarginHighlightColor(useSetting as boolean, value as Color)
Function:
The colour of the fold margin highlight.
Notes:
Defaults to system color for this.
The FoldMarginColor and the FoldMarginHighlightColor colors are used together to draw the chequerboard pattern in the folder margin.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes:
Defaults to system color for this.
The FoldMarginColor and the FoldMarginHighlightColor colors are used together to draw the chequerboard pattern in the folder margin.
ScintillaControlMBS.SetHotspotActiveBackColor(useSetting as boolean, value as Color)
Function:
Sets background color for hotspot.
Notes: 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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: 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.
ScintillaControlMBS.SetHotspotActiveForeColor(useSetting as boolean, value as Color)
Function:
Sets foreground color for hotspot.
Notes: 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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: 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.
ScintillaControlMBS.SetSavePoint
Function:
This method tells Scintilla that the current state of the document is unmodified.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes:
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.
ScintillaControlMBS.SetSel(anchor as Integer, caret as Integer)
Function:
Sets both the anchor and the current position.
Notes: 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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: 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.
ScintillaControlMBS.SetSelBackColor(useSetting as boolean, value as Color)
Function:
You can choose to override the default selection colouring.
Example:
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Example:
// use highlight color for selection and white text
dim c as ScintillaControlMBS // your control
c.SetSelBackColor(True, Color.HighlightColor)
c.SetSelForeColor(True, Color.White)
ScintillaControlMBS.SetSelection(caret as Integer, anchor as Integer)
Function:
Set a single selection from anchor to caret as the only selection.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.SetSelForeColor(useSetting as boolean, value as Color)
Function:
You can choose to override the default selection colouring.
Example:
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Example:
// use highlight color for selection and white text
dim c as ScintillaControlMBS // your control
c.SetSelBackColor(True, Color.HighlightColor)
c.SetSelForeColor(True, Color.White)
ScintillaControlMBS.setStatusText(Text as String)
Function:
Sets message of status field.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ❌ No | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.SetStyling(length as Integer, style as ScintillaStyleMBS)
Function:
Sets the style of length characters starting at the styling position and then increases the styling position by length, ready for the next call.
Notes: StartStyling should be called before the first call to this.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: StartStyling should be called before the first call to this.
See also:
ScintillaControlMBS.SetStyling(start as Integer, length as Integer, style as ScintillaStyleMBS)
Function:
Sets the style of length characters starting at the styling position and then increases the styling position by length, ready for the next call.
Notes: StartStyling should be called before the first call to this.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: StartStyling should be called before the first call to this.
See also:
ScintillaControlMBS.SetStylingEx(Styles as MemoryBlock)
Function:
Sets styling for a range of text.
Notes: 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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: 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.
ScintillaControlMBS.SetTargetRange(start as Integer, ende as Integer)
Function:
Set the start and end of the target.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.SetVisiblePolicy(visiblePolicy as Integer, visibleSlop as Integer)
Function:
This determines how the vertical positioning is determined when EnsureVisibleEnforcePolicy is called.
Notes: It takes kVisiblePolicySlop and kVisiblePolicyStrict flags for the visiblePolicy parameter. It is similar in operation to SetYCaretPolicy.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: It takes kVisiblePolicySlop and kVisiblePolicyStrict flags for the visiblePolicy parameter. It is similar in operation to SetYCaretPolicy.
ScintillaControlMBS.SetWhitespaceBackColor(useSetting as boolean, value as Color)
Function:
Sets background color for white space.
Notes: 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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: 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.
ScintillaControlMBS.SetWhitespaceForeColor(useSetting as boolean, value as Color)
Function:
Sets foreground color for white space.
Notes: 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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: 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.
ScintillaControlMBS.SetXCaretPolicy(caretPolicy as Integer, caretSlop as Integer)
Function:
Sets the caret policy.
Notes:
See kCaretPolicy* constants.
or going into the UZ) display is..."
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes:
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 |
ScintillaControlMBS.SetYCaretPolicy(caretPolicy as Integer, caretSlop as Integer)
Function:
Sets the caret policy.
Notes:
See kCaretPolicy* constants.
or going into the UZ) display is..."
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes:
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 |
ScintillaControlMBS.ShowLines(lineStart as Integer, lineEnd as Integer)
Function:
Marks a range of lines as visible and then redraw the display.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.StartRecord
Function:
Turn macro recording on.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.StartStyling(start as Integer)
Function:
This prepares for styling by setting the styling position start to start at.
Notes: After StartStyling, send multiple SetStyling messages for each lexical entity to style or send SetStylingEX to style in blocks.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: After StartStyling, send multiple SetStyling messages for each lexical entity to style or send SetStylingEX to style in blocks.
ScintillaControlMBS.StopRecord
Function:
Turn macro recording off.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.StringOfSpan(Span as ScintillaSpanMBS) as String
Function:
Queries text for given span.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.StutteredPageDown
Function:
The method to perform the action when this key is pressed.
Notes: You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.StutteredPageDownExtend
Function:
The method to perform the action when this key is pressed.
Notes:
This action extends the selection.
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes:
This action extends the selection.
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.StutteredPageUp
Function:
The method to perform the action when this key is pressed.
Notes: You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.StutteredPageUpExtend
Function:
The method to perform the action when this key is pressed.
Notes:
This action extends the selection.
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes:
This action extends the selection.
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.
ScintillaControlMBS.Style(index as Integer) as ScintillaStyleMBS
Function:
Queries style with given index.
Notes: Index ranges from 0 to 255.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes: Index ranges from 0 to 255.
ScintillaControlMBS.StyleAt(position as Integer) as ScintillaStyleMBS
Function:
This returns the style at pos in the document, or 0 if pos is negative or past the end of the document.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
ScintillaControlMBS.StyleClearAll
Function:
This message sets all styles to have the same attributes as the default style.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Notes:
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.
