Platforms to show: All Mac Windows Linux Cross-Platform

Back to ScintillaControlMBS control.

Previous items Next items

ScintillaControlMBS.Representation(encodedCharacter as String) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Sets or gets a representation.

Some characters, such as control characters and invalid bytes, do not have a visual glyph or use a glyph that is hard to distinguish.

Control characters (characters with codes less than 32, or between 128 and 159 in some encodings) are displayed by Scintilla using their mnemonics inverted in a rounded rectangle. These mnemonics come from the early days of signalling, though some are still used (LF = Line Feed, BS = Back Space, CR = Carriage Return, for example).
For the low 'C0' values: "NUL", "SOH", "STX", "ETX", "EOT", "ENQ", "ACK", "BEL", "BS", "HT", "LF", "VT", "FF", "CR", "SO", "SI", "DLE", "DC1", "DC2", "DC3", "DC4", "NAK", "SYN", "ETB", "CAN", "EM", "SUB", "ESC", "FS", "GS", "RS", "US".
For the high 'C1' values: "PAD", "HOP", "BPH", "NBH", "IND", "NEL", "SSA", "ESA", "HTS", "HTJ", "VTS", "PLD", "PLU", "RI", "SS2", "SS3", "DCS", "PU1", "PU2", "STS", "CCH", "MW", "SPA", "EPA", "SOS", "SGCI", "SCI", "CSI", "ST", "OSC", "PM", "APC".
Invalid bytes are shown in a similar way with an 'x' followed by their value in hexadecimal, like "xFE".

Any character, including those normally displayed as mnemonics may be represented by a Unicode string inverted in a rounded rectangle.

For example, the Ohm sign Ω U+2126 looks very similar to the Greek Omega character Ω U+03C9 so, for the UTF-8 encoding, to distinguish the Ohm sign as "U+2126 Ω" this call could be made: Representation("Ω", "U+2126 Ω")

The encodedCharacter parameter is a string of the bytes for one character in the current encoding. This can not be used to set a representation for multiple-character strings.
The representation parameter is an UTF-8 string with a maximum length of 200 bytes.

One exception to the single character restriction is that the two character sequence "CRLF" (Carriage Return + Line Feed) can have a representation that is visible in line end viewing (ViewEOL property) mode. If there is no representation for "CRLF" then the individual 'CR' and 'LF' representations will be seen.

The NULL (0) character is a special case and specified as an empty string.
(Read and Write computed property)

ScintillaControlMBS.RepresentationAppearance(encodedCharacter as String) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The appearance may be changed using these flags.

If a colour is set and the appearance is set without RepresentationColour() then the representation will show in the colour of the underlying text.
(Read and Write computed property)

ScintillaControlMBS.RepresentationColour(encodedCharacter as String) as Color

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The colour and translucency of a representation may be set.

(Read and Write computed property)

ScintillaControlMBS.ResetElementColour(element 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 the element colour returning to the default colour or set of colours.

ScintillaControlMBS.RotateSelection

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Makes the next selection be the main selection.

ScintillaControlMBS.ScrollCaret

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 position (this is the caret if there is no selection) is not visible, the view is scrolled to make it visible according to the current caret policy.

ScintillaControlMBS.ScrollRange(secondary as Integer, primary as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position.

The behaviour is similar to ScrollCaret with the primary position used instead of the caret. An effort is then made to ensure that the secondary position and range between are also visible. This may be used to make a search match visible.

ScintillaControlMBS.ScrollToEnd

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.

The ScrollToEnd commands scroll the document to the end without changing the selection. These commands match OS X platform conventions for the behaviour of the home and end keys. Scintilla can be made to match OS X applications by binding the home and end keys to these commands.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.ScrollToStart

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.

The ScrollToStart commands scroll the document to the start without changing the selection. These commands match OS X platform conventions for the behaviour of the home and end keys. Scintilla can be made to match OS X applications by binding the home and end keys to these commands.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.SearchAnchor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Sets the search start point used by SearchNext and SearchPrev to the start of the current selection, that is, the end of the selection that is nearer to the start of the document.

You should always call this before calling either of SearchNext or SearchPrev.

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.

Previous items Next items

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


💬 Ask a question or report a problem
The biggest plugin in space...