TextEditor Class
Definition
Represents advanced multi-line Edit control.
Inheritance
Implements
Syntax
[Localizability(LocalizationCategory.Text)]
public class TextEditor : Control, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient, INotifier, ISearch, ITextSearch, IAutoCorrect, INotifyPropertyChanged
Remarks
TextEditor is a multiline WPF 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 for supported languages
- 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
- Multiple selection modes
- Standard editing features like undo/redo and navigation
- Assortment of customizable options like whitespace display, structure guidelines, and many more
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 the Lexer property to specify the 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 TextEditor from the C# code and add event handler to handle clicking on hyper-text urls.
public partial class MainWindow : Window
{
public Form1()
{
InitializeComponent();
}
private void Window_Loaded(object sender, RoutedEventArgs e)
{
#region TextEditorCSharpCreation
var edit = new Alternet.Editor.Wpf.TextEditor();
edit.AllowOutlining = true;
edit.Source.LoadFile("myfile.txt");
edit.JumpToUrl += new Alternet.Editor.Wpf.UrlJumpEvent(this.edit_JumpToUrl);
#endregion
}
#region TextEditorEventHandler
private void edit_JumpToUrl(object sender, UrlJumpEventArgs e)
{
if (window.chbCustomHypertext.IsChecked.Value)
{
System.Windows.MessageBox.Show(e.Text);
e.Handled = true;
}
}
#endregion
}
Here is how to declare a TextEditor from the Visual Basic code and add event handler to handle clicking on hyper-text urls.
Partial Public Class MainWindow
Public Sub New()
InitializeComponent()
End Sub
Private Sub Window_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
Dim edit = New Alternet.Editor.Wpf.TextEditor()
edit.AllowOutlining = True
edit.Source.LoadFile("myfile.txt")
AddHandler edit.JumpToUrl, New Alternet.Editor.Wpf.UrlJumpEvent(AddressOf Me.edit_JumpToUrl)
End Sub
Private Sub edit_JumpToUrl(ByVal sender As Object, ByVal e As UrlJumpEventArgs)
If window.chbCustomHypertext.IsChecked.Value Then
System.Windows.MessageBox.Show(e.Text)
e.Handled = True
End If
End Sub
End Class
Constructors
TextEditor() | Initializes a new instance of the |
TextEditor(TextEditorContentArea) | Creates a new TextEditor instance. |
Fields
Properties
ActiveOutlineRange | Gets currently highlighted outlined range. |
AllowedSelectionMode | Gets or sets types of selection allowed for the TextEditor. |
AllowHorizontalEditorSplit | Gets or sets a boolean value indicating whether TextEditor can be splitted horizontally. |
AllowOutlining | Gets or sets a value indicating whether outlining enabled. |
AllowVerticalEditorSplit | Gets or sets a boolean value indicating whether TextEditor can be splitted vertically. |
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. |
BookmarkImageSource | Gets or sets an ImageSource for bookmarks. |
Braces | Represents an object that implements |
CanCopy | |
CanCut | |
CanDelete | |
CanPaste | |
CanRedo | |
CanUndo | |
CaretBrush | Gets or sets Brush used to paint caret. |
CharsInWidth | Returns number of characters painted with current font that will fit into control's client area. |
ClientHeight | Represents a client area height of the TextEditor control. |
ClientRect | Represents a client area of the TextEditor control. |
ClientWidth | Represents a client area width of the TextEditor control. |
CodeActionImageIndex | Gets or sets a value that specifies index of item in the image collection used to paint light bulb for code action. |
CodeActionPosition | Gets or sets code action position within the text. |
CodeActionsOnGutter | Gets or sets a boolean value indicating whether TextEditor should display code actions images on gutter. |
CodeActionsVisible | Gets or sets a boolean value indicating whether TextEditor should display code actions images. |
CodeCompletionBox | Represents object that specifies a popup window that contains code completion information presented in the form of list. |
CodeCompletionBoxBrush | Gets or sets Brush used to fill Code Completion Box background. |
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. |
CodeCompletionHintBrush | Gets or sets Brush used to fill Code Completion Hint background. |
CodeCompletionMode | |
CodeCompletionTimer | |
CodeSnippetHighlightBrush | Gets or sets Brush used to fill code snippet area. |
ColumnPen | Gets or sets Pen object that describes the color and pattern of EditMargin line. |
ContentArea | Gets a scrollable content area for |
ContentDividerPen | Gets or sets Pen to draw content divider. |
ContentDividersVisible | Gets or sets a boolean value indicating whether content divider should be drawn. |
ContextMenuBackColor | Gets or sets background color for the context menu. |
ContextMenuBorderColor | Gets or sets border color for the context menu. |
CustomGutterItemsVisible | |
DefaultMenu | |
DisplayLines | Represents the object that implements |
DrawAliasedGeometry | Returns a value indicating whether to draw pixel-aliased geometry where supported (outlining etc). The value returned depends on the current DPI. Currently geometry is aliased when the DPI is 100%. |
DrawLineBookmarks | Gets or sets a value indicating whether Edit control should draw triangle at bookmark position inside line. |
DrawStructureGuideLines | Indicates whether edit control should draw columns indentation marks. |
EditMargin | Represents an object that implements |
EffectiveVisualTheme | Gets current visual theme. |
ErrorUnderlinePen | Gets or sets Pen used to draw error underline wave. |
FirstSearch | Gets or sets a value indicating whether control launches text search at first. |
GotoLineDialog | Gets or sets a dialog prompting for index of the line you need to locate. |
GradientGutter | Gets or sets a boolean value indicating whether gutter background should be gradient. |
GuideLinesDashedStyle | Specifies that structure guide lines to be drawn as dashed line. |
GuideLinesForeColor | Specifies guide lines color. |
GutterBrush | Gets or sets Brush used to paint gutter area. |
GutterGradientEndColor | Gets or sets end Color used to paint gradient gutter area. |
GutterGradientStartColor | Gets or sets start Color used to paint gradient gutter area. |
GutterImages | Represents a ImageSource collection to display on TextEditor gutter area. |
GutterImagesResourceNameSuffix | Gets or sets the image resource name suffix. |
GutterRightMargin | Gets or sets width of gutter area right margin. |
GutterVisible | Gets or sets a boolean value indicating whether gutter area is visible. |
GutterWidth | Gets or sets gutter area width. |
HighlightMatchingBlocks | Specifies that edit control should highlight begin/end blocks. |
HighlightOutlineAreaBrush | Gets or sets Brush used to fill highlighted outline area. |
HighlightReferences | Specifies that edit control should highlight find references. |
HighlightSearchResults | Indicates whether search results are highlighted while the search dialog is open. |
HighlightSymbolReferences | Specifies that edit control should highlight symbol references when hovering mouse over them. |
HorizontalScrollBarVisibility | Gets/Sets the horizontal scroll bar visibility. |
HorizontalSplitterEditor | Represents an vertical split view control. |
HyperText | Represents object that implements |
InactiveSelectionBrush | Gets or sets Brush used to fill selected area when TextEditor lost focus. |
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. |
InfoPen | Gets or sets Pen used to draw info underline wave. |
InIncrementalSearch | Indicates whether control is in incremental search state. |
InnerTextSource | Gets inner text source. |
IsSearchFocused | |
KeyList | Represents object that implements |
LeftArrowCursor | |
Lexer | Gets or sets an object that can make lexical analysis for the control's content. |
LineBookmarksBrush | Gets or sets a Brush of the line bookmarks. |
LineHeight | Represents height of the individual line. |
LineModificatorChangedBrush | Gets or sets Brush used to paint line modificator in changed state. |
LineModificatorPadding | Gets or sets Thickness around line modificator. |
LineModificatorSavedBrush | Gets or sets Brush used to paint line modificator in saved state. |
LineModificatorsVisible | Gets or sets a boolean value indicating whether line modificators (color stitch that indicates that the line content is modified, unmodified or saved) should be drawn. |
LineModificatorWidth | Gets or sets line modificator area width. |
LineNumbersBackBrush | Gets or sets Brush used to paint line numbers. |
LineNumbersBrush | Gets or sets Brush used to paint line numbers. |
LineNumbersHorizontalAlignment | Gets or sets horizontal TextAlignment of line numbers. |
LineNumbersLeftMargin | Gets or sets width of line numbers area left margin. |
LineNumbersRightMargin | Gets or sets width of line numbers area right margin. |
LineNumbersStart | Gets or sets index of the first line being painted on the gutter. |
LineNumbersVisible | Gets or sets a boolean value indicating whether TextEditor should display line numbers. |
Lines | Represents object that implements |
LineSeparator | Represents an object that implements |
LinesInHeight | Determines how many lines can fit into control's client area. |
LinesOnGutter | Specifies that numbers of lines should be drawn at the gutter area rather than beyond the gutter. |
LineSpace | Gets or sets line space between individual lines in the Edit control. |
LineSpacing | Gets or sets distance between neighbor lines. |
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 Edit 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. |
MarginPen | Gets or sets Pen object that describes the color and pattern of EditMargin line. |
Minimap | Represents object that implements |
MinimapBackColor | Gets or sets the color of the minimap background. |
MinimapBorderColor | Gets or sets the color of the minimap border. |
MinimapCurrentFrameBorderColor | Gets or sets the color of the minimap's current frame border, i.e., the rectangular area corresponding to the currently visible part of the code. |
MinimapCurrentFrameColor | Gets or sets the color of the minimap's current frame, i.e., the rectangular area corresponding to the currently visible part of the code. |
MinimapHint | Represents object that specifies a popup window that contains minimap information presented in the form of the tooltip. |
MinimapLineHeight | Represents height of the individual minimap line. |
MinimapOptions | Gets or sets a |
MinimapScale | Gets or sets the scale of the minimap. |
MinimapVisible | Gets or sets a value indicating whether minimap area is visible. |
MinimapWidth | Gets or sets the minimap area width. |
NavigateOptions | Gets or sets navigating options. |
NeedsTextInput | |
OpenSharedEditorFunc | When implemented by a class, gets or sets a function that open |
OutlineSectionBoundsPen | Gets or sets Pen used to draw outline section bounds. |
OutlineSectionTextColor | Gets or sets Color used to draw text inside outline section. |
Outlining | Represents an object that implements |
OutliningFillCollapsedBrush | Gets or sets Brush used to fill folding button when outlining region is in collapsed state. |
OutliningFillExpandedBrush | Gets or sets Brush used to fill folding button when outlining region is in expanded state. |
OutliningGlyphBrush | Gets or sets Brush used to paint outlining area glyph. |
OutliningLineBrush | Gets or sets Brush used to paint outlining area. |
OverwriteCaretBrush | Gets or sets Brush used to paint caret when TextEditor is in overwrite state. |
PaintBookMarks | Specifies that bookmarks should be drawn. |
PaintLineModificators | Specifies that line modificators (color stitch that indicates that the line content is modified, unmodified or saved) should be drawn. |
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. |
ReadonlyBackColor | Gets or sets background color used in the readonly state. |
ReferencesBrush | Gets or sets Brush used to fill highlighted reference area. |
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. |
SearchResultsBrush | Gets or sets Brush used to fill highlighted search result area. |
SectionBorderColor | Gets or sets a color of the selection border. |
SelectedWordsBrush | Gets or sets Brush used to fill highlighted selected word area. |
Selection | Represents an object that implements |
SelectionBrush | Gets or sets Brush used to fill selected region. |
SelectionForeColor | Gets or sets Color used to draw selection text. |
SelectionOptions | Gets or sets options determining appearance and behavior of the |
SeparatorOptions | Gets or sets a set of flags customizing appearance and behavior of the |
ShowBookmarkHints | Gets or sets a value indicating whether Edit control should display text describing bookmark in form of tooltip window when mouse pointer is over the gutter bookmark. |
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 |
SpellingPen | Gets or sets Pen used to draw info underline wave. |
Strings | Represents |
SyntaxPaint | Represents |
Text | Gets or sets the string collection as a single string with the individual lines delimited by carriage returns. |
UseDefaultMenu | |
UserMarginBackgroundBrush | Gets or sets Brush used to fill user margin region. |
UserMarginBoundsPen | Gets or sets Pen used to draw user margin bounds. |
UserMarginPadding | Gets or sets Thickness around user margin. |
UserMarginText | Gets or sets a text of the user margin. |
UserMarginTextBrush | Gets or sets Brush used to draw text inside user margin region. |
UserMarginVisible | Gets or sets a boolean value indicating whether TextEditor should draw user margin (allowing to draw additional information). |
UserMarginWidth | Gets or sets user margin area width. |
VerticalScrollBarVisibility | Gets/Sets the vertical scroll bar visibility. |
VerticalSplitterEditor | Represents an vertical split view control. |
VisualTheme | Gets or sets visual theme for the editor. |
VisualThemeType | Gets or sets visual theme type for the editor. |
WarningPen | Gets or sets Pen used to draw warning underline wave. |
Whitespace | Represents an object that implements |
WhitespaceVisible | Gets or sets a value indicating whether white space symbols are visible in the control's text content. |
WideSpaceWidth | Represents average character width. |
WordWrap | Gets or sets a value indicating whether TextEditor control automatically wraps words to the beginning of the next line when necessary. |
WrapAtMargin |
Methods
ApplyTextChanges(IList<ITextUndo>, Boolean) | |
ApplyTheme() | |
ApplyTheme(IVisualTheme) | Applies visual theme to the TextEditor control. |
ApplyThemeStyles() | |
Assign(TextEditor) | Assigns most relevant properties from another |
BlockDeleting(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. |
CheckAutoCorrect() | |
CheckAutoCorrect(Point, String) | |
CleanupResources() | |
ClearActiveOutlineRange() | |
ClearSelection() | |
ClearSymbolReference() | |
CloseCodeCompletionBox(Object, ClosingEventArgs) | |
CloseCodeCompletionButton(Object, ClosingEventArgs) | |
CloseCodeCompletionHint(Object, ClosingEventArgs) | |
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 ICodeCompletionWindow) | 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) | |
Copy() | |
CopyCommandClick() | |
CreateBraces() | |
CreateCodeCompletionBox() | |
CreateCodeCompletionButton() | |
CreateCodeCompletionHint() | |
CreateDisplayLines() | |
CreateEditMargin() | |
CreateGotoLineDialog() | |
CreateHyperText() | |
CreateKeyList() | |
CreateLineSeparator() | |
CreateMacroKeyList() | |
CreateMinimap() | |
CreateMinimapHint() | |
CreatePrinting() | |
CreateScrolling() | |
CreateSearchDialog() | |
CreateSelection() | |
CreateSpelling() | |
CreateSyntaxPaint() | |
CreateWhiteSpace() | |
Cut() | |
CutCommandClick() | |
CycledSearch(String, SearchOptions, Regex, Boolean) | Performs cycled search. |
Delete() | |
DeleteCommandClick() | |
DisableCodeCompletionTimer() | |
DisablePositionUpdate() | Prevents notification of changing of caret position until
calling |
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(OwnerWindow) | Initializes and runs a dialog prompting you for index of the line you need to locate. |
DisplayGotoLineDialog(Window) | Initializes and runs a dialog prompting you for index of the line you need to locate. |
DisplayReplaceDialog() | Initializes and runs a dialog box allowing you to search for text and replace it. |
DisplayReplaceDialog(Window) | 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(OwnerWindow) | Initializes and runs a dialog box allowing you to search for some text. |
DisplaySearchDialog(Window) | 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. |
DisposeCodeCompletionWindow(Object, EventArgs) | |
DoAutoCorrection(Point, String, String) | |
DoCodeCompletion(CodeCompletionArgs) | |
DoCodeCompletion(ISyntaxParser, Point, Boolean, CodeCompletionArgs) | |
DoCodeToolTip(String, Double, Double, Point, Boolean, Boolean) | |
DoFontChanged() | |
DoHighlightAll(String, SearchOptions, Regex) | |
DoHighlightSymbolReferences() | |
DoHighlightSymbolReferences(Point) | |
DoHighlightWholeWord(String) | |
DoMarkAll(String, SearchOptions, Regex, Boolean) | |
DoMinimapTooltip(Int32, Int32, Boolean) | |
DoPromptOnReplace(String, ref Boolean) | |
DoQueryCursor(QueryCursorEventArgs) | |
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) | |
DoTripleClick(Object, EventArgs) | |
EnablePositionUpdate() | Re-enables notification of changing of caret position
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() |
GetCaretBrush() | |
GetCaretSize(Point) | Returns size of the caret's current shape at given position. |
GetCharsInWidth(Double) | Returns number of characters painted with current font that will fit into specified Width. |
GetCharsInWidth(Double, Boolean) | |
GetCodeActionsWidth() | |
GetEffectiveVisualTheme(VisualThemeType, IVisualTheme) | |
GetHitTest(Double, Double, IHitTestInfo) | Fills hitTestInfo parameter by information about a part of the control at specified coordinate. |
GetHitTest(Point, 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. |
GetImage(Int32) | |
GetInfoTipPos(Point) | |
GetLinesInHeight(Double) | Determines how many lines can fit into given Height. |
GetNonTextAreaWidth() | Returns mutual width of Non text area - Gutter, Line Numbers, Outlining and User Margin. |
GetNonTextAreaWidth(Boolean) | Returns mutual width of Non text area - Gutter, Line Numbers, Outlining and User Margin. |
GetReplaceString(String, Match) | |
GetSyntaxErrorAtPoint(Double, Double, out ISyntaxError) | |
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. |
HasCodeFixes(ISyntaxError) | |
HasCodeFixesAsync(ISyntaxError) | |
HideCaret() | Hides the caret's current shape. |
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 given text incrementally. |
InitCycledSearch(SearchOptions) | |
InitDefaultMenu() | |
InitSearchPos(SearchOptions, Boolean) | |
InsertCodeFix(ICodeActionItem, Boolean) | |
InsertCodeRefactor(ICodeActionItem, Boolean) | |
InsertCodeSnippet(ICodeSnippet, Point) | Inserts Code Snippet at the given position in the text |
InsertCodeSnippet(ICodeSnippet, Point, Point, Boolean) | |
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) | |
Invalidate() | Invalidates the entire surface of the control and causes the control to be redrawn. |
Invalidate(Int32, Int32) | Invalidates the part of controls surface and causes the control to be redrawn. |
InvalidateDisplay(Int32, Int32) | Invalidates the part of controls surface and causes the control to be redrawn. |
InvalidateSelection() | Invalidates selection region. |
IsImmediateCompletionType(CodeCompletionType) | |
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. |
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) | |
LoadDefaultGutterImages() | |
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. |
MeasureOverride(Size) | |
MoveCaretOnDrag(DragEventArgs) | 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. |
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. |
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. |
NeedShowCodeCompletion(CodeCompletionArgs) | |
Notification(Object, EventArgs) | Updates control's content according to parameters of notification. |
OnApplyTemplate() | |
OnAutoCorrectDelimitersChanged() | |
OnAutoCorrectionChanged() | |
OnBracesChanged() | |
OnCodeActionImageChanged() | |
OnCodeActionsOnGutterChanged() | |
OnCodeActionsVisibleChanged() | |
OnCodeCompletion() | |
OnCodeCompletion(CodeCompletionArgs) | |
OnCodeCompletion(Object, EventArgs) | |
OnCodeCompletionAccepted(ClosingEventArgs) | |
OnCodeCompletionCharsChanged() | |
OnCodeSnippetInserted(ICodeSnippet, Point) | |
OnContextMenuOpening(ContextMenuEventArgs) | |
OnDefaultMenuChanged() | |
OnDrawStructureGuideLinesChanged() | |
OnEditorSettingsDialogChanged() | |
OnGotFocus(RoutedEventArgs) | |
OnGotoLineDialogChanged() | |
OnGuideLinesDashedStyleChanged() | |
OnGutterClick(Object, EventArgs) | |
OnGutterDlbClick(Object, EventArgs) | |
OnGutterItemMouseDown(Object, GutterMouseButtonEventArgs) | |
OnGutterPropertiesChanged() | |
OnKeyDown(KeyEventArgs) | |
OnKeyUp(KeyEventArgs) | |
OnLineNumbersVisibleChanged() | |
OnLineSeparatorChanged() | |
OnLineSpaceChanged() | |
OnLostFocus(RoutedEventArgs) | |
OnMacroRecordingChanged() | |
OnMacroRecordsChanged() | |
OnMacroSuspendendChanged() | |
OnMinimapPropertiesChanged() | |
OnModifiedChanged() | |
OnMouseDown(MouseButtonEventArgs) | |
OnMouseLeave(MouseEventArgs) | |
OnMouseMove(MouseEventArgs) | |
OnMouseUp(MouseButtonEventArgs) | |
OnNeedCodeActions(CodeActionEventArgs) | |
OnNeedCompletion(CodeCompletionArgs) | |
OnPreviewTextInput(TextCompositionEventArgs) | |
OnQueryContinueDrag(QueryContinueDragEventArgs) | |
OnQueryCustomGutterItem(QueryCustomGutterItemEventArgs) | |
OnRenderCustomGutterItem(RenderCustomGutterItemEventArgs) | |
OnRenderSizeChanged(SizeChangedInfo) | |
OnSearchDialogChanged() | |
OnSearchGlobalChanged() | |
OnSearchOptionsChanged() | |
OnSearchPosChanged() | |
OnSourceChanged() | |
OnSourceStateChanged(NotifyState, Int32, Int32) | |
OnStateChanged(Object, NotifyState) | Updates control's content according to the state of the source. |
OnStringsChanged() | |
OnSyntaxChanged() | |
OnTextChanged(Object, EventArgs) | |
OnTextFound(String, SearchOptions, Regex, Match, Point, Int32, Boolean, Boolean) | Occurs when search text is found. |
OnUseDefaultMenuChanged() | |
OpenSharedEditor(String) | |
OutlineText() | Forces automatic outlining by getting up-to-date information about outline section from the Parser. |
ParameterInfo() | Displays a code completion window containing information for the current method or parameter in the Editor's content. |
ParameterInfo(CodeCompletionArgs) | |
Paste() | |
PasteCommandClick() | |
PauseMacroRecording() | Suspends recording the command sequence. |
PerformCycledSearch(String, SearchOptions, Regex) | |
PerformSearch(String, SearchOptions, Regex) | |
PlayBackMacro() | Repeats the stored command sequence. |
PositionChanged(UpdateReason, Int32, Int32) | |
PositionStillValid(CodeCompletionArgs) | |
ProcessEnter() | Performs specific actions when Enter key is pressed. |
ProcessKey(Keys) | |
ProcessKeyPress(Char) | Processes key press. |
ProcessKeyPress(String) | 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.
|
QuickInfo() | Displays a code completion window with simple tooltip information. |
QuickInfo(CodeCompletionArgs) | |
QuickInfo(CodeCompletionArgs, Point, Boolean) | |
RaisePropertyChanged(String) | |
RecordKeyData(IMacroKeyData) | Adds keyData to the |
Replace() | |
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. |
ReplaceCommandClick() | |
ReplaceCurrent(String, SearchOptions, Match) | Replaces currently selected text. |
ResetLineSpace() | Resets the |
ResetNavigateOptions() | Resets the |
ResetWordWrap() | Resets the |
ResetWrapAtMargin() | Resets the |
RestorePosition(Int32) | Restores position from stored position list by given index. |
RestorePositionWithUndo(Int32) | |
ResumeMacroRecording() | Resumes recording the command sequence. |
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. |
ScreenToDisplay(Double, Double) | Converts given screen coordinates to display coordinates (index of line and character). |
ScreenToDisplay(Double, Double, Boolean) | |
ScreenToDisplayX(Double, Int32) | Converts given screen coordinates to display coordinate of a character. |
ScreenToText(Double, Double) | Converts given screen coordinates to text coordinates (index of line and character). |
ScreenToText(Double, Double, ref Boolean) | Converts given screen coordinates to text coordinates (index of line and character). |
ScreenToText(Point) | 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. |
Search() | |
SearchCommandClick() | |
SelectFirstSnippet() | |
SelectionMatchesSearchText() | |
SelectSnippet(Point, Boolean, Boolean) | |
SetNavigateOptions(NavigateOptions) | Sets navigating options without validating position. |
ShowCaret(Double, Double) | 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) | |
ShowMinimapHint(ICodeCompletionProvider, Point, Point, Point, Point, Boolean, Boolean, ILexer) | |
ShowNotFound(String) | Displays "searched text not found" message box. |
ShowScrollHint() | Displays tooltip indicating destination line when scrolling. |
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() | |
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) | |
TextFound(SearchOptions, Point, Int32, Boolean, Boolean) | |
TextStyleAt(Point) | Gets text style information at specified position. |
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. |
UnhighlightAll() | Unhighlights search results previously highlighted by HighlightAll. |
UpdateCaret() | Ensures the caret is displayed in the current position. |
UpdateChildSplitEditorProperties(TextEditor) | |
UpdateMenu() | |
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. |
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. |
GetUserMarginText | Occurs when the TextEditor checks usermargin text. |
GutterClick | Occurs when the gutter part of Edit control is clicked. |
GutterDblClick | Occurs when the gutter part of Edit control is double-clicked. |
GutterItemMouseDown | |
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. |
ModifyTextDisplay | Occurs when TextEditor measures part of its text content. |
NeedCodeCompletion | Occurs when code completion window is to be displayed. |
PromptOnReplace | Occurs when replace dialog prompts on replace action. |
PropertyChanged | |
QueryCustomGutterItem | |
RenderCustomGutterItem | |
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. |
TextChanged | Occurs when the TextEditor text changed. |
VerticalScroll | Occurs when control scrolls its content in vertical direction. This can be caused by dragging vertical scroll thumb, or caret moving. |