ScintillaControlMBS.MoveCaretInsideView

Any selection is lost.

ScintillaControlMBS.MoveSelectedLinesDown

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.

ScintillaControlMBS.MoveSelectedLinesUp

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.

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

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.

ScintillaControlMBS.MultiEdgeClearAll

ScintillaControlMBS.MultiEdgeColumn(which as Integer) as Integer

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

ScintillaControlMBS.MultipleSelectAddEach

ScintillaControlMBS.MultipleSelectAddNext

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.

ScintillaControlMBS.NewLine

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

ScintillaControlMBS.PageDown

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

ScintillaControlMBS.PageDownExtend

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

ScintillaControlMBS.PageDownRectExtend

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

ScintillaControlMBS.PageUp

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

ScintillaControlMBS.PageUpExtend

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

ScintillaControlMBS.PageUpRectExtend

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

ScintillaControlMBS.ParaDown

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

ScintillaControlMBS.ParaDownExtend

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

ScintillaControlMBS.ParaUp

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

ScintillaControlMBS.ParaUpExtend

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

ScintillaControlMBS.Paste

ScintillaControlMBS.PointXFromPosition(pos as Integer) as Integer

ScintillaControlMBS.PointYFromPosition(pos as Integer) as Integer

ScintillaControlMBS.PositionAfter(pos as Integer) as Integer

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

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

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

ScintillaControlMBS.PositionFromPointClose(x as Integer, y as integer) as integer

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

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

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

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

See kTypeProperty* constants.

ScintillaControlMBS.PropertyValue(Key as String) as String

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

ScintillaControlMBS.RegisterRGBAImage(type as Integer, Width as Integer, Height as Integer, Pixels as MemoryBlock)

// register red dot for auto complete later
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

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

ScintillaControlMBS.ReleaseLineCharacterIndex(lineCharacterIndex as Integer)

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)

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)

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

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

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.

ScintillaControlMBS.Representation(encodedCharacter as String) as String

Some characters, such as control characters and invalid bytes, do not have a visual glyph or use a glyph that is hard to distinguish.

Control characters (characters with codes less than 32, or between 128 and 159 in some encodings) are displayed by Scintilla using their mnemonics inverted in a rounded rectangle. These mnemonics come from the early days of signalling, though some are still used (LF = Line Feed, BS = Back Space, CR = Carriage Return, for example).
For the low 'C0' values: "NUL", "SOH", "STX", "ETX", "EOT", "ENQ", "ACK", "BEL", "BS", "HT", "LF", "VT", "FF", "CR", "SO", "SI", "DLE", "DC1", "DC2", "DC3", "DC4", "NAK", "SYN", "ETB", "CAN", "EM", "SUB", "ESC", "FS", "GS", "RS", "US".
For the high 'C1' values: "PAD", "HOP", "BPH", "NBH", "IND", "NEL", "SSA", "ESA", "HTS", "HTJ", "VTS", "PLD", "PLU", "RI", "SS2", "SS3", "DCS", "PU1", "PU2", "STS", "CCH", "MW", "SPA", "EPA", "SOS", "SGCI", "SCI", "CSI", "ST", "OSC", "PM", "APC".
Invalid bytes are shown in a similar way with an 'x' followed by their value in hexadecimal, like "xFE".

Any character, including those normally displayed as mnemonics may be represented by a Unicode string inverted in a rounded rectangle.

For example, the Ohm sign Ω U+2126 looks very similar to the Greek Omega character Ω U+03C9 so, for the UTF-8 encoding, to distinguish the Ohm sign as "U+2126 Ω" this call could be made: Representation("Ω", "U+2126 Ω")

The encodedCharacter parameter is a string of the bytes for one character in the current encoding. This can not be used to set a representation for multiple-character strings.
The representation parameter is an UTF-8 string with a maximum length of 200 bytes.

One exception to the single character restriction is that the two character sequence "CRLF" (Carriage Return + Line Feed) can have a representation that is visible in line end viewing (ViewEOL property) mode. If there is no representation for "CRLF" then the individual 'CR' and 'LF' representations will be seen.

The NULL (0) character is a special case and specified as an empty string.
(Read and Write computed property)

ScintillaControlMBS.RepresentationAppearance(encodedCharacter as String) as Integer

If a colour is set and the appearance is set without RepresentationColour() then the representation will show in the colour of the underlying text.
(Read and Write computed property)

ScintillaControlMBS.RepresentationColour(encodedCharacter as String) as Color

(Read and Write computed property)

ScintillaControlMBS.ResetElementColour(element as Integer)

ScintillaControlMBS.RotateSelection

ScintillaControlMBS.SaveToHTML(Title as String, tabSize as Integer = 4, wysiwyg as boolean = false, tabs as boolean = true, folding as boolean = false, onlyStylesUsed as boolean = true) as String

Var html As String = MyScintillaControl.SaveToHTML(Me.Title, 4, True, True, True)

// write to file on desktop
Var f As FolderItem = SpecialFolder.Desktop.Child("export.html")
Var b As BinaryStream = BinaryStream.Create(f, True)
b.Write html
b.Close

// and open in browser
f.open

Title: is used for the title attribute in the html.
tabSize: defines how many spaces to use for a tab character.
wysiwyg: if true, changes html to look more like on screen.
tabs: If true, we output tab character instead of space.
folding: If true, adds JavaScript to allow folding sections.
onlyStylesUsed: If true will only add CSS styles for the used styles instead of all defined ones.

ScintillaControlMBS.ScrollCaret

ScintillaControlMBS.ScrollRange(secondary as Integer, primary as Integer)

The behaviour is similar to ScrollCaret with the primary position used instead of the caret. An effort is then made to ensure that the secondary position and range between are also visible. This may be used to make a search match visible.

ScintillaControlMBS.ScrollToEnd

The ScrollToEnd commands scroll the document to the end without changing the selection. These commands match OS X platform conventions for the behaviour of the home and end keys. Scintilla can be made to match OS X applications by binding the home and end keys to these commands.

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

ScintillaControlMBS.ScrollToStart

The ScrollToStart commands scroll the document to the start without changing the selection. These commands match OS X platform conventions for the behaviour of the home and end keys. Scintilla can be made to match OS X applications by binding the home and end keys to these commands.

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