DesktopScintillaControlMBS.SearchAnchor

You should always call this before calling either of SearchNext or SearchPrev.

DesktopScintillaControlMBS.SearchInTarget(text as string) as Integer

The search is modified by the search flags set by SearchFlags property. If the search succeeds, the target is set to the found text and the return value is the position of the start of the matching text. If the search fails, the result is -1.

See Tag() for regular expression results.

Character	Description
.	Matches any character
\(	This marks the start of a region for tagging a match.
\)	This marks the end of a tagged region.
\n	Where n is 1 through 9 refers to the first through ninth tagged region when replacing. For example, if the search string was Fred\([1-9]\)XXX and the replace string was Sam\1YYY, when applied to Fred2XXX this would generate Sam2YYY. \0 refers to all of the matching text.
\<	This matches the start of a word using Scintilla's definitions of words.
\>	This matches the end of a word using Scintilla's definition of words.
\x	This allows you to use a character x that would otherwise have a special meaning. For example, \[ would be interpreted as [ and not as the start of a character set.
[...]	This indicates a set of characters, for example, [abc] means any of the characters a, b or c. You can also use ranges, for example [a-z] for any lower case character.
[^...]	The complement of the characters in the set. For example, [^A-Za-z] means any character except an alphabetic character.
^	This matches the start of a line (unless used inside a set, see above).
$	This matches the end of a line.
*	This matches 0 or more times. For example, Sa*m matches Sm, Sam, Saam, Saaam and so on.
+	This matches 1 or more times. For example, Sa+m matches Sam, Saam, Saaam and so on.

DesktopScintillaControlMBS.SearchNext(searchFlags as Integer, text as String) as Integer

The search is modified by the searchFlags.
See kFindOption* constants.

The return value is -1 if nothing is found, otherwise the return value is the start position of the matching text. The selection is updated to show the matched text, but is not scrolled into view.

DesktopScintillaControlMBS.SearchPrev(searchFlags as Integer, text as String) as Integer

The search is modified by the searchFlags.
See kFindOption* constants.

The return value is -1 if nothing is found, otherwise the return value is the start position of the matching text. The selection is updated to show the matched text, but is not scrolled into view.

DesktopScintillaControlMBS.SelectAll

The current position is not scrolled into view.

DesktopScintillaControlMBS.SelectionDuplicate

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

DesktopScintillaControlMBS.SelectionNAnchor(selection as Integer) as Integer

Selection parameter is zero based.
(Read and Write computed property)

DesktopScintillaControlMBS.SelectionNAnchorVirtualSpace(selection as Integer) as Integer

Selection parameter is zero based.
(Read and Write computed property)

DesktopScintillaControlMBS.SelectionNCaret(selection as Integer) as Integer

Selection parameter is zero based.
(Read and Write computed property)

DesktopScintillaControlMBS.SelectionNCaretVirtualSpace(selection as Integer) as Integer

Selection parameter is zero based.
(Read and Write computed property)

DesktopScintillaControlMBS.SelectionNEnd(selection as Integer) as Integer

Mostly of use to query each range for its text. The selection parameter is zero-based.
(Read and Write computed property)

DesktopScintillaControlMBS.SelectionNEndVirtualSpace(selection as Integer) as Integer

Selection parameter is zero based.

DesktopScintillaControlMBS.SelectionNStart(selection as Integer) as Integer

Mostly of use to query each range for its text. The selection parameter is zero-based.
(Read and Write computed property)

DesktopScintillaControlMBS.SelectionNStartVirtualSpace(selection as Integer) as Integer

Selection parameter is zero based.

DesktopScintillaControlMBS.SetAdditionalSelBackColor(value as Color)

Modify the appearance of additional selections so that they can be differentiated from the main selection.

DesktopScintillaControlMBS.SetAdditionalSelForeColor(value as Color)

Modify the appearance of additional selections so that they can be differentiated from the main selection.

DesktopScintillaControlMBS.SetCharsDefault

This sets whitespace to space, tab and other characters with codes less than &h20, with word characters set to alphanumeric and '_'.

DesktopScintillaControlMBS.SetDocument(otherControl as Variant)

Using this method you can allow multiple controls to share same document, e.g. for split views.

Pass nil to create new empty document.

This method does the following:
1. It removes the current window from the list held by the current document.
2. It reduces the reference count of the current document by 1.
3. If the reference count reaches 0, the document is deleted.
4. doc is set as the new document for the window.
5. If doc was 0, a new, empty document is created and attached to the window.
6. If doc was not 0, its reference count is increased by 1.

Please pass either DesktopScintillaControlMBS or DesktopDesktopScintillaControlMBS here to point to new control.

After you assigned new document, please configure styles as needed.

DesktopScintillaControlMBS.SetEmptySelection(caret as Integer)

The caret is not scrolled into view.

DesktopScintillaControlMBS.SetFoldFlags(FoldFlags as Integer)

In addition to showing markers in the folding margin, you can indicate folds to the user by drawing lines in the text area. The lines are drawn in the kElementFoldLine colour if set. If it is not set then the foreground colour set for kStylesCommonDefault is used.

DesktopScintillaControlMBS.SetFoldMarginColor(useSetting as boolean, value as Color)

// turn folder margin to red
c.SetFoldMarginColor(True, Color.red)

Defaults to system color for this.

The FoldMarginColor and the FoldMarginHighlightColor colors are used together to draw the chequerboard pattern in the folder margin.

DesktopScintillaControlMBS.SetFoldMarginHighlightColor(useSetting as boolean, value as Color)

Defaults to system color for this.

The FoldMarginColor and the FoldMarginHighlightColor colors are used together to draw the chequerboard pattern in the folder margin.

DesktopScintillaControlMBS.SetHotspotActiveBackColor(useSetting as boolean, value as Color)

While the cursor hovers over text in a style with the hotspot attribute set, the default colouring can be modified and an underline drawn with these settings.

DesktopScintillaControlMBS.SetHotspotActiveForeColor(useSetting as boolean, value as Color)

While the cursor hovers over text in a style with the hotspot attribute set, the default colouring can be modified and an underline drawn with these settings.

DesktopScintillaControlMBS.SetSavePoint

This is usually done when the file is saved or loaded, hence the name "save point". As Scintilla performs undo and redo operations, it notifies the container that it has entered or left the save point with SavePointReached and SavePointLeft events, allowing the container to know if the file should be considered dirty or not.
See also: EmptyUndoBuffer or Modify property.

DesktopScintillaControlMBS.SetSel(anchor as Integer, caret as Integer)

If caret is negative, it means the end of the document. If anchor is negative, it means remove any selection (i.e. set the anchor to the same position as caret). The caret is scrolled into view after this operation.

DesktopScintillaControlMBS.SetSelBackColor(useSetting as boolean, value as Color)

// use highlight color for selection and white text

Var c as DesktopScintillaControlMBS // your control
c.SetSelBackColor(True, Color.HighlightColor)
c.SetSelForeColor(True, Color.White)

With the method, the colour you provide is used if you set useSetting to true. If it is set to false, the default styled colouring is used and the fore or back argument has no effect.

DesktopScintillaControlMBS.SetSelection(caret as Integer, anchor as Integer)

DesktopScintillaControlMBS.SetSelForeColor(useSetting as boolean, value as Color)

// use highlight color for selection and white text

Var c as DesktopScintillaControlMBS // your control
c.SetSelBackColor(True, Color.HighlightColor)
c.SetSelForeColor(True, Color.White)

With the method, the colour you provide is used if you set useSetting to true. If it is set to false, the default styled colouring is used and the fore or back argument has no effect.

DesktopScintillaControlMBS.SetStyling(length as Integer, style as ScintillaStyleMBS)

StartStyling should be called before the first call to this.

See also:

• SetStyling(start as Integer, length as Integer, style as ScintillaStyleMBS)

DesktopScintillaControlMBS.SetStyling(start as Integer, length as Integer, style as ScintillaStyleMBS)

StartStyling should be called before the first call to this.

See also:

• SetStyling(length as Integer, style as ScintillaStyleMBS)

DesktopScintillaControlMBS.SetStylingEx(Styles as MemoryBlock)

As an alternative to SetStyling, which applies the same style to each byte, you can use this method which specifies the styles for each of length bytes from the styling position and then increases the styling position by length, ready for the next call. StartStyling should be called before the first call to this.

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

DesktopScintillaControlMBS.SetVisiblePolicy(visiblePolicy as Integer, visibleSlop as Integer)

It takes kVisiblePolicySlop and kVisiblePolicyStrict flags for the visiblePolicy parameter. It is similar in operation to SetYCaretPolicy.

DesktopScintillaControlMBS.SetWhitespaceBackColor(useSetting as boolean, value as Color)

By default, the colour of visible white space is determined by the lexer in use. The foreground and/or background colour of all visible white space can be set globally, overriding the lexer's colours.

DesktopScintillaControlMBS.SetWhitespaceForeColor(useSetting as boolean, value as Color)

By default, the colour of visible white space is determined by the lexer in use. The foreground and/or background colour of all visible white space can be set globally, overriding the lexer's colours.

DesktopScintillaControlMBS.SetXCaretPolicy(caretPolicy as Integer, caretSlop as Integer)

See kCaretPolicy* constants.

slop

strict

jumps

even

Caret can go to the margin

"On reaching limit (going out of visibility

or going into the UZ) display is..."

0	0	0	0	Yes	moved to put caret on top/on right
0	0	0	1	Yes	moved by one position
0	0	1	0	Yes	moved to put caret on top/on right
0	0	1	1	Yes	centred on the caret
0	1	-	0	Caret is always on top/on right of display	-
0	1	-	1	No, caret is always centred	-
1	0	0	0	Yes	moved to put caret out of the asymmetrical UZ
1	0	0	1	Yes	moved to put caret out of the UZ
1	0	1	0	Yes	moved to put caret at 3UZ of the top or right margin
1	0	1	1	Yes	moved to put caret at 3UZ of the margin
1	1	-	0	Caret is always at UZ of top/right margin	-
1	1	0	1	No, kept out of UZ	moved by one position
1	1	1	0	No, kept out of UZ	moved to put caret at 3UZ of the margin

DesktopScintillaControlMBS.SetYCaretPolicy(caretPolicy as Integer, caretSlop as Integer)

See kCaretPolicy* constants.

slop

strict

jumps

even

Caret can go to the margin

"On reaching limit (going out of visibility

or going into the UZ) display is..."

0	0	0	0	Yes	moved to put caret on top/on right
0	0	0	1	Yes	moved by one position
0	0	1	0	Yes	moved to put caret on top/on right
0	0	1	1	Yes	centred on the caret
0	1	-	0	Caret is always on top/on right of display	-
0	1	-	1	No, caret is always centred	-
1	0	0	0	Yes	moved to put caret out of the asymmetrical UZ
1	0	0	1	Yes	moved to put caret out of the UZ
1	0	1	0	Yes	moved to put caret at 3UZ of the top or right margin
1	0	1	1	Yes	moved to put caret at 3UZ of the margin
1	1	-	0	Caret is always at UZ of top/right margin	-
1	1	0	1	No, kept out of UZ	moved by one position
1	1	1	0	No, kept out of UZ	moved to put caret at 3UZ of the margin

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

DesktopScintillaControlMBS.StartRecord

DesktopScintillaControlMBS.StartStyling(start as Integer)

After StartStyling, send multiple SetStyling messages for each lexical entity to style or send SetStylingEX to style in blocks.

DesktopScintillaControlMBS.StopRecord

DesktopScintillaControlMBS.StringOfSpan(Span as ScintillaSpanMBS) as String

DesktopScintillaControlMBS.StutteredPageDown

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

DesktopScintillaControlMBS.StutteredPageDownExtend

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

DesktopScintillaControlMBS.StutteredPageUp

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

DesktopScintillaControlMBS.StutteredPageUpExtend

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

DesktopScintillaControlMBS.Style(index as Integer) as ScintillaStyleMBS

Index ranges from 0 to 255.

DesktopScintillaControlMBS.StyleAt(position as Integer) as ScintillaStyleMBS