Platforms to show: All Mac Windows Linux Cross-Platform
Back to ScintillaMarginMBS class.
ScintillaMarginMBS.BackColor 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)
ScintillaMarginMBS.Cursor 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 may be changed to a normal arrow with Cursor = kCursorShapeArrow or restored to a reversed arrow with Cursor = kCursorShapeReverseArrow.
(Read and Write property)
ScintillaMarginMBS.Layer 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 kLayerBase, kLayerOverText and kLayerUnderText constants.
(Read and Write property)
ScintillaMarginMBS.Margin 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)
ScintillaMarginMBS.Mask as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
Each bit corresponds to one of 32 logical symbols that can be displayed in a margin that is enabled for symbols. There is a useful constant, kMaskFolders (&hFE000000 or -33554432), that is a mask for the 7 logical symbols used to denote folding. You can assign a wide range of symbols and colours to each of the 32 logical symbols, see Markers for more information. If (mask & kMaskFolders) = 0, the margin background colour is controlled by style 33 (kStylesCommonLineNumber).
You add logical markers to a line with SCI_MARKERADD. If a line has an associated marker that does not appear in the mask of any margin with a non-zero width, the marker changes the background colour of the line. For example, suppose you decide to use logical marker 10 to mark lines with a syntax error and you want to show such lines by changing the background colour. The mask for this marker is 1 shifted left 10 times (1<<10) which is 0x400. If you make sure that no symbol margin includes 0x400 in its mask, any line with the marker gets the background colour changed.
To set a non-folding margin 1 use Styles(1). Mask = not kMaskFolders which is the default set by Scintilla. To set a folding margin 2 use Styles(2). Mask = kMaskFolders) ~kMaskFolders is &h1FFFFFF in hexadecimal or 33554431 decimal. Of course, you may need to display all 32 symbols in a margin, in which case use Maks = -1.
(Read and Write property)
ScintillaMarginMBS.Parent as Variant
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)
ScintillaMarginMBS.Sensitive as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
A click in a sensitive margin sends a MarginClick event to the container. Margins that are not sensitive act as selection margins which make it easy to select ranges of lines. By default, all margins are insensitive.
(Read and Write property)
ScintillaMarginMBS.Tag as Variant
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
A variable for you to put any reference information you like.
(Read only property)
ScintillaMarginMBS.Type 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 margin argument should be 0, 1, 2, 3 or 4.
You can use the predefined constants kMarginTypeSymbol (0) and kMarginTypeNumber (1) to set a margin as either a line number or a symbol margin. A margin with application defined text may use kMarginTypeText (4) or kMarginTypeRText (5) to right justify the text. By convention, margin 0 is used for line numbers and the next two are used for symbols. You can also use the constants kMarginTypeBack (2), kMarginTypeFore (3), and kMarginTypeColour (6) for symbol margins that set their background colour to match the kCommonStylesDefault background and foreground colours or a specified colour.
(Read and Write property)
ScintillaMarginMBS.Width as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Scintilla | MBS Scintilla Plugin | 22.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop only |
A margin with zero width is invisible. By default, Scintilla sets margin 1 for symbols with a width of 16 pixels, so this is a reasonable guess if you are not sure what would be appropriate. Line number margins widths should take into account the number of lines in the document and the line number style. You could use something like Styles(kStylesCommonLineNumber).TextWidth("_99999") to get a suitable width.
(Read and Write property)
The items on this page are in the following plugins: MBS Scintilla Plugin.