Class ScintillaGateway
Primary interface to Notepad++/Scintilla.
See https://www.scintilla.org/ScintillaDoc.html for further details.
public class ScintillaGateway : IScintillaGateway- Inheritance
-
ScintillaGateway
- Implements
- Inherited Members
Remarks
If gateways are missing or incomplete, feel free to open a discussion at https://github.com/orgs/npp-dotnet/discussions
Constructors
ScintillaGateway(IntPtr)
public ScintillaGateway(IntPtr scintilla)Parameters
scintillaIntPtr
Properties
CodePage
Gets the encoding of the currently active document.
public Encoding CodePage { get; }Property Value
LineDelimiter
Gets a newline string in the EOL mode of the current document.
public string LineDelimiter { get; }Property Value
Methods
AddRefDocument(IntPtr)
Extend life of document. (Scintilla feature 2376)
public void AddRefDocument(IntPtr doc)Parameters
docIntPtr
AddSelection(Position, Position)
Add a selection (Scintilla feature 2573)
public void AddSelection(Position caret, Position anchor)Parameters
AddStyledText(Position, Cells)
Add array of cells to document. (Scintilla feature 2002)
public void AddStyledText(Position length, Cells c)Parameters
AddTabStop(Position, int)
Add an explicit tab stop for a line. (Scintilla feature 2676)
public void AddTabStop(Position line, int x)Parameters
AddText(string)
Add text to the document at current position. (Scintilla feature 2001)
public void AddText(string text)Parameters
textstring
AddUndoAction(int, UndoFlags)
Add a container action to the undo stack (Scintilla feature 2560)
public void AddUndoAction(int token, UndoFlags flags)Parameters
Allocate(int)
Enlarge the document to a particular size of text bytes. (Scintilla feature 2446)
public void Allocate(int bytes)Parameters
bytesint
AllocateExtendedStyles(int)
Allocate some extended (>255) style numbers and return the start of the range (Scintilla feature 2553)
public int AllocateExtendedStyles(int numberStyles)Parameters
numberStylesint
Returns
AllocateLineCharacterIndex(LineCharacterIndexType)
Request line character index be created or its use count increased. (Scintilla feature 2711)
public 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)
public int AllocateSubStyles(int styleBase, int numberStyles)Parameters
Returns
AnnotationClearAll()
Clear the annotations from all lines (Scintilla feature 2547)
public void AnnotationClearAll()AnnotationGetLines(Position)
Get the number of annotation lines for a line (Scintilla feature 2546)
public int AnnotationGetLines(Position line)Parameters
linePosition
Returns
AnnotationGetStyle(Position)
Get the style number for the annotations for a line (Scintilla feature 2543)
public int AnnotationGetStyle(Position line)Parameters
linePosition
Returns
AnnotationGetStyleOffset()
Get the start of the range of style numbers used for annotations (Scintilla feature 2551)
public int AnnotationGetStyleOffset()Returns
AnnotationGetStyles(Position)
Get the annotation styles for a line (Scintilla feature 2545)
public string AnnotationGetStyles(Position line)Parameters
linePosition
Returns
AnnotationGetText(Position)
Get the annotation text for a line (Scintilla feature 2541)
public string AnnotationGetText(Position line)Parameters
linePosition
Returns
AnnotationGetVisible()
Get the visibility for the annotations for a view (Scintilla feature 2549)
public AnnotationVisible AnnotationGetVisible()Returns
AnnotationSetStyle(Position, int)
Set the style number for the annotations for a line (Scintilla feature 2542)
public void AnnotationSetStyle(Position line, int style)Parameters
AnnotationSetStyleOffset(int)
Get the start of the range of style numbers used for annotations (Scintilla feature 2550)
public void AnnotationSetStyleOffset(int style)Parameters
styleint
AnnotationSetStyles(Position, string)
Set the annotation styles for a line (Scintilla feature 2544)
public void AnnotationSetStyles(Position line, string styles)Parameters
AnnotationSetText(Position, string)
Set the annotation text for a line (Scintilla feature 2540)
public void AnnotationSetText(Position line, string text)Parameters
AnnotationSetVisible(AnnotationVisible)
Set the visibility for the annotations for a view (Scintilla feature 2548)
public void AnnotationSetVisible(AnnotationVisible visible)Parameters
visibleAnnotationVisible
AppendText(string)
Append a string to the end of the document without changing the selection. (Scintilla feature 2282)
public void AppendText(string text)Parameters
textstring
AppendTextAndMoveCursor(string)
public void AppendTextAndMoveCursor(string text)Parameters
textstring
AssignCmdKey(KeyModifier, int)
When key+modifier combination keyDefinition is pressed perform sciCommand. (Scintilla feature 2070)
public void AssignCmdKey(KeyModifier keyDefinition, int sciCommand)Parameters
keyDefinitionKeyModifiersciCommandint
AutoCActive()
Is there an auto-completion list visible? (Scintilla feature 2102)
public bool AutoCActive()Returns
AutoCCancel()
Remove the auto-completion list from the screen. (Scintilla feature 2101)
public void AutoCCancel()AutoCComplete()
User has selected an item so remove the list and insert the selection. (Scintilla feature 2104)
public void AutoCComplete()AutoCGetAutoHide()
Retrieve whether or not autocompletion is hidden automatically when nothing matches. (Scintilla feature 2119)
public bool AutoCGetAutoHide()Returns
AutoCGetCancelAtStart()
Retrieve whether auto-completion cancelled by backspacing before start. (Scintilla feature 2111)
public bool AutoCGetCancelAtStart()Returns
AutoCGetCaseInsensitiveBehaviour()
Get auto-completion case insensitive behaviour. (Scintilla feature 2635)
public CaseInsensitiveBehaviour AutoCGetCaseInsensitiveBehaviour()Returns
AutoCGetChooseSingle()
Retrieve whether a single item auto-completion list automatically choose the item. (Scintilla feature 2114)
public bool AutoCGetChooseSingle()Returns
AutoCGetCurrent()
Get currently selected item position in the auto-completion list (Scintilla feature 2445)
public 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)
public string AutoCGetCurrentText()Returns
AutoCGetDropRestOfWord()
Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion. (Scintilla feature 2271)
public bool AutoCGetDropRestOfWord()Returns
AutoCGetIgnoreCase()
Retrieve state of ignore case flag. (Scintilla feature 2116)
public bool AutoCGetIgnoreCase()Returns
AutoCGetMaxHeight()
Set the maximum height, in rows, of auto-completion and user lists. (Scintilla feature 2211)
public int AutoCGetMaxHeight()Returns
AutoCGetMaxWidth()
Get the maximum width, in characters, of auto-completion and user lists. (Scintilla feature 2209)
public int AutoCGetMaxWidth()Returns
AutoCGetMulti()
Retrieve the effect of autocompleting when there are multiple selections. (Scintilla feature 2637)
public MultiAutoComplete AutoCGetMulti()Returns
AutoCGetOrder()
Get the way autocompletion lists are ordered. (Scintilla feature 2661)
public Ordering AutoCGetOrder()Returns
AutoCGetSeparator()
Retrieve the auto-completion list separator character. (Scintilla feature 2107)
public int AutoCGetSeparator()Returns
AutoCGetTypeSeparator()
Retrieve the auto-completion list type-separator character. (Scintilla feature 2285)
public int AutoCGetTypeSeparator()Returns
AutoCPosStart()
Retrieve the position of the caret when the auto-completion list was displayed. (Scintilla feature 2103)
public Position AutoCPosStart()Returns
AutoCSelect(string)
Select the item in the auto-completion list that starts with a string. (Scintilla feature 2108)
public void AutoCSelect(string select)Parameters
selectstring
AutoCSetAutoHide(bool)
Set whether or not autocompletion is hidden automatically when nothing matches. (Scintilla feature 2118)
public 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)
public 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)
public void AutoCSetCaseInsensitiveBehaviour(CaseInsensitiveBehaviour behaviour)Parameters
behaviourCaseInsensitiveBehaviour
AutoCSetChooseSingle(bool)
Should a single item auto-completion list automatically choose the item. (Scintilla feature 2113)
public 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)
public 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)
public void AutoCSetFillUps(string characterSet)Parameters
characterSetstring
AutoCSetIgnoreCase(bool)
Set whether case is significant when performing auto-completion searches. (Scintilla feature 2115)
public 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)
public 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)
public void AutoCSetMaxWidth(int characterCount)Parameters
characterCountint
AutoCSetMulti(MultiAutoComplete)
Change the effect of autocompleting when there are multiple selections. (Scintilla feature 2636)
public void AutoCSetMulti(MultiAutoComplete multi)Parameters
multiMultiAutoComplete
AutoCSetOrder(Ordering)
Set the way autocompletion lists are ordered. (Scintilla feature 2660)
public 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)
public 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)
public 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)
public 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)
public void AutoCStops(string characterSet)Parameters
characterSetstring
BackTab()
Dedent the selected lines. (Scintilla feature 2328)
public void BackTab()BeginUndoAction()
Start a sequence of actions that is undone and redone as a unit. May be nested. (Scintilla feature 2078)
public void BeginUndoAction()BraceBadLight(Position)
Highlight the character at a position indicating there is no matching brace. (Scintilla feature 2352)
public 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)
public void BraceBadLightIndicator(bool useSetting, int indicator)Parameters
BraceHighlight(int, int)
Highlight the characters at two positions. (Scintilla feature 2351)
public 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)
public 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)
public int BraceMatch(Position pos, int maxReStyle)Parameters
Returns
CallTipActive()
Is there an active call tip? (Scintilla feature 2202)
public bool CallTipActive()Returns
CallTipCancel()
Remove the call tip from the screen. (Scintilla feature 2201)
public void CallTipCancel()CallTipPosStart()
Retrieve the position where the caret was before displaying the call tip. (Scintilla feature 2203)
public int CallTipPosStart()Returns
CallTipSetBack(Colour)
Set the background colour for the call tip. (Scintilla feature 2205)
public void CallTipSetBack(Colour back)Parameters
backColour
CallTipSetFore(Colour)
Set the foreground colour for the call tip. (Scintilla feature 2206)
public void CallTipSetFore(Colour fore)Parameters
foreColour
CallTipSetForeHlt(Colour)
Set the foreground colour for the highlighted part of the call tip. (Scintilla feature 2207)
public void CallTipSetForeHlt(Colour fore)Parameters
foreColour
CallTipSetHlt(int, int)
Highlight a segment of the definition. (Scintilla feature 2204)
public 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)
public void CallTipSetPosStart(int posStart)Parameters
posStartint
CallTipSetPosition(bool)
Set position of calltip, above or below text. (Scintilla feature 2213)
public void CallTipSetPosition(bool above)Parameters
abovebool
CallTipShow(Position, string)
Show a call tip containing a definition near position pos. (Scintilla feature 2200)
public 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)
public void CallTipUseStyle(int tabSize)Parameters
tabSizeint
CanPaste()
Will a paste succeed? (Scintilla feature 2173)
public bool CanPaste()Returns
CanRedo()
Are there any redoable actions in the undo history? (Scintilla feature 2016)
public bool CanRedo()Returns
CanUndo()
Are there any undoable actions in the undo history? (Scintilla feature 2174)
public bool CanUndo()Returns
Cancel()
Cancel any modes such as call tip or auto-completion list display. (Scintilla feature 2325)
public void Cancel()ChangeInsertion(string)
Change the text that is being inserted in response to SC_MOD_INSERTCHECK (Scintilla feature 2672)
public 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)
public int ChangeLexerState(Position start, Position end)Parameters
Returns
CharLeft()
Move caret left one character. (Scintilla feature 2304)
public void CharLeft()CharLeftExtend()
Move caret left one character extending selection to new caret position. (Scintilla feature 2305)
public void CharLeftExtend()CharLeftRectExtend()
Move caret left one character, extending rectangular selection to new caret position. (Scintilla feature 2428)
public void CharLeftRectExtend()CharPositionFromPoint(int, int)
Find the position of a character from a point within the window. (Scintilla feature 2561)
public 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)
public int CharPositionFromPointClose(int x, int y)Parameters
Returns
CharRight()
Move caret right one character. (Scintilla feature 2306)
public void CharRight()CharRightExtend()
Move caret right one character extending selection to new caret position. (Scintilla feature 2307)
public void CharRightExtend()CharRightRectExtend()
Move caret right one character, extending rectangular selection to new caret position. (Scintilla feature 2429)
public void CharRightRectExtend()ChooseCaretX()
Set the last x chosen value to be the caret x position. (Scintilla feature 2399)
public void ChooseCaretX()Clear()
Clear the selection. (Scintilla feature 2180)
public void Clear()ClearAll()
Delete all text in the document. (Scintilla feature 2004)
public void ClearAll()ClearAllCmdKeys()
Drop all key mappings. (Scintilla feature 2072)
public void ClearAllCmdKeys()ClearCmdKey(KeyModifier)
When key+modifier combination keyDefinition is pressed do nothing. (Scintilla feature 2071)
public void ClearCmdKey(KeyModifier keyDefinition)Parameters
keyDefinitionKeyModifier
ClearDocumentStyle()
Set all style bytes to 0, remove all folding information. (Scintilla feature 2005)
public void ClearDocumentStyle()ClearRegisteredImages()
Clear all the registered XPM images. (Scintilla feature 2408)
public void ClearRegisteredImages()ClearRepresentation(string)
Remove a character representation. (Scintilla feature 2667)
public void ClearRepresentation(string encodedCharacter)Parameters
encodedCharacterstring
Remarks
ClearSelectionToCursor()
clears the selection without changing the position of the cursor
public void ClearSelectionToCursor()ClearSelections()
Clear selections to a single empty stream selection (Scintilla feature 2571)
public void ClearSelections()ClearTabStops(Position)
Clear explicit tabstops on a line. (Scintilla feature 2675)
public void ClearTabStops(Position line)Parameters
linePosition
Colourise(Position, Position)
Colourise a segment of the document using the current lexing language. (Scintilla feature 4003)
public 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)
public int ContractedFoldNext(int lineStart)Parameters
lineStartint
Returns
ConvertEOLs(EndOfLine)
Convert all line endings in the document to one mode. (Scintilla feature 2029)
public void ConvertEOLs(EndOfLine eolMode)Parameters
eolModeEndOfLine
Copy()
Copy the selection to the clipboard. (Scintilla feature 2178)
public void Copy()CopyAllowLine()
Copy the selection, if selection empty copy the line with the caret (Scintilla feature 2519)
public void CopyAllowLine()CopyRange(Position, Position)
Copy a range of text to the clipboard. Positions are clipped into the document. (Scintilla feature 2419)
public void CopyRange(Position start, Position end)Parameters
CopyText(string)
Copy argument text to the clipboard. (Scintilla feature 2420)
public void CopyText(string text)Parameters
textstring
CountCharacters(Position, Position)
Count characters between two positions. (Scintilla feature 2633)
public int CountCharacters(Position start, Position end)Parameters
Returns
CountCodeUnits(Position, Position)
Count code units between two positions. (Scintilla feature 2715)
public 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)
public IntPtr CreateDocument(int bytes, DocumentOption documentOptions)Parameters
bytesintdocumentOptionsDocumentOption
Returns
CreateLoader(int, DocumentOption)
Create an ILoader*. (Scintilla feature 2632)
public IntPtr CreateLoader(int bytes, DocumentOption documentOptions)Parameters
bytesintdocumentOptionsDocumentOption
Returns
Cut()
Cut the selection to the clipboard. (Scintilla feature 2177)
public void Cut()DelLineLeft()
Delete back from the current position to the start of the line. (Scintilla feature 2395)
public void DelLineLeft()DelLineRight()
Delete forwards from the current position to the end of the line. (Scintilla feature 2396)
public void DelLineRight()DelWordLeft()
Delete the word to the left of the caret. (Scintilla feature 2335)
public void DelWordLeft()DelWordRight()
Delete the word to the right of the caret. (Scintilla feature 2336)
public void DelWordRight()DelWordRightEnd()
Delete the word to the right of the caret, but not the trailing non-word characters. (Scintilla feature 2518)
public void DelWordRightEnd()DeleteBack()
Delete the selection or if no selection, the character before the caret. (Scintilla feature 2326)
public 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)
public void DeleteBackNotLine()DeleteRange(Position, Position)
Delete a range of text in the document. (Scintilla feature 2645)
public 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)
public string DescribeKeyWordSets()Returns
DescribeProperty(string)
Describe a property. Result is NUL-terminated. (Scintilla feature 4016)
public string DescribeProperty(string name)Parameters
namestring
Returns
DescriptionOfStyle(int)
Retrieve a description of a style. Result is NUL-terminated. (Scintilla feature 4032)
public 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)
public int DistanceToSecondaryStyles()Returns
DocLineFromVisible(int)
Find the document line of a display line taking hidden lines into account. (Scintilla feature 2221)
public int DocLineFromVisible(int displayLine)Parameters
displayLineint
Returns
DocumentEnd()
Move caret to last position in document. (Scintilla feature 2318)
public void DocumentEnd()DocumentEndExtend()
Move caret to last position in document extending selection to new caret position. (Scintilla feature 2319)
public void DocumentEndExtend()DocumentStart()
Move caret to first position in document. (Scintilla feature 2316)
public void DocumentStart()DocumentStartExtend()
Move caret to first position in document extending selection to new caret position. (Scintilla feature 2317)
public void DocumentStartExtend()DropSelectionN(int)
Drop one selection (Scintilla feature 2671)
public void DropSelectionN(int selection)Parameters
selectionint
EditToggleOvertype()
Switch from insert to overtype mode or the reverse. (Scintilla feature 2324)
public void EditToggleOvertype()EmptyUndoBuffer()
Delete the undo history. (Scintilla feature 2175)
public 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)
public string EncodedFromUTF8(string utf8)Parameters
utf8string
Returns
EndUndoAction()
End a sequence of actions that is undone and redone as a unit. (Scintilla feature 2079)
public void EndUndoAction()EnsureVisible(Position)
Ensure a particular line is visible by expanding any header line hiding it. (Scintilla feature 2232)
public 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)
public 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)
public 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)
public int FindColumn(Position line, int column)Parameters
Returns
FindIndicatorFlash(Position, Position)
On OS X, flash a find indicator, then fade out. (Scintilla feature 2641)
public void FindIndicatorFlash(Position start, Position end)Parameters
FindIndicatorHide()
On OS X, hide the find indicator. (Scintilla feature 2642)
public void FindIndicatorHide()FindIndicatorShow(Position, Position)
On OS X, show a find indicator. (Scintilla feature 2640)
public 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")]
public int FindText(FindOption searchFlags, TextToFind ft)Parameters
searchFlagsFindOptionftTextToFind
Returns
FindText(FindOption, TextToFindFull)
Find some text in the document. (Scintilla feature 2196)
public long FindText(FindOption searchFlags, TextToFindFull ft)Parameters
searchFlagsFindOptionftTextToFindFull
Returns
FoldAll(FoldAction)
Expand or contract all fold headers. (Scintilla feature 2662)
public void FoldAll(FoldAction action)Parameters
actionFoldAction
FoldChildren(Position, FoldAction)
Expand or contract a fold header and its children. (Scintilla feature 2238)
public void FoldChildren(Position line, FoldAction action)Parameters
linePositionactionFoldAction
FoldDisplayTextGetStyle()
Get the style of fold display text. (Scintilla feature 2707)
public FoldDisplayTextStyle FoldDisplayTextGetStyle()Returns
FoldDisplayTextSetStyle(FoldDisplayTextStyle)
Set the style of fold display text. (Scintilla feature 2701)
public void FoldDisplayTextSetStyle(FoldDisplayTextStyle style)Parameters
styleFoldDisplayTextStyle
FoldLine(Position, FoldAction)
Expand or contract a fold header. (Scintilla feature 2237)
public void FoldLine(Position line, FoldAction action)Parameters
linePositionactionFoldAction
FormFeed()
Insert a Form Feed character. (Scintilla feature 2330)
public void FormFeed()FreeSubStyles()
Free allocated sub styles (Scintilla feature 4023)
public void FreeSubStyles()GetAccessibility()
Report accessibility status. (Scintilla feature 2703)
public 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)")]
public Colour GetAdditionalCaretFore()Returns
GetAdditionalCaretsBlink()
Whether additional carets will blink (Scintilla feature 2568)
public bool GetAdditionalCaretsBlink()Returns
GetAdditionalCaretsVisible()
Whether additional carets are visible (Scintilla feature 2609)
public 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)")]
public Alpha GetAdditionalSelAlpha()Returns
GetAdditionalSelectionTyping()
Whether typing can be performed into multiple selections (Scintilla feature 2566)
public bool GetAdditionalSelectionTyping()Returns
GetAllLinesVisible()
Are all lines visible? (Scintilla feature 2236)
public bool GetAllLinesVisible()Returns
GetAnchor()
Returns the position of the opposite end of the selection to the caret. (Scintilla feature 2009)
public Position GetAnchor()Returns
GetAutomaticFold()
Get automatic folding behaviours. (Scintilla feature 2664)
public AutomaticFold GetAutomaticFold()Returns
GetBackSpaceUnIndents()
Does a backspace pressed when caret is within indentation unindent? (Scintilla feature 2263)
public bool GetBackSpaceUnIndents()Returns
GetBufferedDraw()
Is drawing done first into a buffer or direct to the screen? (Scintilla feature 2034)
public 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")]
public Colour GetCaretFore()Returns
GetCaretLineBack()
SCI_GETCARETLINEBACK -> colour
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
public 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")]
public Alpha GetCaretLineBackAlpha()Returns
GetCaretLineFrame()
Retrieve the caret line frame width. Width = 0 means this option is disabled. (Scintilla feature 2704)
public int GetCaretLineFrame()Returns
GetCaretLineVisible()
SCI_GETCARETLINEVISIBLE -> bool
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
public bool GetCaretLineVisible()Returns
GetCaretLineVisibleAlways()
Is the caret line always visible? (Scintilla feature 2654)
public bool GetCaretLineVisibleAlways()Returns
GetCaretPeriod()
Get the time in milliseconds that the caret is on and off. (Scintilla feature 2075)
public int GetCaretPeriod()Returns
GetCaretSticky()
Can the caret preferred x position only be changed by explicit movement commands? (Scintilla feature 2457)
public CaretSticky GetCaretSticky()Returns
GetCaretStyle()
Returns the current style of the caret. (Scintilla feature 2513)
public CaretStyle GetCaretStyle()Returns
GetCaretWidth()
Returns the width of the insert mode caret. (Scintilla feature 2189)
public int GetCaretWidth()Returns
GetCharAt(Position)
Returns the character byte at the position. (Scintilla feature 2007)
public int GetCharAt(Position pos)Parameters
posPosition
Returns
GetCharacterCategoryOptimization()
Get the number of characters to have directly indexed categories (Scintilla feature 2721)
public int GetCharacterCategoryOptimization()Returns
GetCharacterPointer()
Compact the document buffer and return a read-only pointer to the characters in the document. (Scintilla feature 2520)
public IntPtr GetCharacterPointer()Returns
GetCodePage()
Get the code page used to interpret the bytes of the document as characters. (Scintilla feature 2137)
public int GetCodePage()Returns
GetColumn(Position)
Retrieve the column number of a position, taking tab width into account. (Scintilla feature 2129)
public int GetColumn(Position pos)Parameters
posPosition
Returns
GetCommandEvents()
Get whether command events are sent to the container. (Scintilla feature 2718)
public bool GetCommandEvents()Returns
GetControlCharSymbol()
Get the way control characters are displayed. (Scintilla feature 2389)
public 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)
public string GetCurLine()Returns
GetCurrentLineNumber()
Get the current line from the current position
public long GetCurrentLineNumber()Returns
GetCurrentPos()
Returns the position of the caret. (Scintilla feature 2008)
public Position GetCurrentPos()Returns
GetCursor()
Get cursor type. (Scintilla feature 2387)
public CursorShape GetCursor()Returns
GetDefaultFoldDisplayText()
Get the default fold display text. (Scintilla feature 2723)
public string GetDefaultFoldDisplayText()Returns
GetDirectFunction()
Retrieve a pointer to a function that processes messages for this Scintilla. (Scintilla feature 2184)
public IntPtr GetDirectFunction()Returns
GetDirectPointer()
Retrieve a pointer value to use as the first argument when calling the function returned by GetDirectFunction. (Scintilla feature 2185)
public IntPtr GetDirectPointer()Returns
GetDocPointer()
Retrieve a pointer to the document object. (Scintilla feature 2357)
public IntPtr GetDocPointer()Returns
GetDocumentOptions()
Get which document options are set. (Scintilla feature 2379)
public DocumentOption GetDocumentOptions()Returns
GetEOLMode()
Retrieve the current end of line mode - one of CRLF, CR, or LF. (Scintilla feature 2030)
public EndOfLine GetEOLMode()Returns
GetEdgeColour()
Retrieve the colour used in edge indication. (Scintilla feature 2364)
public Colour GetEdgeColour()Returns
GetEdgeColumn()
Retrieve the column number which text should be kept within. (Scintilla feature 2360)
public int GetEdgeColumn()Returns
GetEdgeMode()
Retrieve the edge highlight mode. (Scintilla feature 2362)
public EdgeVisualStyle GetEdgeMode()Returns
GetEndAtLastLine()
Retrieve whether the maximum scroll position has the last line at the bottom of the view. (Scintilla feature 2278)
public bool GetEndAtLastLine()Returns
GetEndStyled()
Retrieve the position of the last correctly styled character. (Scintilla feature 2028)
public Position GetEndStyled()Returns
GetExtraAscent()
Get extra ascent for each line (Scintilla feature 2526)
public int GetExtraAscent()Returns
GetExtraDescent()
Get extra descent for each line (Scintilla feature 2528)
public int GetExtraDescent()Returns
GetFirstVisibleLine()
Retrieve the display line at the top of the display. (Scintilla feature 2152)
public Position GetFirstVisibleLine()Returns
GetFocus()
Get internal focus flag. (Scintilla feature 2381)
public bool GetFocus()Returns
GetFoldExpanded(Position)
Is a header line expanded? (Scintilla feature 2230)
public bool GetFoldExpanded(Position line)Parameters
linePosition
Returns
GetFoldLevel(Position)
Retrieve the fold level of a line. (Scintilla feature 2223)
public FoldLevel GetFoldLevel(Position line)Parameters
linePosition
Returns
GetFoldParent(Position)
Find the parent line of a child line. (Scintilla feature 2225)
public Position GetFoldParent(Position line)Parameters
linePosition
Returns
GetFontQuality()
Retrieve the quality level for text. (Scintilla feature 2612)
public 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)
public Position GetGapPosition()Returns
GetHScrollBar()
Is the horizontal scroll bar visible? (Scintilla feature 2131)
public bool GetHScrollBar()Returns
GetHighlightGuide()
Get the highlighted indentation guide column. (Scintilla feature 2135)
public int GetHighlightGuide()Returns
GetHotspotActiveBack()
SCI_GETHOTSPOTACTIVEBACK -> colour
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
public Colour GetHotspotActiveBack()Returns
GetHotspotActiveFore()
SCI_GETHOTSPOTACTIVEFORE -> colour
[Obsolete("Use the element colours APIs instead: https://www.scintilla.org/ScintillaDoc.html#ElementColours")]
public Colour GetHotspotActiveFore()Returns
GetHotspotActiveUnderline()
Get whether underlining for active hotspots. (Scintilla feature 2496)
public bool GetHotspotActiveUnderline()Returns
GetHotspotSingleLine()
Get the HotspotSingleLine property (Scintilla feature 2497)
public bool GetHotspotSingleLine()Returns
GetIMEInteraction()
Is the IME displayed in a window or inline? (Scintilla feature 2678)
public IMEInteraction GetIMEInteraction()Returns
GetIdentifier()
Get the identifier. (Scintilla feature 2623)
public int GetIdentifier()Returns
GetIdleStyling()
Retrieve the limits to idle styling. (Scintilla feature 2693)
public IdleStyling GetIdleStyling()Returns
GetIndent()
Retrieve indentation size. (Scintilla feature 2123)
public int GetIndent()Returns
GetIndentationGuides()
Are the indentation guides visible? (Scintilla feature 2133)
public IndentView GetIndentationGuides()Returns
GetIndicatorCurrent()
Get the current indicator (Scintilla feature 2501)
public int GetIndicatorCurrent()Returns
GetIndicatorValue()
Get the current indicator value (Scintilla feature 2503)
public 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")]
public bool GetKeysUnicode()Returns
GetLastChild(Position, FoldLevel)
Find the last child line of a header line. (Scintilla feature 2224)
public Position GetLastChild(Position line, FoldLevel level)Parameters
Returns
GetLayoutCache()
Retrieve the degree of caching of layout information. (Scintilla feature 2273)
public LineCache GetLayoutCache()Returns
GetLength()
Returns the number of bytes in the document. (Scintilla feature 2006)
public long GetLength()Returns
GetLexer()
Retrieve the lexing language of the document. (Scintilla feature 4002)
public int GetLexer()Returns
GetLexerLanguage()
Retrieve the name of the lexer. Return the length of the text. Result is NUL-terminated. (Scintilla feature 4012)
public string GetLexerLanguage()Returns
GetLine(Position)
Retrieve the contents of a line. Returns the length of the line. (Scintilla feature 2153)
public string GetLine(Position line)Parameters
linePosition
Returns
GetLineCharacterIndex()
Retrieve line character index state. (Scintilla feature 2710)
public LineCharacterIndexType GetLineCharacterIndex()Returns
GetLineCount()
Returns the number of lines in the document. There is always at least one. (Scintilla feature 2154)
public int GetLineCount()Returns
GetLineEndPosition(Position)
Get the position after the last visible characters on a line. (Scintilla feature 2136)
public 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)
public LineEndType GetLineEndTypesActive()Returns
GetLineEndTypesAllowed()
Get the line end types currently allowed. (Scintilla feature 2657)
public 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)
public int GetLineEndTypesSupported()Returns
GetLineIndentPosition(Position)
Retrieve the position before the first non indentation character on a line. (Scintilla feature 2128)
public Position GetLineIndentPosition(Position line)Parameters
linePosition
Returns
GetLineIndentation(Position)
Retrieve the number of columns that a line is indented. (Scintilla feature 2127)
public 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)
public 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)
public Position GetLineSelStartPosition(Position line)Parameters
linePosition
Returns
GetLineState(Position)
Retrieve the extra styling information for a line. (Scintilla feature 2093)
public int GetLineState(Position line)Parameters
linePosition
Returns
GetLineVisible(Position)
Is a line visible? (Scintilla feature 2228)
public bool GetLineVisible(Position line)Parameters
linePosition
Returns
GetMainSelection()
Which selection is the main selection (Scintilla feature 2575)
public int GetMainSelection()Returns
GetMarginBackN(int)
Retrieve the background colour of a margin (Scintilla feature 2251)
public Colour GetMarginBackN(int margin)Parameters
marginint
Returns
GetMarginCursorN(int)
Retrieve the cursor shown in a margin. (Scintilla feature 2249)
public CursorShape GetMarginCursorN(int margin)Parameters
marginint
Returns
GetMarginLeft()
Returns the size in pixels of the left margin. (Scintilla feature 2156)
public int GetMarginLeft()Returns
GetMarginMaskN(int)
Retrieve the marker mask of a margin. (Scintilla feature 2245)
public int GetMarginMaskN(int margin)Parameters
marginint
Returns
GetMarginOptions()
Get the margin options. (Scintilla feature 2557)
public MarginOption GetMarginOptions()Returns
GetMarginRight()
Returns the size in pixels of the right margin. (Scintilla feature 2158)
public int GetMarginRight()Returns
GetMarginSensitiveN(int)
Retrieve the mouse click sensitivity of a margin. (Scintilla feature 2247)
public bool GetMarginSensitiveN(int margin)Parameters
marginint
Returns
GetMarginTypeN(int)
Retrieve the type of a margin. (Scintilla feature 2241)
public MarginType GetMarginTypeN(int margin)Parameters
marginint
Returns
GetMarginWidthN(int)
Retrieve the width of a margin in pixels. (Scintilla feature 2243)
public int GetMarginWidthN(int margin)Parameters
marginint
Returns
GetMargins()
How many margins are there?. (Scintilla feature 2253)
public int GetMargins()Returns
GetMaxLineState()
Retrieve the last line number that has line state. (Scintilla feature 2094)
public int GetMaxLineState()Returns
GetModEventMask()
Get which document modification events are sent to the container. (Scintilla feature 2378)
public ModificationFlags GetModEventMask()Returns
GetModify()
Is the document different from when it was last saved? (Scintilla feature 2159)
public bool GetModify()Returns
GetMouseDownCaptures()
Get whether mouse gets captured. (Scintilla feature 2385)
public bool GetMouseDownCaptures()Returns
GetMouseDwellTime()
Retrieve the time the mouse must sit still to generate a mouse dwell event. (Scintilla feature 2265)
public int GetMouseDwellTime()Returns
GetMouseSelectionRectangularSwitch()
Whether switching to rectangular mode while selecting with the mouse is allowed. (Scintilla feature 2669)
public bool GetMouseSelectionRectangularSwitch()Returns
GetMouseWheelCaptures()
Get whether mouse wheel can be active outside the window. (Scintilla feature 2697)
public bool GetMouseWheelCaptures()Returns
GetMoveExtendsSelection()
Get whether or not regular caret moves will extend or reduce the selection. (Scintilla feature 2706)
public bool GetMoveExtendsSelection()Returns
GetMultiPaste()
Retrieve the effect of pasting when there are multiple selections. (Scintilla feature 2615)
public MultiPaste GetMultiPaste()Returns
GetMultipleSelection()
Whether multiple selections can be made (Scintilla feature 2564)
public bool GetMultipleSelection()Returns
GetNamedStyles()
Retrieve the number of named styles for the lexer. (Scintilla feature 4029)
public int GetNamedStyles()Returns
GetNextTabStop(Position, int)
Find the next explicit tab stop position on a line after a position. (Scintilla feature 2677)
public int GetNextTabStop(Position line, int x)Parameters
Returns
GetOvertype()
Returns true if overtype mode is active otherwise false is returned. (Scintilla feature 2187)
public bool GetOvertype()Returns
GetPasteConvertEndings()
Get convert-on-paste setting (Scintilla feature 2468)
public bool GetPasteConvertEndings()Returns
GetPhasesDraw()
How many phases is drawing done in? (Scintilla feature 2673)
public PhasesDraw GetPhasesDraw()Returns
GetPositionCache()
How many entries are allocated to the position cache? (Scintilla feature 2515)
public int GetPositionCache()Returns
GetPrimaryStyleFromStyle(int)
For a secondary style, return the primary style, else return the argument. (Scintilla feature 4028)
public int GetPrimaryStyleFromStyle(int style)Parameters
styleint
Returns
GetPrintColourMode()
Returns the print colour mode. (Scintilla feature 2149)
public PrintOption GetPrintColourMode()Returns
GetPrintMagnification()
Returns the print magnification. (Scintilla feature 2147)
public int GetPrintMagnification()Returns
GetPrintWrapMode()
Is printing line wrapped? (Scintilla feature 2407)
public Wrap GetPrintWrapMode()Returns
GetProperty(string)
Retrieve a "property" value previously set with SetProperty. Result is NUL-terminated. (Scintilla feature 4008)
public 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")]
public 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)
public int GetPropertyInt(string key, int defaultValue)Parameters
Returns
GetPunctuationChars()
Get the set of characters making up punctuation characters (Scintilla feature 2649)
public 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)
public IntPtr GetRangePointer(Position start, Position lengthRange)Parameters
Returns
GetReadOnly()
In read-only mode? (Scintilla feature 2140)
public bool GetReadOnly()Returns
GetRectangularSelectionAnchor()
Return the anchor position of the rectangular selection. (Scintilla feature 2591)
public Position GetRectangularSelectionAnchor()Returns
GetRectangularSelectionAnchorVirtualSpace()
Return the virtual space of the anchor of the rectangular selection. (Scintilla feature 2595)
public Position GetRectangularSelectionAnchorVirtualSpace()Returns
GetRectangularSelectionCaret()
Return the caret position of the rectangular selection. (Scintilla feature 2589)
public Position GetRectangularSelectionCaret()Returns
GetRectangularSelectionCaretVirtualSpace()
Return the virtual space of the caret of the rectangular selection. (Scintilla feature 2593)
public Position GetRectangularSelectionCaretVirtualSpace()Returns
GetRectangularSelectionModifier()
Get the modifier key used for rectangular selection. (Scintilla feature 2599)
public int GetRectangularSelectionModifier()Returns
GetRepresentation(string)
Set the way a character is drawn. Result is NUL-terminated. (Scintilla feature 2666)
public string GetRepresentation(string encodedCharacter)Parameters
encodedCharacterstring
Returns
Remarks
GetScrollInfo(ScrollInfoMask, ScrollInfoBar)
Get the scroll information for the current Scintilla window.
public 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)
public int GetScrollWidth()Returns
GetScrollWidthTracking()
Retrieve whether the scroll width tracks wide lines. (Scintilla feature 2517)
public bool GetScrollWidthTracking()Returns
GetSearchFlags()
Get the search flags used by SearchInTarget. (Scintilla feature 2199)
public 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")]
public Alpha GetSelAlpha()Returns
GetSelEOLFilled()
Is the selection end of line filled? (Scintilla feature 2479)
public bool GetSelEOLFilled()Returns
GetSelText()
Retrieve the selected text. Return the length of the text. Result is NUL-terminated. (Scintilla feature 2161)
public string GetSelText()Returns
GetSelectionEmpty()
Is every selected range empty? (Scintilla feature 2650)
public bool GetSelectionEmpty()Returns
GetSelectionEnd()
Returns the position at the end of the selection. (Scintilla feature 2145)
public Position GetSelectionEnd()Returns
GetSelectionLength()
public int GetSelectionLength()Returns
GetSelectionMode()
Get the mode of the current selection. (Scintilla feature 2423)
public SelectionMode GetSelectionMode()Returns
GetSelectionNAnchor(int)
Return the anchor position of the nth selection. (Scintilla feature 2579)
public Position GetSelectionNAnchor(int selection)Parameters
selectionint
Returns
GetSelectionNAnchorVirtualSpace(int)
Return the virtual space of the anchor of the nth selection. (Scintilla feature 2583)
public Position GetSelectionNAnchorVirtualSpace(int selection)Parameters
selectionint
Returns
GetSelectionNCaret(int)
Return the caret position of the nth selection. (Scintilla feature 2577)
public Position GetSelectionNCaret(int selection)Parameters
selectionint
Returns
GetSelectionNCaretVirtualSpace(int)
Return the virtual space of the caret of the nth selection. (Scintilla feature 2581)
public Position GetSelectionNCaretVirtualSpace(int selection)Parameters
selectionint
Returns
GetSelectionNEnd(int)
Returns the position at the end of the selection. (Scintilla feature 2587)
public Position GetSelectionNEnd(int selection)Parameters
selectionint
Returns
GetSelectionNStart(int)
Returns the position at the start of the selection. (Scintilla feature 2585)
public Position GetSelectionNStart(int selection)Parameters
selectionint
Returns
GetSelectionStart()
Returns the position at the start of the selection. (Scintilla feature 2143)
public Position GetSelectionStart()Returns
GetSelections()
How many selections are there? (Scintilla feature 2570)
public int GetSelections()Returns
GetStatus()
Get error status. (Scintilla feature 2383)
public Status GetStatus()Returns
GetStyleAt(Position)
Returns the style byte at the position. (Scintilla feature 2010)
public 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")]
public 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")]
public int GetStyleBitsNeeded()Returns
GetStyleFromSubStyle(int)
For a sub style, return the base style, else return the argument. (Scintilla feature 4027)
public 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")]
public int GetStyledText(TextRange tr)Parameters
trTextRange
Returns
GetStyledText(TextRangeFull)
Retrieve a buffer of cells. (Scintilla feature 2778)
public 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)
public string GetSubStyleBases()Returns
GetSubStylesLength(int)
The number of sub styles associated with a base style (Scintilla feature 4022)
public 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)
public int GetSubStylesStart(int styleBase)Parameters
styleBaseint
Returns
GetTabDrawMode()
Retrieve the current tab draw mode. Returns one of SCTD_* constants. (Scintilla feature 2698)
public TabDrawMode GetTabDrawMode()Returns
GetTabIndents()
Does a tab pressed when caret is within indentation indent? (Scintilla feature 2261)
public bool GetTabIndents()Returns
GetTabWidth()
Retrieve the visible size of a tab. (Scintilla feature 2121)
public int GetTabWidth()Returns
GetTag(int)
Retrieve the value of a tag from a regular expression search. Result is NUL-terminated. (Scintilla feature 2616)
public 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)
public Position GetTargetEnd()Returns
GetTargetStart()
Get the position that starts the target. (Scintilla feature 2191)
public Position GetTargetStart()Returns
GetTargetText()
Retrieve the text in the target. (Scintilla feature 2687)
public string GetTargetText()Returns
GetTechnology()
Get the tech. (Scintilla feature 2631)
public Technology GetTechnology()Returns
GetText()
Retrieve all the text in the document. Returns number of characters retrieved. Result is NUL-terminated. (Scintilla feature 2182)
public string GetText()Returns
GetTextLength()
Retrieve the number of characters in the document. (Scintilla feature 2183)
public 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")]
public int GetTextRange(TextRange tr)Parameters
trTextRange
Returns
GetTextRange(TextRangeFull)
Retrieve a range of text. (Scintilla feature 2039)
public 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")]
public bool GetTwoPhaseDraw()Returns
GetUndoCollection()
Is undo history being collected? (Scintilla feature 2019)
public bool GetUndoCollection()Returns
GetUseTabs()
Retrieve whether tabs will be used in indentation. (Scintilla feature 2125)
public bool GetUseTabs()Returns
GetVScrollBar()
Is the vertical scroll bar visible? (Scintilla feature 2281)
public bool GetVScrollBar()Returns
GetViewEOL()
Are the end of line characters visible? (Scintilla feature 2355)
public bool GetViewEOL()Returns
GetViewWS()
Are white space characters currently visible? Returns one of SCWS_* constants. (Scintilla feature 2020)
public WhiteSpace GetViewWS()Returns
GetVirtualSpaceOptions()
Return options for virtual space behaviour. (Scintilla feature 2597)
public VirtualSpace GetVirtualSpaceOptions()Returns
GetWhitespaceChars()
Get the set of characters making up whitespace for when moving or selecting by word. (Scintilla feature 2647)
public string GetWhitespaceChars()Returns
GetWhitespaceSize()
Get the size of the dots used to mark space characters. (Scintilla feature 2087)
public 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)
public string GetWordChars()Returns
GetWrapIndentMode()
Retrieve how wrapped sublines are placed. Default is fixed. (Scintilla feature 2473)
public WrapIndentMode GetWrapIndentMode()Returns
GetWrapMode()
Retrieve whether text is word wrapped. (Scintilla feature 2269)
public Wrap GetWrapMode()Returns
GetWrapStartIndent()
Retrive the start indent for wrapped lines. (Scintilla feature 2465)
public int GetWrapStartIndent()Returns
GetWrapVisualFlags()
Retrive the display mode of visual flags for wrapped lines. (Scintilla feature 2461)
public WrapVisualFlag GetWrapVisualFlags()Returns
GetWrapVisualFlagsLocation()
Retrive the location of visual flags for wrapped lines. (Scintilla feature 2463)
public WrapVisualLocation GetWrapVisualFlagsLocation()Returns
GetXOffset()
Get the xOffset (ie, horizontal scroll position). (Scintilla feature 2398)
public int GetXOffset()Returns
GetZoom()
Retrieve the zoom level. (Scintilla feature 2374)
public int GetZoom()Returns
GotoLine(Position)
Set caret to start of a line and ensure it is visible. (Scintilla feature 2024)
public void GotoLine(Position line)Parameters
linePosition
GotoPos(Position)
Set caret to a position and ensure it is visible. (Scintilla feature 2025)
public void GotoPos(Position caret)Parameters
caretPosition
GrabFocus()
Set the focus to this Scintilla widget. (Scintilla feature 2400)
public void GrabFocus()HideLines(Position, Position)
Make a range of lines invisible. (Scintilla feature 2227)
public void HideLines(Position lineStart, Position lineEnd)Parameters
HideSelection(bool)
Draw the selection either highlighted or in normal (non-highlighted) style. (Scintilla feature 2163)
public void HideSelection(bool hide)Parameters
hidebool
Home()
Move caret to first position on line. (Scintilla feature 2312)
public void Home()HomeDisplay()
Move caret to first position on display line. (Scintilla feature 2345)
public void HomeDisplay()HomeDisplayExtend()
Move caret to first position on display line extending selection to new caret position. (Scintilla feature 2346)
public void HomeDisplayExtend()HomeExtend()
Move caret to first position on line extending selection to new caret position. (Scintilla feature 2313)
public void HomeExtend()HomeRectExtend()
Move caret to first position on line, extending rectangular selection to new caret position. (Scintilla feature 2430)
public 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)
public 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)
public void HomeWrapExtend()IndexPositionFromLine(Position, LineCharacterIndexType)
Retrieve the position measured in index units at the start of a document line. (Scintilla feature 2714)
public Position IndexPositionFromLine(Position line, LineCharacterIndexType lineCharacterIndex)Parameters
linePositionlineCharacterIndexLineCharacterIndexType
Returns
IndicGetAlpha(int)
Get the alpha fill colour of the given indicator. (Scintilla feature 2524)
public Alpha IndicGetAlpha(int indicator)Parameters
indicatorint
Returns
IndicGetFlags(int)
Retrieve the attributes of an indicator. (Scintilla feature 2685)
public IndicFlag IndicGetFlags(int indicator)Parameters
indicatorint
Returns
IndicGetFore(int)
Retrieve the foreground colour of an indicator. (Scintilla feature 2083)
public Colour IndicGetFore(int indicator)Parameters
indicatorint
Returns
IndicGetHoverFore(int)
Retrieve the foreground hover colour of an indicator. (Scintilla feature 2683)
public Colour IndicGetHoverFore(int indicator)Parameters
indicatorint
Returns
IndicGetHoverStyle(int)
Retrieve the hover style of an indicator. (Scintilla feature 2681)
public IndicatorStyle IndicGetHoverStyle(int indicator)Parameters
indicatorint
Returns
IndicGetOutlineAlpha(int)
Get the alpha outline colour of the given indicator. (Scintilla feature 2559)
public Alpha IndicGetOutlineAlpha(int indicator)Parameters
indicatorint
Returns
IndicGetStyle(int)
Retrieve the style of an indicator. (Scintilla feature 2081)
public IndicatorStyle IndicGetStyle(int indicator)Parameters
indicatorint
Returns
IndicGetUnder(int)
Retrieve whether indicator drawn under or over text. (Scintilla feature 2511)
public bool IndicGetUnder(int indicator)Parameters
indicatorint
Returns
IndicSetAlpha(int, Alpha)
Set the alpha fill colour of the given indicator. (Scintilla feature 2523)
public void IndicSetAlpha(int indicator, Alpha alpha)Parameters
IndicSetFlags(int, IndicFlag)
Set the attributes of an indicator. (Scintilla feature 2684)
public void IndicSetFlags(int indicator, IndicFlag flags)Parameters
IndicSetFore(int, Colour)
Set the foreground colour of an indicator. (Scintilla feature 2082)
public void IndicSetFore(int indicator, Colour fore)Parameters
IndicSetHoverFore(int, Colour)
Set the foreground hover colour of an indicator. (Scintilla feature 2682)
public void IndicSetHoverFore(int indicator, Colour fore)Parameters
IndicSetHoverStyle(int, IndicatorStyle)
Set a hover indicator to plain, squiggle or TT. (Scintilla feature 2680)
public void IndicSetHoverStyle(int indicator, IndicatorStyle indicatorStyle)Parameters
indicatorintindicatorStyleIndicatorStyle
IndicSetOutlineAlpha(int, Alpha)
Set the alpha outline colour of the given indicator. (Scintilla feature 2558)
public void IndicSetOutlineAlpha(int indicator, Alpha alpha)Parameters
IndicSetStyle(int, IndicatorStyle)
Set an indicator to plain, squiggle or TT. (Scintilla feature 2080)
public void IndicSetStyle(int indicator, IndicatorStyle indicatorStyle)Parameters
indicatorintindicatorStyleIndicatorStyle
IndicSetUnder(int, bool)
Set an indicator to draw under text or over(default). (Scintilla feature 2510)
public void IndicSetUnder(int indicator, bool under)Parameters
IndicatorAllOnFor(Position)
Are any indicators present at pos? (Scintilla feature 2506)
public int IndicatorAllOnFor(Position pos)Parameters
posPosition
Returns
IndicatorClearRange(Position, Position)
Turn a indicator off over a range. (Scintilla feature 2505)
public void IndicatorClearRange(Position start, Position lengthClear)Parameters
IndicatorEnd(int, Position)
Where does a particular indicator end? (Scintilla feature 2509)
public int IndicatorEnd(int indicator, Position pos)Parameters
Returns
IndicatorFillRange(Position, Position)
Turn a indicator on over a range. (Scintilla feature 2504)
public void IndicatorFillRange(Position start, Position lengthFill)Parameters
IndicatorStart(int, Position)
Where does a particular indicator start? (Scintilla feature 2508)
public int IndicatorStart(int indicator, Position pos)Parameters
Returns
IndicatorValueAt(int, Position)
What value does a particular indicator have at a position? (Scintilla feature 2507)
public int IndicatorValueAt(int indicator, Position pos)Parameters
Returns
InsertText(Position, string)
Insert string at a position. (Scintilla feature 2003)
public void InsertText(Position pos, string text)Parameters
InsertTextAndMoveCursor(string)
public void InsertTextAndMoveCursor(string text)Parameters
textstring
IsRangeWord(Position, Position)
Is the range start..end considered a word? (Scintilla feature 2691)
public bool IsRangeWord(Position start, Position end)Parameters
Returns
LineCopy()
Copy the line containing the caret. (Scintilla feature 2455)
public void LineCopy()LineCut()
Cut the line containing the caret. (Scintilla feature 2337)
public void LineCut()LineDelete()
Delete the line containing the caret. (Scintilla feature 2338)
public void LineDelete()LineDown()
Move caret down one line. (Scintilla feature 2300)
public void LineDown()LineDownExtend()
Move caret down one line extending selection to new caret position. (Scintilla feature 2301)
public void LineDownExtend()LineDownRectExtend()
Move caret down one line, extending rectangular selection to new caret position. (Scintilla feature 2426)
public void LineDownRectExtend()LineDuplicate()
Duplicate the current line. (Scintilla feature 2404)
public void LineDuplicate()LineEnd()
Move caret to last position on line. (Scintilla feature 2314)
public void LineEnd()LineEndDisplay()
Move caret to last position on display line. (Scintilla feature 2347)
public void LineEndDisplay()LineEndDisplayExtend()
Move caret to last position on display line extending selection to new caret position. (Scintilla feature 2348)
public void LineEndDisplayExtend()LineEndExtend()
Move caret to last position on line extending selection to new caret position. (Scintilla feature 2315)
public void LineEndExtend()LineEndRectExtend()
Move caret to last position on line, extending rectangular selection to new caret position. (Scintilla feature 2432)
public 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)
public 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)
public void LineEndWrapExtend()LineFromIndexPosition(Position, LineCharacterIndexType)
Retrieve the document line containing a position measured in index units. (Scintilla feature 2713)
public Position LineFromIndexPosition(Position pos, LineCharacterIndexType lineCharacterIndex)Parameters
posPositionlineCharacterIndexLineCharacterIndexType
Returns
LineFromPosition(Position)
Retrieve the line containing a position. (Scintilla feature 2166)
public Position LineFromPosition(Position pos)Parameters
posPosition
Returns
LineLength(Position)
How many characters are on a line, including end of line characters? (Scintilla feature 2350)
public int LineLength(Position line)Parameters
linePosition
Returns
LineReverse()
Reverse order of selected lines. (Scintilla feature 2354)
public void LineReverse()LineScroll(int, int)
Scroll horizontally and vertically. (Scintilla feature 2168)
public void LineScroll(int columns, int lines)Parameters
LineScrollDown()
Scroll the document down, keeping the caret visible. (Scintilla feature 2342)
public void LineScrollDown()LineScrollUp()
Scroll the document up, keeping the caret visible. (Scintilla feature 2343)
public void LineScrollUp()LineTranspose()
Switch the current line with the previous. (Scintilla feature 2339)
public void LineTranspose()LineUp()
Move caret up one line. (Scintilla feature 2302)
public void LineUp()LineUpExtend()
Move caret up one line extending selection to new caret position. (Scintilla feature 2303)
public void LineUpExtend()LineUpRectExtend()
Move caret up one line, extending rectangular selection to new caret position. (Scintilla feature 2427)
public void LineUpRectExtend()LinesJoin()
Join the lines in the target. (Scintilla feature 2288)
public void LinesJoin()LinesOnScreen()
Retrieves the number of lines completely visible. (Scintilla feature 2370)
public int LinesOnScreen()Returns
LinesSplit(int)
Split the lines in the target into lines that are less wide than pixelWidth where possible. (Scintilla feature 2289)
public 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)]
public void LoadLexerLibrary(string path)Parameters
pathstring
LowerCase()
Transform the selection to lower case. (Scintilla feature 2340)
public void LowerCase()MarginGetStyle(Position)
Get the style number for the text margin for a line (Scintilla feature 2533)
public int MarginGetStyle(Position line)Parameters
linePosition
Returns
MarginGetStyleOffset()
Get the start of the range of style numbers used for margin text (Scintilla feature 2538)
public int MarginGetStyleOffset()Returns
MarginGetStyles(Position)
Get the styles in the text margin for a line (Scintilla feature 2535)
public string MarginGetStyles(Position line)Parameters
linePosition
Returns
MarginGetText(Position)
Get the text in the text margin for a line (Scintilla feature 2531)
public string MarginGetText(Position line)Parameters
linePosition
Returns
MarginSetStyle(Position, int)
Set the style number for the text margin for a line (Scintilla feature 2532)
public 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)
public void MarginSetStyleOffset(int style)Parameters
styleint
MarginSetStyles(Position, string)
Set the style in the text margin for a line (Scintilla feature 2534)
public void MarginSetStyles(Position line, string styles)Parameters
MarginSetText(Position, string)
Set the text in the text margin for a line (Scintilla feature 2530)
public void MarginSetText(Position line, string text)Parameters
MarginTextClearAll()
Clear the margin text on all lines (Scintilla feature 2536)
public 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)
public int MarkerAdd(Position line, int markerNumber)Parameters
Returns
MarkerAddSet(Position, int)
Add a set of markers to a line. (Scintilla feature 2466)
public void MarkerAddSet(Position line, int markerSet)Parameters
MarkerDefine(int, MarkerSymbol)
Set the symbol used for a particular marker number. (Scintilla feature 2040)
public void MarkerDefine(int markerNumber, MarkerSymbol markerSymbol)Parameters
markerNumberintmarkerSymbolMarkerSymbol
MarkerDefinePixmap(int, string)
Define a marker from a pixmap. (Scintilla feature 2049)
public 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)
public void MarkerDefineRGBAImage(int markerNumber, string pixels)Parameters
MarkerDelete(Position, int)
Delete a marker from a line. (Scintilla feature 2044)
public void MarkerDelete(Position line, int markerNumber)Parameters
MarkerDeleteAll(int)
Delete all markers with a particular number from all lines. (Scintilla feature 2045)
public void MarkerDeleteAll(int markerNumber)Parameters
markerNumberint
MarkerDeleteHandle(int)
Delete a marker. (Scintilla feature 2018)
public void MarkerDeleteHandle(int markerHandle)Parameters
markerHandleint
MarkerEnableHighlight(bool)
Enable/disable highlight for current folding bloc (smallest one that contains the caret) (Scintilla feature 2293)
public void MarkerEnableHighlight(bool enabled)Parameters
enabledbool
MarkerGet(Position)
Get a bit mask of all the markers set on a line. (Scintilla feature 2046)
public int MarkerGet(Position line)Parameters
linePosition
Returns
MarkerLineFromHandle(int)
Retrieve the line number at which a particular marker is located. (Scintilla feature 2017)
public 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)
public 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)
public 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)
public void MarkerSetAlpha(int markerNumber, Alpha alpha)Parameters
MarkerSetBack(int, Colour)
Set the background colour used for a particular marker number. (Scintilla feature 2042)
public 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)
public void MarkerSetBackSelected(int markerNumber, Colour back)Parameters
MarkerSetFore(int, Colour)
Set the foreground colour used for a particular marker number. (Scintilla feature 2041)
public void MarkerSetFore(int markerNumber, Colour fore)Parameters
MarkerSymbolDefined(int)
Which symbol was defined for markerNumber with MarkerDefine (Scintilla feature 2529)
public int MarkerSymbolDefined(int markerNumber)Parameters
markerNumberint
Returns
MoveCaretInsideView()
Move the caret inside current view if it's not there already. (Scintilla feature 2401)
public void MoveCaretInsideView()MoveSelectedLinesDown()
Move the selected lines down one line, shifting the line below before the selection (Scintilla feature 2621)
public void MoveSelectedLinesDown()MoveSelectedLinesUp()
Move the selected lines up one line, shifting the line above after the selection (Scintilla feature 2620)
public void MoveSelectedLinesUp()MultiEdgeAddLine(int, Colour)
Add a new vertical edge to the view. (Scintilla feature 2694)
public void MultiEdgeAddLine(int column, Colour edgeColour)Parameters
MultiEdgeClearAll()
Clear all vertical edges. (Scintilla feature 2695)
public 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)
public 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)
public void MultipleSelectAddNext()NameOfStyle(int)
Retrieve the name of a style. Result is NUL-terminated. (Scintilla feature 4030)
public 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)
public void NewLine()Null()
Null operation. (Scintilla feature 2172)
public void Null()NullTerminatedBufferToString(byte[], Encoding)
Decodes a byte buffer according to encoding, with all trailing NULL bytes stripped off.
public static string NullTerminatedBufferToString(byte[] bytes, Encoding encoding)Parameters
Returns
PageDown()
Move caret one page down. (Scintilla feature 2322)
public void PageDown()PageDownExtend()
Move caret one page down extending selection to new caret position. (Scintilla feature 2323)
public void PageDownExtend()PageDownRectExtend()
Move caret one page down, extending rectangular selection to new caret position. (Scintilla feature 2434)
public void PageDownRectExtend()PageUp()
Move caret one page up. (Scintilla feature 2320)
public void PageUp()PageUpExtend()
Move caret one page up extending selection to new caret position. (Scintilla feature 2321)
public void PageUpExtend()PageUpRectExtend()
Move caret one page up, extending rectangular selection to new caret position. (Scintilla feature 2433)
public void PageUpRectExtend()ParaDown()
Move caret down one paragraph (delimited by empty lines). (Scintilla feature 2413)
public void ParaDown()ParaDownExtend()
Extend selection down one paragraph (delimited by empty lines). (Scintilla feature 2414)
public void ParaDownExtend()ParaUp()
Move caret up one paragraph (delimited by empty lines). (Scintilla feature 2415)
public void ParaUp()ParaUpExtend()
Extend selection up one paragraph (delimited by empty lines). (Scintilla feature 2416)
public void ParaUpExtend()Paste()
Paste the contents of the clipboard into the document replacing the selection. (Scintilla feature 2179)
public void Paste()PointXFromPosition(Position)
Retrieve the x value of the point in the window where a position is displayed. (Scintilla feature 2164)
public 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)
public 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)
public 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)
public int PositionBefore(Position pos)Parameters
posPosition
Returns
PositionFromLine(Position)
Retrieve the position at the start of a line. (Scintilla feature 2167)
public Position PositionFromLine(Position line)Parameters
linePosition
Returns
PositionFromPoint(int, int)
Find the position from a point within the window. (Scintilla feature 2022)
public 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)
public 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)
public 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)
public int PositionRelativeCodeUnits(Position pos, Position relative)Parameters
Returns
PrivateLexerCall(int, IntPtr)
For private communication between an application and a known lexer. (Scintilla feature 4013)
public 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)
public string PropertyNames()Returns
PropertyType(string)
Retrieve the type of a property. (Scintilla feature 4015)
public TypeProperty PropertyType(string name)Parameters
namestring
Returns
RGBAImageSetHeight(int)
Set the height for future RGBA image data. (Scintilla feature 2625)
public void RGBAImageSetHeight(int height)Parameters
heightint
RGBAImageSetScale(int)
Set the scale factor in percent for future RGBA image data. (Scintilla feature 2651)
public void RGBAImageSetScale(int scalePercent)Parameters
scalePercentint
RGBAImageSetWidth(int)
Set the width for future RGBA image data. (Scintilla feature 2624)
public void RGBAImageSetWidth(int width)Parameters
widthint
Redo()
Redoes the next action on the undo history. (Scintilla feature 2011)
public void Redo()RegisterImage(int, string)
Register an XPM image for use in autocompletion lists. (Scintilla feature 2405)
public 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)
public void RegisterRGBAImage(int type, string pixels)Parameters
ReleaseAllExtendedStyles()
Release all extended (>255) style numbers (Scintilla feature 2552)
public void ReleaseAllExtendedStyles()ReleaseDocument(IntPtr)
Release a reference to the document, deleting document if it fades to black. (Scintilla feature 2377)
public void ReleaseDocument(IntPtr doc)Parameters
docIntPtr
ReleaseLineCharacterIndex(LineCharacterIndexType)
Decrease use count of line character index and remove if 0. (Scintilla feature 2712)
public void ReleaseLineCharacterIndex(LineCharacterIndexType lineCharacterIndex)Parameters
lineCharacterIndexLineCharacterIndexType
ReplaceSel(string)
Replace the selected text with the argument text. (Scintilla feature 2170)
public 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)
public 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)
public 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)
public int ReplaceTargetRE(string text)Parameters
textstring
Returns
RotateSelection()
Set the main selection to the next selection. (Scintilla feature 2606)
public void RotateSelection()ScrollCaret()
Ensure the caret is visible. (Scintilla feature 2169)
public 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)
public void ScrollRange(int secondary, int primary)Parameters
ScrollToEnd()
Scroll to end of document. (Scintilla feature 2629)
public void ScrollToEnd()ScrollToStart()
Scroll to start of document. (Scintilla feature 2628)
public void ScrollToStart()SearchAnchor()
Sets the current caret position to be the search anchor. (Scintilla feature 2366)
public 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)
public 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)
public 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)
public Position SearchPrev(FindOption searchFlags, string text)Parameters
searchFlagsFindOptiontextstring
Returns
SelectAll()
Select all the text in the document. (Scintilla feature 2013)
public void SelectAll()SelectCurrentLine()
public void SelectCurrentLine()SelectionDuplicate()
Duplicate the selection. If selection empty duplicate the line containing the caret. (Scintilla feature 2469)
public void SelectionDuplicate()SelectionIsRectangle()
Is the selection rectangular? The alternative is the more common stream selection. (Scintilla feature 2372)
public bool SelectionIsRectangle()Returns
SetAccessibility(Accessibility)
Enable or disable accessibility. (Scintilla feature 2702)
public 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)")]
public void SetAdditionalCaretFore(Colour fore)Parameters
foreColour
SetAdditionalCaretsBlink(bool)
Set whether additional carets will blink (Scintilla feature 2567)
public void SetAdditionalCaretsBlink(bool additionalCaretsBlink)Parameters
additionalCaretsBlinkbool
SetAdditionalCaretsVisible(bool)
Set whether additional carets are visible (Scintilla feature 2608)
public 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)")]
public 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)")]
public 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)")]
public void SetAdditionalSelFore(Colour fore)Parameters
foreColour
SetAdditionalSelectionTyping(bool)
Set whether typing can be performed into multiple selections (Scintilla feature 2565)
public 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)
public void SetAnchor(Position anchor)Parameters
anchorPosition
SetAutomaticFold(AutomaticFold)
Set automatic folding behaviours. (Scintilla feature 2663)
public void SetAutomaticFold(AutomaticFold automaticFold)Parameters
automaticFoldAutomaticFold
SetBackSpaceUnIndents(bool)
Sets whether a backspace pressed when caret is within indentation unindents. (Scintilla feature 2262)
public 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)
public 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")]
public 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")]
public 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")]
public 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)
public 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")]
public void SetCaretLineVisible(bool show)Parameters
showbool
SetCaretLineVisibleAlways(bool)
Sets the caret line to always visible. (Scintilla feature 2655)
public 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)
public void SetCaretPeriod(int periodMilliseconds)Parameters
periodMillisecondsint
SetCaretSticky(CaretSticky)
Stop the caret preferred x position changing when the user types. (Scintilla feature 2458)
public void SetCaretSticky(CaretSticky useCaretStickyBehaviour)Parameters
useCaretStickyBehaviourCaretSticky
SetCaretStyle(CaretStyle)
Set the style of the caret to be drawn. (Scintilla feature 2512)
public void SetCaretStyle(CaretStyle caretStyle)Parameters
caretStyleCaretStyle
SetCaretWidth(int)
Set the width of the insert mode caret. (Scintilla feature 2188)
public void SetCaretWidth(int pixelWidth)Parameters
pixelWidthint
SetCharacterCategoryOptimization(int)
Set the number of characters to have directly indexed categories (Scintilla feature 2720)
public void SetCharacterCategoryOptimization(int countCharacters)Parameters
countCharactersint
SetCharsDefault()
Reset the set of characters for whitespace and word characters to the defaults. (Scintilla feature 2444)
public 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)
public void SetCodePage(int codePage)Parameters
codePageint
SetCommandEvents(bool)
Set whether command events are sent to the container. (Scintilla feature 2717)
public 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)
public void SetControlCharSymbol(int symbol)Parameters
symbolint
SetCurrentPos(Position)
Sets the position of the caret. (Scintilla feature 2141)
public void SetCurrentPos(Position caret)Parameters
caretPosition
SetCursor(CursorShape)
Sets the cursor to one of the SC_CURSOR* values. (Scintilla feature 2386)
public void SetCursor(CursorShape cursorType)Parameters
cursorTypeCursorShape
SetDefaultFoldDisplayText(string)
Set the default fold display text. (Scintilla feature 2722)
public void SetDefaultFoldDisplayText(string text)Parameters
textstring
SetDocPointer(IntPtr)
Change the document object used. (Scintilla feature 2358)
public void SetDocPointer(IntPtr doc)Parameters
docIntPtr
SetEOLMode(EndOfLine)
Set the current end of line mode. (Scintilla feature 2031)
public void SetEOLMode(EndOfLine eolMode)Parameters
eolModeEndOfLine
SetEdgeColour(Colour)
Change the colour used in edge indication. (Scintilla feature 2365)
public 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)
public 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)
public void SetEdgeMode(EdgeVisualStyle edgeMode)Parameters
edgeModeEdgeVisualStyle
SetEmptySelection(Position)
Set caret to a position, while removing any existing selection. (Scintilla feature 2556)
public 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)
public void SetEndAtLastLine(bool endAtLastLine)Parameters
endAtLastLinebool
SetExtraAscent(int)
Set extra ascent for each line (Scintilla feature 2525)
public void SetExtraAscent(int extraAscent)Parameters
extraAscentint
SetExtraDescent(int)
Set extra descent for each line (Scintilla feature 2527)
public void SetExtraDescent(int extraDescent)Parameters
extraDescentint
SetFirstVisibleLine(int)
Scroll so that a display line is at the top of the display. (Scintilla feature 2613)
public void SetFirstVisibleLine(int displayLine)Parameters
displayLineint
SetFocus(bool)
Change internal focus flag. (Scintilla feature 2380)
public void SetFocus(bool focus)Parameters
focusbool
SetFoldExpanded(Position, bool)
Show the children of a header line. (Scintilla feature 2229)
public void SetFoldExpanded(Position line, bool expanded)Parameters
SetFoldFlags(FoldFlag)
Set some style options for folding. (Scintilla feature 2233)
public 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)
public 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)
public 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)
public void SetFoldMarginHiColour(bool useSetting, Colour fore)Parameters
SetFontQuality(FontQuality)
Choose the quality level for text from the FontQuality enumeration. (Scintilla feature 2611)
public void SetFontQuality(FontQuality fontQuality)Parameters
fontQualityFontQuality
SetHScrollBar(bool)
Show or hide the horizontal scroll bar. (Scintilla feature 2130)
public void SetHScrollBar(bool visible)Parameters
visiblebool
SetHighlightGuide(int)
Set the highlighted indentation guide column. 0 = no highlighted guide. (Scintilla feature 2134)
public 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")]
public 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")]
public void SetHotspotActiveFore(bool useSetting, Colour fore)Parameters
SetHotspotActiveUnderline(bool)
Enable / Disable underlining active hotspots. (Scintilla feature 2412)
public void SetHotspotActiveUnderline(bool underline)Parameters
underlinebool
SetHotspotSingleLine(bool)
Limit hotspots to single line so hotspots on two lines don't merge. (Scintilla feature 2421)
public void SetHotspotSingleLine(bool singleLine)Parameters
singleLinebool
SetIMEInteraction(IMEInteraction)
Choose to display the the IME in a winow or inline. (Scintilla feature 2679)
public void SetIMEInteraction(IMEInteraction imeInteraction)Parameters
imeInteractionIMEInteraction
SetIdentifier(int)
Set the identifier reported as idFrom in notification messages. (Scintilla feature 2622)
public void SetIdentifier(int identifier)Parameters
identifierint
SetIdentifiers(int, string)
Set the identifiers that are shown in a particular style (Scintilla feature 4024)
public void SetIdentifiers(int style, string identifiers)Parameters
SetIdleStyling(IdleStyling)
Sets limits to idle styling. (Scintilla feature 2692)
public void SetIdleStyling(IdleStyling idleStyling)Parameters
idleStylingIdleStyling
SetIndent(int)
Set the number of spaces used for one level of indentation. (Scintilla feature 2122)
public void SetIndent(int indentSize)Parameters
indentSizeint
SetIndentationGuides(IndentView)
Show or hide indentation guides. (Scintilla feature 2132)
public void SetIndentationGuides(IndentView indentView)Parameters
indentViewIndentView
SetIndicatorCurrent(int)
Set the indicator used for IndicatorFillRange and IndicatorClearRange (Scintilla feature 2500)
public void SetIndicatorCurrent(int indicator)Parameters
indicatorint
SetIndicatorValue(int)
Set the value used for IndicatorFillRange (Scintilla feature 2502)
public void SetIndicatorValue(int value)Parameters
valueint
SetKeyWords(int, string)
Set up the key words used by the lexer. (Scintilla feature 4005)
public 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")]
public void SetKeysUnicode(bool keysUnicode)Parameters
keysUnicodebool
SetLayoutCache(LineCache)
Sets the degree of caching of layout information. (Scintilla feature 2272)
public 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)
public 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)]
public 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)]
public 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)
public void SetLineEndTypesAllowed(LineEndType lineEndBitSet)Parameters
lineEndBitSetLineEndType
SetLineIndentation(Position, int)
Change the indentation of a line to a number of columns. (Scintilla feature 2126)
public void SetLineIndentation(Position line, int indentation)Parameters
SetLineState(Position, int)
Used to hold extra styling information for each line. (Scintilla feature 2092)
public void SetLineState(Position line, int state)Parameters
SetMainSelection(int)
Set the main selection (Scintilla feature 2574)
public 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)
public void SetMarginBackN(int margin, Colour back)Parameters
SetMarginCursorN(int, CursorShape)
Set the cursor shown when the mouse is inside a margin. (Scintilla feature 2248)
public void SetMarginCursorN(int margin, CursorShape cursor)Parameters
marginintcursorCursorShape
SetMarginLeft(int)
Sets the size in pixels of the left margin. (Scintilla feature 2155)
public void SetMarginLeft(int pixelWidth)Parameters
pixelWidthint
SetMarginMaskN(int, int)
Set a mask that determines which markers are displayed in a margin. (Scintilla feature 2244)
public void SetMarginMaskN(int margin, int mask)Parameters
SetMarginOptions(MarginOption)
Set the margin options. (Scintilla feature 2539)
public void SetMarginOptions(MarginOption marginOptions)Parameters
marginOptionsMarginOption
SetMarginRight(int)
Sets the size in pixels of the right margin. (Scintilla feature 2157)
public void SetMarginRight(int pixelWidth)Parameters
pixelWidthint
SetMarginSensitiveN(int, bool)
Make a margin sensitive or insensitive to mouse clicks. (Scintilla feature 2246)
public void SetMarginSensitiveN(int margin, bool sensitive)Parameters
SetMarginTypeN(int, MarginType)
Set a margin to be either numeric or symbolic. (Scintilla feature 2240)
public 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)
public void SetMarginWidthN(int margin, int pixelWidth)Parameters
SetMargins(int)
Allocate a non-standard number of margins. (Scintilla feature 2252)
public void SetMargins(int margins)Parameters
marginsint
SetModEventMask(ModificationFlags)
Set which document modification events are sent to the container. (Scintilla feature 2359)
public void SetModEventMask(ModificationFlags eventMask)Parameters
eventMaskModificationFlags
SetMouseDownCaptures(bool)
Set whether the mouse is captured when its button is pressed. (Scintilla feature 2384)
public 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)
public void SetMouseDwellTime(int periodMilliseconds)Parameters
periodMillisecondsint
SetMouseSelectionRectangularSwitch(bool)
Set whether switching to rectangular mode while selecting with the mouse is allowed. (Scintilla feature 2668)
public void SetMouseSelectionRectangularSwitch(bool mouseSelectionRectangularSwitch)Parameters
mouseSelectionRectangularSwitchbool
SetMouseWheelCaptures(bool)
Set whether the mouse wheel can be active outside the window. (Scintilla feature 2696)
public void SetMouseWheelCaptures(bool captures)Parameters
capturesbool
SetMultiPaste(MultiPaste)
Change the effect of pasting when there are multiple selections. (Scintilla feature 2614)
public void SetMultiPaste(MultiPaste multiPaste)Parameters
multiPasteMultiPaste
SetMultipleSelection(bool)
Set whether multiple selections can be made (Scintilla feature 2563)
public void SetMultipleSelection(bool multipleSelection)Parameters
multipleSelectionbool
SetOvertype(bool)
Set to overtype (true) or insert mode. (Scintilla feature 2186)
public void SetOvertype(bool overType)Parameters
overTypebool
SetPasteConvertEndings(bool)
Enable/Disable convert-on-paste for line endings (Scintilla feature 2467)
public 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)
public void SetPhasesDraw(PhasesDraw phases)Parameters
phasesPhasesDraw
SetPositionCache(int)
Set number of entries in position cache (Scintilla feature 2514)
public void SetPositionCache(int size)Parameters
sizeint
SetPrintColourMode(PrintOption)
Modify colours when printing for clearer printed text. (Scintilla feature 2148)
public 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)
public 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)
public 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)
public 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)
public void SetPunctuationChars(string characters)Parameters
charactersstring
SetReadOnly(bool)
Set to read only or read write. (Scintilla feature 2171)
public void SetReadOnly(bool readOnly)Parameters
readOnlybool
SetRectangularSelectionAnchor(Position)
Set the anchor position of the rectangular selection. (Scintilla feature 2590)
public void SetRectangularSelectionAnchor(Position anchor)Parameters
anchorPosition
SetRectangularSelectionAnchorVirtualSpace(int)
Set the virtual space of the anchor of the rectangular selection. (Scintilla feature 2594)
public void SetRectangularSelectionAnchorVirtualSpace(int space)Parameters
spaceint
SetRectangularSelectionCaret(Position)
Set the caret position of the rectangular selection. (Scintilla feature 2588)
public void SetRectangularSelectionCaret(Position caret)Parameters
caretPosition
SetRectangularSelectionCaretVirtualSpace(int)
Set the virtual space of the caret of the rectangular selection. (Scintilla feature 2592)
public 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)
public void SetRectangularSelectionModifier(int modifier)Parameters
modifierint
SetRepresentation(string, string)
Set the way a character is drawn. (Scintilla feature 2665)
public 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)
public void SetSavePoint()SetScrollWidth(int)
Sets the document width assumed for scrolling. (Scintilla feature 2274)
public void SetScrollWidth(int pixelWidth)Parameters
pixelWidthint
SetScrollWidthTracking(bool)
Sets whether the maximum width line displayed is used to set scroll width. (Scintilla feature 2516)
public void SetScrollWidthTracking(bool tracking)Parameters
trackingbool
SetSearchFlags(FindOption)
Set the search flags used by SearchInTarget. (Scintilla feature 2198)
public void SetSearchFlags(FindOption searchFlags)Parameters
searchFlagsFindOption
SetSel(Position, Position)
Select a range of text. (Scintilla feature 2160)
public 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")]
public 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")]
public void SetSelBack(bool useSetting, Colour back)Parameters
SetSelEOLFilled(bool)
Set the selection to have its end of line filled or not. (Scintilla feature 2480)
public 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")]
public void SetSelFore(bool useSetting, Colour fore)Parameters
SetSelection(Position, Position)
Set a simple selection (Scintilla feature 2572)
public void SetSelection(Position caret, Position anchor)Parameters
SetSelectionEnd(Position)
Sets the position that ends the selection - this becomes the caret. (Scintilla feature 2144)
public 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)
public void SetSelectionMode(SelectionMode selectionMode)Parameters
selectionModeSelectionMode
SetSelectionNAnchor(int, Position)
Set the anchor position of the nth selection. (Scintilla feature 2578)
public void SetSelectionNAnchor(int selection, Position anchor)Parameters
SetSelectionNAnchorVirtualSpace(int, int)
Set the virtual space of the anchor of the nth selection. (Scintilla feature 2582)
public void SetSelectionNAnchorVirtualSpace(int selection, int space)Parameters
SetSelectionNCaret(int, Position)
Set the caret position of the nth selection. (Scintilla feature 2576)
public void SetSelectionNCaret(int selection, Position caret)Parameters
SetSelectionNCaretVirtualSpace(int, int)
Set the virtual space of the caret of the nth selection. (Scintilla feature 2580)
public void SetSelectionNCaretVirtualSpace(int selection, int space)Parameters
SetSelectionNEnd(int, Position)
Sets the position that ends the selection - this becomes the currentPosition. (Scintilla feature 2586)
public void SetSelectionNEnd(int selection, Position caret)Parameters
SetSelectionNStart(int, Position)
Sets the position that starts the selection - this becomes the anchor. (Scintilla feature 2584)
public void SetSelectionNStart(int selection, Position anchor)Parameters
SetSelectionStart(Position)
Sets the position that starts the selection - this becomes the anchor. (Scintilla feature 2142)
public void SetSelectionStart(Position anchor)Parameters
anchorPosition
SetStatus(Status)
Change error status - 0 = OK. (Scintilla feature 2382)
public 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")]
public void SetStyleBits(int _)Parameters
_int
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)
public void SetStyling(Position length, int style)Parameters
SetStylingEx(Position, string)
Set the styles for a segment of the document. (Scintilla feature 2073)
public void SetStylingEx(Position length, string styles)Parameters
SetTabDrawMode(TabDrawMode)
Set how tabs are drawn when visible. (Scintilla feature 2699)
public void SetTabDrawMode(TabDrawMode tabDrawMode)Parameters
tabDrawModeTabDrawMode
SetTabIndents(bool)
Sets whether a tab pressed when caret is within indentation indents. (Scintilla feature 2260)
public 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)
public 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)
public void SetTargetEnd(Position end)Parameters
endPosition
SetTargetRange(Position, Position)
Sets both the start and end of the target in one call. (Scintilla feature 2686)
public 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)
public void SetTargetStart(Position start)Parameters
startPosition
SetTechnology(Technology)
Set the technology used. (Scintilla feature 2630)
public void SetTechnology(Technology technology)Parameters
technologyTechnology
SetText(string)
Replace the contents of the document with the argument text. (Scintilla feature 2181)
public 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")]
public void SetTwoPhaseDraw(bool twoPhase)Parameters
twoPhasebool
SetUndoCollection(bool)
Choose between collecting actions into the undo history and discarding them. (Scintilla feature 2012)
public 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)
public void SetUseTabs(bool useTabs)Parameters
useTabsbool
SetVScrollBar(bool)
Show or hide the vertical scroll bar. (Scintilla feature 2280)
public void SetVScrollBar(bool visible)Parameters
visiblebool
SetViewEOL(bool)
Make the end of line characters visible or invisible. (Scintilla feature 2356)
public void SetViewEOL(bool visible)Parameters
visiblebool
SetViewWS(WhiteSpace)
Make white space characters invisible, always visible or visible outside indentation. (Scintilla feature 2021)
public void SetViewWS(WhiteSpace viewWS)Parameters
viewWSWhiteSpace
SetVirtualSpaceOptions(VirtualSpace)
Set options for virtual space behaviour. (Scintilla feature 2596)
public 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)
public 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)
public 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)
public 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)
public void SetWhitespaceFore(bool useSetting, Colour fore)Parameters
SetWhitespaceSize(int)
Set the size of the dots used to mark space characters. (Scintilla feature 2086)
public 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)
public void SetWordChars(string characters)Parameters
charactersstring
SetWrapIndentMode(WrapIndentMode)
Sets how wrapped sublines are placed. Default is fixed. (Scintilla feature 2472)
public void SetWrapIndentMode(WrapIndentMode wrapIndentMode)Parameters
wrapIndentModeWrapIndentMode
SetWrapMode(Wrap)
Sets whether text is word wrapped. (Scintilla feature 2268)
public void SetWrapMode(Wrap wrapMode)Parameters
wrapModeWrap
SetWrapStartIndent(int)
Set the start indent for wrapped lines. (Scintilla feature 2464)
public void SetWrapStartIndent(int indent)Parameters
indentint
SetWrapVisualFlags(WrapVisualFlag)
Set the display mode of visual flags for wrapped lines. (Scintilla feature 2460)
public void SetWrapVisualFlags(WrapVisualFlag wrapVisualFlags)Parameters
wrapVisualFlagsWrapVisualFlag
SetWrapVisualFlagsLocation(WrapVisualLocation)
Set the location of visual flags for wrapped lines. (Scintilla feature 2462)
public 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)
public void SetXCaretPolicy(CaretPolicy caretPolicy, int caretSlop)Parameters
caretPolicyCaretPolicycaretSlopint
SetXOffset(int)
Set the xOffset (ie, horizontal scroll position). (Scintilla feature 2397)
public 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)
public 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)
public void SetZoom(int zoomInPoints)Parameters
zoomInPointsint
ShowLines(Position, Position)
Make a range of lines visible. (Scintilla feature 2226)
public void ShowLines(Position lineStart, Position lineEnd)Parameters
StartRecord()
Start notifying the container of all key presses and commands. (Scintilla feature 3001)
public 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)
public void StartStyling(Position start, int unused)Parameters
StopRecord()
Stop notifying the container of all key presses and commands. (Scintilla feature 3002)
public void StopRecord()StutteredPageDown()
Move caret to bottom of page, or one page down if already at bottom of page. (Scintilla feature 2437)
public 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)
public void StutteredPageDownExtend()StutteredPageUp()
Move caret to top of page, or one page up if already at top of page. (Scintilla feature 2435)
public 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)
public void StutteredPageUpExtend()StyleClearAll()
Clear all the styles and make equivalent to the global default style. (Scintilla feature 2050)
public void StyleClearAll()StyleGetBack(int)
Get the background colour of a style. (Scintilla feature 2482)
public Colour StyleGetBack(int style)Parameters
styleint
Returns
StyleGetBold(int)
Get is a style bold or not. (Scintilla feature 2483)
public 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)
public 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)
public bool StyleGetChangeable(int style)Parameters
styleint
Returns
StyleGetCharacterSet(int)
Get the character get of the font in a style. (Scintilla feature 2490)
public 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)
public 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)
public string StyleGetFont(int style)Parameters
styleint
Returns
StyleGetFore(int)
Get the foreground colour of a style. (Scintilla feature 2481)
public Colour StyleGetFore(int style)Parameters
styleint
Returns
StyleGetHotSpot(int)
Get is a style a hotspot or not. (Scintilla feature 2493)
public bool StyleGetHotSpot(int style)Parameters
styleint
Returns
StyleGetItalic(int)
Get is a style italic or not. (Scintilla feature 2484)
public bool StyleGetItalic(int style)Parameters
styleint
Returns
StyleGetSize(int)
Get the size of characters of a style. (Scintilla feature 2485)
public 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)
public int StyleGetSizeFractional(int style)Parameters
styleint
Returns
StyleGetUnderline(int)
Get is a style underlined or not. (Scintilla feature 2488)
public bool StyleGetUnderline(int style)Parameters
styleint
Returns
StyleGetVisible(int)
Get is a style visible or not. (Scintilla feature 2491)
public bool StyleGetVisible(int style)Parameters
styleint
Returns
StyleGetWeight(int)
Get the weight of characters of a style. (Scintilla feature 2064)
public FontWeight StyleGetWeight(int style)Parameters
styleint
Returns
StyleResetDefault()
Reset the default style to its state at startup (Scintilla feature 2058)
public void StyleResetDefault()StyleSetBack(int, Colour)
Set the background colour of a style. (Scintilla feature 2052)
public void StyleSetBack(int style, Colour back)Parameters
StyleSetBold(int, bool)
Set a style to be bold or not. (Scintilla feature 2053)
public 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)
public 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)
public void StyleSetChangeable(int style, bool changeable)Parameters
StyleSetCharacterSet(int, CharacterSet)
Set the character set of the font in a style. (Scintilla feature 2066)
public 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)
public void StyleSetEOLFilled(int style, bool eolFilled)Parameters
StyleSetFont(int, string)
Set the font of a style. (Scintilla feature 2056)
public void StyleSetFont(int style, string fontName)Parameters
StyleSetFore(int, Colour)
Set the foreground colour of a style. (Scintilla feature 2051)
public void StyleSetFore(int style, Colour fore)Parameters
StyleSetHotSpot(int, bool)
Set a style to be a hotspot or not. (Scintilla feature 2409)
public void StyleSetHotSpot(int style, bool hotspot)Parameters
StyleSetItalic(int, bool)
Set a style to be italic or not. (Scintilla feature 2054)
public void StyleSetItalic(int style, bool italic)Parameters
StyleSetSize(int, int)
Set the size of characters of a style. (Scintilla feature 2055)
public 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)
public void StyleSetSizeFractional(int style, int sizeHundredthPoints)Parameters
StyleSetUnderline(int, bool)
Set a style to be underlined or not. (Scintilla feature 2059)
public void StyleSetUnderline(int style, bool underline)Parameters
StyleSetVisible(int, bool)
Set a style to be visible or not. (Scintilla feature 2074)
public void StyleSetVisible(int style, bool visible)Parameters
StyleSetWeight(int, FontWeight)
Set the weight of characters of a style. (Scintilla feature 2063)
public void StyleSetWeight(int style, FontWeight weight)Parameters
styleintweightFontWeight
SwapMainAnchorCaret()
Swap that caret and anchor of the main selection. (Scintilla feature 2607)
public 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)
public void Tab()TagsOfStyle(int)
Retrieve a ' ' separated list of style tags like "literal quoted string". Result is NUL-terminated. (Scintilla feature 4031)
public string TagsOfStyle(int style)Parameters
styleint
Returns
TargetAsUTF8()
Returns the target converted to UTF8. Return the length in bytes. (Scintilla feature 2447)
public string TargetAsUTF8()Returns
TargetFromSelection()
Make the target range start and end be the same as the selection range start and end. (Scintilla feature 2287)
public void TargetFromSelection()TargetWholeDocument()
Sets the target to the whole document. (Scintilla feature 2690)
public void TargetWholeDocument()TextHeight(Position)
Retrieve the height of a particular line of text in pixels. (Scintilla feature 2279)
public 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)
public 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)
public void ToggleCaretSticky()ToggleFold(Position)
Switch a header line between expanded and contracted. (Scintilla feature 2231)
public 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)
public void ToggleFoldShowText(Position line, string text)Parameters
Undo()
Undo one action in the undo history. (Scintilla feature 2176)
public void Undo()UpperCase()
Transform the selection to upper case. (Scintilla feature 2341)
public 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)
public void UsePopUp(PopUp popUpMode)Parameters
popUpModePopUp
UserListShow(int, string)
Display a list of strings and send notification when user chooses one. (Scintilla feature 2117)
public 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)
public 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)
public void VCHomeDisplay()VCHomeDisplayExtend()
Like VCHomeDisplay but extending selection to new caret position. (Scintilla feature 2653)
public void VCHomeDisplayExtend()VCHomeExtend()
Like VCHome but extending selection to new caret position. (Scintilla feature 2332)
public 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)
public 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)
public 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)
public void VCHomeWrapExtend()VerticalCentreCaret()
Centre current line in window. (Scintilla feature 2619)
public void VerticalCentreCaret()VisibleFromDocLine(int)
Find the display line of a document line taking hidden lines into account. (Scintilla feature 2220)
public int VisibleFromDocLine(int docLine)Parameters
docLineint
Returns
WordEndPosition(Position, bool)
Get position of end of word. (Scintilla feature 2267)
public int WordEndPosition(Position pos, bool onlyWordCharacters)Parameters
Returns
WordLeft()
Move caret left one word. (Scintilla feature 2308)
public void WordLeft()WordLeftEnd()
Move caret left one word, position cursor at end of word. (Scintilla feature 2439)
public void WordLeftEnd()WordLeftEndExtend()
Move caret left one word, position cursor at end of word, extending selection to new caret position. (Scintilla feature 2440)
public void WordLeftEndExtend()WordLeftExtend()
Move caret left one word extending selection to new caret position. (Scintilla feature 2309)
public void WordLeftExtend()WordPartLeft()
Move to the previous change in capitalisation. (Scintilla feature 2390)
public void WordPartLeft()WordPartLeftExtend()
Move to the previous change in capitalisation extending selection to new caret position. (Scintilla feature 2391)
public void WordPartLeftExtend()WordPartRight()
Move to the change next in capitalisation. (Scintilla feature 2392)
public void WordPartRight()WordPartRightExtend()
Move to the next change in capitalisation extending selection to new caret position. (Scintilla feature 2393)
public void WordPartRightExtend()WordRight()
Move caret right one word. (Scintilla feature 2310)
public void WordRight()WordRightEnd()
Move caret right one word, position cursor at end of word. (Scintilla feature 2441)
public void WordRightEnd()WordRightEndExtend()
Move caret right one word, position cursor at end of word, extending selection to new caret position. (Scintilla feature 2442)
public void WordRightEndExtend()WordRightExtend()
Move caret right one word extending selection to new caret position. (Scintilla feature 2311)
public void WordRightExtend()WordStartPosition(Position, bool)
Get position of start of word. (Scintilla feature 2266)
public int WordStartPosition(Position pos, bool onlyWordCharacters)Parameters
Returns
WrapCount(int)
The number of display lines needed to wrap a document line (Scintilla feature 2235)
public int WrapCount(int docLine)Parameters
docLineint
Returns
ZoomIn()
Magnify the displayed text by increasing the sizes by 1 point. (Scintilla feature 2333)
public void ZoomIn()ZoomOut()
Make the displayed text smaller by decreasing the sizes by 1 point. (Scintilla feature 2334)
public void ZoomOut()