Platforms to show: All Mac Windows Linux Cross-Platform

Back to ScintillaControlMBS control.

Previous items Next items

ScintillaControlMBS.SearchInTarget(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 searches for the first occurrence of a text string in the target defined by TargetStart and TargetEnd.

The search is modified by the search flags set by SearchFlags property. If the search succeeds, the target is set to the found text and the return value is the position of the start of the matching text. If the search fails, the result is -1.

See Tag() for regular expression results.

Character Description
.Matches any character
\(This marks the start of a region for tagging a match.
\)This marks the end of a tagged region.
\nWhere n is 1 through 9 refers to the first through ninth tagged region when replacing. For example, if the search string was Fred\([1-9]\)XXX and the replace string was Sam\1YYY, when applied to Fred2XXX this would generate Sam2YYY. \0 refers to all of the matching text.
\<This matches the start of a word using Scintilla's definitions of words.
\>This matches the end of a word using Scintilla's definition of words.
\xThis allows you to use a character x that would otherwise have a special meaning. For example, \[ would be interpreted as [ and not as the start of a character set.
[...]This indicates a set of characters, for example, [abc] means any of the characters a, b or c. You can also use ranges, for example [a-z] for any lower case character.
[^...]The complement of the characters in the set. For example, [^A-Za-z] means any character except an alphabetic character.
^This matches the start of a line (unless used inside a set, see above).
$This matches the end of a line.
*This matches 0 or more times. For example, Sa*m matches Sm, Sam, Saam, Saaam and so on.
+This matches 1 or more times. For example, Sa+m matches Sam, Saam, Saaam and so on.

ScintillaControlMBS.SearchNext(searchFlags as Integer, 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
SearchNext and SearchPrev search for the next and previous occurrence of the search string pointed at by text.

The search is modified by the searchFlags.
See kFindOption* constants.

The return value is -1 if nothing is found, otherwise the return value is the start position of the matching text. The selection is updated to show the matched text, but is not scrolled into view.

ScintillaControlMBS.SearchPrev(searchFlags as Integer, 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
SearchNext and SearchPrev search for the next and previous occurrence of the search string pointed at by text.

The search is modified by the searchFlags.
See kFindOption* constants.

The return value is -1 if nothing is found, otherwise the return value is the start position of the matching text. The selection is updated to show the matched text, but is not scrolled into view.

ScintillaControlMBS.SelectAll

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This selects all the text in the document.

The current position is not scrolled into view.

ScintillaControlMBS.SelectionDuplicate

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.

ScintillaControlMBS.SelectionNAnchor(selection as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Set or query the position and amount of virtual space for the anchor of each already existing selection.

Selection parameter is zero based.
(Read and Write computed property)

ScintillaControlMBS.SelectionNAnchorVirtualSpace(selection as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Set or query the position and amount of virtual space for the caret of each already existing selection.

Selection parameter is zero based.
(Read and Write computed property)

ScintillaControlMBS.SelectionNCaret(selection as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Set or query the position and amount of virtual space for the caret of each already existing selection.

Selection parameter is zero based.
(Read and Write computed property)

ScintillaControlMBS.SelectionNCaretVirtualSpace(selection as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Set or query the position and amount of virtual space for the caret of each already existing selection.

Selection parameter is zero based.
(Read and Write computed property)

ScintillaControlMBS.SelectionNEnd(selection as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
et or query the end position of each already existing selection.

Mostly of use to query each range for its text. The selection parameter is zero-based.
(Read and Write computed property)

ScintillaControlMBS.SelectionNEndVirtualSpace(selection 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
Query the virtual space at start and end of each selection.

Selection parameter is zero based.

ScintillaControlMBS.SelectionNStart(selection as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Set or query the start position of each already existing selection.

Mostly of use to query each range for its text. The selection parameter is zero-based.
(Read and Write computed property)

ScintillaControlMBS.SelectionNStartVirtualSpace(selection 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
Query the virtual space at start and end of each selection.

Selection parameter is zero based.

ScintillaControlMBS.SetAdditionalSelBackColor(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
Sets background color for additional selection.

Modify the appearance of additional selections so that they can be differentiated from the main selection.

ScintillaControlMBS.SetAdditionalSelForeColor(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
Sets foreground color for additional selection.

Modify the appearance of additional selections so that they can be differentiated from the main selection.

ScintillaControlMBS.SetCharsDefault

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Use the default sets of word and whitespace characters.

This sets whitespace to space, tab and other characters with codes less than &h20, with word characters set to alphanumeric and '_'.

ScintillaControlMBS.SetDocument(otherControl as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Sets document for this control to be same as the other control.

Using this method you can allow multiple controls to share same document, e.g. for split views.

Pass nil to create new empty document.

This method does the following:
1. It removes the current window from the list held by the current document.
2. It reduces the reference count of the current document by 1.
3. If the reference count reaches 0, the document is deleted.
4. doc is set as the new document for the window.
5. If doc was 0, a new, empty document is created and attached to the window.
6. If doc was not 0, its reference count is increased by 1.

Please pass either ScintillaControlMBS or DesktopScintillaControlMBS here to point to new control.

After you assigned new document, please configure styles as needed.

ScintillaControlMBS.SetEmptySelection(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
This removes any selection and sets the caret at caret.

The caret is not scrolled into view.

ScintillaControlMBS.SetFoldFlags(FoldFlags as Integer)

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

In addition to showing markers in the folding margin, you can indicate folds to the user by drawing lines in the text area. The lines are drawn in the kElementFoldLine colour if set. If it is not set then the foreground colour set for kStylesCommonDefault is used.

ScintillaControlMBS.SetFoldMarginColor(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
The colour of the fold margin.
Example

// turn folder margin to red
c.SetFoldMarginColor(True, Color.red)

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.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
The colour of the fold margin highlight.

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)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Sets background color for hotspot.

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)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Sets foreground color for hotspot.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This method tells Scintilla that the current state of the document is unmodified.

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)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Sets both the anchor and the current position.

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)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
You can choose to override the default selection colouring.
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)

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.

ScintillaControlMBS.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
Set a single selection from anchor to caret as the only selection.

ScintillaControlMBS.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
You can choose to override the default selection colouring.
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)

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.

ScintillaControlMBS.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
Sets message of status field.

ScintillaControlMBS.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
Sets the style of length characters starting at 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.

See also:

ScintillaControlMBS.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
Sets the style of length characters starting at 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.

See also:

ScintillaControlMBS.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
Sets styling for a range of text.

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)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Set the start and end of the target.

ScintillaControlMBS.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
This determines how the vertical positioning is determined when EnsureVisibleEnforcePolicy is called.

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)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Sets background color for white space.

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)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Sets foreground color for white space.

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)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Sets the caret policy.

See kCaretPolicy* constants.

slopstrictjumpsevenCaret can go to the margin"On reaching limit (going out of visibility
or going into the UZ) display is..."
0000Yesmoved to put caret on top/on right
0001Yesmoved by one position
0010Yesmoved to put caret on top/on right
0011Yescentred on the caret
01-0Caret is always on top/on right of display-
01-1No, caret is always centred-
1000Yesmoved to put caret out of the asymmetrical UZ
1001Yesmoved to put caret out of the UZ
1010Yesmoved to put caret at 3UZ of the top or right margin
1011Yesmoved to put caret at 3UZ of the margin
11-0Caret is always at UZ of top/right margin-
1101No, kept out of UZmoved by one position
1110No, kept out of UZmoved to put caret at 3UZ of the margin

ScintillaControlMBS.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
Sets the caret policy.

See kCaretPolicy* constants.

slopstrictjumpsevenCaret can go to the margin"On reaching limit (going out of visibility
or going into the UZ) display is..."
0000Yesmoved to put caret on top/on right
0001Yesmoved by one position
0010Yesmoved to put caret on top/on right
0011Yescentred on the caret
01-0Caret is always on top/on right of display-
01-1No, caret is always centred-
1000Yesmoved to put caret out of the asymmetrical UZ
1001Yesmoved to put caret out of the UZ
1010Yesmoved to put caret at 3UZ of the top or right margin
1011Yesmoved to put caret at 3UZ of the margin
11-0Caret is always at UZ of top/right margin-
1101No, kept out of UZmoved by one position
1110No, kept out of UZmoved to put caret at 3UZ of the margin

ScintillaControlMBS.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
Marks a range of lines as visible and then redraw the display.

ScintillaControlMBS.StartRecord

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Turn macro recording on.

ScintillaControlMBS.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
This prepares for styling by setting the styling position start to start at.

After StartStyling, send multiple SetStyling messages for each lexical entity to style or send SetStylingEX to style in blocks.

ScintillaControlMBS.StopRecord

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Turn macro recording off.

ScintillaControlMBS.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
Queries text for given span.

ScintillaControlMBS.StutteredPageDown

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.

ScintillaControlMBS.StutteredPageDownExtend

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.

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

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.

ScintillaControlMBS.StutteredPageUpExtend

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.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Queries style with given index.

Index ranges from 0 to 255.

ScintillaControlMBS.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
This returns the style at pos in the document, or 0 if pos is negative or past the end of the document.

ScintillaControlMBS.StyleClearAll

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 all styles to have the same attributes as the default style.

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.

Previous items Next items

The items on this page are in the following plugins: MBS Scintilla Plugin.


The biggest plugin in space...