Platforms to show: All Mac Windows Linux Cross-Platform

Back to DesktopScintillaControlMBS control.

Previous items Next items

DesktopScintillaControlMBS.EnsureVisibleEnforcePolicy(line as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
A line may be hidden because more than one of its parent lines is contracted.

Both these message travels up the fold hierarchy, expanding any contracted folds until they reach the top level. The line will then be visible. If you use EnsureVisibleEnforcePolicy(), the vertical caret policy set by VisiblePolicy() is then applied.

DesktopScintillaControlMBS.EOLAnnotationClearAll

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

All the lines can be cleared of end of line annotations with EOLAnnotationClearAll which is equivalent to clearing each line (setting to 0) and then deleting other memory used for this feature.

DesktopScintillaControlMBS.EOLAnnotationStyle(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
Gets or sets the style to use for the EOL annotation.

(Read and Write computed property)

DesktopScintillaControlMBS.EOLAnnotationText(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
A different string may be set for each line with EOLAnnotationText.

To clear end of line annotations assign EOLAnnotationText with a empty string. The whole of the text EOLANNOTATION on a line may be displayed in a particular style with
EOLAnnotationStyle(). Setting an end of line annotation will cause a kModificationFlagsChangeEOLAnnotation notification to be sent.
Only some style attributes are active in end of line annotations: font, size/sizeFractional, bold/weight, italics, fore, back, and characterSet.

End of Line Annotations are read-only lines of text at the end of each line of editable text. End of Line Annotations can be used to display an assembler version of code for debugging or to show diagnostic messages inline or to line up different versions of text in a merge tool.
(Read and Write computed property)

DesktopScintillaControlMBS.ExpandChildren(Line as Integer, FoldLevel 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 is used to respond to a change to a line causing its fold level or whether it is a header to change, perhaps when adding or removing a '{'.

By the time the container has received the notification that the line has changed, the fold level has already been set, so the container has to use the previous level in this call so that any range hidden underneath this line can be shown.

DesktopScintillaControlMBS.FindColumn(line as Integer, column 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 of a column on a line taking the width of tabs into account.

It treats a multi-byte character as a single column. Column numbers, like lines start at 0.

DesktopScintillaControlMBS.FindIndicatorFlash(start as Integer, ende as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Show and animate the find indicator.

The indicator remains visible with FindIndicatorShow and fades out after showing for half a second with FindIndicatorFlash. FindIndicatorShow behaves similarly to the OS X TextEdit and Safari applications and is best suited to editing documentation where the search target is often a word. FindIndicatorFlash is similar to Xcode and is suited to editing source code where the match will often be located next to operators which would otherwise be hidden under the indicator's padding.

DesktopScintillaControlMBS.FindIndicatorHide

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Hides the find indicator.

DesktopScintillaControlMBS.FindIndicatorShow(start as Integer, ende as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Show and animate the find indicator.

The indicator remains visible with FindIndicatorShow and fades out after showing for half a second with FindIndicatorFlash. FindIndicatorShow behaves similarly to the OS X TextEdit and Safari applications and is best suited to editing documentation where the search target is often a word. FindIndicatorFlash is similar to Xcode and is suited to editing source code where the match will often be located next to operators which would otherwise be hidden under the indicator's padding.

DesktopScintillaControlMBS.FindText(searchFlags as Integer, Text as String, byref RangeStart as Integer, byref RangeEnd 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
Searches for text in the document.

It does not use or move the current selection. The searchFlags argument controls the search type, which includes regular expression searches.
See kFindOption* constants.

You can search backwards to find the previous occurrence of a search string by setting the end of the search range before the start.

RangeStart and RangeEnd provide the range of positions in the document to search. You can search backwards by setting RangeEnd less than RangeStart. The text parameter holds the search pattern. If your language makes the use of _TextToFind difficult, you should consider using SearchInTarget instead.

The return value is -1 if the search fails or the position of the start of the found text if it succeeds. The RangeStart and RangeEnd parameters of TextToFind are filled in with the start and end positions of the found text.

DesktopScintillaControlMBS.FoldAll(FoldAction as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Contracts, expands or toggles all lines.

Provides a higher-level approach to folding instead of setting expanded flags and showing or hiding individual lines.

An individual fold can be contracted/expanded/toggled with FoldLine(). To affect all child folds as well call FoldChildren().

To affect the entire document call FoldAll(). With kFoldActionToggle the first fold header in the document is examined to decide whether to expand or contract.

DesktopScintillaControlMBS.FoldChildren(Line as Integer, FoldAction as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Contracts, expands or toggles children.

Provides a higher-level approach to folding instead of setting expanded flags and showing or hiding individual lines.

An individual fold can be contracted/expanded/toggled with FoldLine(). To affect all child folds as well call FoldChildren().

To affect the entire document call FoldAll(). With kFoldActionToggle the first fold header in the document is examined to decide whether to expand or contract.

DesktopScintillaControlMBS.FoldExpanded(line as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Set and get the expanded state of a single line.

The set message has no effect on the visible state of the line or any lines that depend on it. It does change the markers in the folding margin. If you ask for the expansion state of a line that is outside the document, the result is false (0).

If you just want to toggle the fold state of one line and handle all the lines that are dependent on it, it is much easier to use ToggleFold. You would use the FolderExpanded() method to process many folds without updating the display until you had finished. See FoldAll() and Expand() for examples of the use of these methods.
(Read and Write computed property)

DesktopScintillaControlMBS.FoldLevel(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
Set and get a 32-bit value that contains the fold level of a line and some flags associated with folding.

The fold level is a number in the range 0 to kFoldLevelNumberMask (&h0FFF). However, the initial fold level is set to kFoldLevelBase (&h400) to allow unsigned arithmetic on folding levels. There are two addition flag bits. kFoldLevelWhiteFlag indicates that the line is blank and allows it to be treated slightly different then its level may indicate. For example, blank lines should generally not be fold points and will be considered part of the preceding section even though they may have a lesser fold level. kFoldLevelHeaderFlag indicates that the line is a header (fold point). kFoldLevelNone is a default level that may occur before folding.

Use FoldLevel(line) AND kFoldLevelNumberMask to get the fold level of a line. Likewise, use FoldLevel(line) AND kFoldLevelNumber*Flag to get the state of the flags. To set the fold level you must or in the associated flags. For instance, to set the level to thisLevel and mark a line as being a fold point use: FoldLevel(line) = thisLevel OR kFoldLevelHeaderFlag.

This method causes the display to redraw.
(Read and Write computed property)

DesktopScintillaControlMBS.FoldLine(Line as Integer, FoldAction as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Contracts, expands or toggles one line.

Provides a higher-level approach to folding instead of setting expanded flags and showing or hiding individual lines.

An individual fold can be contracted/expanded/toggled with FoldLine(). To affect all child folds as well call FoldChildren().

To affect the entire document call FoldAll(). With kFoldActionToggle the first fold header in the document is examined to decide whether to expand or contract.

DesktopScintillaControlMBS.FoldParent(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 method returns the line number of the first line before line that is marked as a fold point with kFoldLevelHeaderFlag and has a fold level less than the line.

If no line is found, or if the header flags and fold levels are inconsistent, the return value is -1.

DesktopScintillaControlMBS.FormatRange(draw as boolean, range as ScintillaRangeToFormatMBS) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 23.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
FormatRange can be used to draw the text onto a display surface which can include a printer display surface.

Printed output shows text styling as on the screen, but it hides all margins except a line number margin. Markers do not appear in a margin but will change line background colour. The selection and caret are hidden.

Different platforms use different display surface ID types to print on. On Windows, these are HDCs., on GTK 3.x cairo_t *, and on Cocoa CGContextRef is used.

For macOS use Integer(g.Handle(Graphics.HandleTypes.CGContextRef)), for windows use Integer(g.Handle(Graphics.HandleTypes.HDC)), for Linux use Integer(g.Handle(Graphics.HandleTypes.CairoContext)) to get the handle.

This call renders a range of text into a device context. If you use this for printing, you will probably want to arrange a page header and footer; Scintilla does not do this for you. Each use of this message renders a range of text into a rectangular area and returns the position in the document of the next character to print.

The draw parameter controls if any output is done. Set this to false if you are paginating.

On Windows, hdc and hdcTarget should both be set to the device context handle of the output device (usually a printer). If you print to a metafile these will not be the same as Windows metafiles (unlike extended metafiles) do not implement the full API for returning information. In this case, set hdcTarget to the screen DC.

Page* properties define the rectangle {0, 0, maxX, maxY} where maxX+1 and maxY+1 are the number of physically printable pixels in x and y.
Area* properties define the rectangle to render the text in (which will, of course, fit within the rectangle defined by Page*).
CharacterRangePosition and CharacterRangeEnd define the start position and maximum position of characters to output. All of each line within this character range is drawn.

On Cocoa, the surface IDs for printing (draw=1) should be the graphics port of the current context (CGContextRef) when the view's drawRect method is called. The Surface IDs are not really used for measurement (draw=0) but can be set to a bitmap context to avoid runtime warnings.

On GTK, the surface IDs to use can be found from the printing context.

CharacterRangePosition and CharacterRangeEnd define the start position and maximum position of characters to output. All of each line within this character range is drawn.

When printing, the most tedious part is always working out what the margins should be to allow for the non-printable area of the paper and printing a header and footer. If you look at the printing code in SciTE, you will find that most of it is taken up with this. The loop that causes Scintilla to render text is quite simple if you strip out all the margin, non-printable area, header and footer code.

DesktopScintillaControlMBS.FormFeed

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.

DesktopScintillaControlMBS.GetLineSelEndPosition(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
Retrieve the position of the end of the selection at the given line with -1 returned if no selection on this line.

DesktopScintillaControlMBS.GetLineSelStartPosition(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
Retrieve the position of the start of the selection at the given line with -1 returned if no selection on this line.

DesktopScintillaControlMBS.GetNextTabStop(line as Integer, x 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
Gets the next explicit tabstop position set after the given x position, or zero if there aren't any.

DesktopScintillaControlMBS.GetStyledText(RangeStart as Integer, RangeEnd as Integer, byref Styledtext as MemoryBlock) 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 collects styled text into a buffer using two bytes for each cell, with the character at the lower address of each pair and the style byte at the upper address.

Characters between the positions RangeStart and RangeEnd are copied to new MemoryBlock and put into Styledtext.
Positions outside the document return character codes and style bytes of 0.

DesktopScintillaControlMBS.GetTextRange(RangeStart as Integer, RangeEnd as Integer, byref 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 collects the text between the positions RangeStart and RangeEnd and returns it in Text parameter.

If RangeEnd is -1, text is returned to the end of the document.
The return value is the length of the returned text.

DesktopScintillaControlMBS.GotoLine(line 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 any selection and sets the caret at the start of line number line and scrolls the view (if needed) to make it visible.

The anchor position is set the same as the current position. If line is outside the lines in the document (first line is 0), the line set is the first or last.

DesktopScintillaControlMBS.GotoPos(pos 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 any selection, sets the caret at caret and scrolls the view to make the caret visible, if necessary.

It is equivalent to SetSel(caret, caret). The anchor position is set the same as the current position.

DesktopScintillaControlMBS.GrabFocus

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Scintilla can be told to grab the focus with GrabFocus.

This is needed more on GTK where focus handling is more complicated than on Windows.

DesktopScintillaControlMBS.HideLines(lineStart as Integer, lineEnd as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Marks a range of lines as invisible and then redraw the display.

If kElementHiddenLine is set then a horizontal line is drawn in that colour to indicate that there are hidden lines.
A fold line drawn in that position overrides the hidden line indicator.

DesktopScintillaControlMBS.HideSelection(hide as Boolean)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
The normal state is to make the selection visible by drawing it as set by SetSelForeColor and SetSelBackColor.

However, if you hide the selection, it is drawn as normal text.

DesktopScintillaControlMBS.Home

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.

DesktopScintillaControlMBS.HomeDisplay

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.

DesktopScintillaControlMBS.HomeDisplayExtend

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.

DesktopScintillaControlMBS.HomeExtend

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.

DesktopScintillaControlMBS.HomeRectExtend

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.

DesktopScintillaControlMBS.HomeWrap

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.

DesktopScintillaControlMBS.HomeWrapExtend

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.

DesktopScintillaControlMBS.IndexPositionFromLine(line 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 position from line 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.

DesktopScintillaControlMBS.Indicator(index as Integer) as ScintillaIndicatorMBS

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

Index is from 0 to 35.

DesktopScintillaControlMBS.IndicatorAllOnFor(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
Retrieve a bitmap value representing which indicators are non-zero at a position.

Only the first 32 indicators are represented in the result so no IME indicators are included.

DesktopScintillaControlMBS.IndicatorClearRange(start as Integer, lengthClear as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Clears a range for the current indicator.

DesktopScintillaControlMBS.IndicatorFillRange(start as Integer, lengthFill as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Fills a range with the current indicator.

See IndicatorValue property.

DesktopScintillaControlMBS.InitializeLexer(Lexer as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Initializes the lexer.

To style files in different languages, different 'lexers' are used. These are objects that are called by Scintilla with a range of text and some context information and which then set styles and folding information for that range. Lexers for Scintilla are now provided by the Lexilla project.

Current list of buit-in lexers is:

a68k, abaqus, ada, apdl, as, asm, asn1, asy, au3, ave, avs, baan, bash, batch, bib, blitzbasic, bullant, caml, cil, clarion, clarionnocase, cmake, COBOL, coffeescript, conf, cpp, cppnocase, csound, css, d, dataflex, diff, DMAP, DMIS, ecl, edifact, eiffel, eiffelkw, erlang, errorlist, escript, f77, flagship, forth, fortran, freebasic, fsharp, gap, gui4cli, haskell, hollywood, hypertext, ihex, indent, inno, json, julia, kix, kvirc, latex, lisp, literatehaskell, lot, lout, lua, magiksf, makefile, markdown, matlab, maxima, metapost, mmixal, modula, mssql, mysql, nim, nimrod, nncrontab, nsis, null, octave, opal, oscript, pascal, powerbasic, perl, phpscript, PL/M, po, pov, powerpro, powershell, abl, props, ps, purebasic, python, r, raku, rebol, registry, ruby, rust, sas, scriptol, smalltalk, SML, sorcins, specman, spice, sql, srec, stata, fcST, TACL, tads3, TAL, tcl, tcmd, tehex, tex, txt2tags, vb, vbscript, verilog, vhdl, visualprolog, x12, xml, yaml, xojo

DesktopScintillaControlMBS.InsertText(Text as String, atPosition as Integer = -1)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
This inserts the text string at position pos or at the current position if pos is -1.

If the current position is after the insertion point then it is moved along with its surrounding text but no scrolling is performed.

DesktopScintillaControlMBS.IsRangeWord(start as Integer, ende 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
Is the range start..end a word or set of words?

This message checks that start is at a word start transition and that end is at a word end transition. It does not check whether there are any spaces inside the range.

DesktopScintillaControlMBS.KeyWords(keyWordSet 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 keyword list.

You can set up to 9 lists of keywords for use by the current lexer. keyWordSet can be 0 to 8 (actually 0 to KEYWORDSET_MAX) and selects which keyword list to replace. keyWords is a list of keywords separated by spaces, tabs, "\n" or "\r" or any combination of these. It is expected that the keywords will be composed of standard ASCII printing characters, but there is nothing to stop you using any non-separator character codes from 1 to 255 (except common sense).
How these keywords are used is entirely up to the lexer. Some languages, such as HTML may contain embedded languages, VBScript and JavaScript are common for HTML. For HTML, key word set 0 is for HTML, 1 is for JavaScript and 2 is for VBScript, 3 is for Python, 4 is for PHP and 5 is for SGML and DTD keywords. Review the lexer code to see examples of keyword list. A fully conforming lexer sets the fourth argument of the LexerModule constructor to be a list of strings that describe the uses of the keyword lists.
Alternatively, you might use set 0 for general keywords, set 1 for keywords that cause indentation and set 2 for keywords that cause unindentation. Yet again, you might have a simple lexer that colours keywords and you could change languages by changing the keywords in set 0. There is nothing to stop you building your own keyword lists into the lexer, but this means that the lexer must be rebuilt if more keywords are added.
(Read and Write computed property)

DesktopScintillaControlMBS.LastChild(line as Integer, level 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
Searches last child.

Searches for the next line after line, that has a folding level that is less than or equal to level and then returns the previous line number. If you set level to -1, level is set to the folding level of line line. If from is a fold point, LastChild(from, -1) returns the last line that would be in made visible or hidden by toggling the fold state.

DesktopScintillaControlMBS.Line(line as Integer) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Scintilla MBS Scintilla Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop only
Queries text of a line.

Index is zero based.

DesktopScintillaControlMBS.LineCopy

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.

DesktopScintillaControlMBS.LineCut

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.

DesktopScintillaControlMBS.LineDelete

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.

DesktopScintillaControlMBS.LineDown

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.

Previous items Next items

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


The biggest plugin in space...