Platforms to show: All Mac Windows Linux Cross-Platform

Back to ScintillaControlMBS control.

Previous items

ScintillaControlMBS.UseTabs as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Determines whether indentation should be created out of a mixture of tabs and spaces or be based purely on spaces.

Set useTabs to false (0) to create all tabs and indents out of spaces. The default is true. You can use Column() to get the column of a position taking the width of a tab into account.
(Read and Write property)

ScintillaControlMBS.ViewEOL as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Normally, the end of line characters are hidden, but ViewEOL allows you to display (or hide) them by setting visible true (or false).

The visible rendering of the end of line characters is similar to (CR), (LF), or (CR+LF).

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.ViewWS as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
White space can be made visible which may be useful for languages in which white space is significant, such as Python.
Example

dim c as ScintillaControlMBS // your control

// show white space
c.ViewWS = c.kWhiteSpaceVisibleAlways

Space characters appear as small centred dots and tab characters as light arrows pointing to the right. There are also ways to control the display of end of line characters. The two messages set and get the white space display mode.
See kWhiteSpaceVisible* constants.
(Read and Write property)

ScintillaControlMBS.VirtualSpaceOptions as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Virtual space can be enabled or disabled for rectangular selections or in other circumstances or in both.

There are three bit flags kVirtualSpaceRectangularSelection=1, kVirtualSpaceUserAccessible=2, and kVirtualSpaceNoWrapLineStart=4 which can be set independently.
kVirtualSpaceNone=0, the default, disables all use of virtual space.
kVirtualSpaceNoWrapLineStart prevents left arrow movement and selection from wrapping to the previous line. This is most commonly desired in conjunction with virtual space but is an independent setting so works without virtual space.
(Read and Write property)

ScintillaControlMBS.VScrollBar as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
By default, the vertical scroll bar is always displayed when required.

You can choose to hide or show it with VScrollBar property and get the current state with VScrollBar.
(Read and Write property)

ScintillaControlMBS.WhitespaceChars as String

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

Similar to WordChars, this property allows the user to define which chars Scintilla considers as whitespace. Setting the whitespace chars allows the user to fine-tune Scintilla's behaviour doing such things as moving the cursor to the start or end of a word; for example, by defining punctuation chars as whitespace, they will be skipped over when the user presses ctrl+left or ctrl+right. This function should be called after WordChars as it will reset the whitespace characters to the default set. WhiteSpaceChars behaves similarly to WordChars.
(Read and Write property)

ScintillaControlMBS.WhitespaceSize 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 the dots used for mark space characters.

The value 0 is valid and makes the dots invisible.
(Read and Write property)

ScintillaControlMBS.WordChars as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Defines which characters are members of the word category.

The character categories are set to default values before processing this function. For example, if you don't allow '_' in your set of characters use:
WordChars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"

This fills the characters parameter with all the characters included in words.
The characters parameter must be large enough to hold all of the characters. If the characters parameter is 0 then the length that should be allocated to store the entire set is returned.
For multi-byte encodings, this API will not return meaningful values for &h80 and above.
(Read and Write property)

ScintillaControlMBS.WrapIndentMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Wrapped sublines can be indented to the position of their first subline or one more indent level.

The default is kWrapIndentModeFixed.
(Read and Write property)

ScintillaControlMBS.WrapMode 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 wrap mode.

Set wrapMode to kWrapWord (1) to enable wrapping on word or style boundaries, kWrapChar (2) to enable wrapping between any characters, kWrapWhiteSpace (3) to enable wrapping on whitespace, and kWrapNone (0) to disable line wrapping. kWrapChar is preferred for Asian languages where there is no white space between words.

By default, Scintilla does not wrap lines of text. If you enable line wrapping, lines wider than the window width are continued on the following lines. Lines are broken after space or tab characters or between runs of different styles. If this is not possible because a word in one style is wider than the window then the break occurs after the last character that completely fits on the line. The horizontal scroll bar does not appear when wrap mode is on.

For wrapped lines Scintilla can draw visual flags (little arrows) at end of a a subline of a wrapped line and at begin of the next subline. These can be enabled individually, but if Scintilla draws the visual flag at the beginning of the next subline this subline will be indented by one char. Independent from drawing a visual flag at the begin the subline can have an indention.

Much of the time used by Scintilla is spent on laying out and drawing text. The same text layout calculations may be performed many times even when the data used in these calculations does not change. To avoid these unnecessary calculations in some circumstances, the line layout cache can store the results of the calculations. The cache is invalidated whenever the underlying data, such as the contents or styling of the document changes. Caching the layout of the whole document has the most effect, making dynamic line wrap as much as 20 times faster but this requires 7 times the memory required by the document contents plus around 80 bytes per line.

Wrapping is not performed immediately there is a change but is delayed until the display is redrawn. This delay improves performance by allowing a set of changes to be performed and then wrapped and displayed once. Because of this, some operations may not occur as expected. If a file is read and the scroll position moved to a particular line in the text, such as occurs when a container tries to restore a previous editing session, then the scroll position will have been determined before wrapping so an unexpected range of text will be displayed. To scroll to the position correctly, delay the scroll until the wrapping has been performed by waiting for an initial Painted event.
(Read and Write property)

ScintillaControlMBS.WrapStartIndent 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 indentation of sublines for wrapped lines.

WrapStartIndent sets the size of indentation of sublines for wrapped lines in terms of the average character width in kStylesCommonDefault. There are no limits on indent sizes, but values less than 0 or large values may have undesirable effects.
The indention of sublines is independent of visual flags, but if kWrapVisualFlagStart is set an indent of at least 1 is used.
(Read and Write property)

ScintillaControlMBS.WrapVisualFlags 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 enable the drawing of visual flags to indicate a line is wrapped.

Bits set in wrapVisualFlags determine which visual flags are drawn.
See kWrapVisualFlag* constants.
(Read and Write property)

ScintillaControlMBS.WrapVisualFlagsLocation 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 whether the visual flags to indicate a line is wrapped are drawn near the border or near the text.

Bits set in wrapVisualFlagsLocation set the location to near the text for the corresponding visual flag.
See kWrapVisualLocation* constants.
(Read and Write property)

ScintillaControlMBS.XOffset 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 xOffset is the horizontal scroll position in pixels of the start of the text view.

A value of 0 is the normal position with the first text column visible at the left of the view.

See FirstVisibleLine property for vertical position.
(Read and Write property)

ScintillaControlMBS.Zoom 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 zoom factor directly.

There is no limit set on the factors you can set, so limiting yourself to -10 to +20 to match the incremental zoom functions is a good idea.

Scintilla incorporates a "zoom factor" that lets you make all the text in the document larger or smaller in steps of one point. The displayed point size never goes below 2, whatever zoom factor you set. You can set zoom factors in the range -10 to +20 points.
(Read and Write property)

See also:

Previous items

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


💬 Ask a question or report a problem
The biggest plugin in space...