Interface IScintillaGateway
Primary interface to Notepad++/Scintilla.
See https://www.scintilla.org/ScintillaDoc.html for further details.
public interface IScintillaGatewayRemarks
If gateways are missing or incomplete, feel free to open a discussion at https://github.com/orgs/npp-dotnet/discussions
Properties
CodePage
Gets the encoding of the currently active document.
Encoding CodePage { get; }Property Value
LineDelimiter
Gets a newline string in the EOL mode of the current document.
string LineDelimiter { get; }Property Value
Methods
AddRefDocument(IntPtr)
Extend life of document. (Scintilla feature 2376)
void AddRefDocument(IntPtr doc)Parameters
docIntPtr
AddSelection(Position, Position)
Add a selection (Scintilla feature 2573)
void AddSelection(Position caret, Position anchor)Parameters
AddStyledText(Position, Cells)
Add array of cells to document. (Scintilla feature 2002)
void AddStyledText(Position length, Cells c)Parameters
AddTabStop(Position, int)
Add an explicit tab stop for a line. (Scintilla feature 2676)
void AddTabStop(Position line, int x)Parameters
AddText(string)
Add text to the document at current position. (Scintilla feature 2001)
void AddText(string text)Parameters
textstring
AddUndoAction(int, UndoFlags)
Add a container action to the undo stack (Scintilla feature 2560)
void AddUndoAction(int token, UndoFlags flags)Parameters
Allocate(int)
Enlarge the document to a particular size of text bytes. (Scintilla feature 2446)
void Allocate(int bytes)Parameters
bytesint
AllocateExtendedStyles(int)
Allocate some extended (>255) style numbers and return the start of the range (Scintilla feature 2553)
int AllocateExtendedStyles(int numberStyles)Parameters
numberStylesint
Returns
AllocateLineCharacterIndex(LineCharacterIndexType)
Request line character index be created or its use count increased. (Scintilla feature 2711)
void AllocateLineCharacterIndex(LineCharacterIndexType lineCharacterIndex)Parameters
lineCharacterIndexLineCharacterIndexType
AllocateSubStyles(int, int)
Allocate a set of sub styles for a particular base style, returning start of range (Scintilla feature 4020)
int AllocateSubStyles(int styleBase, int numberStyles)Parameters
Returns
AnnotationClearAll()
Clear the annotations from all lines (Scintilla feature 2547)
void AnnotationClearAll()AnnotationGetLines(Position)
Get the number of annotation lines for a line (Scintilla feature 2546)
int AnnotationGetLines(Position line)Parameters
linePosition
Returns
AnnotationGetStyle(Position)
Get the style number for the annotations for a line (Scintilla feature 2543)
int AnnotationGetStyle(Position line)Parameters
linePosition
Returns
AnnotationGetStyleOffset()
Get the start of the range of style numbers used for annotations (Scintilla feature 2551)
int AnnotationGetStyleOffset()Returns
AnnotationGetStyles(Position)
Get the annotation styles for a line (Scintilla feature 2545)
string AnnotationGetStyles(Position line)Parameters
linePosition
Returns
AnnotationGetText(Position)
Get the annotation text for a line (Scintilla feature 2541)
string AnnotationGetText(Position line)Parameters
linePosition
Returns
AnnotationGetVisible()
Get the visibility for the annotations for a view (Scintilla feature 2549)
AnnotationVisible AnnotationGetVisible()Returns
AnnotationSetStyle(Position, int)
Set the style number for the annotations for a line (Scintilla feature 2542)
void AnnotationSetStyle(Position line, int style)Parameters
AnnotationSetStyleOffset(int)
Get the start of the range of style numbers used for annotations (Scintilla feature 2550)
void AnnotationSetStyleOffset(int style)Parameters
styleint
AnnotationSetStyles(Position, string)
Set the annotation styles for a line (Scintilla feature 2544)
void AnnotationSetStyles(Position line, string styles)Parameters
AnnotationSetText(Position, string)
Set the annotation text for a line (Scintilla feature 2540)
void AnnotationSetText(Position line, string text)Parameters
AnnotationSetVisible(AnnotationVisible)
Set the visibility for the annotations for a view (Scintilla feature 2548)
void AnnotationSetVisible(AnnotationVisible visible)Parameters
visibleAnnotationVisible
AppendText(string)
Append a string to the end of the document without changing the selection. (Scintilla feature 2282)
void AppendText(string text)Parameters
textstring
AppendTextAndMoveCursor(string)
void AppendTextAndMoveCursor(string text)Parameters
textstring
AssignCmdKey(KeyModifier, int)
When key+modifier combination keyDefinition is pressed perform sciCommand. (Scintilla feature 2070)
void AssignCmdKey(KeyModifier keyDefinition, int sciCommand)Parameters
keyDefinitionKeyModifiersciCommandint
AutoCActive()
Is there an auto-completion list visible? (Scintilla feature 2102)
bool AutoCActive()Returns
AutoCCancel()
Remove the auto-completion list from the screen. (Scintilla feature 2101)
void AutoCCancel()AutoCComplete()
User has selected an item so remove the list and insert the selection. (Scintilla feature 2104)
void AutoCComplete()AutoCGetAutoHide()
Retrieve whether or not autocompletion is hidden automatically when nothing matches. (Scintilla feature 2119)
bool AutoCGetAutoHide()Returns
AutoCGetCancelAtStart()
Retrieve whether auto-completion cancelled by backspacing before start. (Scintilla feature 2111)
bool AutoCGetCancelAtStart()Returns
AutoCGetCaseInsensitiveBehaviour()
Get auto-completion case insensitive behaviour. (Scintilla feature 2635)
CaseInsensitiveBehaviour AutoCGetCaseInsensitiveBehaviour()Returns
AutoCGetChooseSingle()
Retrieve whether a single item auto-completion list automatically choose the item. (Scintilla feature 2114)
bool AutoCGetChooseSingle()Returns
AutoCGetCurrent()
Get currently selected item position in the auto-completion list (Scintilla feature 2445)
int AutoCGetCurrent()Returns
AutoCGetCurrentText()
Get currently selected item text in the auto-completion list Returns the length of the item text Result is NUL-terminated. (Scintilla feature 2610)
string AutoCGetCurrentText()Returns
AutoCGetDropRestOfWord()
Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion. (Scintilla feature 2271)
bool AutoCGetDropRestOfWord()Returns
AutoCGetIgnoreCase()
Retrieve state of ignore case flag. (Scintilla feature 2116)
bool AutoCGetIgnoreCase()Returns
AutoCGetMaxHeight()
Set the maximum height, in rows, of auto-completion and user lists. (Scintilla feature 2211)
int AutoCGetMaxHeight()Returns
AutoCGetMaxWidth()
Get the maximum width, in characters, of auto-completion and user lists. (Scintilla feature 2209)
int AutoCGetMaxWidth()Returns
AutoCGetMulti()
Retrieve the effect of autocompleting when there are multiple selections. (Scintilla feature 2637)
MultiAutoComplete AutoCGetMulti()Returns
AutoCGetOrder()
Get the way autocompletion lists are ordered. (Scintilla feature 2661)
Ordering AutoCGetOrder()Returns
AutoCGetSeparator()
Retrieve the auto-completion list separator character. (Scintilla feature 2107)
int AutoCGetSeparator()Returns
AutoCGetTypeSeparator()
Retrieve the auto-completion list type-separator character. (Scintilla feature 2285)
int AutoCGetTypeSeparator()Returns
AutoCPosStart()
Retrieve the position of the caret when the auto-completion list was displayed. (Scintilla feature 2103)
Position AutoCPosStart()Returns
AutoCSelect(string)
Select the item in the auto-completion list that starts with a string. (Scintilla feature 2108)
void AutoCSelect(string select)Parameters
selectstring
AutoCSetAutoHide(bool)
Set whether or not autocompletion is hidden automatically when nothing matches. (Scintilla feature 2118)
void AutoCSetAutoHide(bool autoHide)Parameters
autoHidebool
AutoCSetCancelAtStart(bool)
Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created. (Scintilla feature 2110)
void AutoCSetCancelAtStart(bool cancel)Parameters
cancelbool
AutoCSetCaseInsensitiveBehaviour(CaseInsensitiveBehaviour)
Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference. (Scintilla feature 2634)
void AutoCSetCaseInsensitiveBehaviour(CaseInsensitiveBehaviour behaviour)Parameters
behaviourCaseInsensitiveBehaviour
AutoCSetChooseSingle(bool)
Should a single item auto-completion list automatically choose the item. (Scintilla feature 2113)
void AutoCSetChooseSingle(bool chooseSingle)Parameters
chooseSinglebool
AutoCSetDropRestOfWord(bool)
Set whether or not autocompletion deletes any word characters after the inserted text upon completion. (Scintilla feature 2270)
void AutoCSetDropRestOfWord(bool dropRestOfWord)Parameters
dropRestOfWordbool
AutoCSetFillUps(string)
Define a set of characters that when typed will cause the autocompletion to choose the selected item. (Scintilla feature 2112)
void AutoCSetFillUps(string characterSet)Parameters
characterSetstring
AutoCSetIgnoreCase(bool)
Set whether case is significant when performing auto-completion searches. (Scintilla feature 2115)
void AutoCSetIgnoreCase(bool ignoreCase)Parameters
ignoreCasebool
AutoCSetMaxHeight(int)
Set the maximum height, in rows, of auto-completion and user lists. The default is 5 rows. (Scintilla feature 2210)
void AutoCSetMaxHeight(int rowCount)Parameters
rowCountint
AutoCSetMaxWidth(int)
Set the maximum width, in characters, of auto-completion and user lists. Set to 0 to autosize to fit longest item, which is the default. (Scintilla feature 2208)
void AutoCSetMaxWidth(int characterCount)Parameters
characterCountint
AutoCSetMulti(MultiAutoComplete)
Change the effect of autocompleting when there are multiple selections. (Scintilla feature 2636)
void AutoCSetMulti(MultiAutoComplete multi)Parameters
multiMultiAutoComplete
AutoCSetOrder(Ordering)
Set the way autocompletion lists are ordered. (Scintilla feature 2660)
void AutoCSetOrder(Ordering order)Parameters
orderOrdering
AutoCSetSeparator(int)
Change the separator character in the string setting up an auto-completion list. Default is space but can be changed if items contain space. (Scintilla feature 2106)
void AutoCSetSeparator(int separatorCharacter)Parameters
separatorCharacterint
AutoCSetTypeSeparator(int)
Change the type-separator character in the string setting up an auto-completion list. Default is '?' but can be changed if items contain '?'. (Scintilla feature 2286)
void AutoCSetTypeSeparator(int separatorCharacter)Parameters
separatorCharacterint
AutoCShow(Position, string)
Display a auto-completion list. The lengthEntered parameter indicates how many characters before the caret should be used to provide context. (Scintilla feature 2100)
void AutoCShow(Position lengthEntered, string itemList)Parameters
AutoCStops(string)
Define a set of character that when typed cancel the auto-completion list. (Scintilla feature 2105)
void AutoCStops(string characterSet)Parameters
characterSetstring
BackTab()
Dedent the selected lines. (Scintilla feature 2328)
void BackTab()BeginUndoAction()
Start a sequence of actions that is undone and redone as a unit. May be nested. (Scintilla feature 2078)
void BeginUndoAction()BraceBadLight(Position)
Highlight the character at a position indicating there is no matching brace. (Scintilla feature 2352)
void BraceBadLight(Position pos)Parameters
posPosition
BraceBadLightIndicator(bool, int)
Use specified indicator to highlight non matching brace instead of changing its style. (Scintilla feature 2499)
void BraceBadLightIndicator(bool useSetting, int indicator)Parameters
BraceHighlight(int, int)
Highlight the characters at two positions. (Scintilla feature 2351)
void BraceHighlight(int posA, int posB)Parameters
BraceHighlightIndicator(bool, int)
Use specified indicator to highlight matching braces instead of changing their style. (Scintilla feature 2498)
void BraceHighlightIndicator(bool useSetting, int indicator)Parameters
BraceMatch(Position, int)
Find the position of a matching brace or INVALID_POSITION if no match. The maxReStyle must be 0 for now. It may be defined in a future release. (Scintilla feature 2353)
int BraceMatch(Position pos, int maxReStyle)Parameters
Returns
CallTipActive()
Is there an active call tip? (Scintilla feature 2202)
bool CallTipActive()Returns
CallTipCancel()
Remove the call tip from the screen. (Scintilla feature 2201)
void CallTipCancel()CallTipPosStart()
Retrieve the position where the caret was before displaying the call tip. (Scintilla feature 2203)
int CallTipPosStart()Returns
CallTipSetBack(Colour)
Set the background colour for the call tip. (Scintilla feature 2205)
void CallTipSetBack(Colour back)Parameters
backColour
CallTipSetFore(Colour)
Set the foreground colour for the call tip. (Scintilla feature 2206)
void CallTipSetFore(Colour fore)Parameters
foreColour
CallTipSetForeHlt(Colour)
Set the foreground colour for the highlighted part of the call tip. (Scintilla feature 2207)
void CallTipSetForeHlt(Colour fore)Parameters
foreColour
CallTipSetHlt(int, int)
Highlight a segment of the definition. (Scintilla feature 2204)
void CallTipSetHlt(int highlightStart, int highlightEnd)Parameters
CallTipSetPosStart(int)
Set the start position in order to change when backspacing removes the calltip. (Scintilla feature 2214)
void CallTipSetPosStart(int posStart)Parameters
posStartint
CallTipSetPosition(bool)
Set position of calltip, above or below text. (Scintilla feature 2213)
void CallTipSetPosition(bool above)Parameters
abovebool
CallTipShow(Position, string)
Show a call tip containing a definition near position pos. (Scintilla feature 2200)
void CallTipShow(Position pos, string definition)Parameters
CallTipUseStyle(int)
Enable use of STYLE_CALLTIP and set call tip tab size in pixels. (Scintilla feature 2212)
void CallTipUseStyle(int tabSize)Parameters
tabSizeint
CanPaste()
Will a paste succeed? (Scintilla feature 2173)
bool CanPaste()Returns
CanRedo()
Are there any redoable actions in the undo history? (Scintilla feature 2016)
bool CanRedo()Returns
CanUndo()
Are there any undoable actions in the undo history? (Scintilla feature 2174)
bool CanUndo()Returns
Cancel()
Cancel any modes such as call tip or auto-completion list display. (Scintilla feature 2325)
void Cancel()ChangeInsertion(string)
Change the text that is being inserted in response to SC_MOD_INSERTCHECK (Scintilla feature 2672)
void ChangeInsertion(string text)Parameters
textstring
ChangeLexerState(Position, Position)
Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw. (Scintilla feature 2617)
int ChangeLexerState(Position start, Position end)Parameters
Returns
CharLeft()
Move caret left one character. (Scintilla feature 2304)
void CharLeft()CharLeftExtend()
Move caret left one character extending selection to new caret position. (Scintilla feature 2305)
void CharLeftExtend()CharLeftRectExtend()
Move caret left one character, extending rectangular selection to new caret position. (Scintilla feature 2428)
void CharLeftRectExtend()CharPositionFromPoint(int, int)
Find the position of a character from a point within the window. (Scintilla feature 2561)
int CharPositionFromPoint(int x, int y)Parameters
Returns
CharPositionFromPointClose(int, int)
Find the position of a character from a point within the window. Return INVALID_POSITION if not close to text. (Scintilla feature 2562)
int CharPositionFromPointClose(int x, int y)Parameters
Returns
CharRight()
Move caret right one character. (Scintilla feature 2306)
void CharRight()CharRightExtend()
Move caret right one character extending selection to new caret position. (Scintilla feature 2307)
void CharRightExtend()CharRightRectExtend()
Move caret right one character, extending rectangular selection to new caret position. (Scintilla feature 2429)
void CharRightRectExtend()ChooseCaretX()
Set the last x chosen value to be the caret x position. (Scintilla feature 2399)
void ChooseCaretX()Clear()
Clear the selection. (Scintilla feature 2180)
void Clear()ClearAll()
Delete all text in the document. (Scintilla feature 2004)
void ClearAll()ClearAllCmdKeys()
Drop all key mappings. (Scintilla feature 2072)
void ClearAllCmdKeys()ClearCmdKey(KeyModifier)
When key+modifier combination keyDefinition is pressed do nothing. (Scintilla feature 2071)
void ClearCmdKey(KeyModifier keyDefinition)Parameters
keyDefinitionKeyModifier
ClearDocumentStyle()
Set all style bytes to 0, remove all folding information. (Scintilla feature 2005)
void ClearDocumentStyle()ClearRegisteredImages()
Clear all the registered XPM images. (Scintilla feature 2408)
void ClearRegisteredImages()ClearRepresentation(string)
Remove a character representation. (Scintilla feature 2667)
void ClearRepresentation(string encodedCharacter)Parameters
encodedCharacterstring
Remarks
ClearSelectionToCursor()
void ClearSelectionToCursor()ClearSelections()
Clear selections to a single empty stream selection (Scintilla feature 2571)
void ClearSelections()ClearTabStops(Position)
Clear explicit tabstops on a line. (Scintilla feature 2675)
void ClearTabStops(Position line)Parameters
linePosition
Colourise(Position, Position)
Colourise a segment of the document using the current lexing language. (Scintilla feature 4003)
void Colourise(Position start, Position end)Parameters
ContractedFoldNext(int)
Find the next line at or after lineStart that is a contracted fold header line. Return -1 when no more lines. (Scintilla feature 2618)
int ContractedFoldNext(int lineStart)Parameters
lineStartint
Returns
ConvertEOLs(EndOfLine)
Convert all line endings in the document to one mode. (Scintilla feature 2029)
void ConvertEOLs(EndOfLine eolMode)Parameters
eolModeEndOfLine
Copy()
Copy the selection to the clipboard. (Scintilla feature 2178)
void Copy()CopyAllowLine()
Copy the selection, if selection empty copy the line with the caret (Scintilla feature 2519)
void CopyAllowLine()CopyRange(Position, Position)
Copy a range of text to the clipboard. Positions are clipped into the document. (Scintilla feature 2419)
void CopyRange(Position start, Position end)Parameters
CopyText(string)
Copy argument text to the clipboard. (Scintilla feature 2420)
void CopyText(string text)Parameters
textstring
CountCharacters(Position, Position)
Count characters between two positions. (Scintilla feature 2633)
int CountCharacters(Position start, Position end)Parameters
Returns
CountCodeUnits(Position, Position)
Count code units between two positions. (Scintilla feature 2715)
int CountCodeUnits(Position start, Position end)Parameters
Returns
CreateDocument(int, DocumentOption)
Create a new document object. Starts with reference count of 1 and not selected into editor. (Scintilla feature 2375)
IntPtr CreateDocument(int bytes, DocumentOption documentOptions)Parameters
bytesintdocumentOptionsDocumentOption
Returns
CreateLoader(int, DocumentOption)
Create an ILoader*. (Scintilla feature 2632)
IntPtr CreateLoader(int bytes, DocumentOption documentOptions)Parameters
bytesintdocumentOptionsDocumentOption
Returns
Cut()
Cut the selection to the clipboard. (Scintilla feature 2177)
void Cut()DelLineLeft()
Delete back from the current position to the start of the line. (Scintilla feature 2395)
void DelLineLeft()DelLineRight()
Delete forwards from the current position to the end of the line. (Scintilla feature 2396)
void DelLineRight()DelWordLeft()
Delete the word to the left of the caret. (Scintilla feature 2335)
void DelWordLeft()DelWordRight()
Delete the word to the right of the caret. (Scintilla feature 2336)
void DelWordRight()DelWordRightEnd()
Delete the word to the right of the caret, but not the trailing non-word characters. (Scintilla feature 2518)
void DelWordRightEnd()DeleteBack()
Delete the selection or if no selection, the character before the caret. (Scintilla feature 2326)
void DeleteBack()DeleteBackNotLine()
Delete the selection or if no selection, the character before the caret. Will not delete the character before at the start of a line. (Scintilla feature 2344)
void DeleteBackNotLine()DeleteRange(Position, Position)
Delete a range of text in the document. (Scintilla feature 2645)
void DeleteRange(Position start, Position lengthDelete)Parameters
DescribeKeyWordSets()
Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer. Result is NUL-terminated. (Scintilla feature 4017)
string DescribeKeyWordSets()Returns
DescribeProperty(string)
Describe a property. Result is NUL-terminated. (Scintilla feature 4016)
string DescribeProperty(string name)Parameters
namestring
Returns
DescriptionOfStyle(int)
Retrieve a description of a style. Result is NUL-terminated. (Scintilla feature 4032)
string DescriptionOfStyle(int style)Parameters
styleint
Returns
DistanceToSecondaryStyles()
Where styles are duplicated by a feature such as active/inactive code return the distance between the two types. (Scintilla feature 4025)
int DistanceToSecondaryStyles()Returns
DocLineFromVisible(int)
Find the document line of a display line taking hidden lines into account. (Scintilla feature 2221)
int DocLineFromVisible(int displayLine)Parameters
displayLineint
Returns
DocumentEnd()
Move caret to last position in document. (Scintilla feature 2318)
void DocumentEnd()DocumentEndExtend()
Move caret to last position in document extending selection to new caret position. (Scintilla feature 2319)
void DocumentEndExtend()DocumentStart()
Move caret to first position in document. (Scintilla feature 2316)
void DocumentStart()DocumentStartExtend()
Move caret to first position in document extending selection to new caret position. (Scintilla feature 2317)
void DocumentStartExtend()DropSelectionN(int)
Drop one selection (Scintilla feature 2671)
void DropSelectionN(int selection)Parameters
selectionint
EditToggleOvertype()
Switch from insert to overtype mode or the reverse. (Scintilla feature 2324)
void EditToggleOvertype()EmptyUndoBuffer()
Delete the undo history. (Scintilla feature 2175)
void EmptyUndoBuffer()EncodedFromUTF8(string)
Translates a UTF8 string into the document encoding. Return the length of the result in bytes. On error return 0. (Scintilla feature 2449)
string EncodedFromUTF8(string utf8)Parameters
utf8string
Returns
EndUndoAction()
End a sequence of actions that is undone and redone as a unit. (Scintilla feature 2079)
void EndUndoAction()EnsureVisible(Position)
Ensure a particular line is visible by expanding any header line hiding it. (Scintilla feature 2232)
void EnsureVisible(Position line)Parameters
linePosition
EnsureVisibleEnforcePolicy(Position)
Ensure a particular line is visible by expanding any header line hiding it. Use the currently set visibility policy to determine which range to display. (Scintilla feature 2234)
void EnsureVisibleEnforcePolicy(Position line)Parameters
linePosition
ExpandChildren(Position, FoldLevel)
Expand a fold header and all children. Use the level argument instead of the line's current level. (Scintilla feature 2239)
void ExpandChildren(Position line, FoldLevel level)Parameters
FindColumn(Position, int)
Find the position of a column on a line taking into account tabs and multi-byte characters. If beyond end of line, return line end position. (Scintilla feature 2456)
int FindColumn(Position line, int column)Parameters
Returns
FindIndicatorFlash(Position, Position)
On OS X, flash a find indicator, then fade out. (Scintilla feature 2641)
void FindIndicatorFlash(Position start, Position end)Parameters
FindIndicatorHide()
On OS X, hide the find indicator. (Scintilla feature 2642)
void FindIndicatorHide()FindIndicatorShow(Position, Position)
On OS X, show a find indicator. (Scintilla feature 2640)
void FindIndicatorShow(Position start, Position end)Parameters
FindText(FindOption, TextToFind)
Find some text in the document. (Scintilla feature 2150)
[Obsolete("Use FindText(Npp.DotNet.Plugin.FindOption, Npp.DotNet.Plugin.TextRangeFull) instead")]
int FindText(FindOption searchFlags, TextToFind ft)Parameters
searchFlagsFindOptionftTextToFind
Returns
FindText(FindOption, TextToFindFull)
Find some text in the document. (Scintilla feature 2196)
long FindText(FindOption searchFlags, TextToFindFull ft)Parameters
searchFlagsFindOptionftTextToFindFull
Returns
FoldAll(FoldAction)
Expand or contract all fold headers. (Scintilla feature 2662)
void FoldAll(FoldAction action)Parameters
actionFoldAction
FoldChildren(Position, FoldAction)
Expand or contract a fold header and its children. (Scintilla feature 2238)
void FoldChildren(Position line, FoldAction action)Parameters
linePositionactionFoldAction
FoldDisplayTextGetStyle()
Get the style of fold display text. (Scintilla feature 2707)
FoldDisplayTextStyle FoldDisplayTextGetStyle()Returns
FoldDisplayTextSetStyle(FoldDisplayTextStyle)
Set the style of fold display text. (Scintilla feature 2701)
void FoldDisplayTextSetStyle(FoldDisplayTextStyle style)Parameters
styleFoldDisplayTextStyle
FoldLine(Position, FoldAction)
Expand or contract a fold header. (Scintilla feature 2237)
void FoldLine(Position line, FoldAction action)Parameters
linePositionactionFoldAction
FormFeed()
Insert a Form Feed character. (Scintilla feature 2330)
void FormFeed()FreeSubStyles()
Free allocated sub styles (Scintilla feature 4023)
void FreeSubStyles()GetAccessibility()
Report accessibility status. (Scintilla feature 2703)
Accessibility GetAccessibility()Returns
GetAdditionalCaretFore()
Get the foreground colour of additional carets. (Scintilla feature 2605)
[Obsolete("Replaced in Scintilla v5 by SCI_GETELEMENTCOLOUR(SC_ELEMENT_CARET)")]
Colour GetAdditionalCaretFore()Returns
GetAdditionalCaretsBlink()
Whether additional carets will blink (Scintilla feature 2568)
bool GetAdditionalCaretsBlink()Returns
GetAdditionalCaretsVisible()
Whether additional carets are visible (Scintilla feature 2609)
bool GetAdditionalCaretsVisible()Returns
GetAdditionalSelAlpha()
Get the alpha of the selection. (Scintilla feature 2603)
[Obsolete("Replaced in Scintilla v5 by SCI_GETELEMENTCOLOUR(SC_ELEMENT_SELECTION_ADDITIONAL_TEXT)")]
Alpha GetAdditionalSelAlpha()Returns
GetAdditionalSelectionTyping()
Whether typing can be performed into multiple selections (Scintilla feature 2566)
bool GetAdditionalSelectionTyping()Returns
GetAllLinesVisible()
Are all lines visible? (Scintilla feature 2236)
bool GetAllLinesVisible()Returns
GetAnchor()
Returns the position of the opposite end of the selection to the caret. (Scintilla feature 2009)
Position GetAnchor()Returns
GetAutomaticFold()
Get automatic folding behaviours. (Scintilla feature 2664)
AutomaticFold GetAutomaticFold()Returns
GetBackSpaceUnIndents()
Does a backspace pressed when caret is within indentation unindent? (Scintilla feature 2263)
bool GetBackSpaceUnIndents()Returns
GetBufferedDraw()
Is drawing done first into a buffer or direct to the screen? (Scintilla feature 2034)
bool GetBufferedDraw()Returns
GetCaretFore()
SCI_GETCARETFORE -> colour
The colour of the caret can be set with SCI_SETELEMENTCOLOUR(SC_ELEMENT_CARET) or SCI_SETCARETFORE and
retrieved with SCI_GETELEMENTCOLOUR(SC_ELEMENT_CARET) or SCI_GETCARETFORE. The element APIs
are preferred and allow setting the translucency of carets.
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
Colour GetCaretFore()Returns
GetCaretLineBack()
SCI_GETCARETLINEBACK -> colour
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
Colour GetCaretLineBack()Returns
GetCaretLineBackAlpha()
SCI_GETCARETLINEBACKALPHA -> int
These APIs are discouraged. It is better to use the SC_ELEMENT_CARET_LINE_BACK element mentioned in the
previous section. You can choose to make the background colour of the line containing the caret different with
these messages. To do this, set the desired background colour with SCI_SETCARETLINEBACK, then use
SCI_SETCARETLINEVISIBLE(true) to enable the effect. You can cancel the effect with
SCI_SETCARETLINEVISIBLE(false). The two SCI_GETCARET* functions return the state and the colour. This form of
background colouring has highest priority when a line has markers that would otherwise change the background
colour. The caret line may also be drawn translucently which allows other background colours to show
through. This is done by setting the alpha (translucency) value by calling SCI_SETCARETLINEBACKALPHA. When
the alpha is not SC_ALPHA_NOALPHA, the caret line is drawn after all other features so will affect the
colour of all other features.
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
Alpha GetCaretLineBackAlpha()Returns
GetCaretLineFrame()
Retrieve the caret line frame width. Width = 0 means this option is disabled. (Scintilla feature 2704)
int GetCaretLineFrame()Returns
GetCaretLineVisible()
SCI_GETCARETLINEVISIBLE -> bool
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
bool GetCaretLineVisible()Returns
GetCaretLineVisibleAlways()
Is the caret line always visible? (Scintilla feature 2654)
bool GetCaretLineVisibleAlways()Returns
GetCaretPeriod()
Get the time in milliseconds that the caret is on and off. (Scintilla feature 2075)
int GetCaretPeriod()Returns
GetCaretSticky()
Can the caret preferred x position only be changed by explicit movement commands? (Scintilla feature 2457)
CaretSticky GetCaretSticky()Returns
GetCaretStyle()
Returns the current style of the caret. (Scintilla feature 2513)
CaretStyle GetCaretStyle()Returns
GetCaretWidth()
Returns the width of the insert mode caret. (Scintilla feature 2189)
int GetCaretWidth()Returns
GetCharAt(Position)
Returns the character byte at the position. (Scintilla feature 2007)
int GetCharAt(Position pos)Parameters
posPosition
Returns
GetCharacterCategoryOptimization()
Get the number of characters to have directly indexed categories (Scintilla feature 2721)
int GetCharacterCategoryOptimization()Returns
GetCharacterPointer()
Compact the document buffer and return a read-only pointer to the characters in the document. (Scintilla feature 2520)
IntPtr GetCharacterPointer()Returns
GetCodePage()
Get the code page used to interpret the bytes of the document as characters. (Scintilla feature 2137)
int GetCodePage()Returns
GetColumn(Position)
Retrieve the column number of a position, taking tab width into account. (Scintilla feature 2129)
int GetColumn(Position pos)Parameters
posPosition
Returns
GetCommandEvents()
Get whether command events are sent to the container. (Scintilla feature 2718)
bool GetCommandEvents()Returns
GetControlCharSymbol()
Get the way control characters are displayed. (Scintilla feature 2389)
int GetControlCharSymbol()Returns
GetCurLine()
Retrieve the text of the line containing the caret. Returns the index of the caret on the line. Result is NUL-terminated. (Scintilla feature 2027)
string GetCurLine()Returns
GetCurrentLineNumber()
Get the current line from the current position
long GetCurrentLineNumber()Returns
GetCurrentPos()
Returns the position of the caret. (Scintilla feature 2008)
Position GetCurrentPos()Returns
GetCursor()
Get cursor type. (Scintilla feature 2387)
CursorShape GetCursor()Returns
GetDefaultFoldDisplayText()
Get the default fold display text. (Scintilla feature 2723)
string GetDefaultFoldDisplayText()Returns
GetDirectFunction()
Retrieve a pointer to a function that processes messages for this Scintilla. (Scintilla feature 2184)
IntPtr GetDirectFunction()Returns
GetDirectPointer()
Retrieve a pointer value to use as the first argument when calling the function returned by GetDirectFunction. (Scintilla feature 2185)
IntPtr GetDirectPointer()Returns
GetDocPointer()
Retrieve a pointer to the document object. (Scintilla feature 2357)
IntPtr GetDocPointer()Returns
GetDocumentOptions()
Get which document options are set. (Scintilla feature 2379)
DocumentOption GetDocumentOptions()Returns
GetEOLMode()
Retrieve the current end of line mode - one of CRLF, CR, or LF. (Scintilla feature 2030)
EndOfLine GetEOLMode()Returns
GetEdgeColour()
Retrieve the colour used in edge indication. (Scintilla feature 2364)
Colour GetEdgeColour()Returns
GetEdgeColumn()
Retrieve the column number which text should be kept within. (Scintilla feature 2360)
int GetEdgeColumn()Returns
GetEdgeMode()
Retrieve the edge highlight mode. (Scintilla feature 2362)
EdgeVisualStyle GetEdgeMode()Returns
GetEndAtLastLine()
Retrieve whether the maximum scroll position has the last line at the bottom of the view. (Scintilla feature 2278)
bool GetEndAtLastLine()Returns
GetEndStyled()
Retrieve the position of the last correctly styled character. (Scintilla feature 2028)
Position GetEndStyled()Returns
GetExtraAscent()
Get extra ascent for each line (Scintilla feature 2526)
int GetExtraAscent()Returns
GetExtraDescent()
Get extra descent for each line (Scintilla feature 2528)
int GetExtraDescent()Returns
GetFirstVisibleLine()
Retrieve the display line at the top of the display. (Scintilla feature 2152)
Position GetFirstVisibleLine()Returns
GetFocus()
Get internal focus flag. (Scintilla feature 2381)
bool GetFocus()Returns
GetFoldExpanded(Position)
Is a header line expanded? (Scintilla feature 2230)
bool GetFoldExpanded(Position line)Parameters
linePosition
Returns
GetFoldLevel(Position)
Retrieve the fold level of a line. (Scintilla feature 2223)
FoldLevel GetFoldLevel(Position line)Parameters
linePosition
Returns
GetFoldParent(Position)
Find the parent line of a child line. (Scintilla feature 2225)
Position GetFoldParent(Position line)Parameters
linePosition
Returns
GetFontQuality()
Retrieve the quality level for text. (Scintilla feature 2612)
FontQuality GetFontQuality()Returns
GetGapPosition()
Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer. (Scintilla feature 2644)
Position GetGapPosition()Returns
GetHScrollBar()
Is the horizontal scroll bar visible? (Scintilla feature 2131)
bool GetHScrollBar()Returns
GetHighlightGuide()
Get the highlighted indentation guide column. (Scintilla feature 2135)
int GetHighlightGuide()Returns
GetHotspotActiveBack()
SCI_GETHOTSPOTACTIVEBACK -> colour
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
Colour GetHotspotActiveBack()Returns
GetHotspotActiveFore()
SCI_GETHOTSPOTACTIVEFORE -> colour
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
Colour GetHotspotActiveFore()Returns
GetHotspotActiveUnderline()
Get whether underlining for active hotspots. (Scintilla feature 2496)
bool GetHotspotActiveUnderline()Returns
GetHotspotSingleLine()
Get the HotspotSingleLine property (Scintilla feature 2497)
bool GetHotspotSingleLine()Returns
GetIMEInteraction()
Is the IME displayed in a window or inline? (Scintilla feature 2678)
IMEInteraction GetIMEInteraction()Returns
GetIdentifier()
Get the identifier. (Scintilla feature 2623)
int GetIdentifier()Returns
GetIdleStyling()
Retrieve the limits to idle styling. (Scintilla feature 2693)
IdleStyling GetIdleStyling()Returns
GetIndent()
Retrieve indentation size. (Scintilla feature 2123)
int GetIndent()Returns
GetIndentationGuides()
Are the indentation guides visible? (Scintilla feature 2133)
IndentView GetIndentationGuides()Returns
GetIndicatorCurrent()
Get the current indicator (Scintilla feature 2501)
int GetIndicatorCurrent()Returns
GetIndicatorValue()
Get the current indicator value (Scintilla feature 2503)
int GetIndicatorValue()Returns
GetKeysUnicode()
On Windows, Scintilla no longer supports narrow character windows so input is always treated as Unicode.
[Obsolete("See https://www.scintilla.org/ScintillaDoc.html#SCI_GETKEYSUNICODE")]
bool GetKeysUnicode()Returns
GetLastChild(Position, FoldLevel)
Find the last child line of a header line. (Scintilla feature 2224)
Position GetLastChild(Position line, FoldLevel level)Parameters
Returns
GetLayoutCache()
Retrieve the degree of caching of layout information. (Scintilla feature 2273)
LineCache GetLayoutCache()Returns
GetLength()
Returns the number of bytes in the document. (Scintilla feature 2006)
long GetLength()Returns
GetLexer()
Retrieve the lexing language of the document. (Scintilla feature 4002)
int GetLexer()Returns
GetLexerLanguage()
Retrieve the name of the lexer. Return the length of the text. Result is NUL-terminated. (Scintilla feature 4012)
string GetLexerLanguage()Returns
GetLine(Position)
Retrieve the contents of a line. Returns the length of the line. (Scintilla feature 2153)
string GetLine(Position line)Parameters
linePosition
Returns
GetLineCharacterIndex()
Retrieve line character index state. (Scintilla feature 2710)
LineCharacterIndexType GetLineCharacterIndex()Returns
GetLineCount()
Returns the number of lines in the document. There is always at least one. (Scintilla feature 2154)
int GetLineCount()Returns
GetLineEndPosition(Position)
Get the position after the last visible characters on a line. (Scintilla feature 2136)
Position GetLineEndPosition(Position line)Parameters
linePosition
Returns
GetLineEndTypesActive()
Get the line end types currently recognised. May be a subset of the allowed types due to lexer limitation. (Scintilla feature 2658)
LineEndType GetLineEndTypesActive()Returns
GetLineEndTypesAllowed()
Get the line end types currently allowed. (Scintilla feature 2657)
LineEndType GetLineEndTypesAllowed()Returns
GetLineEndTypesSupported()
Bit set of LineEndType enumertion for which line ends beyond the standard LF, CR, and CRLF are supported by the lexer. (Scintilla feature 4018)
int GetLineEndTypesSupported()Returns
GetLineIndentPosition(Position)
Retrieve the position before the first non indentation character on a line. (Scintilla feature 2128)
Position GetLineIndentPosition(Position line)Parameters
linePosition
Returns
GetLineIndentation(Position)
Retrieve the number of columns that a line is indented. (Scintilla feature 2127)
int GetLineIndentation(Position line)Parameters
linePosition
Returns
GetLineSelEndPosition(Position)
Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line). (Scintilla feature 2425)
Position GetLineSelEndPosition(Position line)Parameters
linePosition
Returns
GetLineSelStartPosition(Position)
Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line). (Scintilla feature 2424)
Position GetLineSelStartPosition(Position line)Parameters
linePosition
Returns
GetLineState(Position)
Retrieve the extra styling information for a line. (Scintilla feature 2093)
int GetLineState(Position line)Parameters
linePosition
Returns
GetLineVisible(Position)
Is a line visible? (Scintilla feature 2228)
bool GetLineVisible(Position line)Parameters
linePosition
Returns
GetMainSelection()
Which selection is the main selection (Scintilla feature 2575)
int GetMainSelection()Returns
GetMarginBackN(int)
Retrieve the background colour of a margin (Scintilla feature 2251)
Colour GetMarginBackN(int margin)Parameters
marginint
Returns
GetMarginCursorN(int)
Retrieve the cursor shown in a margin. (Scintilla feature 2249)
CursorShape GetMarginCursorN(int margin)Parameters
marginint
Returns
GetMarginLeft()
Returns the size in pixels of the left margin. (Scintilla feature 2156)
int GetMarginLeft()Returns
GetMarginMaskN(int)
Retrieve the marker mask of a margin. (Scintilla feature 2245)
int GetMarginMaskN(int margin)Parameters
marginint
Returns
GetMarginOptions()
Get the margin options. (Scintilla feature 2557)
MarginOption GetMarginOptions()Returns
GetMarginRight()
Returns the size in pixels of the right margin. (Scintilla feature 2158)
int GetMarginRight()Returns
GetMarginSensitiveN(int)
Retrieve the mouse click sensitivity of a margin. (Scintilla feature 2247)
bool GetMarginSensitiveN(int margin)Parameters
marginint
Returns
GetMarginTypeN(int)
Retrieve the type of a margin. (Scintilla feature 2241)
MarginType GetMarginTypeN(int margin)Parameters
marginint
Returns
GetMarginWidthN(int)
Retrieve the width of a margin in pixels. (Scintilla feature 2243)
int GetMarginWidthN(int margin)Parameters
marginint
Returns
GetMargins()
How many margins are there?. (Scintilla feature 2253)
int GetMargins()Returns
GetMaxLineState()
Retrieve the last line number that has line state. (Scintilla feature 2094)
int GetMaxLineState()Returns
GetModEventMask()
Get which document modification events are sent to the container. (Scintilla feature 2378)
ModificationFlags GetModEventMask()Returns
GetModify()
Is the document different from when it was last saved? (Scintilla feature 2159)
bool GetModify()Returns
GetMouseDownCaptures()
Get whether mouse gets captured. (Scintilla feature 2385)
bool GetMouseDownCaptures()Returns
GetMouseDwellTime()
Retrieve the time the mouse must sit still to generate a mouse dwell event. (Scintilla feature 2265)
int GetMouseDwellTime()Returns
GetMouseSelectionRectangularSwitch()
Whether switching to rectangular mode while selecting with the mouse is allowed. (Scintilla feature 2669)
bool GetMouseSelectionRectangularSwitch()Returns
GetMouseWheelCaptures()
Get whether mouse wheel can be active outside the window. (Scintilla feature 2697)
bool GetMouseWheelCaptures()Returns
GetMoveExtendsSelection()
Get whether or not regular caret moves will extend or reduce the selection. (Scintilla feature 2706)
bool GetMoveExtendsSelection()Returns
GetMultiPaste()
Retrieve the effect of pasting when there are multiple selections. (Scintilla feature 2615)
MultiPaste GetMultiPaste()Returns
GetMultipleSelection()
Whether multiple selections can be made (Scintilla feature 2564)
bool GetMultipleSelection()Returns
GetNamedStyles()
Retrieve the number of named styles for the lexer. (Scintilla feature 4029)
int GetNamedStyles()Returns
GetNextTabStop(Position, int)
Find the next explicit tab stop position on a line after a position. (Scintilla feature 2677)
int GetNextTabStop(Position line, int x)Parameters
Returns
GetOvertype()
Returns true if overtype mode is active otherwise false is returned. (Scintilla feature 2187)
bool GetOvertype()Returns
GetPasteConvertEndings()
Get convert-on-paste setting (Scintilla feature 2468)
bool GetPasteConvertEndings()Returns
GetPhasesDraw()
How many phases is drawing done in? (Scintilla feature 2673)
PhasesDraw GetPhasesDraw()Returns
GetPositionCache()
How many entries are allocated to the position cache? (Scintilla feature 2515)
int GetPositionCache()Returns
GetPrimaryStyleFromStyle(int)
For a secondary style, return the primary style, else return the argument. (Scintilla feature 4028)
int GetPrimaryStyleFromStyle(int style)Parameters
styleint
Returns
GetPrintColourMode()
Returns the print colour mode. (Scintilla feature 2149)
PrintOption GetPrintColourMode()Returns
GetPrintMagnification()
Returns the print magnification. (Scintilla feature 2147)
int GetPrintMagnification()Returns
GetPrintWrapMode()
Is printing line wrapped? (Scintilla feature 2407)
Wrap GetPrintWrapMode()Returns
GetProperty(string)
Retrieve a "property" value previously set with SetProperty. Result is NUL-terminated. (Scintilla feature 4008)
string GetProperty(string key)Parameters
keystring
Returns
GetPropertyExpanded(string)
Retrieve a "property" value previously set with SetProperty, with "$()" variable replacement on returned buffer. Result is NUL-terminated. (Scintilla feature 4009)
[Obsolete("This is now the same as SCI_GETPROPERTY - no expansion is performed. See https://www.scintilla.org/ScintillaDoc.html#SCI_GETPROPERTYEXPANDED")]
string GetPropertyExpanded(string key)Parameters
keystring
Returns
GetPropertyInt(string, int)
Retrieve a "property" value previously set with SetProperty, interpreted as an int AFTER any "$()" variable replacement. (Scintilla feature 4010)
int GetPropertyInt(string key, int defaultValue)Parameters
Returns
GetPunctuationChars()
Get the set of characters making up punctuation characters (Scintilla feature 2649)
string GetPunctuationChars()Returns
GetRangePointer(Position, Position)
Return a read-only pointer to a range of characters in the document. May move the gap so that the range is contiguous, but will only move up to lengthRange bytes. (Scintilla feature 2643)
IntPtr GetRangePointer(Position start, Position lengthRange)Parameters
Returns
GetReadOnly()
In read-only mode? (Scintilla feature 2140)
bool GetReadOnly()Returns
GetRectangularSelectionAnchor()
Return the anchor position of the rectangular selection. (Scintilla feature 2591)
Position GetRectangularSelectionAnchor()Returns
GetRectangularSelectionAnchorVirtualSpace()
Return the virtual space of the anchor of the rectangular selection. (Scintilla feature 2595)
Position GetRectangularSelectionAnchorVirtualSpace()Returns
GetRectangularSelectionCaret()
Return the caret position of the rectangular selection. (Scintilla feature 2589)
Position GetRectangularSelectionCaret()Returns
GetRectangularSelectionCaretVirtualSpace()
Return the virtual space of the caret of the rectangular selection. (Scintilla feature 2593)
Position GetRectangularSelectionCaretVirtualSpace()Returns
GetRectangularSelectionModifier()
Get the modifier key used for rectangular selection. (Scintilla feature 2599)
int GetRectangularSelectionModifier()Returns
GetRepresentation(string)
Set the way a character is drawn. Result is NUL-terminated. (Scintilla feature 2666)
string GetRepresentation(string encodedCharacter)Parameters
encodedCharacterstring
Returns
Remarks
GetScrollInfo(ScrollInfoMask, ScrollInfoBar)
Get the scroll information for the current Scintilla window.
Win32.ScrollInfo GetScrollInfo(Win32.ScrollInfoMask mask = ScrollInfoMask.SIF_ALL, Win32.ScrollInfoBar scrollBar = ScrollInfoBar.SB_BOTH)Parameters
maskWin32.ScrollInfoMaskArguments for the scroll information such as tracking
scrollBarWin32.ScrollInfoBarWhich scroll bar information are you looking for
Returns
- Win32.ScrollInfo
A ScrollInfo struct with information of the current scroll state
GetScrollWidth()
Retrieve the document width assumed for scrolling. (Scintilla feature 2275)
int GetScrollWidth()Returns
GetScrollWidthTracking()
Retrieve whether the scroll width tracks wide lines. (Scintilla feature 2517)
bool GetScrollWidthTracking()Returns
GetSearchFlags()
Get the search flags used by SearchInTarget. (Scintilla feature 2199)
FindOption GetSearchFlags()Returns
GetSelAlpha()
SCI_GETSELALPHA -> int
These APIs are now discouraged and should be replaced with a combination of setting the layer with
SCI_SETSELECTIONLAYER and setting translucency through the SC_ELEMENT_SELECTION_BACK element.
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
Alpha GetSelAlpha()Returns
GetSelEOLFilled()
Is the selection end of line filled? (Scintilla feature 2479)
bool GetSelEOLFilled()Returns
GetSelText()
Retrieve the selected text. Return the length of the text. Result is NUL-terminated. (Scintilla feature 2161)
string GetSelText()Returns
GetSelectionEmpty()
Is every selected range empty? (Scintilla feature 2650)
bool GetSelectionEmpty()Returns
GetSelectionEnd()
Returns the position at the end of the selection. (Scintilla feature 2145)
Position GetSelectionEnd()Returns
GetSelectionLength()
int GetSelectionLength()Returns
GetSelectionMode()
Get the mode of the current selection. (Scintilla feature 2423)
SelectionMode GetSelectionMode()Returns
GetSelectionNAnchor(int)
Return the anchor position of the nth selection. (Scintilla feature 2579)
Position GetSelectionNAnchor(int selection)Parameters
selectionint
Returns
GetSelectionNAnchorVirtualSpace(int)
Return the virtual space of the anchor of the nth selection. (Scintilla feature 2583)
Position GetSelectionNAnchorVirtualSpace(int selection)Parameters
selectionint
Returns
GetSelectionNCaret(int)
Return the caret position of the nth selection. (Scintilla feature 2577)
Position GetSelectionNCaret(int selection)Parameters
selectionint
Returns
GetSelectionNCaretVirtualSpace(int)
Return the virtual space of the caret of the nth selection. (Scintilla feature 2581)
Position GetSelectionNCaretVirtualSpace(int selection)Parameters
selectionint
Returns
GetSelectionNEnd(int)
Returns the position at the end of the selection. (Scintilla feature 2587)
Position GetSelectionNEnd(int selection)Parameters
selectionint
Returns
GetSelectionNStart(int)
Returns the position at the start of the selection. (Scintilla feature 2585)
Position GetSelectionNStart(int selection)Parameters
selectionint
Returns
GetSelectionStart()
Returns the position at the start of the selection. (Scintilla feature 2143)
Position GetSelectionStart()Returns
GetSelections()
How many selections are there? (Scintilla feature 2570)
int GetSelections()Returns
GetStatus()
Get error status. (Scintilla feature 2383)
Status GetStatus()Returns
GetStyleAt(Position)
Returns the style byte at the position. (Scintilla feature 2010)
int GetStyleAt(Position pos)Parameters
posPosition
Returns
GetStyleBits()
Always returns 8, indicating that 8 bits are used for styling and there are 256 styles.
[Obsolete("See https://www.scintilla.org/ScintillaDoc.html#SCI_GETSTYLEBITS")]
int GetStyleBits()Returns
GetStyleBitsNeeded()
Always returns 8, indicating that 8 bits are used for styling and there are 256 styles.
[Obsolete("See https://www.scintilla.org/ScintillaDoc.html#SCI_GETSTYLEBITSNEEDED")]
int GetStyleBitsNeeded()Returns
GetStyleFromSubStyle(int)
For a sub style, return the base style, else return the argument. (Scintilla feature 4027)
int GetStyleFromSubStyle(int subStyle)Parameters
subStyleint
Returns
GetStyledText(TextRange)
Retrieve a buffer of cells. Returns the number of bytes in the buffer not including terminating NULs. (Scintilla feature 2015)
[Obsolete("Use GetStyledText(Npp.DotNet.Plugin.TextRangeFull) instead")]
int GetStyledText(TextRange tr)Parameters
trTextRange
Returns
GetStyledText(TextRangeFull)
Retrieve a buffer of cells. (Scintilla feature 2778)
long GetStyledText(TextRangeFull tr)Parameters
Returns
- long
The 64-bit number of bytes in the buffer, not including terminating NULs.
GetSubStyleBases()
Get the set of base styles that can be extended with sub styles Result is NUL-terminated. (Scintilla feature 4026)
string GetSubStyleBases()Returns
GetSubStylesLength(int)
The number of sub styles associated with a base style (Scintilla feature 4022)
int GetSubStylesLength(int styleBase)Parameters
styleBaseint
Returns
GetSubStylesStart(int)
The starting style number for the sub styles associated with a base style (Scintilla feature 4021)
int GetSubStylesStart(int styleBase)Parameters
styleBaseint
Returns
GetTabDrawMode()
Retrieve the current tab draw mode. Returns one of SCTD_* constants. (Scintilla feature 2698)
TabDrawMode GetTabDrawMode()Returns
GetTabIndents()
Does a tab pressed when caret is within indentation indent? (Scintilla feature 2261)
bool GetTabIndents()Returns
GetTabWidth()
Retrieve the visible size of a tab. (Scintilla feature 2121)
int GetTabWidth()Returns
GetTag(int)
Retrieve the value of a tag from a regular expression search. Result is NUL-terminated. (Scintilla feature 2616)
string GetTag(int tagNumber)Parameters
tagNumberint
Returns
Exceptions
- ArgumentException
Thrown if
tagNumberis less than 0.
GetTargetEnd()
Get the position that ends the target. (Scintilla feature 2193)
Position GetTargetEnd()Returns
GetTargetStart()
Get the position that starts the target. (Scintilla feature 2191)
Position GetTargetStart()Returns
GetTargetText()
Retrieve the text in the target. (Scintilla feature 2687)
string GetTargetText()Returns
GetTechnology()
Get the tech. (Scintilla feature 2631)
Technology GetTechnology()Returns
GetText()
Retrieve all the text in the document (or the first length chars of the document). Returns number of characters retrieved. Result is NUL-terminated. (Scintilla feature 2182)
string GetText()Returns
GetTextLength()
Retrieve the number of characters in the document. (Scintilla feature 2183)
long GetTextLength()Returns
GetTextRange(TextRange)
Retrieve a range of text. Return the length of the text. (Scintilla feature 2162)
[Obsolete("Use GetTextRange(Npp.DotNet.Plugin.TextRangeFull) instead")]
int GetTextRange(TextRange tr)Parameters
trTextRange
Returns
GetTextRange(TextRangeFull)
Retrieve a range of text. (Scintilla feature 2039)
long GetTextRange(TextRangeFull tr)Parameters
Returns
- long
The 64-bit length of the text.
GetTwoPhaseDraw()
This has been replaced with GetPhasesDraw() which is more general, allowing multiple phase drawing as well as one and two phase drawing.
[Obsolete("See https://www.scintilla.org/ScintillaDoc.html#SCI_GETTWOPHASEDRAW")]
bool GetTwoPhaseDraw()Returns
GetUndoCollection()
Is undo history being collected? (Scintilla feature 2019)
bool GetUndoCollection()Returns
GetUseTabs()
Retrieve whether tabs will be used in indentation. (Scintilla feature 2125)
bool GetUseTabs()Returns
GetVScrollBar()
Is the vertical scroll bar visible? (Scintilla feature 2281)
bool GetVScrollBar()Returns
GetViewEOL()
Are the end of line characters visible? (Scintilla feature 2355)
bool GetViewEOL()Returns
GetViewWS()
Are white space characters currently visible? Returns one of SCWS_* constants. (Scintilla feature 2020)
WhiteSpace GetViewWS()Returns
GetVirtualSpaceOptions()
Return options for virtual space behaviour. (Scintilla feature 2597)
VirtualSpace GetVirtualSpaceOptions()Returns
GetWhitespaceChars()
Get the set of characters making up whitespace for when moving or selecting by word. (Scintilla feature 2647)
string GetWhitespaceChars()Returns
GetWhitespaceSize()
Get the size of the dots used to mark space characters. (Scintilla feature 2087)
int GetWhitespaceSize()Returns
GetWordChars()
Get the set of characters making up words for when moving or selecting by word. Returns the number of characters (Scintilla feature 2646)
string GetWordChars()Returns
GetWrapIndentMode()
Retrieve how wrapped sublines are placed. Default is fixed. (Scintilla feature 2473)
WrapIndentMode GetWrapIndentMode()Returns
GetWrapMode()
Retrieve whether text is word wrapped. (Scintilla feature 2269)
Wrap GetWrapMode()Returns
GetWrapStartIndent()
Retrive the start indent for wrapped lines. (Scintilla feature 2465)
int GetWrapStartIndent()Returns
GetWrapVisualFlags()
Retrive the display mode of visual flags for wrapped lines. (Scintilla feature 2461)
WrapVisualFlag GetWrapVisualFlags()Returns
GetWrapVisualFlagsLocation()
Retrive the location of visual flags for wrapped lines. (Scintilla feature 2463)
WrapVisualLocation GetWrapVisualFlagsLocation()Returns
GetXOffset()
Get the xOffset (ie, horizontal scroll position). (Scintilla feature 2398)
int GetXOffset()Returns
GetZoom()
Retrieve the zoom level. (Scintilla feature 2374)
int GetZoom()Returns
GotoLine(Position)
Set caret to start of a line and ensure it is visible. (Scintilla feature 2024)
void GotoLine(Position line)Parameters
linePosition
GotoPos(Position)
Set caret to a position and ensure it is visible. (Scintilla feature 2025)
void GotoPos(Position caret)Parameters
caretPosition
GrabFocus()
Set the focus to this Scintilla widget. (Scintilla feature 2400)
void GrabFocus()HideLines(Position, Position)
Make a range of lines invisible. (Scintilla feature 2227)
void HideLines(Position lineStart, Position lineEnd)Parameters
HideSelection(bool)
Draw the selection either highlighted or in normal (non-highlighted) style. (Scintilla feature 2163)
void HideSelection(bool hide)Parameters
hidebool
Home()
Move caret to first position on line. (Scintilla feature 2312)
void Home()HomeDisplay()
Move caret to first position on display line. (Scintilla feature 2345)
void HomeDisplay()HomeDisplayExtend()
Move caret to first position on display line extending selection to new caret position. (Scintilla feature 2346)
void HomeDisplayExtend()HomeExtend()
Move caret to first position on line extending selection to new caret position. (Scintilla feature 2313)
void HomeExtend()HomeRectExtend()
Move caret to first position on line, extending rectangular selection to new caret position. (Scintilla feature 2430)
void HomeRectExtend()HomeWrap()
Like Home but when word-wrap is enabled goes first to start of display line HomeDisplay, then to start of document line Home. (Scintilla feature 2349)
void HomeWrap()HomeWrapExtend()
Like HomeExtend but when word-wrap is enabled extends first to start of display line HomeDisplayExtend, then to start of document line HomeExtend. (Scintilla feature 2450)
void HomeWrapExtend()IndexPositionFromLine(Position, LineCharacterIndexType)
Retrieve the position measured in index units at the start of a document line. (Scintilla feature 2714)
Position IndexPositionFromLine(Position line, LineCharacterIndexType lineCharacterIndex)Parameters
linePositionlineCharacterIndexLineCharacterIndexType
Returns
IndicGetAlpha(int)
Get the alpha fill colour of the given indicator. (Scintilla feature 2524)
Alpha IndicGetAlpha(int indicator)Parameters
indicatorint
Returns
IndicGetFlags(int)
Retrieve the attributes of an indicator. (Scintilla feature 2685)
IndicFlag IndicGetFlags(int indicator)Parameters
indicatorint
Returns
IndicGetFore(int)
Retrieve the foreground colour of an indicator. (Scintilla feature 2083)
Colour IndicGetFore(int indicator)Parameters
indicatorint
Returns
IndicGetHoverFore(int)
Retrieve the foreground hover colour of an indicator. (Scintilla feature 2683)
Colour IndicGetHoverFore(int indicator)Parameters
indicatorint
Returns
IndicGetHoverStyle(int)
Retrieve the hover style of an indicator. (Scintilla feature 2681)
IndicatorStyle IndicGetHoverStyle(int indicator)Parameters
indicatorint
Returns
IndicGetOutlineAlpha(int)
Get the alpha outline colour of the given indicator. (Scintilla feature 2559)
Alpha IndicGetOutlineAlpha(int indicator)Parameters
indicatorint
Returns
IndicGetStyle(int)
Retrieve the style of an indicator. (Scintilla feature 2081)
IndicatorStyle IndicGetStyle(int indicator)Parameters
indicatorint
Returns
IndicGetUnder(int)
Retrieve whether indicator drawn under or over text. (Scintilla feature 2511)
bool IndicGetUnder(int indicator)Parameters
indicatorint
Returns
IndicSetAlpha(int, Alpha)
Set the alpha fill colour of the given indicator. (Scintilla feature 2523)
void IndicSetAlpha(int indicator, Alpha alpha)Parameters
IndicSetFlags(int, IndicFlag)
Set the attributes of an indicator. (Scintilla feature 2684)
void IndicSetFlags(int indicator, IndicFlag flags)Parameters
IndicSetFore(int, Colour)
Set the foreground colour of an indicator. (Scintilla feature 2082)
void IndicSetFore(int indicator, Colour fore)Parameters
IndicSetHoverFore(int, Colour)
Set the foreground hover colour of an indicator. (Scintilla feature 2682)
void IndicSetHoverFore(int indicator, Colour fore)Parameters
IndicSetHoverStyle(int, IndicatorStyle)
Set a hover indicator to plain, squiggle or TT. (Scintilla feature 2680)
void IndicSetHoverStyle(int indicator, IndicatorStyle indicatorStyle)Parameters
indicatorintindicatorStyleIndicatorStyle
IndicSetOutlineAlpha(int, Alpha)
Set the alpha outline colour of the given indicator. (Scintilla feature 2558)
void IndicSetOutlineAlpha(int indicator, Alpha alpha)Parameters
IndicSetStyle(int, IndicatorStyle)
Set an indicator to plain, squiggle or TT. (Scintilla feature 2080)
void IndicSetStyle(int indicator, IndicatorStyle indicatorStyle)Parameters
indicatorintindicatorStyleIndicatorStyle
IndicSetUnder(int, bool)
Set an indicator to draw under text or over(default). (Scintilla feature 2510)
void IndicSetUnder(int indicator, bool under)Parameters
IndicatorAllOnFor(Position)
Are any indicators present at pos? (Scintilla feature 2506)
int IndicatorAllOnFor(Position pos)Parameters
posPosition
Returns
IndicatorClearRange(Position, Position)
Turn a indicator off over a range. (Scintilla feature 2505)
void IndicatorClearRange(Position start, Position lengthClear)Parameters
IndicatorEnd(int, Position)
Where does a particular indicator end? (Scintilla feature 2509)
int IndicatorEnd(int indicator, Position pos)Parameters
Returns
IndicatorFillRange(Position, Position)
Turn a indicator on over a range. (Scintilla feature 2504)
void IndicatorFillRange(Position start, Position lengthFill)Parameters
IndicatorStart(int, Position)
Where does a particular indicator start? (Scintilla feature 2508)
int IndicatorStart(int indicator, Position pos)Parameters
Returns
IndicatorValueAt(int, Position)
What value does a particular indicator have at a position? (Scintilla feature 2507)
int IndicatorValueAt(int indicator, Position pos)Parameters
Returns
InsertText(Position, string)
Insert string at a position. (Scintilla feature 2003)
void InsertText(Position pos, string text)Parameters
InsertTextAndMoveCursor(string)
void InsertTextAndMoveCursor(string text)Parameters
textstring
IsRangeWord(Position, Position)
Is the range start..end considered a word? (Scintilla feature 2691)
bool IsRangeWord(Position start, Position end)Parameters
Returns
LineCopy()
Copy the line containing the caret. (Scintilla feature 2455)
void LineCopy()LineCut()
Cut the line containing the caret. (Scintilla feature 2337)
void LineCut()LineDelete()
Delete the line containing the caret. (Scintilla feature 2338)
void LineDelete()LineDown()
Move caret down one line. (Scintilla feature 2300)
void LineDown()LineDownExtend()
Move caret down one line extending selection to new caret position. (Scintilla feature 2301)
void LineDownExtend()LineDownRectExtend()
Move caret down one line, extending rectangular selection to new caret position. (Scintilla feature 2426)
void LineDownRectExtend()LineDuplicate()
Duplicate the current line. (Scintilla feature 2404)
void LineDuplicate()LineEnd()
Move caret to last position on line. (Scintilla feature 2314)
void LineEnd()LineEndDisplay()
Move caret to last position on display line. (Scintilla feature 2347)
void LineEndDisplay()LineEndDisplayExtend()
Move caret to last position on display line extending selection to new caret position. (Scintilla feature 2348)
void LineEndDisplayExtend()LineEndExtend()
Move caret to last position on line extending selection to new caret position. (Scintilla feature 2315)
void LineEndExtend()LineEndRectExtend()
Move caret to last position on line, extending rectangular selection to new caret position. (Scintilla feature 2432)
void LineEndRectExtend()LineEndWrap()
Like LineEnd but when word-wrap is enabled goes first to end of display line LineEndDisplay, then to start of document line LineEnd. (Scintilla feature 2451)
void LineEndWrap()LineEndWrapExtend()
Like LineEndExtend but when word-wrap is enabled extends first to end of display line LineEndDisplayExtend, then to start of document line LineEndExtend. (Scintilla feature 2452)
void LineEndWrapExtend()LineFromIndexPosition(Position, LineCharacterIndexType)
Retrieve the document line containing a position measured in index units. (Scintilla feature 2713)
Position LineFromIndexPosition(Position pos, LineCharacterIndexType lineCharacterIndex)Parameters
posPositionlineCharacterIndexLineCharacterIndexType
Returns
LineFromPosition(Position)
Retrieve the line containing a position. (Scintilla feature 2166)
Position LineFromPosition(Position pos)Parameters
posPosition
Returns
LineLength(Position)
How many characters are on a line, including end of line characters? (Scintilla feature 2350)
int LineLength(Position line)Parameters
linePosition
Returns
LineReverse()
Reverse order of selected lines. (Scintilla feature 2354)
void LineReverse()LineScroll(int, int)
Scroll horizontally and vertically. (Scintilla feature 2168)
void LineScroll(int columns, int lines)Parameters
LineScrollDown()
Scroll the document down, keeping the caret visible. (Scintilla feature 2342)
void LineScrollDown()LineScrollUp()
Scroll the document up, keeping the caret visible. (Scintilla feature 2343)
void LineScrollUp()LineTranspose()
Switch the current line with the previous. (Scintilla feature 2339)
void LineTranspose()LineUp()
Move caret up one line. (Scintilla feature 2302)
void LineUp()LineUpExtend()
Move caret up one line extending selection to new caret position. (Scintilla feature 2303)
void LineUpExtend()LineUpRectExtend()
Move caret up one line, extending rectangular selection to new caret position. (Scintilla feature 2427)
void LineUpRectExtend()LinesJoin()
Join the lines in the target. (Scintilla feature 2288)
void LinesJoin()LinesOnScreen()
Retrieves the number of lines completely visible. (Scintilla feature 2370)
int LinesOnScreen()Returns
LinesSplit(int)
Split the lines in the target into lines that are less wide than pixelWidth where possible. (Scintilla feature 2289)
void LinesSplit(int pixelWidth)Parameters
pixelWidthint
LoadLexerLibrary(string)
Load a lexer library (dll / so). (Scintilla feature 4007)
[Obsolete("SCI_LOADLEXERLIBRARY was removed in Scintilla 5.0: https://www.scintilla.org/ScintillaDoc.html#SCI_CREATELOADER", true)]
void LoadLexerLibrary(string path)Parameters
pathstring
LowerCase()
Transform the selection to lower case. (Scintilla feature 2340)
void LowerCase()MarginGetStyle(Position)
Get the style number for the text margin for a line (Scintilla feature 2533)
int MarginGetStyle(Position line)Parameters
linePosition
Returns
MarginGetStyleOffset()
Get the start of the range of style numbers used for margin text (Scintilla feature 2538)
int MarginGetStyleOffset()Returns
MarginGetStyles(Position)
Get the styles in the text margin for a line (Scintilla feature 2535)
string MarginGetStyles(Position line)Parameters
linePosition
Returns
MarginGetText(Position)
Get the text in the text margin for a line (Scintilla feature 2531)
string MarginGetText(Position line)Parameters
linePosition
Returns
MarginSetStyle(Position, int)
Set the style number for the text margin for a line (Scintilla feature 2532)
void MarginSetStyle(Position line, int style)Parameters
MarginSetStyleOffset(int)
Get the start of the range of style numbers used for margin text (Scintilla feature 2537)
void MarginSetStyleOffset(int style)Parameters
styleint
MarginSetStyles(Position, string)
Set the style in the text margin for a line (Scintilla feature 2534)
void MarginSetStyles(Position line, string styles)Parameters
MarginSetText(Position, string)
Set the text in the text margin for a line (Scintilla feature 2530)
void MarginSetText(Position line, string text)Parameters
MarginTextClearAll()
Clear the margin text on all lines (Scintilla feature 2536)
void MarginTextClearAll()MarkerAdd(Position, int)
Add a marker to a line, returning an ID which can be used to find or delete the marker. (Scintilla feature 2043)
int MarkerAdd(Position line, int markerNumber)Parameters
Returns
MarkerAddSet(Position, int)
Add a set of markers to a line. (Scintilla feature 2466)
void MarkerAddSet(Position line, int markerSet)Parameters
MarkerDefine(int, MarkerSymbol)
Set the symbol used for a particular marker number. (Scintilla feature 2040)
void MarkerDefine(int markerNumber, MarkerSymbol markerSymbol)Parameters
markerNumberintmarkerSymbolMarkerSymbol
MarkerDefinePixmap(int, string)
Define a marker from a pixmap. (Scintilla feature 2049)
void MarkerDefinePixmap(int markerNumber, string pixmap)Parameters
MarkerDefineRGBAImage(int, string)
Define a marker from RGBA data. It has the width and height from RGBAImageSetWidth/Height (Scintilla feature 2626)
void MarkerDefineRGBAImage(int markerNumber, string pixels)Parameters
MarkerDelete(Position, int)
Delete a marker from a line. (Scintilla feature 2044)
void MarkerDelete(Position line, int markerNumber)Parameters
MarkerDeleteAll(int)
Delete all markers with a particular number from all lines. (Scintilla feature 2045)
void MarkerDeleteAll(int markerNumber)Parameters
markerNumberint
MarkerDeleteHandle(int)
Delete a marker. (Scintilla feature 2018)
void MarkerDeleteHandle(int markerHandle)Parameters
markerHandleint
MarkerEnableHighlight(bool)
Enable/disable highlight for current folding bloc (smallest one that contains the caret) (Scintilla feature 2293)
void MarkerEnableHighlight(bool enabled)Parameters
enabledbool
MarkerGet(Position)
Get a bit mask of all the markers set on a line. (Scintilla feature 2046)
int MarkerGet(Position line)Parameters
linePosition
Returns
MarkerLineFromHandle(int)
Retrieve the line number at which a particular marker is located. (Scintilla feature 2017)
int MarkerLineFromHandle(int markerHandle)Parameters
markerHandleint
Returns
MarkerNext(int, int)
Find the next line at or after lineStart that includes a marker in mask. Return -1 when no more lines. (Scintilla feature 2047)
int MarkerNext(int lineStart, int markerMask)Parameters
Returns
MarkerPrevious(int, int)
Find the previous line before lineStart that includes a marker in mask. (Scintilla feature 2048)
int MarkerPrevious(int lineStart, int markerMask)Parameters
Returns
MarkerSetAlpha(int, Alpha)
Set the alpha used for a marker that is drawn in the text area, not the margin. (Scintilla feature 2476)
void MarkerSetAlpha(int markerNumber, Alpha alpha)Parameters
MarkerSetBack(int, Colour)
Set the background colour used for a particular marker number. (Scintilla feature 2042)
void MarkerSetBack(int markerNumber, Colour back)Parameters
MarkerSetBackSelected(int, Colour)
Set the background colour used for a particular marker number when its folding block is selected. (Scintilla feature 2292)
void MarkerSetBackSelected(int markerNumber, Colour back)Parameters
MarkerSetFore(int, Colour)
Set the foreground colour used for a particular marker number. (Scintilla feature 2041)
void MarkerSetFore(int markerNumber, Colour fore)Parameters
MarkerSymbolDefined(int)
Which symbol was defined for markerNumber with MarkerDefine (Scintilla feature 2529)
int MarkerSymbolDefined(int markerNumber)Parameters
markerNumberint
Returns
MoveCaretInsideView()
Move the caret inside current view if it's not there already. (Scintilla feature 2401)
void MoveCaretInsideView()MoveSelectedLinesDown()
Move the selected lines down one line, shifting the line below before the selection (Scintilla feature 2621)
void MoveSelectedLinesDown()MoveSelectedLinesUp()
Move the selected lines up one line, shifting the line above after the selection (Scintilla feature 2620)
void MoveSelectedLinesUp()MultiEdgeAddLine(int, Colour)
Add a new vertical edge to the view. (Scintilla feature 2694)
void MultiEdgeAddLine(int column, Colour edgeColour)Parameters
MultiEdgeClearAll()
Clear all vertical edges. (Scintilla feature 2695)
void MultiEdgeClearAll()MultipleSelectAddEach()
Add each occurrence of the main selection in the target to the set of selections. If the current selection is empty then select word around caret. (Scintilla feature 2689)
void MultipleSelectAddEach()MultipleSelectAddNext()
Add the next occurrence of the main selection to the set of selections as main. If the current selection is empty then select word around caret. (Scintilla feature 2688)
void MultipleSelectAddNext()NameOfStyle(int)
Retrieve the name of a style. Result is NUL-terminated. (Scintilla feature 4030)
string NameOfStyle(int style)Parameters
styleint
Returns
NewLine()
Insert a new line, may use a CRLF, CR or LF depending on EOL mode. (Scintilla feature 2329)
void NewLine()Null()
Null operation. (Scintilla feature 2172)
void Null()PageDown()
Move caret one page down. (Scintilla feature 2322)
void PageDown()PageDownExtend()
Move caret one page down extending selection to new caret position. (Scintilla feature 2323)
void PageDownExtend()PageDownRectExtend()
Move caret one page down, extending rectangular selection to new caret position. (Scintilla feature 2434)
void PageDownRectExtend()PageUp()
Move caret one page up. (Scintilla feature 2320)
void PageUp()PageUpExtend()
Move caret one page up extending selection to new caret position. (Scintilla feature 2321)
void PageUpExtend()PageUpRectExtend()
Move caret one page up, extending rectangular selection to new caret position. (Scintilla feature 2433)
void PageUpRectExtend()ParaDown()
Move caret down one paragraph (delimited by empty lines). (Scintilla feature 2413)
void ParaDown()ParaDownExtend()
Extend selection down one paragraph (delimited by empty lines). (Scintilla feature 2414)
void ParaDownExtend()ParaUp()
Move caret up one paragraph (delimited by empty lines). (Scintilla feature 2415)
void ParaUp()ParaUpExtend()
Extend selection up one paragraph (delimited by empty lines). (Scintilla feature 2416)
void ParaUpExtend()Paste()
Paste the contents of the clipboard into the document replacing the selection. (Scintilla feature 2179)
void Paste()PointXFromPosition(Position)
Retrieve the x value of the point in the window where a position is displayed. (Scintilla feature 2164)
int PointXFromPosition(Position pos)Parameters
posPosition
Returns
PointYFromPosition(Position)
Retrieve the y value of the point in the window where a position is displayed. (Scintilla feature 2165)
int PointYFromPosition(Position pos)Parameters
posPosition
Returns
PositionAfter(Position)
Given a valid document position, return the next position taking code page into account. Maximum value returned is the last position in the document. (Scintilla feature 2418)
int PositionAfter(Position pos)Parameters
posPosition
Returns
PositionBefore(Position)
Given a valid document position, return the previous position taking code page into account. Returns 0 if passed 0. (Scintilla feature 2417)
int PositionBefore(Position pos)Parameters
posPosition
Returns
PositionFromLine(Position)
Retrieve the position at the start of a line. (Scintilla feature 2167)
Position PositionFromLine(Position line)Parameters
linePosition
Returns
PositionFromPoint(int, int)
Find the position from a point within the window. (Scintilla feature 2022)
int PositionFromPoint(int x, int y)Parameters
Returns
PositionFromPointClose(int, int)
Find the position from a point within the window but return INVALID_POSITION if not close to text. (Scintilla feature 2023)
int PositionFromPointClose(int x, int y)Parameters
Returns
PositionRelative(Position, Position)
Given a valid document position, return a position that differs in a number of characters. Returned value is always between 0 and last position in document. (Scintilla feature 2670)
int PositionRelative(Position pos, Position relative)Parameters
Returns
PositionRelativeCodeUnits(Position, Position)
Given a valid document position, return a position that differs in a number of UTF-16 code units. Returned value is always between 0 and last position in document. The result may point half way (2 bytes) inside a non-BMP character. (Scintilla feature 2716)
int PositionRelativeCodeUnits(Position pos, Position relative)Parameters
Returns
PrivateLexerCall(int, IntPtr)
For private communication between an application and a known lexer. (Scintilla feature 4013)
IntPtr PrivateLexerCall(int operation, IntPtr pointer)Parameters
Returns
PropertyNames()
Retrieve a '\n' separated list of properties understood by the current lexer. Result is NUL-terminated. (Scintilla feature 4014)
string PropertyNames()Returns
PropertyType(string)
Retrieve the type of a property. (Scintilla feature 4015)
TypeProperty PropertyType(string name)Parameters
namestring
Returns
RGBAImageSetHeight(int)
Set the height for future RGBA image data. (Scintilla feature 2625)
void RGBAImageSetHeight(int height)Parameters
heightint
RGBAImageSetScale(int)
Set the scale factor in percent for future RGBA image data. (Scintilla feature 2651)
void RGBAImageSetScale(int scalePercent)Parameters
scalePercentint
RGBAImageSetWidth(int)
Set the width for future RGBA image data. (Scintilla feature 2624)
void RGBAImageSetWidth(int width)Parameters
widthint
Redo()
Redoes the next action on the undo history. (Scintilla feature 2011)
void Redo()RegisterImage(int, string)
Register an XPM image for use in autocompletion lists. (Scintilla feature 2405)
void RegisterImage(int type, string xpmData)Parameters
RegisterRGBAImage(int, string)
Register an RGBA image for use in autocompletion lists. It has the width and height from RGBAImageSetWidth/Height (Scintilla feature 2627)
void RegisterRGBAImage(int type, string pixels)Parameters
ReleaseAllExtendedStyles()
Release all extended (>255) style numbers (Scintilla feature 2552)
void ReleaseAllExtendedStyles()ReleaseDocument(IntPtr)
Release a reference to the document, deleting document if it fades to black. (Scintilla feature 2377)
void ReleaseDocument(IntPtr doc)Parameters
docIntPtr
ReleaseLineCharacterIndex(LineCharacterIndexType)
Decrease use count of line character index and remove if 0. (Scintilla feature 2712)
void ReleaseLineCharacterIndex(LineCharacterIndexType lineCharacterIndex)Parameters
lineCharacterIndexLineCharacterIndexType
ReplaceSel(string)
Replace the selected text with the argument text. (Scintilla feature 2170)
void ReplaceSel(string text)Parameters
textstring
ReplaceTarget(string)
Replace the target text with the argument text. Text is counted so it can contain NULs. Returns the length of the replacement text. (Scintilla feature 2194)
int ReplaceTarget(string text)Parameters
textstring
Returns
ReplaceTargetMinimal(string)
Replace the target text with the argument text but ignore prefix and suffix that are the same as current. (Scintilla feature 2779)
int ReplaceTargetMinimal(string text)Parameters
textstring
Returns
ReplaceTargetRE(string)
Replace the target text with the argument text after \d processing. Text is counted so it can contain NULs. Looks for \d where d is between 1 and 9 and replaces these with the strings matched in the last search operation which were surrounded by ( and ). Returns the length of the replacement text including any change caused by processing the \d patterns. (Scintilla feature 2195)
int ReplaceTargetRE(string text)Parameters
textstring
Returns
RotateSelection()
Set the main selection to the next selection. (Scintilla feature 2606)
void RotateSelection()ScrollCaret()
Ensure the caret is visible. (Scintilla feature 2169)
void ScrollCaret()ScrollRange(int, int)
Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position. This may be used to make a search match visible. (Scintilla feature 2569)
void ScrollRange(int secondary, int primary)Parameters
ScrollToEnd()
Scroll to end of document. (Scintilla feature 2629)
void ScrollToEnd()ScrollToStart()
Scroll to start of document. (Scintilla feature 2628)
void ScrollToStart()SearchAnchor()
Sets the current caret position to be the search anchor. (Scintilla feature 2366)
void SearchAnchor()SearchInTarget(string)
Search for a counted string in the target and set the target to the found range. Text is counted so it can contain NULs. Returns start of found range or -1 for failure in which case target is not moved. (Scintilla feature 2197)
Position SearchInTarget(string text)Parameters
textstring
Returns
SearchNext(FindOption, string)
Find some text starting at the search anchor. Does not ensure the selection is visible. (Scintilla feature 2367)
Position SearchNext(FindOption searchFlags, string text)Parameters
searchFlagsFindOptiontextstring
Returns
SearchPrev(FindOption, string)
Find some text starting at the search anchor and moving backwards. Does not ensure the selection is visible. (Scintilla feature 2368)
Position SearchPrev(FindOption searchFlags, string text)Parameters
searchFlagsFindOptiontextstring
Returns
SelectAll()
Select all the text in the document. (Scintilla feature 2013)
void SelectAll()SelectCurrentLine()
void SelectCurrentLine()SelectionDuplicate()
Duplicate the selection. If selection empty duplicate the line containing the caret. (Scintilla feature 2469)
void SelectionDuplicate()SelectionIsRectangle()
Is the selection rectangular? The alternative is the more common stream selection. (Scintilla feature 2372)
bool SelectionIsRectangle()Returns
SetAccessibility(Accessibility)
Enable or disable accessibility. (Scintilla feature 2702)
void SetAccessibility(Accessibility accessibility)Parameters
accessibilityAccessibility
SetAdditionalCaretFore(Colour)
Set the foreground colour of additional carets. (Scintilla feature 2604)
[Obsolete("Replaced in Scintilla v5 by SCI_SETELEMENTCOLOUR(SC_ELEMENT_CARET, colouralpha)")]
void SetAdditionalCaretFore(Colour fore)Parameters
foreColour
SetAdditionalCaretsBlink(bool)
Set whether additional carets will blink (Scintilla feature 2567)
void SetAdditionalCaretsBlink(bool additionalCaretsBlink)Parameters
additionalCaretsBlinkbool
SetAdditionalCaretsVisible(bool)
Set whether additional carets are visible (Scintilla feature 2608)
void SetAdditionalCaretsVisible(bool additionalCaretsVisible)Parameters
additionalCaretsVisiblebool
SetAdditionalSelAlpha(Alpha)
Set the alpha of the selection. (Scintilla feature 2602)
[Obsolete("Replaced in Scintilla v5 by SCI_SETELEMENTCOLOUR(SC_ELEMENT_SELECTION_ADDITIONAL_TEXT, colouralpha)")]
void SetAdditionalSelAlpha(Alpha alpha)Parameters
alphaAlpha
SetAdditionalSelBack(Colour)
Set the background colour of additional selections. Must have previously called SetSelBack with non-zero first argument for this to have an effect. (Scintilla feature 2601)
[Obsolete("Replaced in Scintilla v5 by SCI_SETELEMENTCOLOUR(SC_ELEMENT_SELECTION_ADDITIONAL_BACK, colourAlpha)")]
void SetAdditionalSelBack(Colour back)Parameters
backColour
SetAdditionalSelFore(Colour)
Set the foreground colour of additional selections. Must have previously called SetSelFore with non-zero first argument for this to have an effect. (Scintilla feature 2600)
[Obsolete("Replaced in Scintilla v5 by SCI_SETELEMENTCOLOUR(SC_ELEMENT_SELECTION_ADDITIONAL_TEXT, colourAlpha)")]
void SetAdditionalSelFore(Colour fore)Parameters
foreColour
SetAdditionalSelectionTyping(bool)
Set whether typing can be performed into multiple selections (Scintilla feature 2565)
void SetAdditionalSelectionTyping(bool additionalSelectionTyping)Parameters
additionalSelectionTypingbool
SetAnchor(Position)
Set the selection anchor to a position. The anchor is the opposite end of the selection from the caret. (Scintilla feature 2026)
void SetAnchor(Position anchor)Parameters
anchorPosition
SetAutomaticFold(AutomaticFold)
Set automatic folding behaviours. (Scintilla feature 2663)
void SetAutomaticFold(AutomaticFold automaticFold)Parameters
automaticFoldAutomaticFold
SetBackSpaceUnIndents(bool)
Sets whether a backspace pressed when caret is within indentation unindents. (Scintilla feature 2262)
void SetBackSpaceUnIndents(bool bsUnIndents)Parameters
bsUnIndentsbool
SetBufferedDraw(bool)
If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker. (Scintilla feature 2035)
void SetBufferedDraw(bool buffered)Parameters
bufferedbool
SetCaretFore(Colour)
SCI_SETCARETFORE( colour fore)
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
void SetCaretFore(Colour fore)Parameters
foreColour
SetCaretLineBack(Colour)
SCI_GETCARETLINEBACK -> colour
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
void SetCaretLineBack(Colour back)Parameters
backColour
SetCaretLineBackAlpha(Alpha)
SCI_SETCARETLINEBACKALPHA( alpha alpha)
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
void SetCaretLineBackAlpha(Alpha alpha)Parameters
alphaAlpha
SetCaretLineFrame(int)
Display the caret line framed. Set width != 0 to enable this option and width = 0 to disable it. (Scintilla feature 2705)
void SetCaretLineFrame(int width)Parameters
widthint
SetCaretLineVisible(bool)
SCI_SETCARETLINEVISIBLE(bool show)
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
void SetCaretLineVisible(bool show)Parameters
showbool
SetCaretLineVisibleAlways(bool)
Sets the caret line to always visible. (Scintilla feature 2655)
void SetCaretLineVisibleAlways(bool alwaysVisible)Parameters
alwaysVisiblebool
SetCaretPeriod(int)
Get the time in milliseconds that the caret is on and off. 0 = steady on. (Scintilla feature 2076)
void SetCaretPeriod(int periodMilliseconds)Parameters
periodMillisecondsint
SetCaretSticky(CaretSticky)
Stop the caret preferred x position changing when the user types. (Scintilla feature 2458)
void SetCaretSticky(CaretSticky useCaretStickyBehaviour)Parameters
useCaretStickyBehaviourCaretSticky
SetCaretStyle(CaretStyle)
Set the style of the caret to be drawn. (Scintilla feature 2512)
void SetCaretStyle(CaretStyle caretStyle)Parameters
caretStyleCaretStyle
SetCaretWidth(int)
Set the width of the insert mode caret. (Scintilla feature 2188)
void SetCaretWidth(int pixelWidth)Parameters
pixelWidthint
SetCharacterCategoryOptimization(int)
Set the number of characters to have directly indexed categories (Scintilla feature 2720)
void SetCharacterCategoryOptimization(int countCharacters)Parameters
countCharactersint
SetCharsDefault()
Reset the set of characters for whitespace and word characters to the defaults. (Scintilla feature 2444)
void SetCharsDefault()SetCodePage(int)
Set the code page used to interpret the bytes of the document as characters. The SC_CP_UTF8 value can be used to enter Unicode mode. (Scintilla feature 2037)
void SetCodePage(int codePage)Parameters
codePageint
SetCommandEvents(bool)
Set whether command events are sent to the container. (Scintilla feature 2717)
void SetCommandEvents(bool commandEvents)Parameters
commandEventsbool
SetControlCharSymbol(int)
Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character. (Scintilla feature 2388)
void SetControlCharSymbol(int symbol)Parameters
symbolint
SetCurrentPos(Position)
Sets the position of the caret. (Scintilla feature 2141)
void SetCurrentPos(Position caret)Parameters
caretPosition
SetCursor(CursorShape)
Sets the cursor to one of the SC_CURSOR* values. (Scintilla feature 2386)
void SetCursor(CursorShape cursorType)Parameters
cursorTypeCursorShape
SetDefaultFoldDisplayText(string)
Set the default fold display text. (Scintilla feature 2722)
void SetDefaultFoldDisplayText(string text)Parameters
textstring
SetDocPointer(IntPtr)
Change the document object used. (Scintilla feature 2358)
void SetDocPointer(IntPtr doc)Parameters
docIntPtr
SetEOLMode(EndOfLine)
Set the current end of line mode. (Scintilla feature 2031)
void SetEOLMode(EndOfLine eolMode)Parameters
eolModeEndOfLine
SetEdgeColour(Colour)
Change the colour used in edge indication. (Scintilla feature 2365)
void SetEdgeColour(Colour edgeColour)Parameters
edgeColourColour
SetEdgeColumn(int)
Set the column number of the edge. If text goes past the edge then it is highlighted. (Scintilla feature 2361)
void SetEdgeColumn(int column)Parameters
columnint
SetEdgeMode(EdgeVisualStyle)
The edge may be displayed by a line (EDGE_LINE/EDGE_MULTILINE) or by highlighting text that goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE). (Scintilla feature 2363)
void SetEdgeMode(EdgeVisualStyle edgeMode)Parameters
edgeModeEdgeVisualStyle
SetEmptySelection(Position)
Set caret to a position, while removing any existing selection. (Scintilla feature 2556)
void SetEmptySelection(Position caret)Parameters
caretPosition
SetEndAtLastLine(bool)
Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default). Setting this to false allows scrolling one page below the last line. (Scintilla feature 2277)
void SetEndAtLastLine(bool endAtLastLine)Parameters
endAtLastLinebool
SetExtraAscent(int)
Set extra ascent for each line (Scintilla feature 2525)
void SetExtraAscent(int extraAscent)Parameters
extraAscentint
SetExtraDescent(int)
Set extra descent for each line (Scintilla feature 2527)
void SetExtraDescent(int extraDescent)Parameters
extraDescentint
SetFirstVisibleLine(int)
Scroll so that a display line is at the top of the display. (Scintilla feature 2613)
void SetFirstVisibleLine(int displayLine)Parameters
displayLineint
SetFocus(bool)
Change internal focus flag. (Scintilla feature 2380)
void SetFocus(bool focus)Parameters
focusbool
SetFoldExpanded(Position, bool)
Show the children of a header line. (Scintilla feature 2229)
void SetFoldExpanded(Position line, bool expanded)Parameters
SetFoldFlags(FoldFlag)
Set some style options for folding. (Scintilla feature 2233)
void SetFoldFlags(FoldFlag flags)Parameters
flagsFoldFlag
SetFoldLevel(Position, FoldLevel)
Set the fold level of a line. This encodes an integer level along with flags indicating whether the line is a header and whether it is effectively white space. (Scintilla feature 2222)
void SetFoldLevel(Position line, FoldLevel level)Parameters
SetFoldMarginColour(bool, Colour)
Set one of the colours used as a chequerboard pattern in the fold margin (Scintilla feature 2290)
void SetFoldMarginColour(bool useSetting, Colour back)Parameters
SetFoldMarginHiColour(bool, Colour)
Set the other colour used as a chequerboard pattern in the fold margin (Scintilla feature 2291)
void SetFoldMarginHiColour(bool useSetting, Colour fore)Parameters
SetFontQuality(FontQuality)
Choose the quality level for text from the FontQuality enumeration. (Scintilla feature 2611)
void SetFontQuality(FontQuality fontQuality)Parameters
fontQualityFontQuality
SetHScrollBar(bool)
Show or hide the horizontal scroll bar. (Scintilla feature 2130)
void SetHScrollBar(bool visible)Parameters
visiblebool
SetHighlightGuide(int)
Set the highlighted indentation guide column. 0 = no highlighted guide. (Scintilla feature 2134)
void SetHighlightGuide(int column)Parameters
columnint
SetHotspotActiveBack(bool, Colour)
SCI_SETHOTSPOTACTIVEBACK(bool useSetting, colour back)
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
void SetHotspotActiveBack(bool useSetting, Colour back)Parameters
SetHotspotActiveFore(bool, Colour)
SCI_SETHOTSPOTACTIVEFORE(bool useSetting, colour fore)
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
void SetHotspotActiveFore(bool useSetting, Colour fore)Parameters
SetHotspotActiveUnderline(bool)
Enable / Disable underlining active hotspots. (Scintilla feature 2412)
void SetHotspotActiveUnderline(bool underline)Parameters
underlinebool
SetHotspotSingleLine(bool)
Limit hotspots to single line so hotspots on two lines don't merge. (Scintilla feature 2421)
void SetHotspotSingleLine(bool singleLine)Parameters
singleLinebool
SetIMEInteraction(IMEInteraction)
Choose to display the the IME in a winow or inline. (Scintilla feature 2679)
void SetIMEInteraction(IMEInteraction imeInteraction)Parameters
imeInteractionIMEInteraction
SetIdentifier(int)
Set the identifier reported as idFrom in notification messages. (Scintilla feature 2622)
void SetIdentifier(int identifier)Parameters
identifierint
SetIdentifiers(int, string)
Set the identifiers that are shown in a particular style (Scintilla feature 4024)
void SetIdentifiers(int style, string identifiers)Parameters
SetIdleStyling(IdleStyling)
Sets limits to idle styling. (Scintilla feature 2692)
void SetIdleStyling(IdleStyling idleStyling)Parameters
idleStylingIdleStyling
SetIndent(int)
Set the number of spaces used for one level of indentation. (Scintilla feature 2122)
void SetIndent(int indentSize)Parameters
indentSizeint
SetIndentationGuides(IndentView)
Show or hide indentation guides. (Scintilla feature 2132)
void SetIndentationGuides(IndentView indentView)Parameters
indentViewIndentView
SetIndicatorCurrent(int)
Set the indicator used for IndicatorFillRange and IndicatorClearRange (Scintilla feature 2500)
void SetIndicatorCurrent(int indicator)Parameters
indicatorint
SetIndicatorValue(int)
Set the value used for IndicatorFillRange (Scintilla feature 2502)
void SetIndicatorValue(int value)Parameters
valueint
SetKeyWords(int, string)
Set up the key words used by the lexer. (Scintilla feature 4005)
void SetKeyWords(int keyWordSet, string keyWords)Parameters
SetKeysUnicode(bool)
On Windows, Scintilla no longer supports narrow character windows so input is always treated as Unicode.
[Obsolete("See https://www.scintilla.org/ScintillaDoc.html#SCI_SETKEYSUNICODE")]
void SetKeysUnicode(bool keysUnicode)Parameters
keysUnicodebool
SetLayoutCache(LineCache)
Sets the degree of caching of layout information. (Scintilla feature 2272)
void SetLayoutCache(LineCache cacheMode)Parameters
cacheModeLineCache
SetLengthForEncode(int)
Set the length of the utf8 argument for calling EncodedFromUTF8. Set to -1 and the string will be measured to the first nul. (Scintilla feature 2448)
void SetLengthForEncode(int bytes)Parameters
bytesint
SetLexer(int)
Set the lexing language of the document. (Scintilla feature 4001)
[Obsolete("Use SCI_SETILEXER instead: https://www.scintilla.org/ScintillaDoc.html#SCI_SETILEXER", true)]
void SetLexer(int lexer)Parameters
lexerint
SetLexerLanguage(string)
Set the lexing language of the document based on string name. (Scintilla feature 4006)
[Obsolete("Use SCI_SETILEXER instead: https://www.scintilla.org/ScintillaDoc.html#SCI_SETILEXER", true)]
void SetLexerLanguage(string language)Parameters
languagestring
SetLineEndTypesAllowed(LineEndType)
Set the line end types that the application wants to use. May not be used if incompatible with lexer or encoding. (Scintilla feature 2656)
void SetLineEndTypesAllowed(LineEndType lineEndBitSet)Parameters
lineEndBitSetLineEndType
SetLineIndentation(Position, int)
Change the indentation of a line to a number of columns. (Scintilla feature 2126)
void SetLineIndentation(Position line, int indentation)Parameters
SetLineState(Position, int)
Used to hold extra styling information for each line. (Scintilla feature 2092)
void SetLineState(Position line, int state)Parameters
SetMainSelection(int)
Set the main selection (Scintilla feature 2574)
void SetMainSelection(int selection)Parameters
selectionint
SetMarginBackN(int, Colour)
Set the background colour of a margin. Only visible for SC_MARGIN_COLOUR. (Scintilla feature 2250)
void SetMarginBackN(int margin, Colour back)Parameters
SetMarginCursorN(int, CursorShape)
Set the cursor shown when the mouse is inside a margin. (Scintilla feature 2248)
void SetMarginCursorN(int margin, CursorShape cursor)Parameters
marginintcursorCursorShape
SetMarginLeft(int)
Sets the size in pixels of the left margin. (Scintilla feature 2155)
void SetMarginLeft(int pixelWidth)Parameters
pixelWidthint
SetMarginMaskN(int, int)
Set a mask that determines which markers are displayed in a margin. (Scintilla feature 2244)
void SetMarginMaskN(int margin, int mask)Parameters
SetMarginOptions(MarginOption)
Set the margin options. (Scintilla feature 2539)
void SetMarginOptions(MarginOption marginOptions)Parameters
marginOptionsMarginOption
SetMarginRight(int)
Sets the size in pixels of the right margin. (Scintilla feature 2157)
void SetMarginRight(int pixelWidth)Parameters
pixelWidthint
SetMarginSensitiveN(int, bool)
Make a margin sensitive or insensitive to mouse clicks. (Scintilla feature 2246)
void SetMarginSensitiveN(int margin, bool sensitive)Parameters
SetMarginTypeN(int, MarginType)
Set a margin to be either numeric or symbolic. (Scintilla feature 2240)
void SetMarginTypeN(int margin, MarginType marginType)Parameters
marginintmarginTypeMarginType
SetMarginWidthN(int, int)
Set the width of a margin to a width expressed in pixels. (Scintilla feature 2242)
void SetMarginWidthN(int margin, int pixelWidth)Parameters
SetMargins(int)
Allocate a non-standard number of margins. (Scintilla feature 2252)
void SetMargins(int margins)Parameters
marginsint
SetModEventMask(ModificationFlags)
Set which document modification events are sent to the container. (Scintilla feature 2359)
void SetModEventMask(ModificationFlags eventMask)Parameters
eventMaskModificationFlags
SetMouseDownCaptures(bool)
Set whether the mouse is captured when its button is pressed. (Scintilla feature 2384)
void SetMouseDownCaptures(bool captures)Parameters
capturesbool
SetMouseDwellTime(int)
Sets the time the mouse must sit still to generate a mouse dwell event. (Scintilla feature 2264)
void SetMouseDwellTime(int periodMilliseconds)Parameters
periodMillisecondsint
SetMouseSelectionRectangularSwitch(bool)
Set whether switching to rectangular mode while selecting with the mouse is allowed. (Scintilla feature 2668)
void SetMouseSelectionRectangularSwitch(bool mouseSelectionRectangularSwitch)Parameters
mouseSelectionRectangularSwitchbool
SetMouseWheelCaptures(bool)
Set whether the mouse wheel can be active outside the window. (Scintilla feature 2696)
void SetMouseWheelCaptures(bool captures)Parameters
capturesbool
SetMultiPaste(MultiPaste)
Change the effect of pasting when there are multiple selections. (Scintilla feature 2614)
void SetMultiPaste(MultiPaste multiPaste)Parameters
multiPasteMultiPaste
SetMultipleSelection(bool)
Set whether multiple selections can be made (Scintilla feature 2563)
void SetMultipleSelection(bool multipleSelection)Parameters
multipleSelectionbool
SetOvertype(bool)
Set to overtype (true) or insert mode. (Scintilla feature 2186)
void SetOvertype(bool overType)Parameters
overTypebool
SetPasteConvertEndings(bool)
Enable/Disable convert-on-paste for line endings (Scintilla feature 2467)
void SetPasteConvertEndings(bool convert)Parameters
convertbool
SetPhasesDraw(PhasesDraw)
In one phase draw, text is drawn in a series of rectangular blocks with no overlap. In two phase draw, text is drawn in a series of lines allowing runs to overlap horizontally. In multiple phase draw, each element is drawn over the whole drawing area, allowing text to overlap from one line to the next. (Scintilla feature 2674)
void SetPhasesDraw(PhasesDraw phases)Parameters
phasesPhasesDraw
SetPositionCache(int)
Set number of entries in position cache (Scintilla feature 2514)
void SetPositionCache(int size)Parameters
sizeint
SetPrintColourMode(PrintOption)
Modify colours when printing for clearer printed text. (Scintilla feature 2148)
void SetPrintColourMode(PrintOption mode)Parameters
modePrintOption
SetPrintMagnification(int)
Sets the print magnification added to the point size of each style for printing. (Scintilla feature 2146)
void SetPrintMagnification(int magnification)Parameters
magnificationint
SetPrintWrapMode(Wrap)
Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE). (Scintilla feature 2406)
void SetPrintWrapMode(Wrap wrapMode)Parameters
wrapModeWrap
SetProperty(string, string)
Set up a value that may be used by a lexer for some optional feature. (Scintilla feature 4004)
void SetProperty(string key, string value)Parameters
SetPunctuationChars(string)
Set the set of characters making up punctuation characters Should be called after SetWordChars. (Scintilla feature 2648)
void SetPunctuationChars(string characters)Parameters
charactersstring
SetReadOnly(bool)
Set to read only or read write. (Scintilla feature 2171)
void SetReadOnly(bool readOnly)Parameters
readOnlybool
SetRectangularSelectionAnchor(Position)
Set the anchor position of the rectangular selection. (Scintilla feature 2590)
void SetRectangularSelectionAnchor(Position anchor)Parameters
anchorPosition
SetRectangularSelectionAnchorVirtualSpace(int)
Set the virtual space of the anchor of the rectangular selection. (Scintilla feature 2594)
void SetRectangularSelectionAnchorVirtualSpace(int space)Parameters
spaceint
SetRectangularSelectionCaret(Position)
Set the caret position of the rectangular selection. (Scintilla feature 2588)
void SetRectangularSelectionCaret(Position caret)Parameters
caretPosition
SetRectangularSelectionCaretVirtualSpace(int)
Set the virtual space of the caret of the rectangular selection. (Scintilla feature 2592)
void SetRectangularSelectionCaretVirtualSpace(int space)Parameters
spaceint
SetRectangularSelectionModifier(int)
On GTK, allow selecting the modifier key to use for mouse-based rectangular selection. Often the window manager requires Alt+Mouse Drag for moving windows. Valid values are SCMOD_CTRL(default), SCMOD_ALT, or SCMOD_SUPER. (Scintilla feature 2598)
void SetRectangularSelectionModifier(int modifier)Parameters
modifierint
SetRepresentation(string, string)
Set the way a character is drawn. (Scintilla feature 2665)
void SetRepresentation(string encodedCharacter, string representation)Parameters
encodedCharacterstringNUL-terminated string of the bytes for one character in the current encoding. This cannot be used to set a representation for multiple-character strings.
representationstringNUL-terminated UTF-8 string with a maximum length of 200 bytes.
Exceptions
- ArgumentException
Thrown if
representationencodes to more than 200 bytes.
SetSavePoint()
Remember the current position in the undo history as the position at which the document was saved. (Scintilla feature 2014)
void SetSavePoint()SetScrollWidth(int)
Sets the document width assumed for scrolling. (Scintilla feature 2274)
void SetScrollWidth(int pixelWidth)Parameters
pixelWidthint
SetScrollWidthTracking(bool)
Sets whether the maximum width line displayed is used to set scroll width. (Scintilla feature 2516)
void SetScrollWidthTracking(bool tracking)Parameters
trackingbool
SetSearchFlags(FindOption)
Set the search flags used by SearchInTarget. (Scintilla feature 2198)
void SetSearchFlags(FindOption searchFlags)Parameters
searchFlagsFindOption
SetSel(Position, Position)
Select a range of text. (Scintilla feature 2160)
void SetSel(Position anchor, Position caret)Parameters
SetSelAlpha(Alpha)
SCI_SETSELALPHA( alpha alpha)
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
void SetSelAlpha(Alpha alpha)Parameters
alphaAlpha
SetSelBack(bool, Colour)
SCI_SETSELBACK(bool useSetting, colour back)
You can choose to override the default selection colouring with these elements and messages. The element APIs
are now preferred as they handle translucency+ layering and cooperation with defaults better. With the
messages, 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.
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
void SetSelBack(bool useSetting, Colour back)Parameters
SetSelEOLFilled(bool)
Set the selection to have its end of line filled or not. (Scintilla feature 2480)
void SetSelEOLFilled(bool filled)Parameters
filledbool
SetSelFore(bool, Colour)
SCI_SETSELFORE(bool useSetting, colour fore)
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
void SetSelFore(bool useSetting, Colour fore)Parameters
SetSelection(Position, Position)
Set a simple selection (Scintilla feature 2572)
void SetSelection(Position caret, Position anchor)Parameters
SetSelectionEnd(Position)
Sets the position that ends the selection - this becomes the caret. (Scintilla feature 2144)
void SetSelectionEnd(Position caret)Parameters
caretPosition
SetSelectionMode(SelectionMode)
Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or by lines (SC_SEL_LINES). (Scintilla feature 2422)
void SetSelectionMode(SelectionMode selectionMode)Parameters
selectionModeSelectionMode
SetSelectionNAnchor(int, Position)
Set the anchor position of the nth selection. (Scintilla feature 2578)
void SetSelectionNAnchor(int selection, Position anchor)Parameters
SetSelectionNAnchorVirtualSpace(int, int)
Set the virtual space of the anchor of the nth selection. (Scintilla feature 2582)
void SetSelectionNAnchorVirtualSpace(int selection, int space)Parameters
SetSelectionNCaret(int, Position)
Set the caret position of the nth selection. (Scintilla feature 2576)
void SetSelectionNCaret(int selection, Position caret)Parameters
SetSelectionNCaretVirtualSpace(int, int)
Set the virtual space of the caret of the nth selection. (Scintilla feature 2580)
void SetSelectionNCaretVirtualSpace(int selection, int space)Parameters
SetSelectionNEnd(int, Position)
Sets the position that ends the selection - this becomes the currentPosition. (Scintilla feature 2586)
void SetSelectionNEnd(int selection, Position caret)Parameters
SetSelectionNStart(int, Position)
Sets the position that starts the selection - this becomes the anchor. (Scintilla feature 2584)
void SetSelectionNStart(int selection, Position anchor)Parameters
SetSelectionStart(Position)
Sets the position that starts the selection - this becomes the anchor. (Scintilla feature 2142)
void SetSelectionStart(Position anchor)Parameters
anchorPosition
SetStatus(Status)
Change error status - 0 = OK. (Scintilla feature 2382)
void SetStatus(Status status)Parameters
statusStatus
SetStyleBits(int)
Scintilla no longer supports style byte indicators. The last version to support style byte indicators was 3.4.2. Any use of these symbols should be removed and replaced with standard indicators.
[Obsolete("See https://www.scintilla.org/ScintillaDoc.html#SCI_SETSTYLEBITS")]
void SetStyleBits(int bits)Parameters
bitsint
SetStyling(Position, int)
Change style from current styling position for length characters to a style and move the current styling position to after this newly styled segment. (Scintilla feature 2033)
void SetStyling(Position length, int style)Parameters
SetStylingEx(Position, string)
Set the styles for a segment of the document. (Scintilla feature 2073)
void SetStylingEx(Position length, string styles)Parameters
SetTabDrawMode(TabDrawMode)
Set how tabs are drawn when visible. (Scintilla feature 2699)
void SetTabDrawMode(TabDrawMode tabDrawMode)Parameters
tabDrawModeTabDrawMode
SetTabIndents(bool)
Sets whether a tab pressed when caret is within indentation indents. (Scintilla feature 2260)
void SetTabIndents(bool tabIndents)Parameters
tabIndentsbool
SetTabWidth(int)
Change the visible size of a tab to be a multiple of the width of a space character. (Scintilla feature 2036)
void SetTabWidth(int tabWidth)Parameters
tabWidthint
SetTargetEnd(Position)
Sets the position that ends the target which is used for updating the document without affecting the scroll position. (Scintilla feature 2192)
void SetTargetEnd(Position end)Parameters
endPosition
SetTargetRange(Position, Position)
Sets both the start and end of the target in one call. (Scintilla feature 2686)
void SetTargetRange(Position start, Position end)Parameters
SetTargetStart(Position)
Sets the position that starts the target which is used for updating the document without affecting the scroll position. (Scintilla feature 2190)
void SetTargetStart(Position start)Parameters
startPosition
SetTechnology(Technology)
Set the technology used. (Scintilla feature 2630)
void SetTechnology(Technology technology)Parameters
technologyTechnology
SetText(string)
Replace the contents of the document with the argument text. (Scintilla feature 2181)
void SetText(string text)Parameters
textstring
SetTwoPhaseDraw(bool)
This has been replaced with GetPhasesDraw() which is more general, allowing multiple phase drawing as well as one and two phase drawing.
[Obsolete("See https://www.scintilla.org/ScintillaDoc.html#SCI_SETTWOPHASEDRAW")]
void SetTwoPhaseDraw(bool twoPhase)Parameters
twoPhasebool
SetUndoCollection(bool)
Choose between collecting actions into the undo history and discarding them. (Scintilla feature 2012)
void SetUndoCollection(bool collectUndo)Parameters
collectUndobool
SetUseTabs(bool)
Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces. (Scintilla feature 2124)
void SetUseTabs(bool useTabs)Parameters
useTabsbool
SetVScrollBar(bool)
Show or hide the vertical scroll bar. (Scintilla feature 2280)
void SetVScrollBar(bool visible)Parameters
visiblebool
SetViewEOL(bool)
Make the end of line characters visible or invisible. (Scintilla feature 2356)
void SetViewEOL(bool visible)Parameters
visiblebool
SetViewWS(WhiteSpace)
Make white space characters invisible, always visible or visible outside indentation. (Scintilla feature 2021)
void SetViewWS(WhiteSpace viewWS)Parameters
viewWSWhiteSpace
SetVirtualSpaceOptions(VirtualSpace)
Set options for virtual space behaviour. (Scintilla feature 2596)
void SetVirtualSpaceOptions(VirtualSpace virtualSpaceOptions)Parameters
virtualSpaceOptionsVirtualSpace
SetVisiblePolicy(VisiblePolicy, int)
Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc. (Scintilla feature 2394)
void SetVisiblePolicy(VisiblePolicy visiblePolicy, int visibleSlop)Parameters
visiblePolicyVisiblePolicyvisibleSlopint
SetWhitespaceBack(bool, Colour)
Set the background colour of all whitespace and whether to use this setting. (Scintilla feature 2085)
void SetWhitespaceBack(bool useSetting, Colour back)Parameters
SetWhitespaceChars(string)
Set the set of characters making up whitespace for when moving or selecting by word. Should be called after SetWordChars. (Scintilla feature 2443)
void SetWhitespaceChars(string characters)Parameters
charactersstring
SetWhitespaceFore(bool, Colour)
Set the foreground colour of all whitespace and whether to use this setting. (Scintilla feature 2084)
void SetWhitespaceFore(bool useSetting, Colour fore)Parameters
SetWhitespaceSize(int)
Set the size of the dots used to mark space characters. (Scintilla feature 2086)
void SetWhitespaceSize(int size)Parameters
sizeint
SetWordChars(string)
Set the set of characters making up words for when moving or selecting by word. First sets defaults like SetCharsDefault. (Scintilla feature 2077)
void SetWordChars(string characters)Parameters
charactersstring
SetWrapIndentMode(WrapIndentMode)
Sets how wrapped sublines are placed. Default is fixed. (Scintilla feature 2472)
void SetWrapIndentMode(WrapIndentMode wrapIndentMode)Parameters
wrapIndentModeWrapIndentMode
SetWrapMode(Wrap)
Sets whether text is word wrapped. (Scintilla feature 2268)
void SetWrapMode(Wrap wrapMode)Parameters
wrapModeWrap
SetWrapStartIndent(int)
Set the start indent for wrapped lines. (Scintilla feature 2464)
void SetWrapStartIndent(int indent)Parameters
indentint
SetWrapVisualFlags(WrapVisualFlag)
Set the display mode of visual flags for wrapped lines. (Scintilla feature 2460)
void SetWrapVisualFlags(WrapVisualFlag wrapVisualFlags)Parameters
wrapVisualFlagsWrapVisualFlag
SetWrapVisualFlagsLocation(WrapVisualLocation)
Set the location of visual flags for wrapped lines. (Scintilla feature 2462)
void SetWrapVisualFlagsLocation(WrapVisualLocation wrapVisualFlagsLocation)Parameters
wrapVisualFlagsLocationWrapVisualLocation
SetXCaretPolicy(CaretPolicy, int)
Set the way the caret is kept visible when going sideways. The exclusion zone is given in pixels. (Scintilla feature 2402)
void SetXCaretPolicy(CaretPolicy caretPolicy, int caretSlop)Parameters
caretPolicyCaretPolicycaretSlopint
SetXOffset(int)
Set the xOffset (ie, horizontal scroll position). (Scintilla feature 2397)
void SetXOffset(int xOffset)Parameters
xOffsetint
SetYCaretPolicy(CaretPolicy, int)
Set the way the line the caret is on is kept visible. The exclusion zone is given in lines. (Scintilla feature 2403)
void SetYCaretPolicy(CaretPolicy caretPolicy, int caretSlop)Parameters
caretPolicyCaretPolicycaretSlopint
SetZoom(int)
Set the zoom level. This number of points is added to the size of all fonts. It may be positive to magnify or negative to reduce. (Scintilla feature 2373)
void SetZoom(int zoomInPoints)Parameters
zoomInPointsint
ShowLines(Position, Position)
Make a range of lines visible. (Scintilla feature 2226)
void ShowLines(Position lineStart, Position lineEnd)Parameters
StartRecord()
Start notifying the container of all key presses and commands. (Scintilla feature 3001)
void StartRecord()StartStyling(Position, int)
Set the current styling position to start. The unused parameter is no longer used and should be set to 0. (Scintilla feature 2032)
void StartStyling(Position start, int unused)Parameters
StopRecord()
Stop notifying the container of all key presses and commands. (Scintilla feature 3002)
void StopRecord()StutteredPageDown()
Move caret to bottom of page, or one page down if already at bottom of page. (Scintilla feature 2437)
void StutteredPageDown()StutteredPageDownExtend()
Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position. (Scintilla feature 2438)
void StutteredPageDownExtend()StutteredPageUp()
Move caret to top of page, or one page up if already at top of page. (Scintilla feature 2435)
void StutteredPageUp()StutteredPageUpExtend()
Move caret to top of page, or one page up if already at top of page, extending selection to new caret position. (Scintilla feature 2436)
void StutteredPageUpExtend()StyleClearAll()
Clear all the styles and make equivalent to the global default style. (Scintilla feature 2050)
void StyleClearAll()StyleGetBack(int)
Get the background colour of a style. (Scintilla feature 2482)
Colour StyleGetBack(int style)Parameters
styleint
Returns
StyleGetBold(int)
Get is a style bold or not. (Scintilla feature 2483)
bool StyleGetBold(int style)Parameters
styleint
Returns
StyleGetCase(int)
Get is a style mixed case, or to force upper or lower case. (Scintilla feature 2489)
CaseVisible StyleGetCase(int style)Parameters
styleint
Returns
StyleGetChangeable(int)
Get is a style changeable or not (read only). Experimental feature, currently buggy. (Scintilla feature 2492)
bool StyleGetChangeable(int style)Parameters
styleint
Returns
StyleGetCharacterSet(int)
Get the character get of the font in a style. (Scintilla feature 2490)
CharacterSet StyleGetCharacterSet(int style)Parameters
styleint
Returns
StyleGetEOLFilled(int)
Get is a style to have its end of line filled or not. (Scintilla feature 2487)
bool StyleGetEOLFilled(int style)Parameters
styleint
Returns
StyleGetFont(int)
Get the font of a style. Returns the length of the fontName Result is NUL-terminated. (Scintilla feature 2486)
string StyleGetFont(int style)Parameters
styleint
Returns
StyleGetFore(int)
Get the foreground colour of a style. (Scintilla feature 2481)
Colour StyleGetFore(int style)Parameters
styleint
Returns
StyleGetHotSpot(int)
Get is a style a hotspot or not. (Scintilla feature 2493)
bool StyleGetHotSpot(int style)Parameters
styleint
Returns
StyleGetItalic(int)
Get is a style italic or not. (Scintilla feature 2484)
bool StyleGetItalic(int style)Parameters
styleint
Returns
StyleGetSize(int)
Get the size of characters of a style. (Scintilla feature 2485)
int StyleGetSize(int style)Parameters
styleint
Returns
StyleGetSizeFractional(int)
Get the size of characters of a style in points multiplied by 100 (Scintilla feature 2062)
int StyleGetSizeFractional(int style)Parameters
styleint
Returns
StyleGetUnderline(int)
Get is a style underlined or not. (Scintilla feature 2488)
bool StyleGetUnderline(int style)Parameters
styleint
Returns
StyleGetVisible(int)
Get is a style visible or not. (Scintilla feature 2491)
bool StyleGetVisible(int style)Parameters
styleint
Returns
StyleGetWeight(int)
Get the weight of characters of a style. (Scintilla feature 2064)
FontWeight StyleGetWeight(int style)Parameters
styleint
Returns
StyleResetDefault()
Reset the default style to its state at startup (Scintilla feature 2058)
void StyleResetDefault()StyleSetBack(int, Colour)
Set the background colour of a style. (Scintilla feature 2052)
void StyleSetBack(int style, Colour back)Parameters
StyleSetBold(int, bool)
Set a style to be bold or not. (Scintilla feature 2053)
void StyleSetBold(int style, bool bold)Parameters
StyleSetCase(int, CaseVisible)
Set a style to be mixed case, or to force upper or lower case. (Scintilla feature 2060)
void StyleSetCase(int style, CaseVisible caseVisible)Parameters
styleintcaseVisibleCaseVisible
StyleSetChangeable(int, bool)
Set a style to be changeable or not (read only). Experimental feature, currently buggy. (Scintilla feature 2099)
void StyleSetChangeable(int style, bool changeable)Parameters
StyleSetCharacterSet(int, CharacterSet)
Set the character set of the font in a style. (Scintilla feature 2066)
void StyleSetCharacterSet(int style, CharacterSet characterSet)Parameters
styleintcharacterSetCharacterSet
StyleSetEOLFilled(int, bool)
Set a style to have its end of line filled or not. (Scintilla feature 2057)
void StyleSetEOLFilled(int style, bool eolFilled)Parameters
StyleSetFont(int, string)
Set the font of a style. (Scintilla feature 2056)
void StyleSetFont(int style, string fontName)Parameters
StyleSetFore(int, Colour)
Set the foreground colour of a style. (Scintilla feature 2051)
void StyleSetFore(int style, Colour fore)Parameters
StyleSetHotSpot(int, bool)
Set a style to be a hotspot or not. (Scintilla feature 2409)
void StyleSetHotSpot(int style, bool hotspot)Parameters
StyleSetItalic(int, bool)
Set a style to be italic or not. (Scintilla feature 2054)
void StyleSetItalic(int style, bool italic)Parameters
StyleSetSize(int, int)
Set the size of characters of a style. (Scintilla feature 2055)
void StyleSetSize(int style, int sizePoints)Parameters
StyleSetSizeFractional(int, int)
Set the size of characters of a style. Size is in points multiplied by 100. (Scintilla feature 2061)
void StyleSetSizeFractional(int style, int sizeHundredthPoints)Parameters
StyleSetUnderline(int, bool)
Set a style to be underlined or not. (Scintilla feature 2059)
void StyleSetUnderline(int style, bool underline)Parameters
StyleSetVisible(int, bool)
Set a style to be visible or not. (Scintilla feature 2074)
void StyleSetVisible(int style, bool visible)Parameters
StyleSetWeight(int, FontWeight)
Set the weight of characters of a style. (Scintilla feature 2063)
void StyleSetWeight(int style, FontWeight weight)Parameters
styleintweightFontWeight
SwapMainAnchorCaret()
Swap that caret and anchor of the main selection. (Scintilla feature 2607)
void SwapMainAnchorCaret()Tab()
If selection is empty or all on one line replace the selection with a tab character. If more than one line selected, indent the lines. (Scintilla feature 2327)
void Tab()TagsOfStyle(int)
Retrieve a ' ' separated list of style tags like "literal quoted string". Result is NUL-terminated. (Scintilla feature 4031)
string TagsOfStyle(int style)Parameters
styleint
Returns
TargetAsUTF8()
Returns the target converted to UTF8. Return the length in bytes. (Scintilla feature 2447)
string TargetAsUTF8()Returns
TargetFromSelection()
Make the target range start and end be the same as the selection range start and end. (Scintilla feature 2287)
void TargetFromSelection()TargetWholeDocument()
Sets the target to the whole document. (Scintilla feature 2690)
void TargetWholeDocument()TextHeight(Position)
Retrieve the height of a particular line of text in pixels. (Scintilla feature 2279)
int TextHeight(Position line)Parameters
linePosition
Returns
TextWidth(int, string)
Measure the pixel width of some text in a particular style. NUL terminated text argument. Does not handle tab or control characters. (Scintilla feature 2276)
int TextWidth(int style, string text)Parameters
Returns
ToggleCaretSticky()
Switch between sticky and non-sticky: meant to be bound to a key. (Scintilla feature 2459)
void ToggleCaretSticky()ToggleFold(Position)
Switch a header line between expanded and contracted. (Scintilla feature 2231)
void ToggleFold(Position line)Parameters
linePosition
ToggleFoldShowText(Position, string)
Switch a header line between expanded and contracted and show some text after the line. (Scintilla feature 2700)
void ToggleFoldShowText(Position line, string text)Parameters
Undo()
Undo one action in the undo history. (Scintilla feature 2176)
void Undo()UpperCase()
Transform the selection to upper case. (Scintilla feature 2341)
void UpperCase()UsePopUp(PopUp)
Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button on certain areas. (Scintilla feature 2371)
void UsePopUp(PopUp popUpMode)Parameters
popUpModePopUp
UserListShow(int, string)
Display a list of strings and send notification when user chooses one. (Scintilla feature 2117)
void UserListShow(int listType, string itemList)Parameters
VCHome()
Move caret to before first visible character on line. If already there move to first character on line. (Scintilla feature 2331)
void VCHome()VCHomeDisplay()
Move caret to before first visible character on display line. If already there move to first character on display line. (Scintilla feature 2652)
void VCHomeDisplay()VCHomeDisplayExtend()
Like VCHomeDisplay but extending selection to new caret position. (Scintilla feature 2653)
void VCHomeDisplayExtend()VCHomeExtend()
Like VCHome but extending selection to new caret position. (Scintilla feature 2332)
void VCHomeExtend()VCHomeRectExtend()
Move caret to before first visible character on line. If already there move to first character on line. In either case, extend rectangular selection to new caret position. (Scintilla feature 2431)
void VCHomeRectExtend()VCHomeWrap()
Like VCHome but when word-wrap is enabled goes first to start of display line VCHomeDisplay, then behaves like VCHome. (Scintilla feature 2453)
void VCHomeWrap()VCHomeWrapExtend()
Like VCHomeExtend but when word-wrap is enabled extends first to start of display line VCHomeDisplayExtend, then behaves like VCHomeExtend. (Scintilla feature 2454)
void VCHomeWrapExtend()VerticalCentreCaret()
Centre current line in window. (Scintilla feature 2619)
void VerticalCentreCaret()VisibleFromDocLine(int)
Find the display line of a document line taking hidden lines into account. (Scintilla feature 2220)
int VisibleFromDocLine(int docLine)Parameters
docLineint
Returns
WordEndPosition(Position, bool)
Get position of end of word. (Scintilla feature 2267)
int WordEndPosition(Position pos, bool onlyWordCharacters)Parameters
Returns
WordLeft()
Move caret left one word. (Scintilla feature 2308)
void WordLeft()WordLeftEnd()
Move caret left one word, position cursor at end of word. (Scintilla feature 2439)
void WordLeftEnd()WordLeftEndExtend()
Move caret left one word, position cursor at end of word, extending selection to new caret position. (Scintilla feature 2440)
void WordLeftEndExtend()WordLeftExtend()
Move caret left one word extending selection to new caret position. (Scintilla feature 2309)
void WordLeftExtend()WordPartLeft()
Move to the previous change in capitalisation. (Scintilla feature 2390)
void WordPartLeft()WordPartLeftExtend()
Move to the previous change in capitalisation extending selection to new caret position. (Scintilla feature 2391)
void WordPartLeftExtend()WordPartRight()
Move to the change next in capitalisation. (Scintilla feature 2392)
void WordPartRight()WordPartRightExtend()
Move to the next change in capitalisation extending selection to new caret position. (Scintilla feature 2393)
void WordPartRightExtend()WordRight()
Move caret right one word. (Scintilla feature 2310)
void WordRight()WordRightEnd()
Move caret right one word, position cursor at end of word. (Scintilla feature 2441)
void WordRightEnd()WordRightEndExtend()
Move caret right one word, position cursor at end of word, extending selection to new caret position. (Scintilla feature 2442)
void WordRightEndExtend()WordRightExtend()
Move caret right one word extending selection to new caret position. (Scintilla feature 2311)
void WordRightExtend()WordStartPosition(Position, bool)
Get position of start of word. (Scintilla feature 2266)
int WordStartPosition(Position pos, bool onlyWordCharacters)Parameters
Returns
WrapCount(int)
The number of display lines needed to wrap a document line (Scintilla feature 2235)
int WrapCount(int docLine)Parameters
docLineint
Returns
ZoomIn()
Magnify the displayed text by increasing the sizes by 1 point. (Scintilla feature 2333)
void ZoomIn()ZoomOut()
Make the displayed text smaller by decreasing the sizes by 1 point. (Scintilla feature 2334)
void ZoomOut()