Platforms to show: All Mac Windows Linux Cross-Platform

Back to ScintillaControlMBS control.

Previous items Next items

ScintillaControlMBS.LineDownExtend

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineDownRectExtend

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineDuplicate

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineEnd

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

See also:

ScintillaControlMBS.LineEnd(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
Queries line end position for the given line.

See also:

ScintillaControlMBS.LineEndDisplay

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineEndDisplayExtend

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineEndExtend

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineEndPosition(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 the position at the end of the line, before any line end characters.

If line is the last line in the document (which does not have any end of line characters) or greater, the result is the size of the document. If line is negative the result is undefined.

ScintillaControlMBS.LineEndRectExtend

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineEndWrap

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineEndWrapExtend

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineFromIndexPosition(pos as Integer, lineCharacterIndex 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
Queries line from position via index.

The document line of a particular character or code unit may be found by calling LineFromIndexPosition with one of kLineCharacterIndexTypeUtf32 (1) or kLineCharacterIndexTypeUtf16 (2). The inverse action, finds the starting position of a document line either in characters or code units from the document start by calling IndexPositionFromLine with the same lineCharacterIndex argument.

ScintillaControlMBS.LineFromPosition(pos 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 method returns the line that contains the position pos in the document.

The return value is 0 if pos <= 0.
The return value is the last line if pos is beyond the end of the document.

ScintillaControlMBS.LineIndentation(line as Integer) 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 amount of indentation on a line.

The indentation is measured in character columns, which correspond to the width of space characters.
(Read and Write computed property)

ScintillaControlMBS.LineIndentPosition(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
The position at the end of indentation of a line.

ScintillaControlMBS.LineLength(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 the length of the line, including any line end characters.

If line is negative or beyond the last line in the document, the result is 0. If you want the length of the line not including any end of line characters, use LineEndPosition(line) - PositionFromLine(line).

ScintillaControlMBS.LineReverse

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineScroll(columns as Integer, lines 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 will attempt to scroll the display by the number of columns and lines that you specify.

Positive line values increase the line number at the top of the screen (i.e. they move the text upwards as far as the user is concerned), Negative line values do the reverse.
The column measure is the width of a space in the default style. Positive values increase the column at the left edge of the view (i.e. they move the text leftwards as far as the user is concerned). Negative values do the reverse.

ScintillaControlMBS.LineScrollDown

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineScrollUp

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LinesJoin

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Join a range of lines indicated by the target into one line by removing line end characters.

Where this would lead to no space between words, an extra space is inserted.

ScintillaControlMBS.LinesSplit(pixelWidth as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Split a range of lines indicated by the target into lines that are at most pixelWidth wide.

Splitting occurs on word boundaries wherever possible in a similar manner to line wrapping. When pixelWidth is 0 then the width of the window is used.

ScintillaControlMBS.LineStart(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
Queries line start position for the given line.

ScintillaControlMBS.LineState(Line as Integer) 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 state for each line.

As well as the 8 bits of lexical state stored for each character there is also an integer stored for each line. This can be used for longer lived parse states such as what the current scripting language is in an ASP page. Assign to LineState to set the integer value and query LineState() to get the value. Changing the value produces a ChangeLineState event.
(Read and Write computed property)

ScintillaControlMBS.LineTranspose

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineUp

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineUpExtend

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineUpRectExtend

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.LineVisible(line as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Reports on the visible state of a line and returns true if it is visible and false if it is not visible.

This method has no effect on fold levels or fold flags.

ScintillaControlMBS.LowerCase

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The method to perform the action when this key is pressed.

You can call it directly to perform this action if needed, e.g. from toolbar or menu command.

ScintillaControlMBS.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.

ScintillaControlMBS.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)

ScintillaControlMBS.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)

ScintillaControlMBS.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)

ScintillaControlMBS.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.

ScintillaControlMBS.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.

ScintillaControlMBS.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.

ScintillaControlMBS.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.

ScintillaControlMBS.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 ScintillaControlMBS // 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.

ScintillaControlMBS.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.

ScintillaControlMBS.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.

ScintillaControlMBS.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.

ScintillaControlMBS.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)

ScintillaControlMBS.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.

ScintillaControlMBS.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;

ScintillaControlMBS.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.

ScintillaControlMBS.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.

ScintillaControlMBS.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;

ScintillaControlMBS.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.

Previous items Next items

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


The biggest plugin in space...