Full API Docs
| Text retrieval and modification | |
|---|---|
| ScEditor.AddText(string text) | Add text to the document at current position. more |
| ScEditor.Allocate(int bytes) | Enlarge the document to a particular size of text bytes. more |
| int ScEditor.AllocateExtendedStyles(int numberStyles) | Allocate some extended (>255) style numbers and return the start of the range more |
| ScEditor.AppendText(string text) | Append a string to the end of the document without changing the selection. more |
| ScEditor.ChangeInsertion(string text) | Change the text that is being inserted in response to SC_MOD_INSERTCHECK more |
| ScEditor.ClearAll() | Delete all text in the document. more |
| ScEditor.ClearDocumentStyle() | Set all style bytes to 0, remove all folding information. more |
| ScEditor.DeleteRange(int pos, int deleteLength) | Delete a range of text in the document. more |
| string,int ScEditor.EncodedFromUTF8(string utf8) | Translates a UTF8 string into the document encoding. Return the length of the result in bytes. On error return 0. more |
| int ScEditor.GetCharAt(int pos) | Returns the character byte at the position. more |
| string ScEditor.GetCurrentLineText() | Returns text of current line more |
| string,int ScEditor.GetLine(int line) | Retrieve the contents of a line. Returns the length of the line. more |
| string ScEditor.GetLineText(int line) | Returns text of specified line more |
| bool ScEditor.GetReadOnly() | In read-only mode? more |
| string ScEditor.GetSelectedText() | Returns selected text more |
| int ScEditor.GetStyleAt(int pos) | Returns the style byte at the position. more |
| string,int ScEditor.GetText() | Retrieve all the text in the document. Returns number of characters retrieved. more |
| ScEditor.InsertText(int pos, string text) | Insert string at a position. more |
| ScEditor.PaneAppend(string txt) | Append text more |
| string ScEditor.PaneGetText(int pos1, int pos2) | Get text between these positions more |
| ScEditor.PaneInsertText(string txt, int pos) | Insert text (without changing selection) more |
| ScEditor.PaneRemoveText(int pos1, int pos2) | Remove text between these positions more |
| ScEditor.PaneWrite(string txt, int pos=None) | Write text, and update selection more |
| ScEditor.ReleaseAllExtendedStyles() | Release all extended (>255) style numbers more |
| ScEditor.ReplaceSel(string text) | Replace the selected text with the argument text. more |
| ScEditor.SetLengthForEncode(int bytes) | Set the length of the utf8 argument for calling EncodedFromUTF8. Set to -1 and the string will be measured to the first nul. more |
| ScEditor.SetReadOnly(bool value) | Set to read only or read write. more |
| ScEditor.SetSavePoint() | Remember the current position in the undo history as the position at which the document was saved. more |
| ScEditor.SetText(string text) | Replace the contents of the document with the argument text. more |
| string,int ScEditor.TargetAsUTF8() | Returns the target converted to UTF8. Return the length in bytes. more |
| int[][] ScEditor.GetMultiSelect() | Support multiple selections. Return a list of (start, end) tuples for each selection |
| string[] ScEditor.GetMultiSelectText() | Support multiple selections. Return a list of strings with the contents of each selection |
| ScApp methods | |
|---|---|
| ScApp.GetProperty(propname) | Returns value of property |
| ScApp.SetProperty(propname, val) | Set value of property |
| ScApp.UnsetProperty(propname) | Unset property |
| ScApp.OpenFile(filename) | Open File |
| ScApp.LocationNext() | Go to next location |
| ScApp.LocationPrev() | Go to previous location |
| ScApp.GetFilePath() | Returns full file path |
| ScApp.GetFileName() | Returns file name |
| ScApp.GetFileDirectory() | Returns directory of file |
| ScApp.GetExternalPython() | Returns path of Python binary |
| ScApp.GetSciteDirectory() | Returns SciTE location |
| ScApp.GetSciteUserDirectory() | Returns SciTE user dir location |
| ScApp.GetActivePane() | Which is focused, editor or output? Defaults to ScEditor if not found |
| ScApp.CmdAbbrev() | Expand Abbreviation |
| ScApp.CmdAbout() | About SciTE |
| ScApp.CmdActivate() | Activate |
| ScApp.CmdBlockComment() | Block Comment or Uncomment |
| ScApp.CmdBookmarkClearAll() | Clear All Bookmarks |
| ScApp.CmdBookmarkNext() | Next Bookmark |
| ScApp.CmdBookmarkNextSelect() | Select to next bookmark |
| ScApp.CmdBookmarkPrev() | Previous Bookmark |
| ScApp.CmdBookmarkPrevSelect() | Select to prev bookmark |
| ScApp.CmdBookmarkToggle() | Toggle Bookmark |
| ScApp.CmdBoxComment() | Box Comment |
| ScApp.CmdBuild() | Build |
| ScApp.CmdClean() | Clean |
| ScApp.CmdClear() | Delete |
| ScApp.CmdClearOutput() | Clear Output |
| ScApp.CmdClose() | Close |
| ScApp.CmdCloseAll() | Close All |
| ScApp.CmdCompile() | Compile |
| ScApp.CmdComplete() | Complete Symbol |
| ScApp.CmdCompleteWord() | Complete Word |
| ScApp.CmdCopy() | Copy |
| ScApp.CmdCopyAsRtf() | Copy as RTF |
| ScApp.CmdCopyPath() | Copy Path |
| ScApp.CmdCut() | Cut |
| ScApp.CmdDuplicate() | Duplicate |
| ScApp.CmdEncodingDefault() | Code Page Property |
| ScApp.CmdEncodingUCookie() | UTF-8 |
| ScApp.CmdEncodingUcs2be() | UTF-16 Big Endian |
| ScApp.CmdEncodingUcs2le() | UTF-16 Little Endian |
| ScApp.CmdEncodingUtf8() | UTF-8 with BOM |
| ScApp.CmdEolConvert() | Convert Line End Characters |
| ScApp.CmdEolCr() | CR |
| ScApp.CmdEolCrlf() | CR + LF |
| ScApp.CmdEolLf() | LF |
| ScApp.CmdExpand() | Toggle current fold |
| ScApp.CmdExpandEnsureChildrenVisible() | Ensure children visible |
| ScApp.CmdFind() | Find |
| ScApp.CmdFindInFiles() | Find in Files |
| ScApp.CmdFindNext() | Find Next |
| ScApp.CmdFindNextBack() | Find Previous |
| ScApp.CmdFindNextBackSel() | Find prev and select what is found |
| ScApp.CmdFindNextSel() | Find next and select what is found |
| ScApp.CmdFoldMargin() | Fold Margin |
| ScApp.CmdFullScreen() | Full Screen |
| ScApp.CmdGo() | Go |
| ScApp.CmdGoto() | Go to |
| ScApp.CmdHelp() | Help |
| ScApp.CmdHelpScite() | SciTE Help |
| ScApp.CmdIncrementalSearch() | Incremental Search |
| ScApp.CmdInsAbbrev() | Insert Abbreviation |
| ScApp.CmdJoin() | Join |
| ScApp.CmdLineNumberMargin() | Line Numbers |
| ScApp.CmdLoadSession() | Load Session |
| ScApp.CmdLowerCase() | Make Selection Lowercase |
| ScApp.CmdMacroList() | List Macros |
| ScApp.CmdMatchBrace() | Match Brace |
| ScApp.CmdMonoFont() | Use Monospaced Font |
| ScApp.CmdMoveTabLeft() | |
| ScApp.CmdMoveTabRight() | |
| ScApp.CmdNew() | New |
| ScApp.CmdNextFile() | Next |
| ScApp.CmdNextFileStack() | |
| ScApp.CmdNextMatchPpc() | Go to next preprocessor section |
| ScApp.CmdNextMsg() | Next Message |
| ScApp.CmdOnTop() | Always On Top |
| ScApp.CmdOpen() | Open |
| ScApp.CmdOpenAbbrevProperties() | Open Abbreviations File |
| ScApp.CmdOpenDirectoryProperties() | Open Directory Options File |
| ScApp.CmdOpenFilesHere() | Open Files Here |
| ScApp.CmdOpenGlobalProperties() | Open Global Options File |
| ScApp.CmdOpenLocalProperties() | Open Local Options File |
| ScApp.CmdOpenLuaExternalfile() | Open Lua Startup Script |
| ScApp.CmdOpenSelected() | Open Selected Filename |
| ScApp.CmdOpenUserProperties() | Open User Options File |
| ScApp.CmdPaste() | Paste |
| ScApp.CmdPasteAndDown() | |
| ScApp.CmdPrevFile() | Previous |
| ScApp.CmdPrevFileStack() | |
| ScApp.CmdPrevMatchPpc() | Go to prev preprocessor section |
| ScApp.CmdPrevMsg() | Previous Message |
| ScApp.CmdPrint() | |
| ScApp.CmdPrintSetup() | Page Setup |
| ScApp.CmdQuit() | Exit |
| ScApp.CmdReadOnly() | Read-Only |
| ScApp.CmdRedo() | Redo |
| ScApp.CmdReplace() | Replace |
| ScApp.CmdRevert() | Revert |
| ScApp.CmdSave() | Save |
| ScApp.CmdSaveACopy() | Save a Copy |
| ScApp.CmdSaveAll() | Save All |
| ScApp.CmdSaveAs() | Save As |
| ScApp.CmdSaveAsHtml() | As HTML |
| ScApp.CmdSaveAsPdf() | As PDF |
| ScApp.CmdSaveAsRtf() | As RTF |
| ScApp.CmdSaveAsTex() | As LaTeX |
| ScApp.CmdSaveAsXml() | As XML |
| ScApp.CmdSaveSession() | Save Session |
| ScApp.CmdSelMargin() | Margin |
| ScApp.CmdSelectAll() | Select All |
| ScApp.CmdSelectToBrace() | Select to Brace |
| ScApp.CmdSelectToNextMatchPpc() | Select to next preprocessor section |
| ScApp.CmdSelectToPrevMatchPpc() | Select to prev preprocessor section |
| ScApp.CmdSelectionAddEach() | Selection Add Each |
| ScApp.CmdSelectionAddNext() | Selection Add Next |
| ScApp.CmdShowCalltip() | Show Calltip |
| ScApp.CmdSplit() | Split |
| ScApp.CmdSplitVertical() | Vertical Split |
| ScApp.CmdStopExecute() | Stop Executing |
| ScApp.CmdStreamComment() | Stream Comment |
| ScApp.CmdSwitchPane() | Switch Pane |
| ScApp.CmdTabSize() | Change Indentation Settings |
| ScApp.CmdToggleFoldAll() | Toggle all folds |
| ScApp.CmdToggleFoldRecursive() | |
| ScApp.CmdToggleOutput() | Output |
| ScApp.CmdToggleParameters() | Parameters |
| ScApp.CmdUndo() | Undo |
| ScApp.CmdUnslash() | |
| ScApp.CmdUpperCase() | Make Selection Uppercase |
| ScApp.CmdViewEol() | End of Line |
| ScApp.CmdViewGuides() | Indentation Guides |
| ScApp.CmdViewSpace() | Whitespace |
| ScApp.CmdViewStatusBar() | Status Bar |
| ScApp.CmdViewTabBar() | Tab Bar |
| ScApp.CmdViewToolbar() | Tool Bar |
| ScApp.CmdWrap() | Wrap |
| ScApp.CmdWrapAround() | |
| ScApp.CmdWrapOutput() | Wrap Output |
| Cut, copy and paste (Use ScOutput instead of ScEditor to refer to the output pane) |
|
|---|---|
| bool ScEditor.CanPaste() | Will a paste succeed? more |
| ScEditor.Clear() | Clear the selection. more |
| ScEditor.Copy() | Copy the selection to the clipboard. more |
| ScEditor.CopyAllowLine() | Copy the selection, if selection empty copy the line with the caret more |
| ScEditor.CopyRange(int start, int end) | Copy a range of text to the clipboard. Positions are clipped into the document. more |
| ScEditor.CopyText(string text) | Copy argument text to the clipboard. more |
| ScEditor.Cut() | Cut the selection to the clipboard. more |
| bool ScEditor.GetPasteConvertEndings() | Get convert-on-paste setting more |
| ScEditor.Paste() | Paste the contents of the clipboard into the document replacing the selection. more |
| ScEditor.SetPasteConvertEndings(bool value) | Enable/Disable convert-on-paste for line endings more |
| string ScEditor.Utils.GetClipboardText() | Get clipboard text (not available on all platforms) more |
| ScEditor.Utils.SetClipboardText(s) | Set clipboard text more |
| Searching | |
|---|---|
| int ScEditor.GetSearchFlags() | Get the search flags used by SearchInTarget. more |
| string ScEditor.GetTag(int tagNumber) | Retrieve the value of a tag from a regular expression search. more |
| int ScEditor.GetTargetEnd() | Get the position that ends the target. more |
| int ScEditor.GetTargetStart() | Get the position that starts the target. more |
| string ScEditor.GetTargetText() | Retrieve the text in the target. more |
| int,int ScEditor.PaneFindText(string s, int pos1=0, int pos2=-1, wholeWord=False, matchCase=False, regExp=False, flags=0) | Find text more |
| int ScEditor.ReplaceTarget(string text) | Replace the target text with the argument text. Text is counted so it can contain NULs. Returns the length of the replacement text. more |
| int ScEditor.ReplaceTargetRE(string text) | 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. more |
| ScEditor.SearchAnchor() | Sets the current caret position to be the search anchor. more |
| int ScEditor.SearchInTarget(string text) | 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 length of range or -1 for failure in which case target is not moved. more |
| int ScEditor.SearchNext(int flags, string text) | Find some text starting at the search anchor. Does not ensure the selection is visible. more |
| int ScEditor.SearchPrev(int flags, string text) | Find some text starting at the search anchor and moving backwards. Does not ensure the selection is visible. more |
| ScEditor.SetSearchFlags(int value) | Set the search flags used by SearchInTarget. more |
| ScEditor.SetTargetEnd(int value) | Sets the position that ends the target which is used for updating the document without affecting the scroll position. more |
| ScEditor.SetTargetRange(int start, int end) | Sets both the start and end of the target in one call. more |
| ScEditor.SetTargetStart(int value) | Sets the position that starts the target which is used for updating the document without affecting the scroll position. more |
| ScEditor.TargetFromSelection() | Make the target range start and end be the same as the selection range start and end. more |
| ScEditor.TargetWholeDocument() | Sets the target to the whole document. more |
| Overtype | |
|---|---|
| bool ScEditor.GetOvertype() | Returns true if overtype mode is active otherwise false is returned. more |
| ScEditor.SetOvertype(bool value) | Set to overtype (true) or insert mode. more |
| Undo and Redo | |
|---|---|
| ScEditor.AddUndoAction(int token, int flags) | Add a container action to the undo stack more |
| ScEditor.BeginUndoAction() | Start a sequence of actions that is undone and redone as a unit. May be nested. more |
| bool ScEditor.CanRedo() | Are there any redoable actions in the undo history? more |
| bool ScEditor.CanUndo() | Are there any undoable actions in the undo history? more |
| ScEditor.EmptyUndoBuffer() | Delete the undo history. more |
| ScEditor.EndUndoAction() | End a sequence of actions that is undone and redone as a unit. more |
| bool ScEditor.GetUndoCollection() | Is undo history being collected? more |
| ScEditor.Redo() | Redoes the next action on the undo history. more |
| ScEditor.SetUndoCollection(bool value) | Choose between collecting actions into the undo history and discarding them. more |
| ScEditor.Undo() | Undo one action in the undo history. more |
| Selection and information | |
|---|---|
| int ScEditor.CharPositionFromPoint(int x, int y) | Find the position of a character from a point within the window. more |
| int ScEditor.CharPositionFromPointClose(int x, int y) | Find the position of a character from a point within the window. Return INVALID_POSITION if not close to text. more |
| ScEditor.ChooseCaretX() | Set the last x chosen value to be the caret x position. more |
| int ScEditor.CountCharacters(int startPos, int endPos) | Count characters between two positions. more |
| int ScEditor.FindColumn(int line, int column) | 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. more |
| int ScEditor.GetAnchor() | Returns the position of the opposite end of the selection to the caret. more |
| int ScEditor.GetColumn(int pos) | Retrieve the column number of a position, taking tab width into account. more |
| string,int ScEditor.GetCurLine() | Retrieve the text of the line containing the caret. Returns the index of the caret on the line. more |
| int ScEditor.GetCurrentPos() | Returns the position of the caret. more |
| int ScEditor.GetLength() | Returns the number of bytes in the document. more |
| int ScEditor.GetLineCount() | Returns the number of lines in the document. There is always at least one. more |
| int ScEditor.GetLineEndPosition(int line) | Get the position after the last visible characters on a line. more |
| int ScEditor.GetLineSelEndPosition(int line) | Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line). more |
| int ScEditor.GetLineSelStartPosition(int line) | Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line). more |
| int ScEditor.GetLinesOnScreen() | Retrieves the number of lines completely visible. more |
| bool ScEditor.GetModify() | Is the document different from when it was last saved? more |
| bool ScEditor.GetMouseSelectionRectangularSwitch() | Whether switching to rectangular mode while selecting with the mouse is allowed. more |
| string,int ScEditor.GetSelText() | Retrieve the selected text. Return the length of the text. more |
| int ScEditor.GetSelectionEnd() | Returns the position at the end of the selection. more |
| bool ScEditor.GetSelectionIsRectangle() | Is the selection rectangular? The alternative is the more common stream selection. more |
| int ScEditor.GetSelectionMode() | Get the mode of the current selection. more |
| int ScEditor.GetSelectionStart() | Returns the position at the start of the selection. more |
| int ScEditor.GetTextLength() | Retrieve the number of characters in the document. more |
| ScEditor.GotoLine(int line) | Set caret to start of a line and ensure it is visible. more |
| ScEditor.GotoPos(int pos) | Set caret to a position and ensure it is visible. more |
| ScEditor.HideSelection(bool normal) | Draw the selection in normal style or with selection highlighted. more |
| bool ScEditor.IsRangeWord(int start, int end) | Is the range start..end considered a word? more |
| int ScEditor.LineFromPosition(int pos) | Retrieve the line containing a position. more |
| int ScEditor.LineLength(int line) | How many characters are on a line, including end of line characters? more |
| ScEditor.MoveCaretInsideView() | Move the caret inside current view if it's not there already. more |
| ScEditor.MoveSelectedLinesDown() | Move the selected lines down one line, shifting the line below before the selection more |
| ScEditor.MoveSelectedLinesUp() | Move the selected lines up one line, shifting the line above after the selection more |
| int ScEditor.PointXFromPosition(int pos) | Retrieve the x value of the point in the window where a position is displayed. more |
| int ScEditor.PointYFromPosition(int pos) | Retrieve the y value of the point in the window where a position is displayed. more |
| int ScEditor.PositionAfter(int pos) | Given a valid document position, return the next position taking code page into account. Maximum value returned is the last position in the document. more |
| int ScEditor.PositionBefore(int pos) | Given a valid document position, return the previous position taking code page into account. Returns 0 if passed 0. more |
| int ScEditor.PositionFromLine(int line) | Retrieve the position at the start of a line. more |
| int ScEditor.PositionFromPoint(int x, int y) | Find the position from a point within the window. more |
| int ScEditor.PositionFromPointClose(int x, int y) | Find the position from a point within the window but return INVALID_POSITION if not close to text. more |
| int ScEditor.PositionRelative(int pos, int relative) | 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. more |
| ScEditor.SelectAll() | Select all the text in the document. more |
| ScEditor.SetAnchor(int value) | Set the selection anchor to a position. The anchor is the opposite end of the selection from the caret. more |
| ScEditor.SetCurrentPos(int value) | Sets the position of the caret. more |
| ScEditor.SetEmptySelection(int pos) | Set caret to a position, while removing any existing selection. more |
| ScEditor.SetMouseSelectionRectangularSwitch(bool value) | Set whether switching to rectangular mode while selecting with the mouse is allowed. more |
| ScEditor.SetSel(int start, int end) | Select a range of text. more |
| ScEditor.SetSelectionEnd(int value) | Sets the position that ends the selection - this becomes the currentPosition. more |
| ScEditor.SetSelectionMode(int value) | Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or by lines (SC_SEL_LINES). more |
| ScEditor.SetSelectionStart(int value) | Sets the position that starts the selection - this becomes the anchor. more |
| int ScEditor.TextHeight(int line) | Retrieve the height of a particular line of text in pixels. more |
| int ScEditor.TextWidth(int style, string text) | Measure the pixel width of some text in a particular style. Does not handle tab or control characters. more |
| ScEditor.Utils.ExpandSelectionToIncludeEntireLines() | Ensure entire lines are selected more |
| int ScEditor.WordEndPosition(int pos, bool onlyWordCharacters) | Get position of end of word. more |
| int ScEditor.WordStartPosition(int pos, bool onlyWordCharacters) | Get position of start of word. more |
| Multiple Selection and Virtual Space | |
|---|---|
| int ScEditor.AddSelection(int caret, int anchor) | Add a selection more |
| ScEditor.ClearSelections() | Clear selections to a single empty stream selection more |
| ScEditor.DropSelectionN(int selection) | Drop one selection more |
| colour ScEditor.GetAdditionalCaretFore() | Get the foreground colour of additional carets. more |
| bool ScEditor.GetAdditionalCaretsBlink() | Whether additional carets will blink more |
| bool ScEditor.GetAdditionalCaretsVisible() | Whether additional carets are visible more |
| int ScEditor.GetAdditionalSelAlpha() | Get the alpha of the selection. more |
| bool ScEditor.GetAdditionalSelectionTyping() | Whether typing can be performed into multiple selections more |
| int ScEditor.GetMainSelection() | Which selection is the main selection more |
| int ScEditor.GetMultiPaste() | Retrieve the effect of pasting when there are multiple selections. more |
| bool ScEditor.GetMultipleSelection() | Whether multiple selections can be made more |
| int ScEditor.GetRectangularSelectionAnchor() | Returns the position at the end of the selection. more |
| int ScEditor.GetRectangularSelectionAnchorVirtualSpace() | Returns the position at the end of the selection. more |
| int ScEditor.GetRectangularSelectionCaret() | Returns the position at the end of the selection. more |
| int ScEditor.GetRectangularSelectionCaretVirtualSpace() | Returns the position at the end of the selection. more |
| int ScEditor.GetRectangularSelectionModifier() | Get the modifier key used for rectangular selection. more |
| bool ScEditor.GetSelectionEmpty() | Is every selected range empty? more |
| int ScEditor.GetSelectionNAnchor(int selection) | Which selection is the main selection more |
| int ScEditor.GetSelectionNAnchorVirtualSpace(int selection) | Which selection is the main selection more |
| int ScEditor.GetSelectionNCaret(int selection) | Which selection is the main selection more |
| int ScEditor.GetSelectionNCaretVirtualSpace(int selection) | Which selection is the main selection more |
| int ScEditor.GetSelectionNEnd(int selection) | Returns the position at the end of the selection. more |
| int ScEditor.GetSelectionNStart(int selection) | Returns the position at the start of the selection. more |
| int ScEditor.GetSelections() | How many selections are there? more |
| int ScEditor.GetVirtualSpaceOptions() | Returns the position at the end of the selection. more |
| ScEditor.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. more |
| ScEditor.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. more |
| ScEditor.RotateSelection() | Set the main selection to the next selection. more |
| ScEditor.SetAdditionalCaretFore(colour value) | Set the foreground colour of additional carets. more |
| ScEditor.SetAdditionalCaretsBlink(bool value) | Set whether additional carets will blink more |
| ScEditor.SetAdditionalCaretsVisible(bool value) | Set whether additional carets are visible more |
| ScEditor.SetAdditionalSelAlpha(int value) | Set the alpha of the selection. more |
| ScEditor.SetAdditionalSelBack(colour value) | Set the background colour of additional selections. Must have previously called SetSelBack with non-zero first argument for this to have an effect. more |
| ScEditor.SetAdditionalSelFore(colour value) | Set the foreground colour of additional selections. Must have previously called SetSelFore with non-zero first argument for this to have an effect. more |
| ScEditor.SetAdditionalSelectionTyping(bool value) | Set whether typing can be performed into multiple selections more |
| ScEditor.SetMainSelection(int value) | Set the main selection more |
| ScEditor.SetMultiPaste(int value) | Change the effect of pasting when there are multiple selections. more |
| ScEditor.SetMultipleSelection(bool value) | Set whether multiple selections can be made more |
| ScEditor.SetRectangularSelectionAnchor(int value) | Returns the position at the end of the selection. more |
| ScEditor.SetRectangularSelectionAnchorVirtualSpace(int value) | Returns the position at the end of the selection. more |
| ScEditor.SetRectangularSelectionCaret(int value) | Returns the position at the end of the selection. more |
| ScEditor.SetRectangularSelectionCaretVirtualSpace(int value) | Returns the position at the end of the selection. more |
| ScEditor.SetRectangularSelectionModifier(int value) | 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. more |
| int ScEditor.SetSelection(int caret, int anchor) | Set a simple selection more |
| ScEditor.SetSelectionNAnchor(int selection, int value) | Which selection is the main selection more |
| ScEditor.SetSelectionNAnchorVirtualSpace(int selection, int value) | Which selection is the main selection more |
| ScEditor.SetSelectionNCaret(int selection, int value) | Which selection is the main selection more |
| ScEditor.SetSelectionNCaretVirtualSpace(int selection, int value) | Which selection is the main selection more |
| ScEditor.SetSelectionNEnd(int selection, int value) | Sets the position that ends the selection - this becomes the currentPosition. more |
| ScEditor.SetSelectionNStart(int selection, int value) | Sets the position that starts the selection - this becomes the anchor. more |
| ScEditor.SetVirtualSpaceOptions(int value) | Returns the position at the end of the selection. more |
| ScEditor.SwapMainAnchorCaret() | Swap that caret and anchor of the main selection. more |
| Scrolling and automatic scrolling | |
|---|---|
| bool ScEditor.GetEndAtLastLine() | Retrieve whether the maximum scroll position has the last line at the bottom of the view. more |
| int ScEditor.GetFirstVisibleLine() | Retrieve the display line at the top of the display. more |
| bool ScEditor.GetHScrollBar() | Is the horizontal scroll bar visible? more |
| int ScEditor.GetScrollWidth() | Retrieve the document width assumed for scrolling. more |
| bool ScEditor.GetScrollWidthTracking() | Retrieve whether the scroll width tracks wide lines. more |
| bool ScEditor.GetVScrollBar() | Is the vertical scroll bar visible? more |
| int ScEditor.GetXOffset() | Get and Set the xOffset (ie, horizontal scroll position). more |
| ScEditor.LineScroll(int columns, int lines) | Scroll horizontally and vertically. more |
| ScEditor.ScrollCaret() | Ensure the caret is visible. more |
| ScEditor.ScrollRange(int secondary, int primary) | 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. more |
| ScEditor.SetEndAtLastLine(bool value) | 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. more |
| ScEditor.SetFirstVisibleLine(int value) | Scroll so that a display line is at the top of the display. more |
| ScEditor.SetHScrollBar(bool value) | Show or hide the horizontal scroll bar. more |
| ScEditor.SetScrollWidth(int value) | Sets the document width assumed for scrolling. more |
| ScEditor.SetScrollWidthTracking(bool value) | Sets whether the maximum width line displayed is used to set scroll width. more |
| ScEditor.SetVScrollBar(bool value) | Show or hide the vertical scroll bar. more |
| ScEditor.SetVisiblePolicy(int visiblePolicy, int visibleSlop) | Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc. more |
| ScEditor.SetXCaretPolicy(int caretPolicy, int caretSlop) | Set the way the caret is kept visible when going sideways. The exclusion zone is given in pixels. more |
| ScEditor.SetXOffset(int value) | Get and Set the xOffset (ie, horizontal scroll position). more |
| ScEditor.SetYCaretPolicy(int caretPolicy, int caretSlop) | Set the way the line the caret is on is kept visible. The exclusion zone is given in lines. more |
| White space | |
|---|---|
| int ScEditor.GetExtraAscent() | Get extra ascent for each line more |
| int ScEditor.GetExtraDescent() | Get extra descent for each line more |
| int ScEditor.GetViewWS() | Are white space characters currently visible? Returns one of SCWS_* constants. more |
| int ScEditor.GetWhitespaceSize() | Get the size of the dots used to mark space characters. more |
| ScEditor.SetExtraAscent(int value) | Set extra ascent for each line more |
| ScEditor.SetExtraDescent(int value) | Set extra descent for each line more |
| ScEditor.SetViewWS(int value) | Make white space characters invisible, always visible or visible outside indentation. more |
| ScEditor.SetWhitespaceBack(bool useSetting, colour back) | Set the background colour of all whitespace and whether to use this setting. more |
| ScEditor.SetWhitespaceFore(bool useSetting, colour fore) | Set the foreground colour of all whitespace and whether to use this setting. more |
| ScEditor.SetWhitespaceSize(int value) | Set the size of the dots used to mark space characters. more |
| Cursor | |
|---|---|
| int ScEditor.GetCursor() | Get cursor type. more |
| ScEditor.SetCursor(int value) | Sets the cursor to one of the SC_CURSOR* values. more |
| Line endings | |
|---|---|
| ScEditor.ConvertEOLs(int eolMode) | Convert all line endings in the document to one mode. more |
| int ScEditor.GetEOLMode() | Retrieve the current end of line mode - one of CRLF, CR, or LF. more |
| int ScEditor.GetLineEndTypesActive() | Get the line end types currently recognised. May be a subset of the allowed types due to lexer limitation. more |
| int ScEditor.GetLineEndTypesAllowed() | Get the line end types currently allowed. more |
| int ScEditor.GetLineEndTypesSupported() | Bit set of LineEndType enumertion for which line ends beyond the standard LF, CR, and CRLF are supported by the lexer. more |
| bool ScEditor.GetViewEOL() | Are the end of line characters visible? more |
| ScEditor.SetEOLMode(int value) | Set the current end of line mode. more |
| ScEditor.SetLineEndTypesAllowed(int value) | Set the line end types that the application wants to use. May not be used if incompatible with lexer or encoding. more |
| ScEditor.SetViewEOL(bool value) | Make the end of line characters visible or invisible. more |
| string ScEditor.Utils.GetEolCharacter() | Return current EOL character, e.g. \r\n more |
| Styling | |
|---|---|
| int ScEditor.GetEndStyled() | Retrieve the position of the last correctly styled character. more |
| int ScEditor.GetIdleStyling() | Retrieve the limits to idle styling. more |
| int ScEditor.GetLineState(int line) | Retrieve the extra styling information for a line. more |
| int ScEditor.GetMaxLineState() | Retrieve the last line number that has line state. more |
| ScEditor.SetIdleStyling(int value) | Sets limits to idle styling. more |
| ScEditor.SetLineState(int line, int value) | Used to hold extra styling information for each line. more |
| ScEditor.SetStyling(int length, int style) | Change style from current styling position for length characters to a style and move the current styling position to after this newly styled segment. more |
| ScEditor.SetStylingEx(string styles) | Set the styles for a segment of the document. more |
| ScEditor.StartStyling(int pos, int mask) | Set the current styling position to pos and the styling mask to mask. The styling mask can be used to protect some bits in each styling byte from modification. more |
| Style definition | |
|---|---|
| colour ScEditor.GetStyleBack(int style) | Get the background colour of a style. more |
| bool ScEditor.GetStyleBold(int style) | Get is a style bold or not. more |
| int ScEditor.GetStyleCase(int style) | Get is a style mixed case, or to force upper or lower case. more |
| bool ScEditor.GetStyleChangeable(int style) | Get is a style changeable or not (read only). Experimental feature, currently buggy. more |
| int ScEditor.GetStyleCharacterSet(int style) | Get the character get of the font in a style. more |
| bool ScEditor.GetStyleEOLFilled(int style) | Get is a style to have its end of line filled or not. more |
| string ScEditor.GetStyleFont(int style) | Get the font of a style. Returns the length of the fontName more |
| colour ScEditor.GetStyleFore(int style) | Get the foreground colour of a style. more |
| bool ScEditor.GetStyleHotSpot(int style) | Get is a style a hotspot or not. more |
| bool ScEditor.GetStyleItalic(int style) | Get is a style italic or not. more |
| int ScEditor.GetStyleSize(int style) | Get the size of characters of a style. more |
| int ScEditor.GetStyleSizeFractional(int style) | Get the size of characters of a style in points multiplied by 100 more |
| bool ScEditor.GetStyleUnderline(int style) | Get is a style underlined or not. more |
| bool ScEditor.GetStyleVisible(int style) | Get is a style visible or not. more |
| int ScEditor.GetStyleWeight(int style) | Get the weight of characters of a style. more |
| ScEditor.SetStyleBack(int style, colour value) | Set the background colour of a style. more |
| ScEditor.SetStyleBold(int style, bool value) | Set a style to be bold or not. more |
| ScEditor.SetStyleCase(int style, int value) | Set a style to be mixed case, or to force upper or lower case. more |
| ScEditor.SetStyleChangeable(int style, bool value) | Set a style to be changeable or not (read only). Experimental feature, currently buggy. more |
| ScEditor.SetStyleCharacterSet(int style, int value) | Set the character set of the font in a style. more |
| ScEditor.SetStyleEOLFilled(int style, bool value) | Set a style to have its end of line filled or not. more |
| ScEditor.SetStyleFont(int style, string value) | Set the font of a style. more |
| ScEditor.SetStyleFore(int style, colour value) | Set the foreground colour of a style. more |
| ScEditor.SetStyleHotSpot(int style, bool value) | Set a style to be a hotspot or not. more |
| ScEditor.SetStyleItalic(int style, bool value) | Set a style to be italic or not. more |
| ScEditor.SetStyleSize(int style, int value) | Set the size of characters of a style. more |
| ScEditor.SetStyleSizeFractional(int style, int value) | Set the size of characters of a style. Size is in points multiplied by 100. more |
| ScEditor.SetStyleUnderline(int style, bool value) | Set a style to be underlined or not. more |
| ScEditor.SetStyleVisible(int style, bool value) | Set a style to be visible or not. more |
| ScEditor.SetStyleWeight(int style, int value) | Set the weight of characters of a style. more |
| ScEditor.StyleClearAll() | Clear all the styles and make equivalent to the global default style. more |
| ScEditor.StyleResetDefault() | Reset the default style to its state at startup more |
| Caret, selection, and hotspot styles | |
|---|---|
| colour ScEditor.GetCaretFore() | Get the foreground colour of the caret. more |
| colour ScEditor.GetCaretLineBack() | Get the colour of the background of the line containing the caret. more |
| int ScEditor.GetCaretLineBackAlpha() | Get the background alpha of the caret line. more |
| bool ScEditor.GetCaretLineVisible() | Is the background of the line containing the caret in a different colour? more |
| bool ScEditor.GetCaretLineVisibleAlways() | Is the caret line always visible? more |
| int ScEditor.GetCaretPeriod() | Get the time in milliseconds that the caret is on and off. more |
| int ScEditor.GetCaretSticky() | Can the caret preferred x position only be changed by explicit movement commands? more |
| int ScEditor.GetCaretStyle() | Returns the current style of the caret. more |
| int ScEditor.GetCaretWidth() | Returns the width of the insert mode caret. more |
| colour ScEditor.GetHotspotActiveBack() | Get the back colour for active hotspots. more |
| colour ScEditor.GetHotspotActiveFore() | Get the fore colour for active hotspots. more |
| bool ScEditor.GetHotspotActiveUnderline() | Get whether underlining for active hotspots. more |
| bool ScEditor.GetHotspotSingleLine() | Get the HotspotSingleLine property more |
| int ScEditor.GetSelAlpha() | Get the alpha of the selection. more |
| bool ScEditor.GetSelEOLFilled() | Is the selection end of line filled? more |
| ScEditor.SetCaretFore(colour value) | Set the foreground colour of the caret. more |
| ScEditor.SetCaretLineBack(colour value) | Set the colour of the background of the line containing the caret. more |
| ScEditor.SetCaretLineBackAlpha(int value) | Set background alpha of the caret line. more |
| ScEditor.SetCaretLineVisible(bool value) | Display the background of the line containing the caret in a different colour. more |
| ScEditor.SetCaretLineVisibleAlways(bool value) | Sets the caret line to always visible. more |
| ScEditor.SetCaretPeriod(int value) | Get the time in milliseconds that the caret is on and off. 0 = steady on. more |
| ScEditor.SetCaretSticky(int value) | Stop the caret preferred x position changing when the user types. more |
| ScEditor.SetCaretStyle(int value) | Set the style of the caret to be drawn. more |
| ScEditor.SetCaretWidth(int value) | Set the width of the insert mode caret. more |
| ScEditor.SetHotspotActiveBack(bool useSetting, colour back) | Set a back colour for active hotspots. more |
| ScEditor.SetHotspotActiveFore(bool useSetting, colour fore) | Set a fore colour for active hotspots. more |
| ScEditor.SetHotspotActiveUnderline(bool value) | Enable / Disable underlining active hotspots. more |
| ScEditor.SetHotspotSingleLine(bool value) | Limit hotspots to single line so hotspots on two lines don't merge. more |
| ScEditor.SetSelAlpha(int value) | Set the alpha of the selection. more |
| ScEditor.SetSelBack(bool useSetting, colour back) | Set the background colour of the main and additional selections and whether to use this setting. more |
| ScEditor.SetSelEOLFilled(bool value) | Set the selection to have its end of line filled or not. more |
| ScEditor.SetSelFore(bool useSetting, colour fore) | Set the foreground colour of the main and additional selections and whether to use this setting. more |
| ScEditor.ToggleCaretSticky() | Switch between sticky and non-sticky: meant to be bound to a key. more |
| Character representations | |
|---|---|
| ScEditor.ClearRepresentation(string encodedCharacter) | Remove a character representation. more |
| int ScEditor.GetControlCharSymbol() | Get the way control characters are displayed. more |
| string ScEditor.GetRepresentation(string encodedCharacter) | Set the way a character is drawn. more |
| ScEditor.SetControlCharSymbol(int value) | Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character. more |
| ScEditor.SetRepresentation(string encodedCharacter, string value) | Set the way a character is drawn. more |
| Margins | |
|---|---|
| int ScEditor.GetMarginCursorN(int margin) | Retrieve the cursor shown in a margin. more |
| int ScEditor.GetMarginLeft() | Returns the size in pixels of the left margin. more |
| int ScEditor.GetMarginMaskN(int margin) | Retrieve the marker mask of a margin. more |
| int ScEditor.GetMarginOptions() | Get the margin options. more |
| int ScEditor.GetMarginRight() | Returns the size in pixels of the right margin. more |
| bool ScEditor.GetMarginSensitiveN(int margin) | Retrieve the mouse click sensitivity of a margin. more |
| int ScEditor.GetMarginStyle(int line) | Get the style number for the text margin for a line more |
| int ScEditor.GetMarginStyleOffset() | Get the start of the range of style numbers used for margin text more |
| string ScEditor.GetMarginStyles(int line) | Get the styles in the text margin for a line more |
| string ScEditor.GetMarginText(int line) | Get the text in the text margin for a line more |
| int ScEditor.GetMarginTypeN(int margin) | Retrieve the type of a margin. more |
| int ScEditor.GetMarginWidthN(int margin) | Retrieve the width of a margin in pixels. more |
| ScEditor.MarginTextClearAll() | Clear the margin text on all lines more |
| ScEditor.SetFoldMarginColour(bool useSetting, colour back) | Set the colours used as a chequerboard pattern in the fold margin more |
| ScEditor.SetFoldMarginHiColour(bool useSetting, colour fore) | Set the colours used as a chequerboard pattern in the fold margin more |
| ScEditor.SetMarginCursorN(int margin, int value) | Set the cursor shown when the mouse is inside a margin. more |
| ScEditor.SetMarginLeft(int value) | Sets the size in pixels of the left margin. more |
| ScEditor.SetMarginMaskN(int margin, int value) | Set a mask that determines which markers are displayed in a margin. more |
| ScEditor.SetMarginOptions(int value) | Set the margin options. more |
| ScEditor.SetMarginRight(int value) | Sets the size in pixels of the right margin. more |
| ScEditor.SetMarginSensitiveN(int margin, bool value) | Make a margin sensitive or insensitive to mouse clicks. more |
| ScEditor.SetMarginStyle(int line, int value) | Set the style number for the text margin for a line more |
| ScEditor.SetMarginStyleOffset(int value) | Get the start of the range of style numbers used for margin text more |
| ScEditor.SetMarginStyles(int line, string value) | Set the style in the text margin for a line more |
| ScEditor.SetMarginText(int line, string value) | Set the text in the text margin for a line more |
| ScEditor.SetMarginTypeN(int margin, int value) | Set a margin to be either numeric or symbolic. more |
| ScEditor.SetMarginWidthN(int margin, int value) | Set the width of a margin to a width expressed in pixels. more |
| Annotations | |
|---|---|
| ScEditor.AnnotationClearAll() | Clear the annotations from all lines more |
| int ScEditor.GetAnnotationLines(int line) | Get the number of annotation lines for a line more |
| int ScEditor.GetAnnotationStyle(int line) | Get the style number for the annotations for a line more |
| int ScEditor.GetAnnotationStyleOffset() | Get the start of the range of style numbers used for annotations more |
| string ScEditor.GetAnnotationStyles(int line) | Get the annotation styles for a line more |
| string ScEditor.GetAnnotationText(int line) | Get the annotation text for a line more |
| int ScEditor.GetAnnotationVisible() | Get the visibility for the annotations for a view more |
| ScEditor.SetAnnotationStyle(int line, int value) | Set the style number for the annotations for a line more |
| ScEditor.SetAnnotationStyleOffset(int value) | Get the start of the range of style numbers used for annotations more |
| ScEditor.SetAnnotationStyles(int line, string value) | Set the annotation styles for a line more |
| ScEditor.SetAnnotationText(int line, string value) | Set the annotation text for a line more |
| ScEditor.SetAnnotationVisible(int value) | Set the visibility for the annotations for a view more |
| Other settings | |
|---|---|
| bool ScEditor.GetBufferedDraw() | Is drawing done first into a buffer or direct to the screen? more |
| int ScEditor.GetCodePage() | Get the code page used to interpret the bytes of the document as characters. more |
| bool ScEditor.GetFocus() | Get internal focus flag. more |
| int ScEditor.GetFontQuality() | Retrieve the quality level for text. more |
| int ScEditor.GetIMEInteraction() | Is the IME displayed in a window or inline? more |
| int ScEditor.GetPhasesDraw() | How many phases is drawing done in? more |
| string ScEditor.GetPunctuationChars() | Get the set of characters making up punctuation characters more |
| int ScEditor.GetTechnology() | Get the tech. more |
| bool ScEditor.GetTwoPhaseDraw() | Is drawing done in two phases with backgrounds drawn before foregrounds? more |
| string ScEditor.GetWhitespaceChars() | Get the set of characters making up whitespace for when moving or selecting by word. more |
| string ScEditor.GetWordChars() | Get the set of characters making up words for when moving or selecting by word. Returns the number of characters more |
| ScEditor.GrabFocus() | Set the focus to this Scintilla widget. more |
| ScEditor.SetBufferedDraw(bool value) | If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker. more |
| ScEditor.SetCharsDefault() | Reset the set of characters for whitespace and word characters to the defaults. more |
| ScEditor.SetCodePage(int value) | 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. more |
| ScEditor.SetFocus(bool value) | Change internal focus flag. more |
| ScEditor.SetFontQuality(int value) | Choose the quality level for text from the FontQuality enumeration. more |
| ScEditor.SetIMEInteraction(int value) | Choose to display the the IME in a winow or inline. more |
| ScEditor.SetPhasesDraw(int value) | 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. more |
| ScEditor.SetPunctuationChars(string value) | Set the set of characters making up punctuation characters Should be called after SetWordChars. more |
| ScEditor.SetTechnology(int value) | Set the technology used. more |
| ScEditor.SetTwoPhaseDraw(bool value) | In twoPhaseDraw mode, drawing is performed in two phases, first the background and then the foreground. This avoids chopping off characters that overlap the next run. more |
| ScEditor.SetWhitespaceChars(string value) | Set the set of characters making up whitespace for when moving or selecting by word. Should be called after SetWordChars. more |
| ScEditor.SetWordChars(string value) | Set the set of characters making up words for when moving or selecting by word. First sets defaults like SetCharsDefault. more |
| Brace highlighting | |
|---|---|
| ScEditor.BraceBadLight(int pos) | Highlight the character at a position indicating there is no matching brace. more |
| ScEditor.BraceBadLightIndicator(bool useBraceBadLightIndicator, int indicator) | Use specified indicator to highlight non matching brace instead of changing its style. more |
| ScEditor.BraceHighlight(int pos1, int pos2) | Highlight the characters at two positions. more |
| ScEditor.BraceHighlightIndicator(bool useBraceHighlightIndicator, int indicator) | Use specified indicator to highlight matching braces instead of changing their style. more |
| int ScEditor.BraceMatch(int pos) | Find the position of a matching brace or INVALID_POSITION if no match. more |
| Tabs and Indentation Guides | |
|---|---|
| ScEditor.AddTabStop(int line, int x) | Add an explicit tab stop for a line. more |
| ScEditor.ClearTabStops(int line) | Clear explicit tabstops on a line. more |
| bool ScEditor.GetBackSpaceUnIndents() | Does a backspace pressed when caret is within indentation unindent? more |
| int ScEditor.GetHighlightGuide() | Get the highlighted indentation guide column. more |
| int ScEditor.GetIndent() | Retrieve indentation size. more |
| int ScEditor.GetIndentationGuides() | Are the indentation guides visible? more |
| int ScEditor.GetLineIndentPosition(int line) | Retrieve the position before the first non indentation character on a line. more |
| int ScEditor.GetLineIndentation(int line) | Retrieve the number of columns that a line is indented. more |
| int ScEditor.GetNextTabStop(int line, int x) | Find the next explicit tab stop position on a line after a position. more |
| bool ScEditor.GetTabIndents() | Does a tab pressed when caret is within indentation indent? more |
| int ScEditor.GetTabWidth() | Retrieve the visible size of a tab. more |
| bool ScEditor.GetUseTabs() | Retrieve whether tabs will be used in indentation. more |
| ScEditor.SetBackSpaceUnIndents(bool value) | Sets whether a backspace pressed when caret is within indentation unindents. more |
| ScEditor.SetHighlightGuide(int value) | Set the highlighted indentation guide column. 0 = no highlighted guide. more |
| ScEditor.SetIndent(int value) | Set the number of spaces used for one level of indentation. more |
| ScEditor.SetIndentationGuides(int value) | Show or hide indentation guides. more |
| ScEditor.SetLineIndentation(int line, int value) | Change the indentation of a line to a number of columns. more |
| ScEditor.SetTabIndents(bool value) | Sets whether a tab pressed when caret is within indentation indents. more |
| ScEditor.SetTabWidth(int value) | Change the visible size of a tab to be a multiple of the width of a space character. more |
| ScEditor.SetUseTabs(bool value) | Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces. more |
| Markers | |
|---|---|
| int ScEditor.MarkerAdd(int line, int markerNumber) | Add a marker to a line, returning an ID which can be used to find or delete the marker. more |
| ScEditor.MarkerAddSet(int line, int set) | Add a set of markers to a line. more |
| ScEditor.MarkerDefine(int markerNumber, int markerSymbol) | Set the symbol used for a particular marker number. more |
| ScEditor.MarkerDefinePixmap(int markerNumber, string pixmap) | Define a marker from a pixmap. more |
| ScEditor.MarkerDefineRGBAImage(int markerNumber, string pixels) | Define a marker from RGBA data. It has the width and height from RGBAImageSetWidth/Height more |
| ScEditor.MarkerDelete(int line, int markerNumber) | Delete a marker from a line. more |
| ScEditor.MarkerDeleteAll(int markerNumber) | Delete all markers with a particular number from all lines. more |
| ScEditor.MarkerDeleteHandle(int handle) | Delete a marker. more |
| ScEditor.MarkerEnableHighlight(bool enabled) | Enable/disable highlight for current folding bloc (smallest one that contains the caret) more |
| int ScEditor.MarkerGet(int line) | Get a bit mask of all the markers set on a line. more |
| int ScEditor.MarkerLineFromHandle(int handle) | Retrieve the line number at which a particular marker is located. more |
| int ScEditor.MarkerNext(int lineStart, int markerMask) | Find the next line at or after lineStart that includes a marker in mask. Return -1 when no more lines. more |
| int ScEditor.MarkerPrevious(int lineStart, int markerMask) | Find the previous line before lineStart that includes a marker in mask. more |
| int ScEditor.MarkerSymbolDefined(int markerNumber) | Which symbol was defined for markerNumber with MarkerDefine more |
| ScEditor.SetMarkerAlpha(int markerNumber, int value) | Set the alpha used for a marker that is drawn in the text area, not the margin. more |
| ScEditor.SetMarkerBack(int markerNumber, colour value) | Set the background colour used for a particular marker number. more |
| ScEditor.SetMarkerBackSelected(int markerNumber, colour value) | Set the background colour used for a particular marker number when its folding block is selected. more |
| ScEditor.SetMarkerFore(int markerNumber, colour value) | Set the foreground colour used for a particular marker number. more |
| ScEditor.SetRGBAImageHeight(int value) | Set the height for future RGBA image data. more |
| ScEditor.SetRGBAImageScale(int value) | Set the scale factor in percent for future RGBA image data. more |
| ScEditor.SetRGBAImageWidth(int value) | Set the width for future RGBA image data. more |
| Indicators | |
|---|---|
| ScEditor.FindIndicatorFlash(int start, int end) | On OS X, flash a find indicator, then fade out. more |
| ScEditor.FindIndicatorHide() | On OS X, hide the find indicator. more |
| ScEditor.FindIndicatorShow(int start, int end) | On OS X, show a find indicator. more |
| int ScEditor.GetIndicAlpha(int indicator) | Get the alpha fill colour of the given indicator. more |
| int ScEditor.GetIndicFlags(int indic) | Retrieve the attributes of an indicator. more |
| colour ScEditor.GetIndicFore(int indic) | Retrieve the foreground colour of an indicator. more |
| colour ScEditor.GetIndicHoverFore(int indic) | Retrieve the foreground hover colour of an indicator. more |
| int ScEditor.GetIndicHoverStyle(int indic) | Retrieve the hover style of an indicator. more |
| int ScEditor.GetIndicOutlineAlpha(int indicator) | Get the alpha outline colour of the given indicator. more |
| int ScEditor.GetIndicStyle(int indic) | Retrieve the style of an indicator. more |
| bool ScEditor.GetIndicUnder(int indic) | Retrieve whether indicator drawn under or over text. more |
| int ScEditor.GetIndicatorCurrent() | Get the current indicator more |
| int ScEditor.GetIndicatorValue() | Get the current indicator value more |
| int ScEditor.IndicatorAllOnFor(int int) | Are any indicators present at position? more |
| ScEditor.IndicatorClearRange(int int, int clearLength) | Turn a indicator off over a range. more |
| int ScEditor.IndicatorEnd(int indicator, int int) | Where does a particular indicator end? more |
| ScEditor.IndicatorFillRange(int int, int fillLength) | Turn a indicator on over a range. more |
| int ScEditor.IndicatorStart(int indicator, int int) | Where does a particular indicator start? more |
| int ScEditor.IndicatorValueAt(int indicator, int int) | What value does a particular indicator have at at a position? more |
| ScEditor.SetIndicAlpha(int indicator, int value) | Set the alpha fill colour of the given indicator. more |
| ScEditor.SetIndicFlags(int indic, int value) | Set the attributes of an indicator. more |
| ScEditor.SetIndicFore(int indic, colour value) | Set the foreground colour of an indicator. more |
| ScEditor.SetIndicHoverFore(int indic, colour value) | Set the foreground hover colour of an indicator. more |
| ScEditor.SetIndicHoverStyle(int indic, int value) | Set a hover indicator to plain, squiggle or TT. more |
| ScEditor.SetIndicOutlineAlpha(int indicator, int value) | Set the alpha outline colour of the given indicator. more |
| ScEditor.SetIndicStyle(int indic, int value) | Set an indicator to plain, squiggle or TT. more |
| ScEditor.SetIndicUnder(int indic, bool value) | Set an indicator to draw under text or over(default). more |
| ScEditor.SetIndicatorCurrent(int value) | Set the indicator used for IndicatorFillRange and IndicatorClearRange more |
| ScEditor.SetIndicatorValue(int value) | Set the value used for IndicatorFillRange more |
| Autocompletion | |
|---|---|
| bool ScEditor.AutoCActive() | Is there an auto-completion list visible? more |
| ScEditor.AutoCCancel() | Remove the auto-completion list from the screen. more |
| ScEditor.AutoCComplete() | User has selected an item so remove the list and insert the selection. more |
| int ScEditor.AutoCPosStart() | Retrieve the position of the caret when the auto-completion list was displayed. more |
| ScEditor.AutoCSelect(string text) | Select the item in the auto-completion list that starts with a string. more |
| ScEditor.AutoCShow(int lenEntered, string itemList) | Display a auto-completion list. The lenEntered parameter indicates how many characters before the caret should be used to provide context. more |
| ScEditor.AutoCStops(string characterSet) | Define a set of character that when typed cancel the auto-completion list. more |
| ScEditor.ClearRegisteredImages() | Clear all the registered XPM images. more |
| bool ScEditor.GetAutoCAutoHide() | Retrieve whether or not autocompletion is hidden automatically when nothing matches. more |
| bool ScEditor.GetAutoCCancelAtStart() | Retrieve whether auto-completion cancelled by backspacing before start. more |
| int ScEditor.GetAutoCCaseInsensitiveBehaviour() | Get auto-completion case insensitive behaviour. more |
| bool ScEditor.GetAutoCChooseSingle() | Retrieve whether a single item auto-completion list automatically choose the item. more |
| int ScEditor.GetAutoCCurrent() | Get currently selected item position in the auto-completion list more |
| string ScEditor.GetAutoCCurrentText() | Get currently selected item text in the auto-completion list Returns the length of the item text more |
| bool ScEditor.GetAutoCDropRestOfWord() | Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion. more |
| bool ScEditor.GetAutoCIgnoreCase() | Retrieve state of ignore case flag. more |
| int ScEditor.GetAutoCMaxHeight() | Set the maximum height, in rows, of auto-completion and user lists. more |
| int ScEditor.GetAutoCMaxWidth() | Get the maximum width, in characters, of auto-completion and user lists. more |
| int ScEditor.GetAutoCMulti() | Retrieve the effect of autocompleting when there are multiple selections. more |
| int ScEditor.GetAutoCOrder() | Get the way autocompletion lists are ordered. more |
| int ScEditor.GetAutoCSeparator() | Retrieve the auto-completion list separator character. more |
| int ScEditor.GetAutoCTypeSeparator() | Retrieve the auto-completion list type-separator character. more |
| ScEditor.RegisterImage(int type, string xpmData) | Register an XPM image for use in autocompletion lists. more |
| ScEditor.RegisterRGBAImage(int type, string pixels) | Register an RGBA image for use in autocompletion lists. It has the width and height from RGBAImageSetWidth/Height more |
| ScEditor.SetAutoCAutoHide(bool value) | Set whether or not autocompletion is hidden automatically when nothing matches. more |
| ScEditor.SetAutoCCancelAtStart(bool value) | Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created. more |
| ScEditor.SetAutoCCaseInsensitiveBehaviour(int value) | Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference. more |
| ScEditor.SetAutoCChooseSingle(bool value) | Should a single item auto-completion list automatically choose the item. more |
| ScEditor.SetAutoCDropRestOfWord(bool value) | Set whether or not autocompletion deletes any word characters after the inserted text upon completion. more |
| ScEditor.SetAutoCFillUps(string value) | Define a set of characters that when typed will cause the autocompletion to choose the selected item. more |
| ScEditor.SetAutoCIgnoreCase(bool value) | Set whether case is significant when performing auto-completion searches. more |
| ScEditor.SetAutoCMaxHeight(int value) | Set the maximum height, in rows, of auto-completion and user lists. The default is 5 rows. more |
| ScEditor.SetAutoCMaxWidth(int value) | 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. more |
| ScEditor.SetAutoCMulti(int value) | Change the effect of autocompleting when there are multiple selections. more |
| ScEditor.SetAutoCOrder(int value) | Set the way autocompletion lists are ordered. more |
| ScEditor.SetAutoCSeparator(int value) | Change the separator character in the string setting up an auto-completion list. Default is space but can be changed if items contain space. more |
| ScEditor.SetAutoCTypeSeparator(int value) | Change the type-separator character in the string setting up an auto-completion list. Default is '?' but can be changed if items contain '?'. more |
| User lists | |
|---|---|
| ScEditor.UserListShow(int listType, string itemList) | Display a list of strings and send notification when user chooses one. more |
| Call tips | |
|---|---|
| bool ScEditor.CallTipActive() | Is there an active call tip? more |
| ScEditor.CallTipCancel() | Remove the call tip from the screen. more |
| int ScEditor.CallTipPosStart() | Retrieve the position where the caret was before displaying the call tip. more |
| ScEditor.CallTipSetHlt(int start, int end) | Highlight a segment of the definition. more |
| ScEditor.CallTipShow(int pos, string definition) | Show a call tip containing a definition near position pos. more |
| ScEditor.SetCallTipBack(colour value) | Set the background colour for the call tip. more |
| ScEditor.SetCallTipFore(colour value) | Set the foreground colour for the call tip. more |
| ScEditor.SetCallTipForeHlt(colour value) | Set the foreground colour for the highlighted part of the call tip. more |
| ScEditor.SetCallTipPosStart(int value) | Set the start position in order to change when backspacing removes the calltip. more |
| ScEditor.SetCallTipPosition(bool value) | Set position of calltip, above or below text. more |
| ScEditor.SetCallTipUseStyle(int value) | Enable use of STYLE_CALLTIP and set call tip tab size in pixels. more |
| Printing | |
|---|---|
| int ScEditor.GetPrintColourMode() | Returns the print colour mode. more |
| int ScEditor.GetPrintMagnification() | Returns the print magnification. more |
| int ScEditor.GetPrintWrapMode() | Is printing line wrapped? more |
| ScEditor.SetPrintColourMode(int value) | Modify colours when printing for clearer printed text. more |
| ScEditor.SetPrintMagnification(int value) | Sets the print magnification added to the point size of each style for printing. more |
| ScEditor.SetPrintWrapMode(int value) | Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE). more |
| Folding | |
|---|---|
| int ScEditor.ContractedFoldNext(int lineStart) | Find the next line at or after lineStart that is a contracted fold header line. Return -1 when no more lines. more |
| int ScEditor.DocLineFromVisible(int lineDisplay) | Find the document line of a display line taking hidden lines into account. more |
| ScEditor.EnsureVisible(int line) | Ensure a particular line is visible by expanding any header line hiding it. more |
| ScEditor.EnsureVisibleEnforcePolicy(int line) | 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. more |
| ScEditor.ExpandChildren(int line, int level) | Expand a fold header and all children. Use the level argument instead of the line's current level. more |
| ScEditor.FoldAll(int action) | Expand or contract all fold headers. more |
| ScEditor.FoldChildren(int line, int action) | Expand or contract a fold header and its children. more |
| ScEditor.FoldLine(int line, int action) | Expand or contract a fold header. more |
| bool ScEditor.GetAllLinesVisible() | Are all lines visible? more |
| int ScEditor.GetAutomaticFold() | Get automatic folding behaviours. more |
| bool ScEditor.GetFoldExpanded(int line) | Is a header line expanded? more |
| int ScEditor.GetFoldLevel(int line) | Retrieve the fold level of a line. more |
| int ScEditor.GetFoldParent(int line) | Find the parent line of a child line. more |
| int ScEditor.GetLastChild(int line, int level) | Find the last child line of a header line. more |
| bool ScEditor.GetLineVisible(int line) | Is a line visible? more |
| ScEditor.HideLines(int lineStart, int lineEnd) | Make a range of lines invisible. more |
| ScEditor.SetAutomaticFold(int value) | Set automatic folding behaviours. more |
| ScEditor.SetFoldExpanded(int line, bool value) | Show the children of a header line. more |
| ScEditor.SetFoldFlags(int value) | Set some style options for folding. more |
| ScEditor.SetFoldLevel(int line, int value) | 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. more |
| ScEditor.ShowLines(int lineStart, int lineEnd) | Make a range of lines visible. more |
| ScEditor.ToggleFold(int line) | Switch a header line between expanded and contracted. more |
| int ScEditor.VisibleFromDocLine(int line) | Find the display line of a document line taking hidden lines into account. more |
| Line wrapping | |
|---|---|
| int ScEditor.GetLayoutCache() | Retrieve the degree of caching of layout information. more |
| int ScEditor.GetPositionCache() | How many entries are allocated to the position cache? more |
| int ScEditor.GetWrapIndentMode() | Retrieve how wrapped sublines are placed. Default is fixed. more |
| int ScEditor.GetWrapMode() | Retrieve whether text is word wrapped. more |
| int ScEditor.GetWrapStartIndent() | Retrive the start indent for wrapped lines. more |
| int ScEditor.GetWrapVisualFlags() | Retrive the display mode of visual flags for wrapped lines. more |
| int ScEditor.GetWrapVisualFlagsLocation() | Retrive the location of visual flags for wrapped lines. more |
| ScEditor.LinesJoin() | Join the lines in the target. more |
| ScEditor.LinesSplit(int pixelWidth) | Split the lines in the target into lines that are less wide than pixelWidth where possible. more |
| ScEditor.SetLayoutCache(int value) | Sets the degree of caching of layout information. more |
| ScEditor.SetPositionCache(int value) | Set number of entries in position cache more |
| ScEditor.SetWrapIndentMode(int value) | Sets how wrapped sublines are placed. Default is fixed. more |
| ScEditor.SetWrapMode(int value) | Sets whether text is word wrapped. more |
| ScEditor.SetWrapStartIndent(int value) | Set the start indent for wrapped lines. more |
| ScEditor.SetWrapVisualFlags(int value) | Set the display mode of visual flags for wrapped lines. more |
| ScEditor.SetWrapVisualFlagsLocation(int value) | Set the location of visual flags for wrapped lines. more |
| int ScEditor.WrapCount(int line) | The number of display lines needed to wrap a document line more |
| Zooming | |
|---|---|
| int ScEditor.GetZoom() | Retrieve the zoom level. more |
| ScEditor.SetZoom(int value) | 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. more |
| ScEditor.ZoomIn() | Magnify the displayed text by increasing the sizes by 1 point. more |
| ScEditor.ZoomOut() | Make the displayed text smaller by decreasing the sizes by 1 point. more |
| Long lines | |
|---|---|
| colour ScEditor.GetEdgeColour() | Retrieve the colour used in edge indication. more |
| int ScEditor.GetEdgeColumn() | Retrieve the column number which text should be kept within. more |
| int ScEditor.GetEdgeMode() | Retrieve the edge highlight mode. more |
| ScEditor.SetEdgeColour(colour value) | Change the colour used in edge indication. more |
| ScEditor.SetEdgeColumn(int value) | Set the column number of the edge. If text goes past the edge then it is highlighted. more |
| ScEditor.SetEdgeMode(int value) | The edge may be displayed by a line (EDGE_LINE) or by highlighting text that goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE). more |
| Lexer | |
|---|---|
| int ScEditor.AllocateSubStyles(int styleBase, int numberStyles) | Allocate a set of sub styles for a particular base style, returning start of range more |
| int ScEditor.ChangeLexerState(int start, int end) | Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw. more |
| ScEditor.Colourise(int start, int end) | Colourise a segment of the document using the current lexing language. more |
| string,int ScEditor.DescribeKeyWordSets() | Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer. more |
| string,int ScEditor.DescribeProperty(string name) | Describe a property. more |
| ScEditor.FreeSubStyles() | Free allocated sub styles more |
| int ScEditor.GetDistanceToSecondaryStyles() | Where styles are duplicated by a feature such as active/inactive code return the distance between the two types. more |
| int ScEditor.GetLexer() | Retrieve the lexing language of the document. more |
| string ScEditor.GetLexerLanguage() | Retrieve the name of the lexer. Return the length of the text. more |
| int ScEditor.GetPrimaryStyleFromStyle(int style) | For a secondary style, return the primary style, else return the argument. more |
| string ScEditor.GetProperty(string key) | Retrieve a "property" value previously set with SetProperty. more |
| string ScEditor.GetPropertyExpanded(string key) | Retrieve a "property" value previously set with SetProperty, with "$()" variable replacement on returned buffer. more |
| int ScEditor.GetPropertyInt(string key) | Retrieve a "property" value previously set with SetProperty, interpreted as an int AFTER any "$()" variable replacement. more |
| int ScEditor.GetStyleFromSubStyle(int subStyle) | For a sub style, return the base style, else return the argument. more |
| string ScEditor.GetSubStyleBases() | Get the set of base styles that can be extended with sub styles more |
| int ScEditor.GetSubStylesLength(int styleBase) | The number of sub styles associated with a base style more |
| int ScEditor.GetSubStylesStart(int styleBase) | The starting style number for the sub styles associated with a base style more |
| ScEditor.LoadLexerLibrary(string path) | Load a lexer library (dll / so). more |
| string,int ScEditor.PropertyNames() | Retrieve a '\n' separated list of properties understood by the current lexer. more |
| int ScEditor.PropertyType(string name) | Retrieve the type of a property. more |
| ScEditor.SetIdentifiers(int style, string value) | Set the identifiers that are shown in a particular style more |
| ScEditor.SetKeyWords(int keywordSet, string value) | Set up the key words used by the lexer. more |
| ScEditor.SetLexer(int value) | Set the lexing language of the document. more |
| ScEditor.SetLexerLanguage(string value) | Set the lexing language of the document based on string name. more |
| ScEditor.SetProperty(string key, string value) | Set up a value that may be used by a lexer for some optional feature. more |
| Commands typically bound to key presses | |
|---|---|
| ScEditor.BackTab() | Dedent the selected lines. more |
| ScEditor.Cancel() | Cancel any modes such as call tip or auto-completion list display. more |
| ScEditor.CharLeft() | Move caret left one character. more |
| ScEditor.CharLeftExtend() | Move caret left one character extending selection to new caret position. more |
| ScEditor.CharLeftRectExtend() | Move caret left one character, extending rectangular selection to new caret position. more |
| ScEditor.CharRight() | Move caret right one character. more |
| ScEditor.CharRightExtend() | Move caret right one character extending selection to new caret position. more |
| ScEditor.CharRightRectExtend() | Move caret right one character, extending rectangular selection to new caret position. more |
| ScEditor.DelWordLeft() | Delete the word to the left of the caret. more |
| ScEditor.DelWordRight() | Delete the word to the right of the caret. more |
| ScEditor.DelWordRightEnd() | Delete the word to the right of the caret, but not the trailing non-word characters. more |
| ScEditor.DeleteBack() | Delete the selection or if no selection, the character before the caret. more |
| ScEditor.DocumentEnd() | Move caret to last position in document. more |
| ScEditor.DocumentEndExtend() | Move caret to last position in document extending selection to new caret position. more |
| ScEditor.DocumentStart() | Move caret to first position in document. more |
| ScEditor.DocumentStartExtend() | Move caret to first position in document extending selection to new caret position. more |
| ScEditor.Home() | Move caret to first position on line. more |
| ScEditor.HomeExtend() | Move caret to first position on line extending selection to new caret position. more |
| ScEditor.HomeRectExtend() | Move caret to first position on line, extending rectangular selection to new caret position. more |
| ScEditor.HomeWrap() | These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?. more |
| ScEditor.HomeWrapExtend() | These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?. more |
| ScEditor.LineCopy() | Copy the line containing the caret. more |
| ScEditor.LineCut() | Cut the line containing the caret. more |
| ScEditor.LineDelete() | Delete the line containing the caret. more |
| ScEditor.LineDown() | Move caret down one line. more |
| ScEditor.LineDownExtend() | Move caret down one line extending selection to new caret position. more |
| ScEditor.LineDownRectExtend() | Move caret down one line, extending rectangular selection to new caret position. more |
| ScEditor.LineDuplicate() | Duplicate the current line. more |
| ScEditor.LineEnd() | Move caret to last position on line. more |
| ScEditor.LineEndDisplay() | Move caret to last position on display line. more |
| ScEditor.LineEndDisplayExtend() | Move caret to last position on display line extending selection to new caret position. more |
| ScEditor.LineEndExtend() | Move caret to last position on line extending selection to new caret position. more |
| ScEditor.LineEndRectExtend() | Move caret to last position on line, extending rectangular selection to new caret position. more |
| ScEditor.LineEndWrap() | These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?. more |
| ScEditor.LineEndWrapExtend() | These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?. more |
| ScEditor.LineScrollDown() | Scroll the document down, keeping the caret visible. more |
| ScEditor.LineScrollUp() | Scroll the document up, keeping the caret visible. more |
| ScEditor.LineTranspose() | Switch the current line with the previous. more |
| ScEditor.LineUp() | Move caret up one line. more |
| ScEditor.LineUpExtend() | Move caret up one line extending selection to new caret position. more |
| ScEditor.LineUpRectExtend() | Move caret up one line, extending rectangular selection to new caret position. more |
| ScEditor.LowerCase() | Transform the selection to lower case. more |
| ScEditor.NewLine() | Insert a new line, may use a CRLF, CR or LF depending on EOL mode. more |
| ScEditor.PageDown() | Move caret one page down. more |
| ScEditor.PageDownExtend() | Move caret one page down extending selection to new caret position. more |
| ScEditor.PageDownRectExtend() | Move caret one page down, extending rectangular selection to new caret position. more |
| ScEditor.PageUp() | Move caret one page up. more |
| ScEditor.PageUpExtend() | Move caret one page up extending selection to new caret position. more |
| ScEditor.PageUpRectExtend() | Move caret one page up, extending rectangular selection to new caret position. more |
| ScEditor.ParaDown() | Move caret between paragraphs (delimited by empty lines). more |
| ScEditor.ParaDownExtend() | Move caret between paragraphs (delimited by empty lines). more |
| ScEditor.ParaUp() | Move caret between paragraphs (delimited by empty lines). more |
| ScEditor.ParaUpExtend() | Move caret between paragraphs (delimited by empty lines). more |
| int ScEditor.PrivateLexerCall(int operation, int pointer) | For private communication between an application and a known lexer. more |
| ScEditor.ScrollToEnd() | Scroll to end of document. more |
| ScEditor.ScrollToStart() | Scroll to start of document. more |
| ScEditor.SelectionDuplicate() | Duplicate the selection. If selection empty duplicate the line containing the caret. more |
| ScEditor.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. more |
| ScEditor.UpperCase() | Transform the selection to upper case. more |
| ScEditor.VCHome() | Move caret to before first visible character on line. If already there move to first character on line. more |
| ScEditor.VCHomeDisplay() | Move caret to before first visible character on display line. If already there move to first character on display line. more |
| ScEditor.VCHomeDisplayExtend() | Like VCHomeDisplay but extending selection to new caret position. more |
| ScEditor.VCHomeExtend() | Like VCHome but extending selection to new caret position. more |
| ScEditor.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. more |
| ScEditor.VCHomeWrap() | These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?. more |
| ScEditor.VCHomeWrapExtend() | These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?. more |
| ScEditor.WordLeft() | Move caret left one word. more |
| ScEditor.WordLeftEnd() | Move caret left one word, position cursor at end of word. more |
| ScEditor.WordLeftEndExtend() | Move caret left one word, position cursor at end of word, extending selection to new caret position. more |
| ScEditor.WordLeftExtend() | Move caret left one word extending selection to new caret position. more |
| ScEditor.WordPartLeft() | Move to the previous change in capitalisation. more |
| ScEditor.WordPartLeftExtend() | Move to the previous change in capitalisation extending selection to new caret position. more |
| ScEditor.WordPartRight() | Move to the change next in capitalisation. more |
| ScEditor.WordPartRightExtend() | Move to the next change in capitalisation extending selection to new caret position. more |
| ScEditor.WordRight() | Move caret right one word. more |
| ScEditor.WordRightEnd() | Move caret right one word, position cursor at end of word. more |
| ScEditor.WordRightEndExtend() | Move caret right one word, position cursor at end of word, extending selection to new caret position. more |
| ScEditor.WordRightExtend() | Move caret right one word extending selection to new caret position. more |
| Constants |
|---|
| int ScConst.MakeKeymod(keycode, bool shift, bool ctrl, bool alt) |
| int ScConst.MakeColor(byte red, byte green, byte blue) |
| tuple ScConst.GetColor(int v) |
| ScConst.StopEventPropagation |
| ScConst.ANNOTATION_BOXED |
| ScConst.ANNOTATION_HIDDEN |
| ScConst.ANNOTATION_INDENTED |
| ScConst.ANNOTATION_STANDARD |
| ScConst.CARETSTYLE_BLOCK |
| ScConst.CARETSTYLE_INVISIBLE |
| ScConst.CARETSTYLE_LINE |
| ScConst.CARET_EVEN |
| ScConst.CARET_JUMPS |
| ScConst.CARET_SLOP |
| ScConst.CARET_STRICT |
| ScConst.EDGE_BACKGROUND |
| ScConst.EDGE_LINE |
| ScConst.EDGE_NONE |
| ScConst.INDIC0_MASK |
| ScConst.INDIC1_MASK |
| ScConst.INDIC2_MASK |
| ScConst.INDICS_MASK |
| ScConst.INDIC_BOX |
| ScConst.INDIC_COMPOSITIONTHICK |
| ScConst.INDIC_COMPOSITIONTHIN |
| ScConst.INDIC_CONTAINER |
| ScConst.INDIC_DASH |
| ScConst.INDIC_DIAGONAL |
| ScConst.INDIC_DOTBOX |
| ScConst.INDIC_DOTS |
| ScConst.INDIC_FULLBOX |
| ScConst.INDIC_HIDDEN |
| ScConst.INDIC_IME |
| ScConst.INDIC_IME_MAX |
| ScConst.INDIC_MAX |
| ScConst.INDIC_PLAIN |
| ScConst.INDIC_ROUNDBOX |
| ScConst.INDIC_SQUIGGLE |
| ScConst.INDIC_SQUIGGLELOW |
| ScConst.INDIC_SQUIGGLEPIXMAP |
| ScConst.INDIC_STRAIGHTBOX |
| ScConst.INDIC_STRIKE |
| ScConst.INDIC_TEXTFORE |
| ScConst.INDIC_TT |
| ScConst.INVALID_POSITION |
| ScConst.KEYWORDSET_MAX |
| ScConst.MARKER_MAX |
| ScConst.SCEN_CHANGE |
| ScConst.SCEN_KILLFOCUS |
| ScConst.SCEN_SETFOCUS |
| ScConst.SCFIND_CXX11REGEX |
| ScConst.SCFIND_MATCHCASE |
| ScConst.SCFIND_POSIX |
| ScConst.SCFIND_REGEXP |
| ScConst.SCFIND_WHOLEWORD |
| ScConst.SCFIND_WORDSTART |
| ScConst.SCMOD_ALT |
| ScConst.SCMOD_CTRL |
| ScConst.SCMOD_META |
| ScConst.SCMOD_NORM |
| ScConst.SCMOD_SHIFT |
| ScConst.SCMOD_SUPER |
| ScConst.SCVS_NONE |
| ScConst.SCVS_RECTANGULARSELECTION |
| ScConst.SCVS_USERACCESSIBLE |
| ScConst.SCWS_INVISIBLE |
| ScConst.SCWS_VISIBLEAFTERINDENT |
| ScConst.SCWS_VISIBLEALWAYS |
| ScConst.SCWS_VISIBLEONLYININDENT |
| ScConst.SC_ALPHA_NOALPHA |
| ScConst.SC_ALPHA_OPAQUE |
| ScConst.SC_ALPHA_TRANSPARENT |
| ScConst.SC_AUTOMATICFOLD_CHANGE |
| ScConst.SC_AUTOMATICFOLD_CLICK |
| ScConst.SC_AUTOMATICFOLD_SHOW |
| ScConst.SC_CACHE_CARET |
| ScConst.SC_CACHE_DOCUMENT |
| ScConst.SC_CACHE_NONE |
| ScConst.SC_CACHE_PAGE |
| ScConst.SC_CARETSTICKY_OFF |
| ScConst.SC_CARETSTICKY_ON |
| ScConst.SC_CARETSTICKY_WHITESPACE |
| ScConst.SC_CASEINSENSITIVEBEHAVIOUR_IGNORECASE |
| ScConst.SC_CASEINSENSITIVEBEHAVIOUR_RESPECTCASE |
| ScConst.SC_CASE_CAMEL |
| ScConst.SC_CASE_LOWER |
| ScConst.SC_CASE_MIXED |
| ScConst.SC_CASE_UPPER |
| ScConst.SC_CHARSET_8859_15 |
| ScConst.SC_CHARSET_ANSI |
| ScConst.SC_CHARSET_ARABIC |
| ScConst.SC_CHARSET_BALTIC |
| ScConst.SC_CHARSET_CHINESEBIG5 |
| ScConst.SC_CHARSET_CYRILLIC |
| ScConst.SC_CHARSET_DEFAULT |
| ScConst.SC_CHARSET_EASTEUROPE |
| ScConst.SC_CHARSET_GB2312 |
| ScConst.SC_CHARSET_GREEK |
| ScConst.SC_CHARSET_HANGUL |
| ScConst.SC_CHARSET_HEBREW |
| ScConst.SC_CHARSET_JOHAB |
| ScConst.SC_CHARSET_MAC |
| ScConst.SC_CHARSET_OEM |
| ScConst.SC_CHARSET_OEM866 |
| ScConst.SC_CHARSET_RUSSIAN |
| ScConst.SC_CHARSET_SHIFTJIS |
| ScConst.SC_CHARSET_SYMBOL |
| ScConst.SC_CHARSET_THAI |
| ScConst.SC_CHARSET_TURKISH |
| ScConst.SC_CHARSET_VIETNAMESE |
| ScConst.SC_CP_UTF8 |
| ScConst.SC_CURSORARROW |
| ScConst.SC_CURSORNORMAL |
| ScConst.SC_CURSORREVERSEARROW |
| ScConst.SC_CURSORWAIT |
| ScConst.SC_EFF_QUALITY_ANTIALIASED |
| ScConst.SC_EFF_QUALITY_DEFAULT |
| ScConst.SC_EFF_QUALITY_LCD_OPTIMIZED |
| ScConst.SC_EFF_QUALITY_MASK |
| ScConst.SC_EFF_QUALITY_NON_ANTIALIASED |
| ScConst.SC_EOL_CR |
| ScConst.SC_EOL_CRLF |
| ScConst.SC_EOL_LF |
| ScConst.SC_FOLDACTION_CONTRACT |
| ScConst.SC_FOLDACTION_EXPAND |
| ScConst.SC_FOLDACTION_TOGGLE |
| ScConst.SC_FOLDLEVELBASE |
| ScConst.SC_FOLDLEVELHEADERFLAG |
| ScConst.SC_FOLDLEVELNUMBERMASK |
| ScConst.SC_FOLDLEVELWHITEFLAG |
| ScConst.SC_FONT_SIZE_MULTIPLIER |
| ScConst.SC_IDLESTYLING_AFTERVISIBLE |
| ScConst.SC_IDLESTYLING_ALL |
| ScConst.SC_IDLESTYLING_NONE |
| ScConst.SC_IDLESTYLING_TOVISIBLE |
| ScConst.SC_IME_INLINE |
| ScConst.SC_IME_WINDOWED |
| ScConst.SC_INDICFLAG_VALUEFORE |
| ScConst.SC_INDICVALUEBIT |
| ScConst.SC_INDICVALUEMASK |
| ScConst.SC_IV_LOOKBOTH |
| ScConst.SC_IV_LOOKFORWARD |
| ScConst.SC_IV_NONE |
| ScConst.SC_IV_REAL |
| ScConst.SC_LINE_END_TYPE_DEFAULT |
| ScConst.SC_LINE_END_TYPE_UNICODE |
| ScConst.SC_MARGINOPTION_NONE |
| ScConst.SC_MARGINOPTION_SUBLINESELECT |
| ScConst.SC_MARGIN_BACK |
| ScConst.SC_MARGIN_FORE |
| ScConst.SC_MARGIN_NUMBER |
| ScConst.SC_MARGIN_RTEXT |
| ScConst.SC_MARGIN_SYMBOL |
| ScConst.SC_MARGIN_TEXT |
| ScConst.SC_MASK_FOLDERS |
| ScConst.SC_MAX_MARGIN |
| ScConst.SC_MULTIAUTOC_EACH |
| ScConst.SC_MULTIAUTOC_ONCE |
| ScConst.SC_MULTIPASTE_EACH |
| ScConst.SC_MULTIPASTE_ONCE |
| ScConst.SC_ORDER_CUSTOM |
| ScConst.SC_ORDER_PERFORMSORT |
| ScConst.SC_ORDER_PRESORTED |
| ScConst.SC_PHASES_MULTIPLE |
| ScConst.SC_PHASES_ONE |
| ScConst.SC_PHASES_TWO |
| ScConst.SC_PRINT_BLACKONWHITE |
| ScConst.SC_PRINT_COLOURONWHITE |
| ScConst.SC_PRINT_COLOURONWHITEDEFAULTBG |
| ScConst.SC_PRINT_INVERTLIGHT |
| ScConst.SC_PRINT_NORMAL |
| ScConst.SC_SEL_LINES |
| ScConst.SC_SEL_RECTANGLE |
| ScConst.SC_SEL_STREAM |
| ScConst.SC_SEL_THIN |
| ScConst.SC_STATUS_BADALLOC |
| ScConst.SC_STATUS_FAILURE |
| ScConst.SC_STATUS_OK |
| ScConst.SC_STATUS_WARN_REGEX |
| ScConst.SC_STATUS_WARN_START |
| ScConst.SC_TECHNOLOGY_DEFAULT |
| ScConst.SC_TECHNOLOGY_DIRECTWRITE |
| ScConst.SC_TECHNOLOGY_DIRECTWRITEDC |
| ScConst.SC_TECHNOLOGY_DIRECTWRITERETAIN |
| ScConst.SC_TIME_FOREVER |
| ScConst.SC_TYPE_BOOLEAN |
| ScConst.SC_TYPE_INTEGER |
| ScConst.SC_TYPE_STRING |
| ScConst.SC_WEIGHT_BOLD |
| ScConst.SC_WEIGHT_NORMAL |
| ScConst.SC_WEIGHT_SEMIBOLD |
| ScConst.SC_WRAPINDENT_FIXED |
| ScConst.SC_WRAPINDENT_INDENT |
| ScConst.SC_WRAPINDENT_SAME |
| ScConst.SC_WRAPVISUALFLAGLOC_DEFAULT |
| ScConst.SC_WRAPVISUALFLAGLOC_END_BY_TEXT |
| ScConst.SC_WRAPVISUALFLAGLOC_START_BY_TEXT |
| ScConst.SC_WRAPVISUALFLAG_END |
| ScConst.SC_WRAPVISUALFLAG_MARGIN |
| ScConst.SC_WRAPVISUALFLAG_NONE |
| ScConst.SC_WRAPVISUALFLAG_START |
| ScConst.SC_WRAP_CHAR |
| ScConst.SC_WRAP_NONE |
| ScConst.SC_WRAP_WHITESPACE |
| ScConst.SC_WRAP_WORD |
| ScConst.STYLE_BRACEBAD |
| ScConst.STYLE_BRACELIGHT |
| ScConst.STYLE_CALLTIP |
| ScConst.STYLE_CONTROLCHAR |
| ScConst.STYLE_DEFAULT |
| ScConst.STYLE_INDENTGUIDE |
| ScConst.STYLE_LASTPREDEFINED |
| ScConst.STYLE_LINENUMBER |
| ScConst.STYLE_MAX |
| ScConst.UNDO_MAY_COALESCE |
| ScConst.VISIBLE_SLOP |
| ScConst.VISIBLE_STRICT |
- See also:
- User strips (e.g.
RegexPreviewTool()in scite-with-python source) - Interactive context menus (e.g.
reopenClosedTab()in scite-with-python source) - Register for callbacks (e.g.
customcommandsregisterin scite-with-python source)
- User strips (e.g.
Back