Platforms to show: All Mac Windows Linux Cross-Platform

Back to ScintillaControlMBS control.

Previous items Next items

ScintillaControlMBS.MoveExtendsSelection as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This returns true if regular caret moves will extend or reduce the selection, false if not.

SetSelectionMode toggles this setting between on and off.
(Read only property)

ScintillaControlMBS.MultiPaste as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
How to do paste with multiple selection.

When pasting into multiple selections, the pasted text can go into just the main selection with kMultiPasteOnce=0 or into each selection with kMultiPasteEach=1. kMultiPasteOnce is the default.
(Read and Write property)

ScintillaControlMBS.MultipleSelection as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Enable or disable multiple selection.

When multiple selection is disabled, it is not possible to select multiple ranges by holding down the Ctrl key while dragging with the mouse.

There may be multiple selections active at one time. More selections are made by holding down the Ctrl key while dragging with the mouse. The most recent selection is the main selection and determines which part of the document is shown automatically. Any selection apart from the main selection is called an additional selection. The calls in the previous section operate on the main selection. There is always at least one selection. The selection can be simplified down to just the main selection by Cancel which is normally mapped to the Esc key.

Rectangular selections are handled as multiple selections although the original rectangular range is remembered so that subsequent operations may be handled differently for rectangular selections. For example, pasting a rectangular selection places each piece in a vertical column.

Virtual space is space beyond the end of each line. The caret may be moved into virtual space but no real space will be added to the document until there is some text typed or some other text insertion command is used.

When discontiguous selections are copied to the clipboard, each selection is added to the clipboard text in order with no delimiting characters. For rectangular selections the document's line end is added after each line's text. Rectangular selections are always copied from top line to bottom, not in the in order of selection.Virtual space is not copied.
(Read and Write property)

ScintillaControlMBS.NamedStyles as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Retrieve the number of named styles for the lexer.

(Read only property)

ScintillaControlMBS.NSView as Variant

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The Cocoa view for macOS.

Object is from NSViewMBS class.
(Read only property)

ScintillaControlMBS.Overtype as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
When overtype is enabled, each typed character replaces the character to the right of the text caret.

When overtype is disabled, characters are inserted at the caret. Returns true if overtyping is active, otherwise false will be returned.
(Read and Write property)

ScintillaControlMBS.PasteConvertEndings as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Whether to match end of line on pasting.

If this property is set then when text is pasted any line ends are converted to match the document's end of line mode as set with EOLMode. Defaults to true.
(Read and Write property)

ScintillaControlMBS.Position 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 current position.

This sets the current position and creates a selection between the anchor and the current position. The caret is not scrolled into view.
(Read and Write property)

ScintillaControlMBS.PositionCache 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 size in entries of the position cache.

The position cache stores position information for short runs of text so that their layout can be determined more quickly if the run recurs.
(Read and Write property)

ScintillaControlMBS.PrintColourMode 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 and get the method used to render coloured text on a printer that is probably using white paper.

It is especially important to consider the treatment of colour if you use a dark or black screen background. Printing white on black uses up toner and ink very many times faster than the other way around.
See kPrintOption* constants.
(Read and Write property)

ScintillaControlMBS.PrintMagnification as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Lets you to print at a different size than the screen font.

magnification is the number of points to add to the size of each screen font. A value of -3 or -4 gives reasonably small print.
(Read and Write property)

ScintillaControlMBS.PrintWrapMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Get and set the printer wrap mode.

wrapMode can be set to kWrapNone (0) or kWrapWord (1). The default is kWrapWord, which wraps printed output so that all characters fit into the print rectangle. If you set kWrapNone, each line of text generates one line of output and the line is truncated if it is too long to fit into the print area.
kWrapWord tries to wrap only between words as indicated by white space or style changes although if a word is longer than a line, it will be wrapped before the line end.
kWrapChar is not supported for printing.
(Read and Write property)

ScintillaControlMBS.PropertyNames as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Returns a string with all of the valid properties separated by LF.

If the lexer does not support this call then an empty string is returned.
(Read only property)

ScintillaControlMBS.PunctuationChars as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Similar to WordChars and WhiteSpaceChars, this message allows the user to define which chars Scintilla considers as punctuation.

(Read and Write property)

ScintillaControlMBS.ReadOnly as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Set and get the read-only flag for the document.

If you mark a document as read only, attempts to modify the text cause the ModifyAttemptReadOnly event.
(Read and Write property)

ScintillaControlMBS.RectangularSelectionAnchor 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 for the anchor of the rectangular selection.

After setting the rectangular selection, this is broken down into multiple selections, one for each line.
(Read and Write property)

ScintillaControlMBS.RectangularSelectionAnchorVirtualSpace 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 of the rectangular selection.

After setting the rectangular selection, this is broken down into multiple selections, one for each line.
(Read and Write property)

ScintillaControlMBS.RectangularSelectionCaret 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 for the caret of the rectangular selection.

After setting the rectangular selection, this is broken down into multiple selections, one for each line.

There may be multiple selections active at one time. More selections are made by holding down the Ctrl key while dragging with the mouse. The most recent selection is the main selection and determines which part of the document is shown automatically. Any selection apart from the main selection is called an additional selection. The calls in the previous section operate on the main selection. There is always at least one selection. The selection can be simplified down to just the main selection by Cancel which is normally mapped to the Esc key.

Rectangular selections are handled as multiple selections although the original rectangular range is remembered so that subsequent operations may be handled differently for rectangular selections. For example, pasting a rectangular selection places each piece in a vertical column.

Virtual space is space beyond the end of each line. The caret may be moved into virtual space but no real space will be added to the document until there is some text typed or some other text insertion command is used.

When discontiguous selections are copied to the clipboard, each selection is added to the clipboard text in order with no delimiting characters. For rectangular selections the document's line end is added after each line's text. Rectangular selections are always copied from top line to bottom, not in the in order of selection.Virtual space is not copied.
(Read and Write property)

ScintillaControlMBS.RectangularSelectionCaretVirtualSpace 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 the rectangular selection.

After setting the rectangular selection, this is broken down into multiple selections, one for each line.
(Read and Write property)

ScintillaControlMBS.RectangularSelectionModifier as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
On GTK and Qt, the key used to indicate that a rectangular selection should be created when combined with a mouse drag can be set.

The three possible values are kKeyModCtrl=2, kKeyModAlt=4 (default) or kKeyModSuper=8. Since kKeyModAlt may already be used by a window manager, the window manager may need configuring to allow this choice. kKeyModSuper is often a system dependent modifier key such as the Left Windows key on a Windows keyboard or the Command key on a Mac.
(Read and Write property)

ScintillaControlMBS.ScrollWidth as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
For performance, Scintilla does not measure the display width of the document to determine the properties of the horizontal scroll bar.

Instead, an assumed width is used. These messages set and get the document width in pixels assumed by Scintilla. The default value is 2000. To ensure the width of the currently visible lines can be scrolled use ScrollWidthTracking.
(Read and Write property)

ScintillaControlMBS.ScrollWidthTracking as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
If scroll width tracking is enabled then the scroll width is adjusted to ensure that all of the lines currently displayed can be completely scrolled.

This mode never adjusts the scroll width to be narrower.
(Read and Write property)

ScintillaControlMBS.SearchFlags as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
These get and set the searchFlags used by SearchInTarget.

There are several option flags including a simple regular expression search.
See kFindOption* constants.
(Read and Write property)

ScintillaControlMBS.SelAlpha as Integer

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 selection alpha value.

(Read and Write property)

ScintillaControlMBS.SelectedText as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This copies the currently selected text.

This allows for rectangular and discontiguous selections as well as simple selections. See Multiple Selection for information on how multiple and rectangular selections and virtual space are copied.
(Read only property)

ScintillaControlMBS.SelectionEmpty as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Return true if every selected range is empty else false.

This can be used as CanCopy or CanCut for building menu.
(Read only property)

ScintillaControlMBS.SelectionEnd 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 end position of the selection.

SelectionStart and SelectionEnd return the start and end of the selection without regard to which end is the current position and which is the anchor. SelectionStart returns the smaller of the current position or the anchor position. SelectionEnd returns the larger of the two values.

Assign new value to set the selection based on the assumption that the anchor position is less than the current position.
(Read and Write property)

ScintillaControlMBS.SelectionIsRectangle as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This returns true if the current selection is in rectangle mode, false if not.

(Read only property)

ScintillaControlMBS.SelectionLayer 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 selection background can be drawn translucently over the text or opaquely on the base layer.

See kLayer* constants.
(Read and Write property)

ScintillaControlMBS.SelectionMode 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 selection mode.

Can be stream (kSelectionModeStream=0) or rectangular (kSelectionModeRectangle=1) or by lines (kSelectionModeLines=2) or thin rectangular (kSelectionModeThin=3). When set in these modes, regular caret moves will extend or reduce the selection, until the mode is cancelled by a call with same value or with Cancel. The get function returns the current mode even if the selection was made by mouse or with regular extended moves. SC_SEL_THIN is the mode after a rectangular selection has been typed into and ensures that no characters are selected.
(Read and Write property)

ScintillaControlMBS.Selections as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Return the number of selections currently active.

There is always at least one selection.
(Read only property)

ScintillaControlMBS.SelectionSpan as ScintillaSpanMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Queries selection start and end as a span object.

(Read only property)

ScintillaControlMBS.SelectionStart 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 start position of the selection.

SelectionStart and SelectionEnd return the start and end of the selection without regard to which end is the current position and which is the anchor. SelectionStart returns the smaller of the current position or the anchor position. SelectionEnd returns the larger of the two values.

Assign new value to set the selection based on the assumption that the anchor position is less than the current position.
(Read and Write property)

ScintillaControlMBS.SelEOLFilled as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The selection can be drawn up to the right hand border by setting this property.

(Read and Write property)

ScintillaControlMBS.ShowInfoBar as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Whether to show info bar on macOS.

Defaults to true.
The info bar allows you to show a status message and to do zoom levels.
(Read and Write property)

ScintillaControlMBS.Status as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
If an error occurs, Scintilla may set an internal error number that can be retrieved with this property.

To clear the error status call SCI_SETSTATUS(0). Status values from 1 to 999 are errors and status kStatusWarnStart (1000) and above are warnings.
See kStatus* constants.
(Read and Write property)

ScintillaControlMBS.TabDrawMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Get and set how tab characters are drawn when white space is visible.

See kTabDrawMode* constants.
(Read and Write property)

ScintillaControlMBS.TabIndents as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Whether tab indents.

Inside indentation white space, the tab and backspace keys can be made to indent and unindent rather than insert a tab character or delete a character with the TabIndents and BackSpaceUnIndents functions.
(Read and Write property)

ScintillaControlMBS.TabMinimumWidth 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 minimum size of a tab in pixels to ensure that the tab can be seen.

The default value is 2. This is particularly useful with proportional fonts with fractional widths where the character before the tab may end a fraction of a pixel before a tab stop, causing the tab to only be a fraction of a pixel wide without this setting. Where displaying a miniaturized version of the document, setting this to 0 may make the miniaturized version lay out more like the normal size version.
(Read and Write property)

ScintillaControlMBS.TabWidth 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 size of a tab as a multiple of the size of a space character in kStylesCommonDefault.

The default tab width is 8 characters. There are no limits on tab sizes, but values less than 1 or large values may have undesirable effects.
(Read and Write property)

ScintillaControlMBS.TargetEnd as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
End of target selection in text.

(Read and Write property)

ScintillaControlMBS.TargetEndVirtualSpace as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
End of the virtual space of target selection in text.

This allows text to be inserted in virtual space more easily.
(Read and Write property)

ScintillaControlMBS.TargetSpan as ScintillaSpanMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Queries targert start and end as a span object.

(Read and Write property)

ScintillaControlMBS.TargetStart as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Start of the virtual space of target selection in text.

This allows text to be inserted in virtual space more easily.
When searching you can set start greater than end to find the last matching text in the target rather than the first matching text.
The target is also set by a successful by SearchInTarget.
(Read and Write property)

ScintillaControlMBS.TargetStartVirtualSpace as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Start of target selection in text.

When searching you can set start greater than end to find the last matching text in the target rather than the first matching text.
(Read and Write property)

ScintillaControlMBS.TargetText as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Retrieve the value in the target.

(Read only property)

ScintillaControlMBS.Technology 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 technology property allows choosing between different drawing APIs and options.

On most platforms, the only choice is kTechnologyDefault (0). On Windows Vista or later, kTechnologyDirectWrite (1), kTechnologyDirectWriteRetain (2), or kTechnologyDirectWriteDC (3) can be chosen to use the Direct2D and DirectWrite APIs for higher quality antialiased drawing. kTechnologyDirectWriteRetain differs from kTechnologyDirectWrite by requesting that the frame is retained after being presented which may prevent drawing failures on some cards and drivers. kTechnologyDirectWriteDC differs from kTechnologyDirectWrite by using DirectWrite to draw into a GDI DC.
On Win32, buffered drawing is set to a reasonable value for the technology: on for GDI and off for Direct2D as Direct2D performs its own buffering. This can be changed after setting technology with BufferDraw property.
When using DirectWrite, you can use FontLocale to set an appropriate font locale to draw text with expected language-dependent glyphs.
(Read and Write property)

ScintillaControlMBS.Text as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Get or set the text of the document.

(Read and Write property)

ScintillaControlMBS.TextLength 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 length of the document in bytes.

(Read only property)

ScintillaControlMBS.UndoCollection as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
You can control whether Scintilla collects undo information.

Set to true to collect information and false to stop collecting. If you stop collection, you should also use EmptyUndoBuffer to avoid the undo buffer being unsynchronized with the data in the buffer.

You might wish to turn off saving undo information if you use the Scintilla to store text generated by a program (a Log view) or in a display window where text is often deleted and regenerated.
(Read and Write property)

Previous items Next items

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


The biggest plugin in space...