Platforms to show: All Mac Windows Linux Cross-Platform

Back to ScintillaControlMBS control.

Previous items Next items

ScintillaControlMBS.CharRightExtend

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

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Scintilla remembers the x value of the last position horizontally moved to explicitly by the user and this value is then used when moving vertically such as by using the up and down keys.

This message sets the current x position of the caret as the remembered value.

ScintillaControlMBS.Clear

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Clears text from current selection.

ScintillaControlMBS.ClearAll

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Unless the document is read-only, this deletes all the text.

ScintillaControlMBS.ClearAllCmdKeys

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This command removes all keyboard command mapping by setting an empty mapping table.

ScintillaControlMBS.ClearAllRepresentations

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Reset representations to defaults.

ScintillaControlMBS.ClearCmdKey(keyDefinition 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 makes the given key definition do nothing by assigning the action Null to it.
Example

dim c as ScintillaControlMBS
// disable tab key for editor
c.ClearCmdKey c.kKeysTab

ScintillaControlMBS.ClearDocumentStyle

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
When wanting to completely restyle the document, for example after choosing a lexer, the ClearDocumentStyle method can be used to clear all styling information and reset the folding state.

ScintillaControlMBS.ClearRegisteredImages

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Clears all registered images.

ScintillaControlMBS.ClearRepresentation(encodedCharacter as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Reset this representation to default.

ScintillaControlMBS.ClearSelections

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 empty selection at 0 as the only selection.

ScintillaControlMBS.ClearTabStops(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
Clears explicit tabstops on a line.

Changing tab stops produces a ChangeTabStops event.

ScintillaControlMBS.Colourise(start as Integer, ende as Integer = -1)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This requests the current lexer or the container (if the lexer is set to nil) to style the document between start and end.

If end is -1, the document is styled from start to the end. If the "fold" property is set to "1" and your lexer or container supports folding, fold levels are also set. This method causes a redraw.

ScintillaControlMBS.ColouriseAll

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This requests the current lexer or the container (if the lexer is set to nil) to style the document.

If the "fold" property is set to "1" and your lexer or container supports folding, fold levels are also set. This method causes a redraw.

ScintillaControlMBS.Column(pos 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 method returns the column number of a position pos within the document taking the width of tabs into account.

This returns the column number of the last tab on the line before pos, plus the number of characters between the last tab and pos. If there are no tab characters on the line, the return value is the number of characters up to the position on the line. In both cases, double byte characters count as a single character. This is probably only useful with monospaced fonts.

ScintillaControlMBS.ContractedFoldNext(lineStart 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
Search efficiently for lines that are contracted fold headers.

This is useful when saving the user's folding when switching documents or saving folding with a file. The search starts at line number lineStart and continues forwards to the end of the file. lineStart is returned if it is a contracted fold header otherwise the next contracted fold header is returned. If there are no more contracted fold headers then -1 is returned.

ScintillaControlMBS.ConvertEOLs(EndOfLineMode as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Converts end of line characters for the document.

Scintilla can handle the major line end conventions and, depending on settings and the current lexer also support additional Unicode line ends.
Scintilla can interpret any of the Macintosh (CR), Unix (LF) and Windows (CR+LF) line ends. When the user presses the Enter key, one of these line end strings is inserted into the buffer. The default is CRL+LF in Windows and LF in Unix, but this can be changed with the EOLMode proeprty. You can also convert the entire document to one of these line endings with ConvertEOLs. Finally, you can choose to display the line endings with ViewEOL.

For the UTF-8 encoding, three additional Unicode line ends, Next Line (NEL=U+0085), Line Separator (LS=U+2028), and Paragraph Separator (PS=U+2029) may optionally be interpreted when Unicode line ends is turned on and the current lexer also supports Unicode line ends.

ScintillaControlMBS.Copy

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Copy current text selection and puts text on the clipboard.

ScintillaControlMBS.CopyAllowLine

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Works the same as Copy() except that if the selection is empty then the current line is copied.

On Windows, an extra "MSDEVLineSelect" marker is added to the clipboard which is then used in SCI_PASTE to paste the whole line before the current line.

ScintillaControlMBS.CopyRange(RangeStart as Integer, RangeEnd as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Copies a range of text from the document to the system clipboard.

ScintillaControlMBS.CopyText(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
Copies a supplied piece of text to the system clipboard.

ScintillaControlMBS.CountCharacters(start as Integer, ende 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
Returns the number of whole characters between two positions.

ScintillaControlMBS.CountCodeUnits(start as Integer, ende 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
Returns the number of whole characters between two positions.

This counts in UTF-16 code units.

ScintillaControlMBS.CreateLoader(bytes as Integer = 1000000, documentOptions as Integer = 0) as ScintillaLoaderMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Creates a loader object.

An application can load all of a file into a buffer it allocates on a background thread and then add the data in that buffer into a Scintilla document on the user interface thread. That technique uses extra memory to store a complete copy of the file and also means that the time that Scintilla takes to perform initial line end discovery blocks the user interface.

To avoid these issues, a loader object may be created and used to load the file.
Returns an object that supports the ScintillaLoaderMBS interface which can be used to load data and then be turned into a Scintilla document object for attachment to a view object. The bytes argument determines the initial memory allocation for the document as it is more efficient to allocate once rather than rely on the buffer growing as data is added. If CreateLoader fails then nil is returned.

See kDocumentOption* constants.

ScintillaControlMBS.Cut

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Cuts current text selection and puts text on the clipboard.

ScintillaControlMBS.DeleteBack

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

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.DeleteRange(start as Integer, lengthDelete as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Deletes a range of text in the document.

ScintillaControlMBS.DelLineLeft

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

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

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

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

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.

ScintillaControlMBS.DescribeProperty(Key as String) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Information may be retrieved about the properties that can be set for the current lexer.

ScintillaControlMBS.DocLineFromVisible(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.

This method returns the document line number that corresponds to a display line (counting the display line of the first line in the document as 0). If displayLine is less than or equal to 0, the result is 0. If displayLine is greater than or equal to the number of displayed lines, the result is the number of lines in the document.

ScintillaControlMBS.DocumentEnd

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

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

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

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.DropSelectionN(selection 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 there are multiple selections, remove the indicated selection.

If this was the main selection then make the previous selection the main and if it was the first then the last selection becomes main. If there is only one selection, or there is no selection selection, then there is no effect.

ScintillaControlMBS.EditToggleOvertype

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.ElementAllowsTranslucent(element 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
Returns true when the element currently allows translucent drawing when an alpha component is included.

This may change based on circumstances - different platforms or graphics technologies may implement translucency and newer versions of Scintilla may implement translucency for elements that did not previously support it.

ScintillaControlMBS.ElementBaseColour(element as Integer) as Color

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Returns the default colour of an element.

This may be a value defined by Scintilla or it may be derived from the operating system or platform. Which values are set from the operating system may differ between operating systems and operating system versions. When undefined the return value is 0 which is equivalent to completely transparent black. These colours may be useful when defining styles with similarities such as synthesizing dark mode styles that use the same colours as the system.

On Win32, autocompletion list colours like kElementList are currently provided by the platform layer and on Cocoa, selection background colours like kElementSelectionBack are provided.

ScintillaControlMBS.ElementColour(element as Integer) as Color

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This changes the colour of the indicated visual element overriding any current colour.

If the element supports translucency, then the alpha portion of the value is used. An opaque alpha value (&hff) should always be included when an opaque colour is desired as the value 0 is completely transparent and thus invisible.
(Read and Write computed property)

ScintillaControlMBS.ElementIsSet(element 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
Returns true when an element colour has been set.

When false indicates that a default colour or set of colours is displayed.

ScintillaControlMBS.EmptyUndoBuffer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This command tells Scintilla to forget any saved undo or redo history.

It also sets the save point to the start of the undo buffer, so the document will appear to be unmodified. This does not cause the SavePointReached event to be sent to the container.

ScintillaControlMBS.EndStyled as Integer

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

Scintilla keeps a record of the last character that is likely to be styled correctly. This is moved forwards when characters after it are styled and moved backwards if changes are made to the text of the document before it. Before drawing text, this position is checked to see if any styling is needed and, if so, a StyleNeeded event is sent to the container. The container can send EndStyled to work out where it needs to start styling. Scintilla will always ask to style whole lines.

ScintillaControlMBS.EndUndoAction

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Ends a composed undo action.

Call BeginUndoAction to mark the beginning and EndUndoAction to end of a set of operations that you want to undo all as one operation but that you have to generate as several operations. Alternatively, you can use these to mark a set of operations that you do not want to have combined with the preceding or following operations if they are undone.

ScintillaControlMBS.EnsureVisible(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
A line may be hidden because more than one of its parent lines is contracted.

Both these message travels up the fold hierarchy, expanding any contracted folds until they reach the top level. The line will then be visible. If you use EnsureVisibleEnforcePolicy(), the vertical caret policy set by VisiblePolicy() is then applied.

Previous items Next items

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


The biggest plugin in space...