Platforms to show: All Mac Windows Linux Cross-Platform

Back to ScintillaControlMBS control.

Previous items Next items

ScintillaControlMBS.DefaultFoldDisplayText as String

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 default text displayed at the right of the folded text.

(Read and Write property)

ScintillaControlMBS.DescribeKeyWordSets as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
A description of all of the keyword sets separated by LF.

(Read only property)

ScintillaControlMBS.DocumentOptions 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 documentation options used to create the document.

(Read only property)

ScintillaControlMBS.EdgeColor as Color

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 colour of the marker used to show that a line has exceeded the length set by EdgeColumn property.

(Read and Write property)

ScintillaControlMBS.EdgeColumn 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 column number at which to display the long line marker.

When drawing lines, the column sets a position in units of the width of a space character in kStylesCommonDefault. When setting the background colour, the column is a character count (allowing for tabs) into the line.
(Read and Write property)

ScintillaControlMBS.EdgeMode 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 mode used to display long lines.

You can choose to mark lines that exceed a given length by drawing a vertical line or by colouring the background of characters that exceed the set length.

See kEdgeVisualStyle* constants.
(Read and Write property)

ScintillaControlMBS.EndAtLastLine as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
EndAtLastLine sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default).

Setting this to false allows scrolling one page below the last line.
(Read and Write property)

ScintillaControlMBS.EOLAnnotationVisible 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 annotation display mode.

End of Line Annotations can be made visible in a view and there is a choice of display style when visible.

See kEOLAnnotationVisible* constants.
(Read and Write property)

ScintillaControlMBS.EOLMode 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 the characters that are added into the document when the user presses the Enter key.

You can set eolMode to one of kEndOfLineCRLF (0), kEndOfLineCR (1), or kEndOfLineLF (2).

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.
(Read and Write property)

ScintillaControlMBS.ExtraAscent 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 extra ascent.

Text is drawn with the base of each character on a 'baseline'. The height of a line is found from the maximum that any style extends above the baseline (its 'ascent'), added to the maximum that any style extends below the baseline (its 'descent'). Space may be added to the maximum ascent (ExtraAscent) and the maximum descent (ExtraDescent) to allow for more space between lines. This may done to make the text easier to read or to accommodate underlines or highlights.

The extra ascent and descent values can be negative but that should be done with care as it may lead to unexpected interference when lines share space.
(Read and Write property)

ScintillaControlMBS.ExtraDescent 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 extra descent.

Text is drawn with the base of each character on a 'baseline'. The height of a line is found from the maximum that any style extends above the baseline (its 'ascent'), added to the maximum that any style extends below the baseline (its 'descent'). Space may be added to the maximum ascent (ExtraAscent) and the maximum descent (ExtraDescent) to allow for more space between lines. This may done to make the text easier to read or to accommodate underlines or highlights.

The extra ascent and descent values can be negative but that should be done with care as it may lead to unexpected interference when lines share space.
(Read and Write property)

ScintillaControlMBS.FirstVisibleLine 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 or set the line number of the first visible line in the Scintilla view.

The first line in the document is numbered 0. The value is a visible line rather than a document line.
(Read and Write property)

ScintillaControlMBS.Focus 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 we have focus.

Scintilla can be told to grab the focus with GrabFocus. This is needed more on GTK where focus handling is more complicated than on Windows.
The internal focus flag can be set with Focus. This is used by clients that have complex focus requirements such as having their own window that gets the real focus but with the need to indicate that Scintilla has the logical focus.
(Read and Write property)

ScintillaControlMBS.FoldDisplayTextStyle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Changes the appearance of fold text tags.

(Read and Write property)

ScintillaControlMBS.FontLocale as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Set the locale used for font selection with language-dependent glyphs.

It may, depending on platform and other circumstances influence the display of text, so setting "zh-Hant" may result in traditional Chinese display and "zh-Hans" may result in simplified Chinese display. It is currently only implemented for Win32 using DirectWrite where the value is passed as the localeName argument to CreateTextFormat. The default value is US English "en-us".
(Read and Write property)

ScintillaControlMBS.FontQuality as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Manage font quality (antialiasing method).

See kFontQualityQuality* constants.
(Read and Write property)

ScintillaControlMBS.HasBorder as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.4 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Enable/disable border for Windows.

If this flag is set before the control is constructed, you get the control instated on Windows with a border line.
(Read and Write property)

ScintillaControlMBS.HighlightGuide as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
When brace highlighting occurs, the indentation guide corresponding to the braces may be highlighted with the brace highlighting style, kStylesCommonBraceLight (34).

Set column to 0 to cancel this highlight.
(Read and Write property)

ScintillaControlMBS.HotspotActiveBack as Color

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

(Read only property)

ScintillaControlMBS.HotspotActiveFore as Color

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

(Read only property)

ScintillaControlMBS.HotspotActiveUnderline as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
While the cursor hovers over text in a style with the hotspot attribute set, this option shows underline.

(Read and Write property)

ScintillaControlMBS.HotspotSingleLine as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Single line mode stops a hotspot from wrapping onto next line.

(Read and Write property)

ScintillaControlMBS.HScrollBar 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 horizontal scroll bar is only displayed if it is needed for the assumed width.

If you never wish to see it, call HScrollBar = false. Use HScrollBar = true to enable it again. Querying HScrollBar returns the current state. The default state is to display it when needed.
(Read and Write property)

ScintillaControlMBS.IdleStyling 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 idel styling setting.

By default, kIdleStylingNone (0), syntax styling is performed for all the currently visible text before displaying it. On very large files, this may make scrolling down slow. With kIdleStylingToVisible (1), a small amount of styling is performed before display and then further styling is performed incrementally in the background as an idle-time task. This may result in the text initially appearing uncoloured and then, some time later, it is coloured. Text after the currently visible portion may be styled in the background with kIdleStylingAfterVisible (2). To style both before and after the visible text in the background use kIdleStylingAll (3).
Since wrapping also needs to perform styling and also uses idle time, this setting has no effect when the document is displayed wrapped.
(Read and Write property)

ScintillaControlMBS.IMEInteraction as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Configures IME interaction.

When entering text in Chinese, Japanese, or Korean an Input Method Editor (IME) may be displayed. The IME may be an extra window appearing above Scintilla or may be displayed by Scintilla itself as text. On some platforms there is a choice between the two techniques. A windowed IME kIMEInteractionWindowed (0) may be more similar in appearance and behaviour to the IME in other applications. An inline IME kIMEInteractionInline (1) may work better with some Scintilla features such as rectangular and multiple selection.
The windowed behaviour can be chosen with IMEInteraction = kIMEInteractionWindowed and the inline behaviour with IMEInteraction = kIMEInteractionInline. Scintilla may ignore this call in some cases. For example, the inline behaviour might only be supported for some languages.
When the inline IME mode is active, characters are added tentatively before being finalised and an CharacterAdded event (with characterSource set to kCharacterSourceTentativeInput) is sent for each character.
(Read and Write property)

ScintillaControlMBS.Indent 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 the size of indentation in terms of the width of a space in KStylesCommonDefault.

If you set a width of 0, the indent size is the same as the tab size. There are no limits on indent sizes, but values less than 0 or large values may have undesirable effects.

Indentation (the white space at the start of a line) is often used by programmers to clarify program structure and in some languages, for example Python, it may be part of the language syntax. Tabs are normally used in editors to insert a tab character or to pad text with spaces up to the next tab.
When Scintilla is laying out a section of text, text after a tab character will usually be displayed at the next multiple of TabWidth columns from the left. However, it is also possible to explicitly set tabstops in pixels for each line.
Scintilla can be set to treat tab and backspace in the white space at the start of a line in a special way: inserting a tab indents the line to the next indent position rather than just inserting a tab at the current character position and backspace unindents the line rather than deleting a character. Scintilla can also display indentation guides (vertical lines) to help you to generate code.
(Read and Write property)

ScintillaControlMBS.IndentationGuides as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Indentation guides are dotted vertical lines that appear within indentation white space every indent size columns.

They make it easy to see which constructs line up especially when they extend over multiple pages. Style kStylesCommonIndentGuide (37) is used to specify the foreground and background colour of the indentation guides.
There are 4 indentation guide views. kIndentViewNone turns the feature off but the other 3 states determine how far the guides appear on empty lines.
(Read and Write property)

ScintillaControlMBS.IndicatorCurrent as ScintillaIndicatorMBS

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

(Read and Write property)

ScintillaControlMBS.IndicatorValue 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 value that will be set by calls to IndicatorFillRange.

(Read and Write property)

ScintillaControlMBS.LayoutCache as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Enable layout cache.

(Read and Write property)

ScintillaControlMBS.Length 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.LexerLanguage 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 the name of the current lexer.

(Read only property)

ScintillaControlMBS.LineCharacterIndex as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Returns which if any indexes are active.

(Read only property)

ScintillaControlMBS.LineCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This returns the number of lines in the document.

An empty document contains 1 line. A document holding only an end of line sequence has 2 lines.
(Read only property)

ScintillaControlMBS.LineEndTypesActive as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Reports the set of line ends currently interpreted by Scintilla.

It is LineEndTypesSupported and LineEndTypesAllowed.

See kLineEndType* constants.
(Read only property)

ScintillaControlMBS.LineEndTypesAllowed as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
By default, only the ASCII line ends are interpreted.

Unicode line ends may be requested with LineEndTypesAllowed = kLineEndTypeUnicode but this will be ineffective unless the lexer also allows you Unicode line ends.

See kLineEndType* constants.
(Read and Write property)

ScintillaControlMBS.LineEndTypesSupported as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Reports the different types of line ends supported by the current lexer.

This is a bit set although there is currently only a single choice with either kLineEndTypeDefault (0) or kLineEndTypeUnicode (1). These values are also used by the other messages concerned with Unicode line ends.

See kLineEndType* constants.
(Read only property)

ScintillaControlMBS.LinesOnScreen as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This returns the number of complete lines visible on the screen.

With a constant line height, this is the vertical space available divided by the line separation. Unless you arrange to size your window to an integral number of lines, there may be a partial line visible at the bottom of the view.
(Read only property)

ScintillaControlMBS.MainSelection as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Queries index of main selection.

One of the selections is the main selection which is used to determine what range of text is automatically visible. The main selection may be displayed in different colours or with a differently styled caret. Only an already existing selection can be made main.
(Read and Write property)

ScintillaControlMBS.MarginLeft 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 width of the blank margin on left side of the text in pixels.

The default is to one pixel on each side.
(Read and Write property)

ScintillaControlMBS.MarginOptions as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Define margin options by enabling appropriate bit flags.

At the moment, only one flag is available kMarginOptionSubLineSelect = 1, which controls how wrapped lines are selected when clicking on margin in front of them. If kMarginOptionSubLineSelect is set only sub line of wrapped line is selected, otherwise whole wrapped line is selected. Margin options are set to kMarginOptionNone=0 by default.
(Read and Write property)

ScintillaControlMBS.MarginRight 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 width of the blank margin on right side of the text in pixels.

The default is to one pixel on each side.
(Read and Write property)

ScintillaControlMBS.Margins as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Allocate the number of margins or find the number of margins currently allocated.

(Read and Write property)

ScintillaControlMBS.MaxLineState as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This returns the last line that has any line state.

(Read only property)

ScintillaControlMBS.ModEventMask 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 modification event masks.

Set and get an event mask that determines which document change events are notified to the container with Modify event. For example, a container may decide to see only notifications about changes to text and not styling changes by setting ModEventMask = kModificationFlagsInsertText + kModificationFlagsDeleteText.
(Read and Write property)

ScintillaControlMBS.Modify 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 document is modified and false if it is unmodified.

The modified status of a document is determined by the undo position relative to the save point. The save point is set by SetSavePoint, usually when you have saved data to a file.
If you need to be notified when the document becomes modified, Scintilla notifies the container that it has entered or left the save point with the SavePointReached and SavePointLeft notification messages.
(Read only property)

ScintillaControlMBS.MouseDownCaptures 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 the mouse is pressed inside Scintilla, it is captured so future mouse movement events are sent to Scintilla.

This behaviour may be turned off with MouseDownCaptures = false.
(Read and Write property)

ScintillaControlMBS.MouseDwellTime 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 time the mouse must sit still, in milliseconds, to generate a DWellStart event.

If set to kTimeForever, the default, no dwell events are generated.
(Read and Write property)

ScintillaControlMBS.MouseSelectionRectangularSwitch 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 the ability to switch to rectangular selection mode while making a selection with the mouse.

When this option is turned on, mouse selections in stream mode can be switched to rectangular mode by pressing the corresponding modifier key. They then stick to rectangular mode even when the modifier key is released again. When this option is turned off, mouse selections will always stick to the mode the selection was started in. It is off by default.
(Read and Write property)

ScintillaControlMBS.MouseWheelCaptures 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 capture mouse wheel events.

On Windows, Scintilla captures all WM_MOUSEWHEEL messages if it has the focus, even if the mouse pointer is nowhere near the Scintilla editor window. This behaviour can be changed with MouseWheelCaptures = false so that Scintilla passes the WM_MOUSEWHEEL messages to its parent window. Scintilla will still react to the mouse wheel if the mouse pointer is over the editor window.
(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...