Platforms to show: All Mac Windows Linux Cross-Platform
Back to ScintillaControlMBS control.
ScintillaControlMBS.BackSpaceUnIndents as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
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.Bidirectional 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 bidirectional features in Scintilla are experimental and incomplete.
Some languages, like Arabic and Hebrew, are written from right to left instead of from left to right as English is. Documents that use multiple languages may contain both directions and this is termed "bidirectional". The default text direction may be right to left or left to right. Scintilla only correctly displays bidirectional text on some platforms. Currently, there is experimental support for bidirectional text on Win32 using DirectWrite and on macOS using Cocoa. Only UTF-8 documents will show bidirectional behaviour and only in kBidirectionalL2R mode. Some features, such as virtual space may not work with bidirectional text or may work only in some circumstances. kBidirectionalR2L may be implemented in the future.
There are additional processing and storage costs to bidirectional text. As some applications may not want to pay the costs, bidirectional support must be explicitly enabled by calling Bidirectional = kBidirectionalL2R (1) which chooses left to right as the default direction or Bidirectional = kBidirectionalR2L (2) for default right to left.
On Win32, this should be done after setting the technology to kTechnologyDirectWrite, kTechnologyDirectWriteRetain, or kTechnologyDirectWriteDC.
If the call succeeded Bidirectional query will return the same value otherwise kBidirectionalDisabled (0) is returned.
(Read and Write property)
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 |
(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 |
(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 |
(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 |
(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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
(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 |
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 |
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 |
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 |
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 |
(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 |
(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 |
(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 |
(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 |
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 |
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 |
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 |
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 |
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 |
(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 |
(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 |
(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 |
(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 |
(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 |
(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 |
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 |
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 |
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 |
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 |
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.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 |
(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 |
Value is a NSViewMBS. We use variant to reduce dependency to other plugins.
(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 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 |
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 |
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 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 |
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 |
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 |
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)
The items on this page are in the following plugins: MBS Scintilla Plugin.