Platforms to show: All Mac Windows Linux Cross-Platform

Back to DesktopScintillaControlMBS control.

DesktopScintillaControlMBS.Accessibility 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 or disable accessibility status.

Can be set to kAccessibilityEnabled to enable.
(Read and Write property)

DesktopScintillaControlMBS.AdditionalCaretForeColor as Color

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Modify the appearance of additional carets so that they can be differentiated from the main caret which has its appearance.

(Read and Write property)

DesktopScintillaControlMBS.AdditionalCaretsBlink as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Modify the appearance of additional carets so that they can be differentiated from the main caret which has its appearance.

(Read and Write property)

DesktopScintillaControlMBS.AdditionalCaretsVisible as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Determine whether to show additional carets (defaults to true).

(Read and Write property)

DesktopScintillaControlMBS.AdditionalSelAlpha 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 alpha for additional selection.

Modify the appearance of additional selections so that they can be differentiated from the main selection.
(Read and Write property)

DesktopScintillaControlMBS.AdditionalSelectionTyping 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 typing, new line, cursor left/right/up/down, backspace, delete, home, and end work with multiple selections simultaneously.

Also allows selection and word and line deletion commands.
(Read and Write property)

DesktopScintillaControlMBS.AllLinesVisible as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Returns true if all lines are visible and false if some lines are hidden.

(Read only property)

DesktopScintillaControlMBS.Anchor 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 anchor position.

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

DesktopScintillaControlMBS.AnnotationVisible as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Annotations can be made visible in a view and there is a choice of display style when visible.

See kAnnotationVisible* constants.
(Read and Write property)

DesktopScintillaControlMBS.AutoCImageScale as Integer   New in 26.0

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 26.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Get or set the scale factor in percent for all autocompletion list images.

This is useful on macOS with a retina display where each display unit is 2 pixels: use a factor of 200 so that each image pixel is displayed using a screen pixel. The default scale, 100, will stretch each image pixel to cover 4 screen pixels on a retina display.

This is currently only implemented for the Qt and GTK platforms.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteActive as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Returns true if there is an active auto completion list and false if there is not.

(Read only property)

DesktopScintillaControlMBS.AutoCompleteAutoHide 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 list is cancelled if there are no viable matches (the user has typed characters that no longer match a list entry).

If you want to keep displaying the original list, set autoHide to false. This also effects AutoCompleteSelect.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteCancelAtStart 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 default behaviour is for the list to be cancelled if the caret moves to the location it was at when the list was displayed.

By calling this message with a false argument, the list is not cancelled until the caret moves at least one character before the word being completed.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteCaseInsensitiveBehaviour as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Whether to ignore case on auto completion.

When auto completion is set to ignore case (kCaseInsensitiveBehaviourIgnoreCase), by default it will nonetheless select the first list member that matches in a case sensitive way to entered characters. This corresponds to a behaviour property of kCaseInsensitiveBehaviourRespectCase (0). If you want auto completion to ignore case at all, choose kCaseInsensitiveBehaviourIgnoreCase (1).
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteChooseSingle 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 choose single item directly.

If you use AutoCompleteChooseSingle(1) and a list has only one item, it is automatically added and no list is displayed. The default is to display the list even if there is only a single item.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteCurrent 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 to select an item in the autocompletion list.

It searches the list of words for the first that matches select. By default, comparisons are case sensitive, but you can change this with AutoCIgnoreCase. The match is character by character for the length of the select string. That is, if select is "Fred" it will match "Frederick" if this is the first item in the list that begins with "Fred". If an item is found, it is selected. If the item is not found, the autocompletion list closes if auto-hide is true (see AutoCAutoHide).
The current selection index can be retrieved with AutoCompleteCurrent.
(Read only property)

DesktopScintillaControlMBS.AutoCompleteCurrentText as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Retrieves the current selected text in the autocompletion list.

Normally the AutoCompletion event is used instead.
The value is copied to the text buffer or if not found, an empty string is returned.
(Read only property)

DesktopScintillaControlMBS.AutoCompleteDropRestOfWord 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 an item is selected, any word characters following the caret are first erased if dropRestOfWord is set true.

The default is false.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteIgnoreCase 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, matching of characters to list members is case sensitive.

These method let you set and get case sensitivity.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteMaxHeight 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 or set the maximum number of rows that will be visible in an auto completion list.

If there are more rows in the list, then a vertical scrollbar is shown. The default is 5.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteMaxWidth 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 or set the maximum width of an auto completion list expressed as the number of characters in the longest item that will be totally visible.

If zero (the default) then the list's width is calculated to fit the item with the most characters. Any items that cannot be fully displayed within the available width are indicated by the presence of ellipsis.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteMulti as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Whether to auto complete multiple selections.

When auto completing with multiple selections present, the auto completed text can go into just the main selection with kMultiAutoCompleteOnce (0) or into each selection with kMultiAutoCompleteEach (1). The default is kMultiAutoCompleteOnce.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteOptions 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 options for auto completion.

See kAutoCompleteOption* constants.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteOrder 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 default setting kOrderingPreSorted (0) requires that the list be provided in alphabetical sorted order.

Sorting the list can be done by Scintilla instead of the application with kOrderingPerformSort (1). This will take additional time.
Applications that wish to prioritize some values and show the list in order of priority instead of alphabetical order can use kOrderingCustom (2). This requires extra processing in AutoCompleteShow to create a sorted index.
Setting the order should be done before calling AutoCompleteShow.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteSeparator 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 separator character used to separate words in the AutoCompleteShow list.

The default is the space character.
(Read and Write property)

DesktopScintillaControlMBS.AutoCompleteTypeSeparator 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 get the type separator for auto complete.

(Read and Write property)

DesktopScintillaControlMBS.AutoCStyle as Integer   New in 26.0

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 26.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Get or set the style used by autocompletion lists to determine the font facename, size and character set used to display characters.

Defaults to STYLE_DEFAULT. Always call AllocateExtendedStyles(1) to make a new style.
(Read and Write property)

DesktopScintillaControlMBS.AutomaticFold 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 automatic folding behavior.

The fundamental operation in folding is making lines invisible or visible. Line visibility is a property of the view rather than the document so each view may be displaying a different set of lines. From the point of view of the user, lines are hidden and displayed using fold points. Generally, the fold points of a document are based on the hierarchical structure of the document contents. In Python, the hierarchy is determined by indentation and in C++ by brace characters. This hierarchy can be represented within a Scintilla document object by attaching a numeric "fold level" to each line. The fold level is most easily set by a lexer, but you can also set it with method.

It is up to your code to set the connection between user actions and folding and unfolding. The best way to see how this is done is to search the SciTE source code for the methods used in this section of the documentation and see how they are used. You will also need to use markers and a folding margin to complete your folding implementation. The "fold" property should be set to "1" with SetProperty("fold", "1") to enable folding.

Instead of implementing all the logic for handling folding in the container, Scintilla can provide behaviour that is adequate for many applications. The automaticFold argument is a bit set defining which of the 3 pieces of folding implementation should be enabled. Most applications should be able to use the kAutomaticFoldShow and kAutomaticFoldChange flags unless they wish to implement quite different behaviour such as defining their own fold structure. kAutomaticFoldClick is more likely to be set off when an application would like to add or change click behaviour such as showing method headers only when Shift+Alt is used in conjunction with a click.
(Read and Write property)

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


The biggest plugin in space...