Platforms to show: All Mac Windows Linux Cross-Platform

Back to DesktopScintillaControlMBS control.

DesktopScintillaControlMBS.Margin(index as Integer) as ScintillaMarginMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Queries margin with given index.

Index ranges from 0 to 5.

DesktopScintillaControlMBS.MarginStyle(Line as Integer) as ScintillaStyleMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The tyle for the margin on this line.

The style to use for the margin.
(Read and Write computed property)

DesktopScintillaControlMBS.MarginStyles(line as Integer) as MemoryBlock

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The styles for the margin on this line.

The MemoryBlock contains an array of bytes with each byte setting the style of the corresponding text byte similar to style index.
(Read and Write computed property)

DesktopScintillaControlMBS.MarginText(line as Integer) 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 text for the margin on this line.

Text margins are created with the type kMarginTypeText or kMarginTypeRText. A different string may be set for each line with MarginText(). The whole of the text margin on a line may be displayed in a particular style with MarginStyle() or each character may be individually styled with MarginStyles() which uses an array of bytes with each byte setting the style of the corresponding text byte similar to style index. Setting a text margin will cause a kModificationFlagsChangeMargin notification to be sent.
Only some style attributes are active in text margins: font, size/sizeFractional, bold/weight, italics, fore, back, and characterSet.
(Read and Write computed property)

DesktopScintillaControlMBS.MarginTextClearAll

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Clears all texts for margin.

DesktopScintillaControlMBS.Marker(index as Integer) as ScintillaMarkerMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Queries marker with given index.

Index ranges from 0 to 35.

DesktopScintillaControlMBS.MarkerAdd(Line as Integer, markerNumber as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This function searches the document for the marker with this handle and deletes the marker if it is found.

The markerHandle argument is an identifier for a marker returned by MarkerAdd.

DesktopScintillaControlMBS.MarkerAddSet(line as Integer, markerSet as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Add one or more markers to a line with a single call.

Add one or more markers to a line with a single call, specified in the same "one-bit-per-marker" 32-bit integer format returned by Marker() (and used by the mask-based marker search functions MarkerNext() and MarkerPrevious()). As with MarkerAdd, no check is made to see if any of the markers are already present on the targeted line.

DesktopScintillaControlMBS.MarkerDefineRGBAImage(markerNumber as Integer, Width as Integer, Height as Integer, ScalePercent as Integer = 100, Pixels as MemoryBlock)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 23.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Set a translucent pixmap to be used to draw the marker.
Example
Var c as DesktopScintillaControlMBS // your control

// define red dot for breakpoints
Const size = 18

Var r As New Picture(size, size) // red dot
Var m As New Picture(size, size) // mask, a white dot on black, black is transparent
Var rg As Graphics = r.Graphics
Var mg As Graphics = m.Graphics

// we draw the image and the mask one
rg.DrawingColor = &c000000
rg.FillRectangle 0, 0, size, size
rg.DrawingColor = &cFF0000
rg.FillOval 0, 0, size, size
mg.DrawingColor = &c000000
mg.FillRectangle 0, 0, size, size
mg.DrawingColor = &cFFFFFF
mg.FillOval 0, 0, size, size

// now we convert to memoryblock
Var rr As RGBSurface = r.RGBSurface
Var mr As RGBSurface = m.RGBSurface

Var pixels As New MemoryBlock(size * size * 4)
Var PixelPtr As ptr = pixels
Var o As Integer = 0
For y As Integer = 0 To size-1
For x As Integer = 0 To size-1
Var mc As Color = mr.Pixel(x,y)
Var rc As Color = rr.Pixel(x,y)
PixelPtr.UInt8(o+0) = rc.Red
PixelPtr.UInt8(o+1) = rc.Green
PixelPtr.UInt8(o+2) = rc.Blue
PixelPtr.UInt8(o+3) = mc.Green
o = o + 4
Next
Next

// and define the marker
c.Marker(1).Symbol = ScintillaMarkerMBS.kMarkerSymbolPixmap
c.MarkerDefineRGBAImage(1, size, size, 100, pixels)

Please pass the marker number, the size of the picture, it's scale in percent and the pixels memoryblock.

DesktopScintillaControlMBS.MarkerDelete(Line as Integer, markerNumber as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This searches the given line number for the given marker number and deletes it if it is present.

If you added the same marker more than once to the line, this will delete one copy each time it is used. If you pass in a marker number of -1, all markers are deleted from the line.

DesktopScintillaControlMBS.MarkerDeleteAll(markerNumber as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This removes markers of the given number from all lines.

If markerNumber is -1, it deletes all markers from all lines.

DesktopScintillaControlMBS.MarkerDeleteHandle(markerHandle as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Deletes a marker.

The markerHandle argument is an identifier for a marker returned by MarkerAdd.
This function searches the document for the marker with this handle and deletes the marker if it is found.

DesktopScintillaControlMBS.MarkerEnableHighlight(enabled as Boolean)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This method allows to enable/disable the highlight folding block when it is selected.

(i.e. block that contains the caret)

DesktopScintillaControlMBS.MarkerGet(Line as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This returns a 32-bit integer that indicates which markers were present on the line.

Bit 0 is set if marker 0 is present, bit 1 for marker 1 and so on.

DesktopScintillaControlMBS.MarkerHandleFromLine(line as Integer, which as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Returns the Nth marker handle in a given line.

Handles are returned by MarkerAdd. If which is greater or equal to the number of markers on a line, this returns -1;

DesktopScintillaControlMBS.MarkerLineFromHandle(markerHandle as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This function searches the document for the marker with this handle and returns the line number that contains it or -1 if it is not found.

The markerHandle argument is an identifier for a marker returned by MarkerAdd.

DesktopScintillaControlMBS.MarkerNext(lineStart as Integer, markerMask as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Search efficiently for lines that include a given set of markers.

The search starts at line number lineStart and continues forwards to the end of the file (MarkerNext) or backwards to the start of the file (MarkerPrevious).
The markerMask argument should have one bit set for each marker you wish to find. Set bit 0 to find marker 0, bit 1 for marker 1 and so on. The message returns the line number of the first line that contains one of the markers in markerMask or -1 if no marker is found.

DesktopScintillaControlMBS.MarkerNumberFromLine(line as Integer, which as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Returns the Nth marker number in a given line.

Handles are returned by MarkerAdd. If which is greater or equal to the number of markers on a line, this returns -1;

DesktopScintillaControlMBS.MarkerPrevious(lineStart as Integer, markerMask as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Search efficiently for lines that include a given set of markers.

The search starts at line number lineStart and continues forwards to the end of the file (MarkerNext) or backwards to the start of the file (MarkerPrevious).
The markerMask argument should have one bit set for each marker you wish to find. Set bit 0 to find marker 0, bit 1 for marker 1 and so on. The message returns the line number of the first line that contains one of the markers in markerMask or -1 if no marker is found.

DesktopScintillaControlMBS.MarkerSymbolDefined(markerNumber as Integer) as Integer   New in 26.0

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 26.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Returns the symbol defined for a markerNumber.

Returns the symbol defined for a markerNumber with MarkerSymbolDefined or SC_MARK_PIXMAP if defined with kMarkerSymbolPixmap or kMarkerSymbolRgbaImage if defined with MarkerDefineRGBAImage.

DesktopScintillaControlMBS.MoveCaretInsideView

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
If the caret is off the top or bottom of the view, it is moved to the nearest line that is visible to its current position.

Any selection is lost.

DesktopScintillaControlMBS.MoveSelectedLinesDown

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Move the selected lines down one line, shifting the line below before the selection.

The selection will be automatically extended to the beginning of the selection's first line and the end of the selection's last line. If nothing was selected, the line the cursor is currently at will be selected.

DesktopScintillaControlMBS.MoveSelectedLinesUp

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Move the selected lines up one line, shifting the line above after the selection.

The selection will be automatically extended to the beginning of the selection's first line and the end of the selection's last line. If nothing was selected, the line the cursor is currently at will be selected.

DesktopScintillaControlMBS.MultiEdgeAddLine(column as Integer, edgeColour as Color)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Adds a new vertical edge to the view.

The edge will be displayed at the given column number. The resulting edge position depends on the metric of a space character in STYLE_DEFAULT. All the edges can be cleared with MultiEdgeClearAll. MultiEdgeColumn returns the column of the Nth vertical edge (indexed from 0). If which is greater or equal to the number of vertical edges, this returns -1.

DesktopScintillaControlMBS.MultiEdgeClearAll

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
All the edges can be cleared with MultiEdgeClearAll.

DesktopScintillaControlMBS.MultiEdgeColumn(which as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
MultiEdgeColumn returns the column of the Nth vertical edge (indexed from 0).

If which is greater or equal to the number of vertical edges, this returns -1.

DesktopScintillaControlMBS.MultipleSelectAddEach

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
MultipleSelectAddEach is similar to MultipleSelectAddNext but adds multiple occurrences instead of just one.

DesktopScintillaControlMBS.MultipleSelectAddNext

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Adds the next occurrence of the main selection within the target to the set of selections as main.

If the current selection is empty then select word around caret. The current searchFlags are used so the application may choose case sensitivity and word search options.

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


The biggest plugin in space...