Platforms to show: All Mac Windows Linux Cross-Platform

Back to DesktopScintillaControlMBS control.

Previous items Next items

DesktopScintillaControlMBS.StyleResetDefault

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This message resets default style (kStylesCommonDefault) to its state when Scintilla was initialised.

DesktopScintillaControlMBS.SupportsFeature(feature as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Different platforms support different features and SupportsFeature can be used to check which are currently available.

For example, on Win32, Direct2D supports drawing translucent lines but GDI does not so SupportsFeature(kSupportsTranslucentStroke) will return 1 for Direct2D and 0 for GDI. Its possible that translucent line drawing will be implemented in a future revision to the GDI platform layer or will be implemented on particular Windows versions. This call allows applications to tailor their settings: perhaps displaying a box with translucent coloured fill on Direct2D but a hollow box on GDI.

See kSupport* constants.

DesktopScintillaControlMBS.SwapMainAnchorCaret

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Moves the caret to the opposite end of the main selection.

DesktopScintillaControlMBS.Tab

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.

DesktopScintillaControlMBS.Tag(tagNumber as Integer) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Discover what text was matched by tagged expressions in a regular expression search.

This is useful if the application wants to interpret the replacement string itself.

DesktopScintillaControlMBS.TargetFromSelection

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

DesktopScintillaControlMBS.TargetWholeDocument

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

DesktopScintillaControlMBS.TextHeight(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
This returns the height in pixels of a particular line.

Currently all lines are the same height.

DesktopScintillaControlMBS.ToggleCaretSticky

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
These method set, get or toggle the caretSticky setting which controls when the last position of the caret on the line is saved.

When set to kCaretStickyOff (0), the sticky flag is off; all text changes (and all caret position changes) will remember the caret's new horizontal position when moving to different lines. This is the default.
When set to kCaretStickyOn (1), the sticky flag is on, and the only thing which will cause the editor to remember the horizontal caret position is moving the caret with mouse or keyboard (left/right arrow keys, home/end keys, etc).
When set to kCaretStickyWhiteSpace (2), the caret acts like mode 0 (sticky off) except under one special case; when space or tab characters are inserted. (Including pasting only space/tabs -- undo, redo, etc. do not exhibit this behaviour..).
ToggleCaretSticky switches from kCaretStickyOn and kCaretStickyWhiteSpace to kCaretStickyOff and from kCaretStickyOff to kCaretStickyOn.

DesktopScintillaControlMBS.ToggleFold(line as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Toggle a folder at the given line.

Each fold point may be either expanded, displaying all its child lines, or contracted, hiding all the child lines. This method toggle the folding state of the given line as long as it has the kFoldLevelHeaderFlag set. This method take care of folding or expanding all the lines that depend on the line. The display updates after this method.

DesktopScintillaControlMBS.ToggleFoldShowText(Line as Integer, text as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Toggle a folder at the given line with hsowing text.

Each fold point may be either expanded, displaying all its child lines, or contracted, hiding all the child lines. This method toggle the folding state of the given line as long as it has the kFoldLevelHeaderFlag set. This method take care of folding or expanding all the lines that depend on the line. The display updates after this method.

An optional text tag may be shown to the right of the folded text with the text argument to ToggleFoldShowText. The default text for all header lines can be set with DefaultFoldDisplayText. The text is drawn with the kStylesCommonFoldDisplayText style.

DesktopScintillaControlMBS.Undo

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Undoes one action.

Or if the undo buffer has reached a EndUndoAction point, all the actions back to the corresponding BeginUndoAction.

Scintilla has multiple level undo and redo. It will continue to collect undoable actions until memory runs out. Scintilla saves actions that change the document. Scintilla does not save caret and selection movements, view scrolling and the like. Sequences of typing or deleting are compressed into single transactions to make it easier to undo and redo at a sensible level of detail. Sequences of actions can be combined into transactions that are undone as a unit. These sequences occur between BeginUndoAction and EndUndoAction messages. These transactions can be nested and only the top-level sequences are undone as units.

DesktopScintillaControlMBS.UpperCase

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.

DesktopScintillaControlMBS.UsePopUp(popUpMode as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Clicking the wrong button on the mouse pops up a short default editing menu.

This may be turned off with UsePopup(kPopUpNever). If you turn it off, context menu commands (in Windows, WM_CONTEXTMENU) will not be handled by Scintilla, so the parent of the Scintilla window will have the opportunity to handle the message.

DesktopScintillaControlMBS.UserListShow(listType as Integer, itemList as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Shows an user list.

User lists use the same internal mechanisms as autocompletion lists, and all the calls listed for autocompletion work on them; you cannot display a user list at the same time as an autocompletion list is active. They differ in the following respects:

  • The AutoCChooseSingle method has no effect.

  • When the user makes a selection you are sent a UserListSelection event rather than AutoCompleteSelection.

BEWARE: if you have set fillup characters or stop characters, these will still be active with the user list, and may result in items being selected or the user list cancelled due to the user typing into the editor.


The listType parameter is carried to the events. It must be greater than 0 as this is how Scintilla tells the difference between an autocompletion list and a user list. If you have different types of list, for example a list of buffers and a list of macros, you can use listType to tell which one has returned a selection.

DesktopScintillaControlMBS.VCHome

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.

DesktopScintillaControlMBS.VCHomeDisplay

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.

DesktopScintillaControlMBS.VCHomeDisplayExtend

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.

DesktopScintillaControlMBS.VCHomeExtend

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.

DesktopScintillaControlMBS.VCHomeRectExtend

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.

DesktopScintillaControlMBS.VCHomeWrap

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.

DesktopScintillaControlMBS.VCHomeWrapExtend

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.

DesktopScintillaControlMBS.VerticalCentreCaret

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.

DesktopScintillaControlMBS.VisibleFromDocLine(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
When some lines are hidden and/or annotations are displayed, then a particular line in the document may be displayed at a different position to its document position.

If no lines are hidden and there are no annotations, this method returns docLine. Otherwise, this returns the display line (counting the very first visible line as 0). The display line of an invisible line is the same as the previous visible line. The display line number of the first line in the document is 0. If lines are hidden and docLine is outside the range of lines in the document, the return value is -1. Lines can occupy more than one display line if they wrap.

DesktopScintillaControlMBS.WordEndPosition(pos as Integer, onlyWordCharacters as boolean) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Returns the end of words using the same definition of words as used internally within Scintilla.

You can set your own list of characters that count as words with WordChars. The position sets the start or the search, which is forwards when searching for the end and backwards when searching for the start.

DesktopScintillaControlMBS.WordLeft

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.

DesktopScintillaControlMBS.WordLeftEnd

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 *End methods move between word ends instead of word starts.
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

DesktopScintillaControlMBS.WordLeftEndExtend

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 *End methods move between word ends instead of word starts.
This action extends the selection.
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

DesktopScintillaControlMBS.WordLeftExtend

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.

DesktopScintillaControlMBS.WordPartLeft

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 WordPart** commands are used to move between word segments marked by capitalisation (aCamelCaseIdentifier) or underscores (an_under_bar_ident).
You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

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...