SyntaxEdit Class
Definition
Represents advanced multi-line text edit control.
Implements
Syntax
[ToolboxBitmap(typeof(SyntaxEdit), "Images.TextEditor.Icon.bmp")]
public class SyntaxEdit : Control, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, ISyntaxEdit, ISearch, ITextSearch, IEditNotifier, INotifier, ICaret, IEditNavigate, INavigate, IEdit, IUpdate, IWordWrap, ITextExport, IExport, ITextImport, IImport, ICodeCompletion, IFindReferences, IRecordPlayBack, ISplitView, IAutoCorrect, IControl
Remarks
SyntaxEdit is a multi-line WindowsForms text edit control that provides text editing functionality and supports advanced text editing features. These include customizable syntax highlighting, IntelliSense, code outlining, unlimited undo/redo, bookmarks, word wrap, drag-n-drop, built-in search/replace dialogs, multiple views of the text, and more.
Here are some of the essential features provided by the editor:
- IntelliSense (Code completion)
- Code outlining (collapsible code regions)
- Syntax highlighting
- Errors and warnings highlighting
- Code snippets
- Scroll bar annotations
- Search and replace
- Word wrapping
- Bookmarks
- The gutter area with indicators
- Multiple views and split view
- Customizable appearance, including line styles
- Printing and print preview support
- Stream and Block selection modes
- Multi-level undo/redo
- Whitespace display
Set the Text property to specify the string collection as a single string with the individual lines delimited by a carriage return.
Use the LoadFile or LoadStream methods to load text content into the edit control.
Set Lexer property to specify Parser component that will perform syntax highlighting and optionally provide advanced capabilities such as code completion, code outlining, and syntax error reporting.
Examples
Here is how to declare a SyntaxEdit from the C# code and add event handler to handle clicking on hyper-text urls.
public partial class Form1 : Form
{
private void Form1_Load(object sender, EventArgs e)
{
var syntaxEdit1 = new Alternet.Editor.SyntaxEdit(this.components);
syntaxEdit1.Dock = System.Windows.Forms.DockStyle.Fill;
syntaxEdit1.LoadFile("myfile.txt");
syntaxEdit1.HyperText.HighlightHyperText = true;
syntaxEdit1.JumpToUrl += new Alternet.Editor.UrlJumpEvent(this.SyntaxEdit1_JumpToUrl);
}
private void SyntaxEdit1_JumpToUrl(object sender, UrlJumpEventArgs e)
{
if (chbCustomHypertext.Checked)
{
MessageBox.Show(e.Text);
e.Handled = true;
}
}
}
Here is how to declare a SyntaxEdit from the Visual Basic code and add event handler to handle clicking on hyper-text urls.
Public Partial Class Form1
Inherits Form
Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
Dim syntaxEdit1 = New Alternet.Editor.SyntaxEdit(Me.components)
syntaxEdit1.Dock = System.Windows.Forms.DockStyle.Fill
syntaxEdit1.LoadFile("myfile.txt")
syntaxEdit1.HyperText.HighlightHyperText = True
AddHandler syntaxEdit1.JumpToUrl, New Alternet.Editor.UrlJumpEvent(AddressOf Me.SyntaxEdit1_JumpToUrl)
End Sub
Private Sub SyntaxEdit1_JumpToUrl(ByVal sender As Object, ByVal e As UrlJumpEventArgs)
If chbCustomHypertext.Checked Then
MessageBox.Show(e.Text)
e.Handled = True
End If
End Sub
End Class
Constructors
SyntaxEdit() | Initializes a new instance of the |
SyntaxEdit(IContainer) | Initializes a new instance of the |
Properties
AcceptReturns | Gets or set a boolean value that indicates whether Enter key should be accepted by SyntaxEdit control as input key. |
AcceptTabs | Gets or set a boolean value that indicates whether TAB key should be accepted by SyntaxEdit control as input key. |
ActiveOutlineRange | Gets currently highlighted outlined range. |
AllowDrop | Gets or sets a value indicating whether the control can accept data that the user drags onto it. |
AutoCorrectDelimiters | Gets or sets an array of chars that used as word delimiters. |
AutoCorrection | Gets or sets a boolean value indicating whether to auto correct words being typed. |
BorderColor | Gets or sets the border color for the SyntaxEdit control. |
BorderStyle | Gets or sets the border style for the SyntaxEdit control. |
BorderWidth | Gets or sets the border width for the SyntaxEdit control. |
Braces | Represents an object that implements |
CharsInWidth | Returns number of characters painted with current font that will fit into control's client area. |
ClientArea | Gets the rectangle that represents the client area of the SyntaxEdit control. Non-client areas area like rulers are excluded. |
ClientHeight | Gets the width of the client area of the SyntaxEdit control. |
ClientRect | Gets the rectangle that represents the client area of the SyntaxEdit control. |
ClientWidth | Gets the width of the client area of the SyntaxEdit control. |
CodeCompletionBox | Represents object that specifies a popup window that contains code completion information presented in the form of list. |
CodeCompletionButton | Represents object that specifies a popup window that contains code completion information presented in the form of list. |
CodeCompletionChars | Represents a collection of characters that initializes a code completion procedure when typing in the editor. |
CodeCompletionHint | Represents object that specifies a popup window that contains code completion information presented in the form of the tooltip. |
CodeCompletionMode | Gets or sets code completion box mode. |
CodeCompletionTimer | |
CreateParams | |
CurrentBlockRange | Gets currently highlighted block range. |
Cursor | |
DefaultMenu | Gets or sets default context menu for the editor control. |
DisplayLines | Represents the object that implements |
EditMargin | Represents an object that implements |
EffectiveVisualTheme | Gets current visual theme. |
EventHandlers | Represents object that holds |
FirstSearch | Gets or sets a value indicating whether control launches text search at first. |
Font | When implemented by a class, gets or sets the font of the text displayed by the control. |
GotoLineDialog | Gets or sets a dialog prompting for index of the line you need to locate. |
Gutter | Represents object that implements |
HideCaret | Gets or sets a value indicating whether the control should display caret when it has input focus. |
HideWhiteSpaceCursor | |
HighlightCurrentBlock | Specifies that SyntaxEdit control should highlight current block. |
HighlightMatchingBlocks | Specifies that SyntaxEdit control should highlight begin/end blocks. |
HighlightReferences | Specifies that SyntaxEdit control should highlight found references. |
HighlightSearchResults | Indicates whether search results are highlighted while the search dialog is open. |
HighlightSymbolReferences | Specifies that SyntaxEdit control should highlight symbol references when hovering mouse over them. |
HorzSplitEdit | Represents horizontal split view control. |
HorzSplitter | Represents a horizontal Splitter control allowing to split Edit content horizontally. |
HyperText | Represents object that implements |
IncrementalSearchCursor | |
IncrementalSearchString | Return text to search if class is in incremental search state; otherwise return empty string. |
InCycledSearch | Indicates whether control is in incremental search state. |
IndentOptions | Gets or sets |
InIncrementalSearch | Indicates whether control is in incremental search state. |
InnerTextSource | Gets inner text source |
IsCodeCompletionWindowFocused | Indicates whether |
IsFocused | |
IsSearchFocused | Gets a boolean value indicating whether search dialog box has input focus. |
IsTransparent | |
KeepCaretOnLostFocus | Keeps caret in visible state even SyntaxEdit control lost focus. |
KeyList | Represents object that implements |
LeftArrowCursor | |
Lexer | Gets or sets an object that can make lexical analysis for the control's content. |
Lines | Represents object that implements |
LineSeparator | Represents an object that implements |
LinesInHeight | Determines how many lines can fit into control's client area. |
LineSpace | Gets or sets line space between individual lines in the SyntaxEdit control. |
LineStyles | Represents an object that implements |
LineTerminator | Gets or sets a string value that terminates line. |
MacroRecording | Gets or sets a boolean value indicating whether SyntaxEdit control should record sequence of keyboard commands. |
MacroRecords | Represents an array containing keyboard commands. |
MacroSuspendend | Gets or sets a boolean value indicating whether recording is suspended. |
MaxLength | Specifies the maximum number of characters that can be entered into the SyntaxEdit control. |
Minimap | Represents object that implements |
Modified | Gets or sets a value indicating whether the control's text content is modified. |
NavigateOptions | Gets or sets navigating options. |
OpenSharedEditorFunc | Gets or sets a function that open |
Outlining | Represents an object that implements |
Overwrite | Gets or sets a value indicating whether the inserted text overwrites existing text. |
Pages | Represents an object that implements |
Painter | Represents an object that implements |
Position | Gets or sets the current position within the control's text content. |
PrevPosition | Gets previous position within the control's text content. |
Printing | Represents an object that implements |
ReadOnly | Gets or sets a value indicating whether the control's content is read-only. |
ReverseIncrementalSearchCursor | |
Scrolling | Represents an object that implements |
SearchDialog | Gets or sets a dialog box allowing to search for the text or replace it. |
SearchDialogAppearance | |
SearchGlobal | Gets or sets a value indicating whether search should be global. |
SearchLen | Represents length of the last found text. |
SearchOptions | Gets or sets a value that defines search and replace options. |
SearchPos | Gets or sets a value that represents position of the last found text. |
Selection | Represents an object that implements |
ShowWhiteSpaceCursor | |
SingleLineMode | Gets or sets a value indicating whether the control accepts only one line of the text. |
Source | Gets or sets an object that implements |
Spelling | Represents object that implements |
Strings | Represents |
SyntaxPaint | Represents an object that implements |
Text | Gets or sets the string collection as a single string with the individual lines delimited by carriage returns. |
Transparent | Gets or sets a boolean value that indicates whether SyntaxEdit control should draw its background. |
UpdateCount | Keeps track of calls to |
UseDefaultMenu | Indicates whether SyntaxEdit control should use built in popup menu. |
VertSplitEdit | Represents an vertical split view control. |
VertSplitter | Represents a vertical Splitter control allowing to split Edit content vertically. |
VisualTheme | Gets or sets visual theme for the editor. |
VisualThemeType | Gets or sets visual theme type for the editor. |
WhiteSpace | Represents an object that implements |
WordWrap | Gets or sets a value indicating whether control automatically wraps words to the beginning of the next line when necessary. |
WrapAtMargin | Gets or sets a value indicating whether control automatically wraps words at margin position. |
WrapMargin | Gets position of the wrapping margin. |
Methods
ApplyTextChanges(IList<ITextUndo>, Boolean) | |
ApplyTheme() | |
ApplyTheme(IVisualTheme) | Applies visual theme to the SyntaxEdit control. |
ApplyThemeStyles() | |
Assign(ISyntaxEdit) | Assigns most relevant properties from another |
BeginUpdate() | Prevents editor updating until calling |
BlockDeleting(Rectangle) | |
BreakLine(Boolean) | Breaks current line into two lines. |
CancelDragging() | |
CanDeleteBlock(Rectangle) | |
CanFindNext() | Indicates whether search engine can find next occurrence of the text specified by previous search or it is only first attempt to search. |
CanFindNextSelected() | Indicates whether search engine can find next occurrence of the selected text or it is the first attempt to search. |
CanFindPrevious() | Indicates whether search engine can find previous occurrence of the text specified to search or it is the first attempt to search. |
CanFindPreviousSelected() | Indicates whether search engine can find previous occurrence of the selected text or it is the first attempt to search. |
CanSearchSelection(out String) | Returns whether search can be performed inside selection. |
CanSplit(Boolean) | |
CanSplitHorz() | Indicates whether the control can split its content horizontally. |
CanSplitVert() | Indicates whether the control can split its content vertically. |
CanUnsplit(Boolean) | |
CanUnsplitHorz() | Indicates whether control has horizontal split view. |
CanUnsplitVert() | Indicates whether control has vertical split view. |
CheckAutoCorrect() | |
CheckAutoCorrect(Point, String) | |
ClearActiveOutlineRange() | |
ClearSelection() | |
ClearSymbolReference() | |
CloseCodeCompletionBox(Object, ClosingEventArgs) | |
CloseCodeCompletionButton(Object, ClosingEventArgs) | |
CloseCodeCompletionHint(Object, ClosingEventArgs) | |
CloseCodeCompletionWindows() | |
CloseMinimapHint() | |
ClosePopupWindow() | |
CodeCompletion(CodeCompletionArgs) | Performs code completion for the specified text representing language element. |
CodeCompletion(Char, Byte, Boolean) | |
CodeCompletionAction() | |
CodeCompletionEnd() | |
CodeCompletionHintHyperTextClicked(Object, EventArgs) | |
CodeCompletionStart() | |
CodeCompletionWindowFocused(out Control) | Indicates whether |
CodeSnippets() | Displays a code completion window with list of available code snippets. |
CodeSnippets(CodeCompletionArgs) | |
CompleteCodeActions() | Displays a code completion window with list of available code fixes or code refactors. |
CompleteCodeActions(CodeCompletionArgs, Point, Point, Point, Point) | |
CompleteCodeFixes() | Displays a code completion window with list of available code fixes. |
CompleteCodeFixes(CodeCompletionArgs, Point, Point) | |
CompleteCodeRefactors() | Displays a code completion window with list of available code refactors. |
CompleteCodeRefactors(CodeCompletionArgs, Point, Point, Point) | |
CompleteWord() | Displays a code completion window that displays members of the current class in the Editor's content in a form of the popup list box and locates single member, if possible. |
CompleteWord(CodeCompletionArgs) | |
CreateBraces() | |
CreateCaret() | Creates a new shape for the system caret and gets ownership of the caret. |
CreateCodeCompletionBox() | |
CreateCodeCompletionButton() | |
CreateCodeCompletionHint() | |
CreateDisplayLines() | |
CreateEditHyperText() | |
CreateEditLineStyles() | |
CreateEditPages() | |
CreateGutter() | |
CreateHandle() | |
CreateKeyList() | |
CreateLineSeparator() | |
CreateMacroKeyList() | |
CreateMargin() | |
CreateMinimap() | |
CreateOutlining() | |
CreatePainter() | |
CreatePrinting() | |
CreateScrolling() | |
CreateSearchDialog() | |
CreateSelection() | |
CreateSpelling() | |
CreateSplitEdit(Boolean) | |
CreateSplitter(Boolean) | |
CreateSyntaxPaint() | |
CreateWhiteSpace() | |
CycledSearch(String, SearchOptions, Regex, Boolean) | Performs cycled search. |
DeleteBlock(Rectangle, Boolean) | Deletes a specified block of characters. |
DeleteLeft(Int32, Boolean) | Deletes a specified number of characters to the left of the active point. |
DeleteRight(Int32, Boolean) | Deletes a specified number of characters to the right of the active point. |
DestroyCaret() | Destroys the caret's current shape, frees the caret from the control, and removes the caret from the screen. |
DestroyCodeCompletionBox() | |
DestroyCodeCompletionButton() | |
DestroyCodeCompletionHint() | |
DisableCodeCompletionTimer() | |
DisablePositionUpdate() | Prevents notification of changing of caret position until
calling |
DisableUpdate() | Prevents editor updating until calling |
DisplayCaretNowhere() | |
DisplayDragCaret() | Displays dragging caret rather than regular caret. |
DisplayGotoLineDialog() | Initializes and runs a dialog prompting you for index of the line you need to locate. |
DisplayGotoLineDialog(IWin32Window) | Initializes and runs a dialog prompting you for index of the line you need to locate. |
DisplayModalReplaceDialog() | Initializes and runs a modal dialog box allowing you to search for text and replace it. |
DisplayModalReplaceDialog(IWin32Window) | Initializes and runs a modal dialog box allowing you to search for text and replace it. |
DisplayModalSearchDialog() | Initializes and runs a modal dialog box allowing you to search for some text. |
DisplayModalSearchDialog(IWin32Window) | Initializes and runs a modal dialog box allowing you to search for some text. |
DisplayReplaceDialog() | Initializes and runs a dialog box allowing you to search for text and replace it. |
DisplayReplaceDialog(IWin32Window) | Initializes and runs a dialog box allowing you to search for text and replace it. |
DisplaySearchDialog() | Initializes and runs a dialog box allowing you to search for some text. |
DisplaySearchDialog(IWin32Window) | Initializes and runs a dialog box allowing you to search for some text. |
DisplayToScreen(Int32, Int32) | Converts given display coordinates, index of line and character, to screen coordinates. |
DisplayToScreen(Int32, Int32, Boolean) | Converts given display coordinates, index of line and character, to screen coordinates. |
Dispose(Boolean) | |
DisposeCodeCompletionWindow(Object, EventArgs) | |
DoAutoCorrection(Point, String, String) | |
DoCodeCompletion(CodeCompletionArgs) | |
DoCodeCompletion(ISyntaxParser, Point, Boolean, CodeCompletionArgs) | |
DoCodeToolTip(String, Int32, Int32, Point, Boolean, Boolean) | |
DoCopy(Object, EventArgs) | |
DoCut(Object, EventArgs) | |
DoDelete(Object, EventArgs) | |
DoFontChanged() | |
DoHighlightAll(String, SearchOptions, Regex) | |
DoHighlightSelectedWords(String) | |
DoHighlightSymbolReferences() | |
DoHighlightSymbolReferences(Point) | |
DoMarkAll(String, SearchOptions, Regex, Boolean) | |
DoMinimapTooltip(Int32, Int32, Boolean) | |
DoOutlineToolTip(IOutlineRange, Int32, Int32) | |
DoPaste(Object, EventArgs) | |
DoPromptOnReplace(String, ref Boolean) | |
DoRedo(Object, EventArgs) | |
DoReplace(String, String, SearchOptions, Match) | |
DoReplace(String, String, SearchOptions, Match, ref Boolean) | |
DoReplace(String, String, SearchOptions, Regex, Boolean) | |
DoReplaceAll(String, String, SearchOptions, Regex, out Int32) | |
DoReplaceAll(String, String, SearchOptions, Regex, out Int32, out Boolean) | |
DoSelectAll(Object, EventArgs) | |
DoTripleClick(Object, EventArgs) | |
DoUndo(Object, EventArgs) | |
EnablePositionUpdate() | Re-enables notification of changing of caret position
that was turn of by calling |
EnableUpdate() | Re-enables editor updating, that was turn of by calling |
EndUpdate() | Re-enables outline editor updating, that was turn of by calling |
ExecuteCodeCompletion(CodeCompletionArgs) | |
Find(String) | Searches for given text within the control's contents. |
Find(String, SearchOptions) | Searches for given text within the control's contents with specified options. |
Find(String, SearchOptions, Regex) | Searches for given text within the control's contents with specified options using specified regular expression. |
Find(String, SearchOptions, Regex, Boolean, Boolean) | Searches for all occurrences of given text within the control's contents with specified options using specified regular expression. |
Find(String, SearchOptions, Regex, IList<IRange>) | Searches for all occurrences of given text within the control's contents with specified options using specified regular expression. |
Find(String, SearchOptions, Regex, ref Point, out Int32, out Match, Boolean) | Searches for given text within the control's text content. |
FindDeclaration() | Finds the declaration of the symbol at the current position |
FindDeclaration(Point) | Finds the declaration of the symbol under a given position |
FindDeclarationAsync() | Finds the declaration of the symbol at the current position. |
FindDeclarationAsync(Point) | Finds the declaration of the symbol under a given position |
FindImplementations(Point, IRangeList) | Finds all implementations of the symbol under a given position |
FindImplementationsAsync(Point, IRangeList) | Finds all implementations of the symbol under a given position |
FindNext() | Searches for the next occurrence of the text specified by previous search. |
FindNextSelected() | Searches for the next occurrence of the selected text. |
FindPrevious() | Searches for the previous occurrence of the text specified by previous search. |
FindPreviousSelected() | Searches for the previous occurrence of the selected text. |
FindReferences(Point, IRangeList) | Finds all references of the symbol under a given position |
FindReferencesAsync(Point, IRangeList) | Finds all references of the symbol under a given position |
FinishIncrementalSearch() | Leaves control from the incremental search state. StartIncrementalSearch() |
GetCaretSize(Point) | Returns size of the caret's current shape at given position. |
GetCharsInWidth(Int32) | Returns number of characters painted with current font that will fit into specified Width. |
GetCharsInWidth(Int32, Boolean) | |
GetClientRect(Boolean) | |
GetClientRectangle() | Gets the rectangle that represents the client area excluding custom border of the Edit control. |
GetClientWidth(Boolean) | |
GetEffectiveVisualTheme(VisualThemeType, IVisualTheme) | |
GetHitTest(Point, IHitTestInfo) | Fills hitTestInfo parameter by information about a part of the control at specified coordinate. |
GetHitTest(Int32, Int32, IHitTestInfo) | Fills hitTestInfo parameter by information about a part of the control at specified coordinate. |
GetHitTestAtTextPoint(Point, IHitTestInfo) | Fills hitTestInfo parameter by information about a part of control at specified text coordinate. |
GetHitTestAtTextPoint(Int32, Int32, IHitTestInfo) | Retrieves information about part of control at specified text coordinate. |
GetIndentString() | Gets indentation string at current position. |
GetInfoTipPos(Point) | |
GetLinesInHeight(Int32) | Determines how many lines can fit into given Height. |
GetOutlineHint(IOutlineRange) | |
GetReplaceString(String, Match) | |
GetSplitEdit(Boolean) | |
GetSplitter(Boolean) | |
GetTextAtCursor() | Returns word at the cursor position. |
GetTextToSearchAtCursor() | Returns word at the cursor position. |
GetWordAt(IStringItem, Int32, out Int32, out Int32) | Checks word accordingly to specified conditions. |
GetWordAtLeft(Point) | |
GetWrapMargin() | Returns position of the wrapping margin. |
HasAutoCorrection(String, out String) | Checks whether specified word has correction. |
HasCodeCompletionBox() | |
HasCodeCompletionHint() | |
HasCodeFixes(ISyntaxError) | |
HasCodeFixesAsync(ISyntaxError) | |
HideCodeActions() | |
HideDragCaret() | Hides dragging caret. |
HideScrollHint() | Hides scroll hint window if necessary. |
HighlightAll(String, SearchOptions, Regex) | Highlights all occurrences of specified string in the class text content. |
HighlightSelectedWords(String) | Highlights all occurrences of selected whole word in the class text content. |
IncrementalSearch(String) | Finds the given text incrementally. |
IncrementalSearch(String, Boolean) | Finds the given text incrementally. |
IndentLine() | Inserts spaces to the start of the current line.
Number of spaces is calculated from indent options or |
IndentLine(String, Boolean) | Inserts white space to the start of the current line. white space string Indicates if the change needs to be translated to the parser |
InitCycledSearch(SearchOptions) | |
InitDefaultMenu() | |
InitSearchPos(SearchOptions, Boolean) | |
Insert(String, Boolean) | Inserts the given string at the specified location. |
InsertBlock(ITextStrings, Boolean) | Inserts the given string collection at the specified location. |
InsertBlock(String, Boolean) | Inserts the given string at the specified location. |
InsertBlock(String[], Boolean) | Inserts the given string array at the specified location. |
InsertBlock(String[], Boolean, Boolean) | Inserts the given string array at the specified location. |
InsertCodeFix(ICodeActionItem, Boolean) | |
InsertCodeRefactor(ICodeActionItem, Boolean) | |
InsertCodeSnippet(ICodeSnippet, Point) | Inserts Code Snippet at the given position in the text |
InsertCodeSnippet(ICodeSnippet, Point, Point, Boolean) | |
InsertFromFile(String) | Inserts the file text content at the specified location. |
InsertTextFromProvider(ICodeCompletionProvider, String, Point, Point, Int32, Boolean, Boolean, Boolean) | |
InsertTextFromProvider(ICodeCompletionProvider, String, Point, ref Point, Int32, Boolean, out Point, Boolean, Boolean, Boolean, out Int32) | |
InternalProcessKey(Char) | |
InvalidateWindow(Int32, Int32, Boolean) | |
IsImmediateCompletionType(CodeCompletionType) | |
IsInputChar(Char) | |
IsInputKey(Keys) | |
IsMouseOnPageWhiteSpace(Int32, Int32) | |
IsMouseOnSyntaxError(Int32, Int32, out ISyntaxError) | |
IsSignificantMouseMove(Point, Point) | |
IsValidText(Byte) | |
IsValidText(Point) | Indicates whether text at the specified position is valid (that is does not contain comments or string constants). |
JumpToDeclaration() | Finds the declaration of the symbol under the current position and navigates to it. |
JumpToDeclarationAsync() | Finds the declaration of the symbol under the current position and navigates to it. |
KillFocus() | Ensure the caret is not visible. |
LineIsHidden(Int32) | Determines whether the given line is hidden. |
LineIsReadonly(Int32) | Determines whether the given line is readonly. |
ListMembers() | Displays a code completion window that displays members of the current class in the Editor's content in a form of the popup list box. |
ListMembers(CodeCompletionArgs) | |
ListMembers(CodeCompletionArgs, CodeCompletionType) | |
LoadFile(String) | Loads the contents of the specified file. |
LoadFile(String, IStringImport) | Loads content from the given file with specified importer. |
LoadFile(String, IStringImport, Encoding) | Loads content from the given file with specified importer and specific encoding. |
LoadFile(String, Encoding) | Loads the contents of the specified file with specified encoding. |
LoadMacros(Stream) | Loads the macro records from the given stream. |
LoadMacros(TextReader) | Loads the macro records from the given stream. |
LoadMacros(String) | Loads the macro records from the given file. |
LoadStream(Stream) | Loads the contents of the specified stream. |
LoadStream(Stream, IStringImport) | Loads the text content from the given stream with specified importer. |
LoadStream(Stream, IStringImport, Encoding) | Loads the text content from the given stream with specified importer. |
LoadStream(Stream, Encoding) | Loads the contents of the specified stream. |
LoadStream(TextReader) | Loads the contents of the specified stream. |
LoadStream(TextReader, IStringImport) | Loads the contents of the specified stream. |
MakeVisible(Point) | Scrolls the control's content, if necessary, to ensure a specified text position is in view. |
MakeVisible(Point, Boolean) | Scrolls the control's content, if necessary, to ensure a specified text position is in view. |
MarkAll(String, SearchOptions, Boolean) | Marks all occurrences of specified string in the class text content by unnumbered bookmarks and moves to the last occurrence. |
MarkAll(String, SearchOptions, Regex, Boolean) | Marks all occurrences of specified string in the class text content by unnumbered bookmarks and moves to the last occurrence. |
MarkAll(String, Boolean) | Marks all occurrences of specified string in the class text content by unnumbered bookmarks and moves to the last occurrence. |
MoveCaretOnDrag() | Moves caret to the position of drag cursor. |
MoveCharLeft() | Moves the current position one character to the left. |
MoveCharRight() | Moves the current position one character to the right. |
MoveFileBegin() | Moves the current position to the first character of the first line. |
MoveFileEnd() | Moves the current position to the last character of the last line. |
MoveLineBegin() | Moves the current position to the first character of current line. |
MoveLineBeginCycled() | Moves the current position to the first not whitespace character/first character of current line. |
MoveLineDown() | Moves the current position to the next line. |
MoveLineEnd() | Moves the current position to the last character of current line. |
MoveLineEndCycled() | Moves the current position to the last not whitespace character/last character of current line. |
MoveLineUp() | Moves the current position to the previous line. |
MovePageDown() | Moves current position to the next page. |
MovePageUp() | Moves current position to the previous page. |
MoveScreenBottom() | Moves the current position to the bottom of the screen. |
MoveScreenTop() | Moves the current position to the top of the screen. |
MoveTo(Point) | Moves the current position to the given position. |
MoveTo(Int32, Int32) | Moves the current position to the given position. |
MoveToBrace() | Moves the current position to the next open or close brace in the text content. |
MoveToChar(Int32) | Moves the current position to the specified character in current line. |
MoveToCloseBrace() | Moves the current position to the next close brace in the text content. |
MoveToLine(Int32) | Moves the current position to the specified line. |
MoveToLine(Int32, Int32) | Moves the current position to the specified line. |
MoveToOpenBrace() | Moves the current position to the previous open brace in the text content. |
MoveWordLeft() | Moves the current position one word to the left. |
MoveWordRight() | Moves the current position one word to the right. |
Navigate(Int32, Int32) | Moves current position by the given offset value. |
NeedImeComposition() | |
NeedMouseError(CodeCompletionArgs) | |
NeedReplaceCurrent() | Indicates whether search engine need to replace successfully found and selected text. |
NeedReplaceCurrent(out Match) | Indicates whether search engine need to replace successfully found and selected text. |
NeedResizeRedraw() | |
NeedShowCodeCompletion(CodeCompletionArgs) | |
NewLine() | Inserts a line break at the current position. |
NewLine(ref String, Boolean) | Inserts a line break at the current position with indentation |
NewLineAbove() | Inserts a line break above the current position. |
NewLineBelow() | Inserts a line break below the current position. |
Notification(Object, EventArgs) | Updates control's content according to parameters of notification. |
OnAcceptReturnsChanged() | |
OnAcceptTabsChanged() | |
OnAutoCorrectDelimitersChanged() | |
OnAutoCorrectionChanged() | |
OnBorderColorChanged() | |
OnBorderStyleChanged() | |
OnBorderWidthChanged() | |
OnBracesChanged() | |
OnCodeCompletion() | |
OnCodeCompletion(CodeCompletionArgs) | |
OnCodeCompletion(Object, EventArgs) | |
OnCodeCompletionAccepted(ClosingEventArgs) | |
OnCodeCompletionCharsChanged() | |
OnCodeSnippetInserted(ICodeSnippet, Point) | |
OnDefaultMenuChanged() | |
OnDragDrop(DragEventArgs) | |
OnDragEnter(DragEventArgs) | |
OnDragLeave(EventArgs) | |
OnDragOver(DragEventArgs) | |
OnEditMarginChanged() | |
OnEnabledChanged(EventArgs) | |
OnFontChanged(EventArgs) | |
OnForeColorChanged(EventArgs) | |
OnGotFocus(EventArgs) | |
OnGotoLineDialogChanged() | |
OnGutterChanged() | |
OnHandleCreated(EventArgs) | |
OnHandleDestroyed(EventArgs) | |
OnHideCaretChanged() | |
OnHighlightCurrentBlockChanged() | |
OnHyperTextChanged() | |
OnKeepCaretOnLostFocusChanged() | |
OnKeyDown(KeyEventArgs) | |
OnKeyPress(KeyPressEventArgs) | |
OnKeyUp(KeyEventArgs) | |
OnLineSeparatorChanged() | |
OnLineSpaceChanged() | |
OnLineStylesChanged() | |
OnLostFocus(EventArgs) | |
OnMacroRecordingChanged() | |
OnMacroRecordsChanged() | |
OnMacroSuspendendChanged() | |
OnMinimapChanged() | |
OnModifiedChanged() | |
OnMouseDown(MouseEventArgs) | |
OnMouseLeave(EventArgs) | |
OnMouseMove(MouseEventArgs) | |
OnMouseUp(MouseEventArgs) | |
OnMouseWheel(MouseEventArgs) | |
OnNeedCodeActions(CodeActionEventArgs) | |
OnNeedCompletion(CodeCompletionArgs) | |
OnOutliningChanged() | |
OnPagesChanged() | |
OnPaint(PaintEventArgs) | |
OnPaintBackground(PaintEventArgs) | |
OnPrintingChanged() | |
OnResize(EventArgs) | |
OnScrollingChanged() | |
OnSearchDialogChanged() | |
OnSearchGlobalChanged() | |
OnSearchOptionsChanged() | |
OnSearchPosChanged() | |
OnSelectionChanged() | |
OnSizeChanged(EventArgs) | |
OnSourceStateChanged(NotifyState, Int32, Int32) | |
OnSpellingChanged() | |
OnStateChanged(Object, NotifyState) | Updates control's content according to the state of the source. |
OnStringsChanged() | |
OnSyntaxChanged() | |
OnSyntaxPaintChanged() | |
OnTextFound(String, SearchOptions, Regex, Match, Point, Int32, Boolean, Boolean) | Occurs when search text is found. |
OnTransparentChanged() | |
OnUseDefaultMenuChanged() | |
OnVisibleChanged(EventArgs) | |
OnWhiteSpaceChanged() | |
OpenSharedEditor(String) | |
OutlineText() | Forces automatic outlining by getting up-to-date information about outline section from the Parser. |
PaintDragCaret(Point, Boolean) | |
ParameterInfo() | Displays a code completion window containing information for the current method or parameter in the Editor's content. |
ParameterInfo(CodeCompletionArgs) | |
PauseMacroRecording() | Suspends recording the command sequence. |
PerformCycledSearch(String, SearchOptions, Regex) | |
PerformSearch(String, SearchOptions, Regex) | |
PlayBackMacro() | Repeats the stored command sequence. |
PopupDefaultMenu(Point) | |
PositionChanged(UpdateReason, Int32, Int32) | |
PositionIsReadonly(Point) | Determines whether the text at given position is readonly. |
PositionStillValid(CodeCompletionArgs) | |
PreProcessMessage(ref Message) | Preprocesses input messages within the message loop before they are dispatched. |
ProcessCmdKey(ref Message, Keys) | |
ProcessEnter() | Performs specific actions when Enter key is pressed.
|
ProcessKey(Keys) | |
ProcessKeyMsg(ref Message) | Processes a keyboard message. |
ProcessKeyPress(Char) | Processes key press. |
ProcessMouseLeave(EventArgs) | |
ProcessMouseMove(MouseEventArgs) | Processes a mouse move message. |
ProcessShiftTab(Point) | Performs specific actions when Shift + Tab key is pressed.
|
ProcessTab(Point) | Performs specific actions when Tab key is pressed.
|
QueryEndDrag(Object, QueryContinueDragEventArgs) | |
QuickInfo() | Displays a code completion window with simple tooltip information. |
QuickInfo(CodeCompletionArgs) | |
QuickInfo(CodeCompletionArgs, Point, Boolean) | |
RecordKeyData(IMacroKeyData) | Adds keyData to the |
Replace(String, String) | Searches for the first occurrence of given text within the text content and if succeed replaces it by specified string. |
Replace(String, String, SearchOptions) | Searches for first occurrence given text within the text content with specified options and if succeed replaces it by specified string. |
Replace(String, String, SearchOptions, Regex) | Searches for first occurrence given text within the text content with specified options using specified regular expression and if succeed replaces it by specified string. |
ReplaceAll(String, String, SearchOptions, out Int32) | Replaces all occurrences of given text within text content by specified replaceWith string. |
ReplaceAll(String, String, SearchOptions, Regex, out Int32) | Replaces all occurrences of given text within class text content by specified replaceWith string. |
ReplaceAll(String, String, SearchOptions, Regex, out Int32, out Boolean) | Replaces all occurrences of given text within class text content by specified replaceWith string. |
ReplaceAll(String, String, out Int32) | Replaces all occurrences of given text within class text content by specified replaceWith string. |
ReplaceCurrent(String, SearchOptions, Match) | Replaces currently selected text. |
ResetAcceptReturns() | Resets the |
ResetAcceptTabs() | Resets the |
ResetBackColor() | |
ResetBorderColor() | Resets the |
ResetBorderStyle() | Resets the |
ResetCursor() | |
ResetFont() | |
ResetHideCaret() | Resets the |
ResetIndentOptions() | Resets the |
ResetKeepCaretOnLostFocus() | Resets the |
ResetLineSpace() | Resets the |
ResetMaxLength() | Resets the |
ResetModified() | Resets the |
ResetNavigateOptions() | Resets the |
ResetOverWrite() | Resets the |
ResetReadOnly() | Resets the |
ResetSingleLineMode() | Resets the |
ResetWordWrap() | Resets the |
ResetWrapAtMargin() | Resets the |
RestorePosition(Int32) | Restores position from stored position list by given index. |
RestorePositionWithUndo(Int32) | Restores position from stored position list by given index. |
ResumeMacroRecording() | Resumes recording the command sequence. |
SaveFile(String) | Saves text content to the specific file. |
SaveFile(String, IStringExport) | Saves content to the given file in the specific format. |
SaveFile(String, IStringExport, Encoding) | Saves content to the given file in the specific format with specific encoding. |
SaveFile(String, Encoding) | Saves text content to the specific file with specific encoding. |
SaveMacros(Stream) | Saves the macro records to the given stream in xml format. |
SaveMacros(TextWriter) | Saves the macro records to the given stream in xml format. |
SaveMacros(String) | Saves the macro records to the given file in xml format. |
SaveStream(Stream) | Saves content of the snippet to the specified stream. |
SaveStream(Stream, IStringExport) | Saves content to the specific stream in the specific format. |
SaveStream(Stream, IStringExport, Encoding) | Saves content to the specific stream in the specific format and specific encoding. |
SaveStream(Stream, Encoding) | Saves the text content to the specified stream. |
SaveStream(TextWriter) | Saves the text content to the specified stream. |
SaveStream(TextWriter, IStringExport) | Saves the text content to the specified stream. |
ScreenToDisplay(Int32, Int32) | Converts given screen coordinates to display coordinates (index of line and character). |
ScreenToDisplay(Int32, Int32, Boolean) | Converts given screen coordinates to display coordinates (index of line and character). |
ScreenToDisplayX(Int32, Int32) | Converts given screen coordinates to display coordinate of a character. |
ScreenToText(Point) | Converts given screen coordinates to text coordinates (index of line and character). |
ScreenToText(Int32, Int32) | Converts given screen coordinates to text coordinates (index of line and character). |
ScreenToText(Int32, Int32, ref Boolean) | Converts given screen coordinates to text coordinates (index of line and character). |
ScrollLineDown() | Scrolls text content one line down. |
ScrollLineUp() | Scrolls text content one line up. |
SelectFirstSnippet() | |
SelectionMatchesSearchText() | |
SelectSnippet(Point, Boolean, Boolean) | |
SetLineHidden(Int32, Boolean) | Sets readonly state for the given line. |
SetLineHidden(Int32[], Boolean) | Sets readonly state for the given line. |
SetLineReadonly(Int32, Boolean) | Sets readonly state for the given line. |
SetLineReadonly(Int32[], Boolean) | Sets readonly state for the given line. |
SetNavigateOptions(NavigateOptions) | Sets navigating options without validating position. |
ShouldSerializeBackColor() | Indicates whether the |
ShouldSerializeBorderColor() | Indicates whether the |
ShouldSerializeBorderStyle() | Indicates whether the |
ShouldSerializeCodeCompletionChars() | Indicates whether the |
ShouldSerializeCursor() | Indicates whether the |
ShouldSerializeFont() | Indicates whether the |
ShouldSerializeIndentOptions() | Indicates whether the |
ShouldSerializeNavigateOptions() | Indicates whether the |
ShouldSerializeReadOnly() | Indicates whether the |
ShouldSerializeSearchOptions() | Indicates whether the |
ShouldSerializeText() | Indicates whether the |
ShowCaret(Int32, Int32) | Moves the caret to the specified coordinates. |
ShowCodeActions(Point, Point, Point) | |
ShowCodeCompletionBox(ICodeCompletionProvider, CodeCompletionType) | Shows code completion popup window with given provider at the current position. |
ShowCodeCompletionBox(ICodeCompletionProvider, CodeCompletionType, Point) | Shows code completion popup window with given Provider at the specified position. |
ShowCodeCompletionBox(ICodeCompletionProvider, CodeCompletionType, Point, Point, Point) | |
ShowCodeCompletionButton(ICodeCompletionProvider) | Shows code completion popup window with given provider at the current position. |
ShowCodeCompletionButton(ICodeCompletionProvider, Point, Boolean) | Shows code completion popup window with given Provider at the specified position. |
ShowCodeCompletionButton(ICodeCompletionProvider, Point, Point, Point, Boolean) | |
ShowCodeCompletionHint(ICodeCompletionProvider, ILexer) | Displays |
ShowCodeCompletionHint(ICodeCompletionProvider, Point, ILexer) | Displays |
ShowCodeCompletionHint(ICodeCompletionProvider, Point, Point, Point, Point, Boolean, Boolean, ILexer, ICustomPaint) | |
ShowNotFound(String) | Displays "searched text not found" message box. |
ShowScrollHint(Int32) | Displays tooltip indicating destination line when scrolling. |
SplitterMoved(Object, SplitterEventArgs) | |
SplitView(Boolean) | |
SplitViewHorz() | Splits control content horizontally. |
SplitViewVert() | Splits control content vertically. |
StartDragging() | |
StartIncrementalSearch() | Enters control to the incremental search state. FinishIncrementalSearch() |
StartIncrementalSearch(Boolean) | Enters control to the incremental search state. FinishIncrementalSearch() |
StartMacroRecording() | Starts recording the command sequence. |
StartTripleClickTimer() | |
StopCodeCompletionThread() | |
StopMacroRecording() | Stops recording the command sequence. |
StopTripleClickTimer() | |
StorePosition(Point) | Stores given position to stored position list. |
StorePosition(Point, Boolean) | Stores given position to stored position list. |
StorePositionWithUndo(Point) | Stores given position to stored position list preserving it for undo. |
TextFound(SearchOptions, Point, Int32, Boolean, Boolean) | |
TextStyleAt(Point) | |
TextToScreen(Point) | Converts given text coordinates, index of line and character, to screen coordinates. |
TextToScreen(Point, Boolean) | Converts given text coordinates, index of line and character, to screen coordinates. |
TextToScreen(Int32, Int32) | Converts given text coordinates, index of line and character, to screen coordinates. |
TextToScreen(Int32, Int32, Boolean) | |
ToggleMacroRecording() | Toggles recording the command sequence. |
UnBreakLine(Boolean) | Concatenates lines at current position. |
UnhighlightAll() | Unhighlights search results previously highlighted by HighlightAll. |
UnsplitView(Boolean) | |
UnsplitViewHorz() | Removes horizontal split view. |
UnsplitViewVert() | Removes vertical split view. |
UpdateCaret() | Ensures the caret is displayed in the current position. |
UpdateCaretMode() | |
UpdateCursor() | Causes current mouse cursor to be updated. |
UpdateMenu() | |
UpdateMonospaced() | |
UpdateStartSearchPos() | |
UpdateView() | Updates editor content, caret and pages area. |
UpdateWordWrap() | Re-wraps all lines in the text. |
UpdateWordWrap(Int32, Int32) | Re-wraps lines in the text within specific scope. |
ValidatePosition(ref Point) | Validates given position within control's text content. |
WndProc(ref Message) |
Events
AutoCorrect | Occurs when control tries to auto correct word being typed. |
CheckHyperText | Occurs when a control needs checking whether some string represents hypertext. |
CodeSnippetInserted | Occurs when code snippet is inserted. |
CustomDraw | Occurs when control draws its content. |
DrawHeader | Occurs when header or footer part of each page is drawing. |
DrawUserMargin | Occurs when user margin part of each line is drawing. |
GutterClick | Occurs when the gutter part of Edit Syntaxcontrol is clicked. |
GutterDblClick | Occurs when the gutter part of SyntaxEdit control is double-clicked. |
HorizontalScroll | Occurs when control scrolls its content in horizontal direction. This can be caused by dragging horizontal scroll thumb, or caret moving. |
JumpToUrl | Occurs when user attempts to jump to url. |
ModifiedChanged | Occurs when modified state is changed. |
NeedCodeCompletion | Occurs when code completion window is to be displayed. |
PaintBackground | Occurs when SyntaxEdit control should paint its background in transparent mode. |
PromptOnReplace | Occurs when replace dialog prompts on replace action. |
ScrollButtonClick | Occurs when some scrolling button is clicked. |
SelectionChanged | Occurs when selection bounds are changed. |
SourceChanged | Occurs when source changes. |
SourceStateChanged | Occurs when text Source's state is changed, for example when caret position moved, text edited, amount of lines changed, lexer changed, etc. |
SplitHorz | Occurs when user splits SyntaxEdit control horizontally. |
SplitVert | Occurs when user splits SyntaxEdit control vertically. |
UndoEvent | Occurs when undo/redo operation performed. |
UnsplitHorz | Occurs when horizontal split view is removed. |
UnsplitVert | Occurs when vertical split view is removed. |
VerticalScroll | Occurs when control scrolls its content in vertical direction. This can be caused by dragging vertical scroll thumb, or caret moving. |
WordSpell | Occurs when spelling of some word within the text needs checking. |