Platforms to show: All Mac Windows Linux Cross-Platform

Back to ScintillaControlMBS control.

Previous items Next items

ScintillaControlMBS.PageDownExtend

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

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

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

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

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

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

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

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

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Performs the paste operation from clipboard.

ScintillaControlMBS.PointXFromPosition(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
Return the x display pixel location of text at position pos in the document.

ScintillaControlMBS.PointYFromPosition(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
Return the y display pixel location of text at position pos in the document.

ScintillaControlMBS.PositionAfter(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
Returns the position after another position in the document taking into account the current code page.

The minimum position returned is 0 and the maximum is the last position in the document. If called with a position within a multi byte character will return the position of the start/end of that character.

ScintillaControlMBS.PositionBefore(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
Returns the position before another position in the document taking into account the current code page.

The minimum position returned is 0 and the maximum is the last position in the document. If called with a position within a multi byte character will return the position of the start/end of that character.

ScintillaControlMBS.PositionFromLine(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 document position that corresponds with the start of the line.

If line is negative, the position of the line holding the start of the selection is returned. If line is greater than the lines in the document, the return value is -1. If line is equal to the number of lines in the document (i.e. 1 line past the last line), the return value is the end of the document.

ScintillaControlMBS.PositionFromPoint(x as Integer, y 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
Finds the closest character position to a point.

ScintillaControlMBS.PositionFromPointClose(x as Integer, y 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
Finds the closest character position to a point.

Returns -1 if the point is outside the window or not close to any characters.

ScintillaControlMBS.PositionRelative(pos as Integer, relative 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
Count a number of whole characters before or after the argument position and return that position.

The minimum position returned is 0 and the maximum is the last position in the document. If the position goes past the document end then 0 is returned.

ScintillaControlMBS.PositionRelativeCodeUnits(pos as Integer, relative 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
Count a number of whole characters before or after the argument position and return that position.

The minimum position returned is 0 and the maximum is the last position in the document. If the position goes past the document end then 0 is returned.

These is the UTF-16 versions of PositionRelative() working in terms of UTF-16 code units

ScintillaControlMBS.PropertyInt(name as String, defaultValue as Integer = 0) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Lookup a keyword:value pair using the specified key; if found, interpret the value as an integer and return it.

If not found (or the value is an empty string) then return the supplied default. If the keyword:value pair is found but is not a number, then return 0.

ScintillaControlMBS.PropertyType(name as String) 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 property type.

See kTypeProperty* constants.

ScintillaControlMBS.PropertyValue(Key as String) as String

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

Lookup a keyword:value pair using the specified key; if found, copy the value to the user-supplied buffer and return the length (not including the terminating 0). If not found, copy an empty string to the buffer and return 0.

If the value argument is 0 then the length that should be allocated to store the value is returned; again, the terminating 0 is not included.

You can communicate settings to lexers with keyword:value string pairs. There is no limit to the number of keyword pairs you can set, other than available memory. key is a case sensitive keyword, value is a string that is associated with the keyword. If there is already a value string associated with the keyword, it is replaced. If you pass a zero length string, the method does nothing. Both key and value are used without modification; extra spaces at the beginning or end of key are significant.
The value string can no longer refer to other keywords as was possible in older releases of Scintilla.

Lexers may only store values for keywords they support.
Currently the "fold" property is defined for most of the lexers to set the fold structure if set to "1". SCLEX_PYTHON understands "tab.timmy.whinge.level" as a setting that determines how to indicate bad indentation. Most keywords have values that are interpreted as integers. Search the lexer sources for GetPropertyInt to see how properties are used.
There is a convention for naming properties used by lexers so that the set of properties can be found by scripts. Property names should start with "lexer.<lexer>." or "fold.<lexer>." when they apply to one lexer or start with "lexer." or "fold." if they apply to multiple lexers.

Applications may discover the set of properties used by searching the source code of lexers for lines that contain GetProperty or DefineProperty and a double quoted string and extract the value of the double quoted string as the property name. The lexilla/scripts/LexillaData.py script does this and can be used as an example. Documentation for the property may be located above the call as a multi-line comment starting with 
// property <property-name>
(Read and Write computed property)

ScintillaControlMBS.Redo

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Undoes the effect of the last Undo operation.

ScintillaControlMBS.RegisterRGBAImage(type as Integer, Width as Integer, Height as Integer, 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
Registers an icon for auto completion.
Example

// register red dot for auto complete later
Const size = 18

Dim r As New Picture(size, size) // red dot
Dim m As New Picture(size, size) // mask, a white dot on black, black is transparent
Dim rg As Graphics = r.Graphics
Dim 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
Dim rr As RGBSurface = r.RGBSurface
Dim mr As RGBSurface = m.RGBSurface

dim pixels As New MemoryBlock(size * size * 4)
Dim PixelPtr As ptr = pixels
Dim o As Integer = 0
For y As Integer = 0 To size-1
For x As Integer = 0 To size-1
Dim mc As Color = mr.Pixel(x,y)
Dim 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

c.RegisterRGBAImage(1, size, size, pixels)

Autocompletion list items may display an image as well as text. Each image is first registered with an integer type. Then this integer is included in the text of the list separated by a '?' from the text. For example, "fclose?2 fopen" displays image 2 before the string "fclose" and no image before "fopen". The images are in RGBA format and set with RegisterRGBAImage.
The set of registered images can be cleared with ClearRegisteredImages method and the '?' separator changed with AutoCompleteSeparator property.

ScintillaControlMBS.ReleaseAllExtendedStyles

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Releases any extended styles allocated by the container.

ScintillaControlMBS.ReleaseLineCharacterIndex(lineCharacterIndex as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Release one or more indexes.

Different aspects of an application may need indexes for different periods and should allocate for those periods. Indexes use additional memory so releasing them can help minimize memory but they also take time to recalculate. Scintilla may also allocate indexes to support features like accessibility or input method editors. Only one index of each type is created for a document at a time.

ScintillaControlMBS.ReplaceRectangular(length as Integer, text as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Replaces the selected text or empty selection with the given text.

The insertion is performed similarly to rectangular pastes: new lines in the given text are interpreted as moving to the next line without inserting new lines unless at the end of the document.

ScintillaControlMBS.ReplaceSelection(text as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The currently selected text between the anchor and the current position is replaced by the text string.

If the anchor and current position are the same, the text is inserted at the caret position. The caret is positioned after the inserted text and the caret is scrolled into view.

ScintillaControlMBS.ReplaceTarget(text as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Replace target area with new text.

After replacement, the target range refers to the replacement text. The return value is the length of the replacement string.
Note that the recommended way to delete text in the document is to set the target to the text to be removed, and to perform a replace target with an empty string.

ScintillaControlMBS.ReplaceTargetRE(text as string) 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 replaces the target using regular expressions.

If length is -1, text is a zero terminated string, otherwise length is the number of characters to use. The replacement string is formed from the text string with any sequences of \1 through \9 replaced by tagged matches from the most recent regular expression search. \0 is replaced with all the matched text from the most recent search. After replacement, the target range refers to the replacement text. The return value is the length of the replacement string.

Previous items Next 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...