WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class EditControl

    Show / Hide Table of Contents

    Class EditControl

    Represents a windows control that enables the user to create powerful text editor control that supports syntax highlighting, code outlining, block selection, efficient code editing, IntelliSense, custom language configuration, and much more. It also offers built-in language highlighting support.

    Inheritance
    System.Object
    BaseLocalizableControl
    EditControl
    Implements
    ILocalizableTypeDescriptor
    System.ComponentModel.ICustomTypeDescriptor
    System.ComponentModel.ISupportInitialize
    IThemeProvider
    IVisualStyle
    Namespace: Syncfusion.Windows.Forms.Edit
    Assembly: Syncfusion.Edit.Windows.dll
    Syntax
    public class EditControl : BaseLocalizableControl, ILocalizableTypeDescriptor, ICustomTypeDescriptor, ISupportInitialize, IThemeProvider, IVisualStyle

    Constructors

    EditControl()

    Initializes a new instance of the Syncfusion.Windows.Forms.Edit class.

    Declaration
    public EditControl()

    Properties

    AcceptsEscape

    Gets or sets a value indicating whether the edit control should handle Escape key to close the parent form only when the parent form contains the cancel button. Default value is true. Setting it to false will close the parent form.

    Declaration
    public bool AcceptsEscape { get; set; }
    Property Value
    Type Description
    System.Boolean

    ActualText

    Gets or sets the actual text with considering \r as well.

    Declaration
    protected string ActualText { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    Used by WM_GETTEXTLENGTH Message.

    AllowDeleteReadOnlyRegion

    Gets or sets a value indicating whether removing a read-only region is allowed in EditControl.

    Declaration
    public bool AllowDeleteReadOnlyRegion { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowDrop

    Gets or sets a value indicating whether the EditControl can accept data that the user drags onto it.

    Declaration
    public bool AllowDrop { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowInsertBeforeReadonlyNewLine

    Gets or sets a value indicating whether inserting text should be allowed at the beginning of read-only region at the start of new line.

    Declaration
    public bool AllowInsertBeforeReadonlyNewLine { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowZoom

    Gets or sets a value indicating whether the Text area of the EditControl can be zoomed or not.

    Declaration
    public bool AllowZoom { get; set; }
    Property Value
    Type Description
    System.Boolean

    AlwaysShowScrollers

    Gets or sets a value indicating whether scrollers should be always visible in EditControl.

    Declaration
    public bool AlwaysShowScrollers { get; set; }
    Property Value
    Type Description
    System.Boolean

    AutoCompleteSingleLexem

    Gets or sets a value indicating whether context choice list gets autocompleted when single lexem remains in the list.

    Declaration
    public bool AutoCompleteSingleLexem { get; set; }
    Property Value
    Type Description
    System.Boolean

    AutoFormattingManager

    Gets the autoformatting manager of EditControl.

    Declaration
    public AutoFormattingManager AutoFormattingManager { get; }
    Property Value
    Type Description
    AutoFormattingManager

    AutoIndent

    Gets or sets a value indicating whether smart auto indent should be used. When set to true, AutoIndentMode is set to smart. When set to false, AutoIndentMode is set to None. Obsolete, use AutoIndentMode now.

    Declaration
    [Obsolete("Please use AutoIndentMode property instead of this one. This property will be removed in a future releases.")]
    public bool AutoIndent { get; set; }
    Property Value
    Type Description
    System.Boolean

    AutoIndentGuideline

    Gets or sets a value indicating whether indent guideline should be shown automatically after cursor repositioning.

    Declaration
    public bool AutoIndentGuideline { get; set; }
    Property Value
    Type Description
    System.Boolean

    AutoIndentMode

    Gets or sets the mode of auto indentation. The options provided are None, Block and Smart as like in Visual studio code editor.

    Declaration
    public AutoIndentMode AutoIndentMode { get; set; }
    Property Value
    Type Description
    AutoIndentMode

    AutoSave

    Gets or sets a value indicating whether the files can be autosaved or not in EditControl.

    Declaration
    public bool AutoSave { get; set; }
    Property Value
    Type Description
    System.Boolean

    AutoSize

    Gets or sets a value indicating whether auto resizing of the control is turned on.

    Declaration
    public bool AutoSize { get; set; }
    Property Value
    Type Description
    System.Boolean

    BackgroundColor

    Gets or sets the background color of EditControl.

    Declaration
    public BrushInfo BackgroundColor { get; set; }
    Property Value
    Type Description
    BrushInfo

    Bookmarks

    Gets the read-only copy of the bookmarks collection in EditControl.

    Declaration
    public BookmarksCollection Bookmarks { get; }
    Property Value
    Type Description
    BookmarksCollection

    BookmarkTooltipBackgroundBrush

    Gets or sets the brush info object that is used to draw bookmark tooltip background color.

    Declaration
    public BrushInfo BookmarkTooltipBackgroundBrush { get; set; }
    Property Value
    Type Description
    BrushInfo

    BookmarkTooltipBorderColor

    Gets or sets the border color of bookmark tooltip form.

    Declaration
    public Color BookmarkTooltipBorderColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    BorderStyle

    Gets or sets the border style of the EditControl.

    Declaration
    public BorderStyle BorderStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.BorderStyle

    BottomVerticalSplitterPosition

    Gets or sets the position of the bottom vertical splitter in EditControl.

    Declaration
    public int BottomVerticalSplitterPosition { get; set; }
    Property Value
    Type Description
    System.Int32

    CanApplyTheme

    Gets or sets a value indicating whether a SkinManager theme settings can be applied to the control.

    Declaration
    public bool CanApplyTheme { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true.

    Remarks

    This property must be initialized before applying the VisualTheme />

    CanCopy

    Gets a value indicating whether copy operation can be done in EditControl.

    Declaration
    public bool CanCopy { get; }
    Property Value
    Type Description
    System.Boolean

    CanCut

    Gets a value indicating whether cut operation can be done in EditControl.

    Declaration
    public bool CanCut { get; }
    Property Value
    Type Description
    System.Boolean

    CanOverrideStyle

    Gets or sets a value indicating whether control elements styles can be overridden by theme style settings.

    Declaration
    public bool CanOverrideStyle { get; set; }
    Property Value
    Type Description
    System.Boolean

    Default value is false.

    Remarks

    By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. This property should be enabled or disabled before calling the ThemeName property of the control.

    CanPaste

    Gets a value indicating whether paste operation can be done in EditControl.

    Declaration
    public bool CanPaste { get; }
    Property Value
    Type Description
    System.Boolean

    CanRedo

    Gets a value indicating whether redo operation can be done in EditControl.

    Declaration
    public bool CanRedo { get; }
    Property Value
    Type Description
    System.Boolean

    CanUndo

    Gets a value indicating whether undo operation can be done in EditControl.

    Declaration
    public bool CanUndo { get; }
    Property Value
    Type Description
    System.Boolean

    ChangedLinesMarkingLineColor

    Gets or sets the color of changed lines marking line in EditControl.

    Declaration
    public Color ChangedLinesMarkingLineColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ClearStaticDataOnDispose

    Gets or sets a value indicating whether static data should be cleared on dispose. Frees memory, but impairs time of next loading of EditControl.

    Declaration
    public bool ClearStaticDataOnDispose { get; set; }
    Property Value
    Type Description
    System.Boolean

    CodeSnipptSize

    Gets or sets the size of CodeSnippet block.

    Declaration
    public Size CodeSnipptSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    ColumnGuideItems

    Gets or sets the array of ColumnGuideItems objects.

    Declaration
    public ColumnGuideItem[] ColumnGuideItems { get; set; }
    Property Value
    Type Description
    ColumnGuideItem[]

    ColumnGuidesMeasuringFont

    Gets or sets the font that is used while measuring position of column guides.

    Declaration
    public Font ColumnGuidesMeasuringFont { get; set; }
    Property Value
    Type Description
    System.Drawing.Font

    Commands

    Gets the list of commands that are used in EditControl.

    Declaration
    public IKeyCommandList Commands { get; }
    Property Value
    Type Description
    IKeyCommandList

    Configurator

    Gets or sets the language configurator in EditControl.

    Declaration
    public Config Configurator { get; set; }
    Property Value
    Type Description
    Config

    ContextChoiceAutoReplace

    Gets or sets a value indicating whether the ContextChoice replace is required.

    Declaration
    public bool ContextChoiceAutoReplace { get; set; }
    Property Value
    Type Description
    System.Boolean

    ContextChoiceBackColor

    Gets or sets the background color of the context choice that helps to speed up coding by reducing typos and other common mistakes.

    Declaration
    public Color ContextChoiceBackColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ContextChoiceBorderColor

    Gets or sets the border color of context choice that helps to speed up coding by reducing typos and other common mistakes.

    Declaration
    public Color ContextChoiceBorderColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ContextChoiceController

    Gets the context choice controller with a list of code completion options to speed up coding by reducing typos and other common mistakes.

    Declaration
    public IContextChoiceController ContextChoiceController { get; }
    Property Value
    Type Description
    IContextChoiceController

    ContextChoiceFont

    Gets or sets the font that are used in ContextChoice that helps to speed up coding by reducing typos and other common mistakes.

    Declaration
    public Font ContextChoiceFont { get; set; }
    Property Value
    Type Description
    System.Drawing.Font

    ContextChoiceForeColor

    Gets or sets the foreground color of the context choice that helps to speed up coding by reducing typos and other common mistakes.

    Declaration
    public Color ContextChoiceForeColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ContextChoiceSize

    Gets or sets the size of the context choice pop-up window that helps to speed up coding by reducing typos and other common mistakes.

    Declaration
    public Size ContextChoiceSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    ContextMenuEnabled

    Gets or sets a value indicating whether context menu should be shown or not while right click on EditControl.

    Declaration
    public bool ContextMenuEnabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    ContextMenuManager

    Gets or sets the context menu manager that allows the user to edit the contents, and open or create a new file in EditControl.

    Declaration
    public ContextMenuManager ContextMenuManager { get; set; }
    Property Value
    Type Description
    ContextMenuManager

    ContextPromptBackgroundBrush

    Gets or sets the brush info object that is used to draw context prompt background color.

    Declaration
    public BrushInfo ContextPromptBackgroundBrush { get; set; }
    Property Value
    Type Description
    BrushInfo

    ContextPromptBorderColor

    Gets or sets the border color of context prompt that enables user to speed up text input, formatting, auto correction and much more.

    Declaration
    public Color ContextPromptBorderColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ContextPromptCustomSize

    Gets or sets the size of context prompt pop-up window that enables user to speed up text input, formatting, auto correction and much more.

    Declaration
    public Size ContextPromptCustomSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    ContextTooltipBackgroundBrush

    Gets or sets the brush info object that is used to draw context tooltip background color.

    Declaration
    public BrushInfo ContextTooltipBackgroundBrush { get; set; }
    Property Value
    Type Description
    BrushInfo

    ContextTooltipBorderColor

    Gets or sets the border color of context tooltip form.

    Declaration
    public Color ContextTooltipBorderColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ControlName

    Gets the name of the control.

    Declaration
    public string ControlName { get; }
    Property Value
    Type Description
    System.String

    ConvertOnLoad

    Gets or sets a value indicating whether all new-line symbols in text should be converted to one common new-line symbol while loading the control.

    Declaration
    public bool ConvertOnLoad { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Such file conversion is needed if file contains different new-line symbols or sequences.

    CreateParams

    Overriden. Changes System.Windows.Forms.CreateParams.Style to show or hide scrollbars and also consider the controls BorderStyle setting.

    Declaration
    protected override CreateParams CreateParams { get; }
    Property Value
    Type Description
    System.Windows.Forms.CreateParams

    CurrentColumn

    Gets or sets the current column in EditControl.

    Declaration
    public int CurrentColumn { get; set; }
    Property Value
    Type Description
    System.Int32

    CurrentLine

    Gets or sets the current line in EditControl.

    Declaration
    public int CurrentLine { get; set; }
    Property Value
    Type Description
    System.Int32

    CurrentLineHighlightColor

    Gets or sets the color of current line highlight in EditControl.

    Declaration
    public Color CurrentLineHighlightColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    CurrentLineInstance

    Gets the instance of the current line in EditControl.

    Declaration
    public ILexemLine CurrentLineInstance { get; }
    Property Value
    Type Description
    ILexemLine

    CurrentLineText

    Gets the text of the current line in EditControl.

    Declaration
    public string CurrentLineText { get; }
    Property Value
    Type Description
    System.String

    CurrentPosition

    Gets or sets the current position of cursor in term of virtual coordinates in EditControl.

    Declaration
    public Point CurrentPosition { get; set; }
    Property Value
    Type Description
    System.Drawing.Point

    Cursor

    Sets the cursor that is displayed when the mouse pointer is over the control.

    Declaration
    public override Cursor Cursor { set; }
    Property Value
    Type Description
    System.Windows.Forms.Cursor

    CursorGraphicalLocation

    Gets the location of right-bottom position cursor's in control coordinates.

    Declaration
    public Point CursorGraphicalLocation { get; }
    Property Value
    Type Description
    System.Drawing.Point

    CustomBookmarks

    Gets the read-only copy of the custom bookmarks collection EditControl.

    Declaration
    public CustomBookmarksCollection CustomBookmarks { get; }
    Property Value
    Type Description
    CustomBookmarksCollection

    CustomCursor

    Gets or sets the custom bitmap for mouse pointer.

    Declaration
    public Bitmap CustomCursor { get; set; }
    Property Value
    Type Description
    System.Drawing.Bitmap

    CustomLineWrappingMarkingImage

    Gets or sets the custom image that marks lines wrapping.

    Declaration
    public Image CustomLineWrappingMarkingImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    CustomWrappedLinesMarkingImage

    Gets or sets the custom image that marks wrapped lines.

    Declaration
    public Image CustomWrappedLinesMarkingImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    DefaultNewLineStyle

    Gets or sets the new line style of the newly created stream.

    Declaration
    public NewLineStyle DefaultNewLineStyle { get; set; }
    Property Value
    Type Description
    NewLineStyle

    DisplayedFileName

    Gets the name of the file.

    Declaration
    public string DisplayedFileName { get; }
    Property Value
    Type Description
    System.String

    DrawCodeSnippetBorder

    Gets or sets a value indicating whether border should be drawn around active code snippets.

    Declaration
    public bool DrawCodeSnippetBorder { get; set; }
    Property Value
    Type Description
    System.Boolean

    DropAllFiles

    Gets or sets a value indicating whether all files can be dropped to EditControl. If set to false, only files with extension contained in FileExtensions can be dropped.

    Declaration
    public bool DropAllFiles { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableBlockSelection

    Gets or sets a value indicating whether to enable VS like Block selection. This property is applicable only when the Selection Mode is in normal selection.

    Declaration
    public bool EnableBlockSelection { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableInlineCollapsing

    Gets or sets a value indicating whether the nested Collapsing behavior should be enabled.

    Declaration
    public bool EnableInlineCollapsing { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableMD5

    Gets or sets a value indicating whether EditControl support MD5.

    Declaration
    public bool EnableMD5 { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableRTL

    Gets or sets a value indicating whether the control support RightToLeft mode.

    Declaration
    public bool EnableRTL { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableSmartInBlockIndent

    Gets or sets a value indicating whether auto indent smart mode should be work in block mode.

    Declaration
    public bool EnableSmartInBlockIndent { get; set; }
    Property Value
    Type Description
    System.Boolean

    EndOfLineBackColor

    Gets or sets the background color for the line break character to be added at the end of the line on pressing the enter key.

    Declaration
    public Color EndOfLineBackColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color
    Remarks

    The background color of the line break character is applicable only if ShowEndOfLine property is true.

    See Also
    ShowEndOfLine

    EndOfLineForeColor

    Gets or sets the foreground color for the line break character to be added at the end of the line on pressing the enter key.

    Declaration
    public Color EndOfLineForeColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color
    Remarks

    The text color of the line break character is applicable only if ShowEndOfLine property is true.

    See Also
    ShowEndOfLine

    ExtendItemsFilteringString

    Gets or sets a value indicating whether context choice items filtering string should be extended back to the whitespace.

    Declaration
    public bool ExtendItemsFilteringString { get; set; }
    Property Value
    Type Description
    System.Boolean

    ExtendSelectionToFarRight

    Gets or sets a value indicating whether line selection should be extended to far right.

    Declaration
    public bool ExtendSelectionToFarRight { get; set; }
    Property Value
    Type Description
    System.Boolean

    FileExtensions

    Gets or sets the extensions of files that can be dropped to EditControl.

    Declaration
    public string[] FileExtensions { get; set; }
    Property Value
    Type Description
    System.String[]

    FileModified

    Gets or sets a value indicating whether the file is modified or not.

    Declaration
    public bool FileModified { get; set; }
    Property Value
    Type Description
    System.Boolean

    FileName

    Gets or sets the name of the currently opened file in EditControl.

    Declaration
    public string FileName { get; set; }
    Property Value
    Type Description
    System.String

    FileOpened

    Gets or sets the file stream, that is used as an input in EditControl.

    Declaration
    public FileStream FileOpened { get; set; }
    Property Value
    Type Description
    System.IO.FileStream

    FilterAutoCompleteItems

    Gets or sets a value indicating whether context choice items should be filtered while typing.

    Declaration
    public bool FilterAutoCompleteItems { get; set; }
    Property Value
    Type Description
    System.Boolean

    FindControl

    Gets or sets the find dialog form that helps to find occurrences of specified text with constraints such as case matching, matching whole words etc., in EditControl.

    Declaration
    public IFindDialogForm FindControl { get; set; }
    Property Value
    Type Description
    IFindDialogForm

    FindHistory

    Gets the search history details which had been performed in Find dialog box.

    Declaration
    public ArrayList FindHistory { get; }
    Property Value
    Type Description
    System.Collections.ArrayList

    FlushSavedLines

    Gets or sets a value indicating whether the saved lines will be flushed or not. If set to false, the saved lines will not have flushed.

    Declaration
    public bool FlushSavedLines { get; set; }
    Property Value
    Type Description
    System.Boolean

    FlushUndoRedoOnSave

    Gets or sets a value indicating whether to enable Undo/Redo after save.

    Declaration
    public bool FlushUndoRedoOnSave { get; set; }
    Property Value
    Type Description
    System.Boolean

    GotoControl

    Gets or sets the GoTo dialog form which is used to position the mouse pointer on any specified line that the user wish to go in EditControl.

    Declaration
    public IGotoDialogForm GotoControl { get; set; }
    Property Value
    Type Description
    IGotoDialogForm

    GraphicsCompositingQuality

    Gets or sets the image composition quality in EditControl.

    Declaration
    public CompositingQuality GraphicsCompositingQuality { get; set; }
    Property Value
    Type Description
    System.Drawing.Drawing2D.CompositingQuality

    GraphicsInterpolationMode

    Gets or sets the interpolation mode in EditControl.

    Declaration
    public InterpolationMode GraphicsInterpolationMode { get; set; }
    Property Value
    Type Description
    System.Drawing.Drawing2D.InterpolationMode

    GraphicsSmoothingMode

    Gets or sets the rendering quality for the EditControl.

    Declaration
    public SmoothingMode GraphicsSmoothingMode { get; set; }
    Property Value
    Type Description
    System.Drawing.Drawing2D.SmoothingMode

    GraphicsTextRenderingHint

    Gets or sets the rendering mode for text associated with the EditControl.

    Declaration
    public TextRenderingHint GraphicsTextRenderingHint { get; set; }
    Property Value
    Type Description
    System.Drawing.Text.TextRenderingHint

    GroupUndo

    Gets or sets a value indicating whether grouping should be enabled while performing undo/redo actions.

    Declaration
    public bool GroupUndo { get; set; }
    Property Value
    Type Description
    System.Boolean

    HighlightCurrentLine

    Gets or sets a value indicating whether current line should be highlighted in EditControl.

    Declaration
    public bool HighlightCurrentLine { get; set; }
    Property Value
    Type Description
    System.Boolean

    HorizontalSplitterPosition

    Gets or sets the position of the horizontal splitter in EditControl.

    Declaration
    public int HorizontalSplitterPosition { get; set; }
    Property Value
    Type Description
    System.Int32

    HScrollBar

    Gets a reference to an object with horizontal scrollbar settings of the control.

    Declaration
    public ScrollBarWrapper HScrollBar { get; }
    Property Value
    Type Description
    ScrollBarWrapper

    IndentationBlockBackgroundBrush

    Gets or sets the brush info object that is used to draw indentation block background.

    Declaration
    public BrushInfo IndentationBlockBackgroundBrush { get; set; }
    Property Value
    Type Description
    BrushInfo

    IndentationBlockBorderColor

    Gets or sets the color of indentation block border line.

    Declaration
    public Color IndentationBlockBorderColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    IndentationBlockBorderStyle

    Gets or sets the style of indentation block border line.

    Declaration
    public FrameBorderStyle IndentationBlockBorderStyle { get; set; }
    Property Value
    Type Description
    FrameBorderStyle

    IndentBlockHighlightingColor

    Gets or sets the color for the highlighting indented block start and end.

    Declaration
    public Color IndentBlockHighlightingColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    IndentLineColor

    Gets or sets the color for block indentation line.

    Declaration
    public Color IndentLineColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    IndicatorMarginBackColor

    Gets or sets the background color of the indicator margin. Indicator margin is used for displaying the custom indicators and bookmarks.

    Declaration
    public Color IndicatorMarginBackColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    InsertDroppedFileIntoText

    Gets or sets a value indicating whether outer file dragged and dropped into EditControl should be inserted into current content. If set to false, current file is closed and dropped outer file is opened.

    Declaration
    public bool InsertDroppedFileIntoText { get; set; }
    Property Value
    Type Description
    System.Boolean

    InsertMode

    Gets or sets a value indicating whether the characters typed get inserted into the EditControl, without overwriting the existing text. If set to False, the characters typed overwrite the existing text.

    Declaration
    public bool InsertMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsClosed

    Gets a value indicating whether the underlying stream is closed or not.

    Declaration
    [Obsolete("When underlying stream is closed, new stream is opened.")]
    public bool IsClosed { get; }
    Property Value
    Type Description
    System.Boolean

    IsModified

    Gets a value indicating whether the content of the file was modified in EditControl.

    Declaration
    public bool IsModified { get; }
    Property Value
    Type Description
    System.Boolean

    IsVisualStyleEnabled

    Gets a value indicating whether the visual style based theme is applied to the EditControl. This also indicates whether the theme files are referred from external assemblies or not.

    Declaration
    public bool IsVisualStyleEnabled { get; }
    Property Value
    Type Description
    System.Boolean

    Return true, if the visual style based theme is applied to . Otherwise returns false.

    KeyBinder

    Gets the key binder that provides advanced customization of keystroke bindings for all editing and navigation operations.

    Declaration
    public IKeyCommandListBinder KeyBinder { get; }
    Property Value
    Type Description
    IKeyCommandListBinder

    KeyBindingProcessor

    Gets or sets the key binding processor.

    Declaration
    public KeyProcessor KeyBindingProcessor { get; set; }
    Property Value
    Type Description
    KeyProcessor

    Language

    Gets or sets the currently used configuration language in EditControl.

    Declaration
    public IConfigLanguage Language { get; set; }
    Property Value
    Type Description
    IConfigLanguage

    Languages

    Gets the list of available languages in EditControl.

    Declaration
    public IList Languages { get; }
    Property Value
    Type Description
    System.Collections.IList

    LexicalMacrosManager

    Gets the lexical macros manager.

    Declaration
    public MacrosManager LexicalMacrosManager { get; }
    Property Value
    Type Description
    MacrosManager

    LikeVisualStudioSearch

    Gets or sets a value indicating whether searching the text is same as like in visual studio editor.

    Declaration
    public bool LikeVisualStudioSearch { get; set; }
    Property Value
    Type Description
    System.Boolean

    LineNumbersAlignment

    Gets or sets the alignment of line number area in EditControl.

    Declaration
    public LineNumberAlignment LineNumbersAlignment { get; set; }
    Property Value
    Type Description
    LineNumberAlignment

    LineNumbersColor

    Gets or sets the color of line numbers which was displayed on the indicator margin in EditControl.

    Declaration
    public Color LineNumbersColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    LineNumbersFont

    Gets or sets the font of line numbers which was displayed on the indicator margin in EditControl.

    Declaration
    public Font LineNumbersFont { get; set; }
    Property Value
    Type Description
    System.Drawing.Font

    Lines

    Gets or sets the collection of the text lines in EditControl.

    Declaration
    public string[] Lines { get; set; }
    Property Value
    Type Description
    System.String[]

    LoadConfigFile

    Gets or sets a value indicating whether config file should be loaded. If set to false, default language is created from code.

    Declaration
    [Obsolete("Is ignored.")]
    public bool LoadConfigFile { get; set; }
    Property Value
    Type Description
    System.Boolean

    MarkChangedLines

    Gets or sets a value indicating whether the changed lines should be marked in EditControl.

    Declaration
    public bool MarkChangedLines { get; set; }
    Property Value
    Type Description
    System.Boolean

    MarkerAreaWidth

    Gets or sets the width of marker area.

    Declaration
    public int MarkerAreaWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    MarkLineWrapping

    Gets or sets a value indicating whether the lines wrapping should be marked or not.

    Declaration
    public bool MarkLineWrapping { get; set; }
    Property Value
    Type Description
    System.Boolean

    MarkWrappedLines

    Gets or sets a value indicating whether wrapped lines should be marked or not.

    Declaration
    public bool MarkWrappedLines { get; set; }
    Property Value
    Type Description
    System.Boolean

    MinSize

    Gets or sets the minimum size of the EditControl in autosize mode.

    Declaration
    public Size MinSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    OnlyHighlightMatchingBraces

    Gets or sets a value indicating whether to highlight brackets in EditControl.

    Declaration
    public bool OnlyHighlightMatchingBraces { get; set; }
    Property Value
    Type Description
    System.Boolean

    PageHeaderAndFooterVisible

    Gets or sets a value indicating whether the page header and footer should be printed or not.

    Declaration
    public bool PageHeaderAndFooterVisible { get; set; }
    Property Value
    Type Description
    System.Boolean

    ParagraphOffset

    Gets or sets the offset of paragraphs.

    Declaration
    public int ParagraphOffset { get; set; }
    Property Value
    Type Description
    System.Int32

    Parser

    Gets the parser for internal usage.

    Declaration
    public RenderableLexemParser Parser { get; }
    Property Value
    Type Description
    RenderableLexemParser

    ParsingMode

    Gets or sets the text parsing mode in EditControl. User can select between high parsing speed or high syntax highlighting accuracy.

    Declaration
    public TextParsingMode ParsingMode { get; set; }
    Property Value
    Type Description
    TextParsingMode

    PhysicalLineCount

    Gets the number of lines in the files of EditControl.

    Declaration
    public int PhysicalLineCount { get; }
    Property Value
    Type Description
    System.Int32

    PrintDocument

    Gets the print document, which is used to print the contents of the EditControl.

    Declaration
    public PrintDocument PrintDocument { get; }
    Property Value
    Type Description
    System.Drawing.Printing.PrintDocument

    PrintDocumentName

    Gets or sets a value indicating whether the document name should be printed when page header is visible.

    Declaration
    public bool PrintDocumentName { get; set; }
    Property Value
    Type Description
    System.Boolean

    PrintPageNumber

    Gets or sets a value indicating whether page number should be printed when page footer is visible.

    Declaration
    public bool PrintPageNumber { get; set; }
    Property Value
    Type Description
    System.Boolean

    PseudoFileName

    Gets or sets the file name to be shown in SaveAs dialog.

    Declaration
    public string PseudoFileName { get; set; }
    Property Value
    Type Description
    System.String

    ReadOnly

    Gets or sets a value indicating whether EditControl is in read-only mode.

    Declaration
    public bool ReadOnly { get; set; }
    Property Value
    Type Description
    System.Boolean

    RenderRightToLeft

    Gets or sets a value indicating whether to render the content of the control in RightToLeft layout.

    Declaration
    public bool RenderRightToLeft { get; set; }
    Property Value
    Type Description
    System.Boolean

    ReplaceControl

    Gets or sets the replace dialog form that helps to replace specified text with replacement text as per the conditions specified in EditControl.

    Declaration
    public IReplaceDialogForm ReplaceControl { get; set; }
    Property Value
    Type Description
    IReplaceDialogForm

    ReplaceHistory

    Gets the history of Replace dialog.

    Declaration
    public ArrayList ReplaceHistory { get; }
    Property Value
    Type Description
    System.Collections.ArrayList

    ReplaceSearchHistory

    Gets the search history details which had been performed in Replace dialog box.

    Declaration
    public ArrayList ReplaceSearchHistory { get; }
    Property Value
    Type Description
    System.Collections.ArrayList

    RespectTabStopsOnInsertingText

    Gets or sets a value indicating whether tab stops should be respected on inserting blocks of text.

    Declaration
    public bool RespectTabStopsOnInsertingText { get; set; }
    Property Value
    Type Description
    System.Boolean

    RightToLeft

    Use RenderRightToLeft instead.

    Declaration
    public override RightToLeft RightToLeft { get; }
    Property Value
    Type Description
    System.Windows.Forms.RightToLeft

    SavedLinesMarkingLineColor

    Gets or sets the color of saved lines marking line in EditControl.

    Declaration
    public Color SavedLinesMarkingLineColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    SaveOnClose

    Gets or sets a value indicating whether save prompt dialog should be displayed before EditControl is closed.

    Declaration
    public bool SaveOnClose { get; set; }
    Property Value
    Type Description
    System.Boolean

    ScrollbarBottomButtons

    Gets the buttons on the bottom of vertical scrollbar.

    Declaration
    public ControlsCollection ScrollbarBottomButtons { get; }
    Property Value
    Type Description
    ControlsCollection

    ScrollbarLeftButtons

    Gets the buttons on the left of horizontal scrollbar.

    Declaration
    public ControlsCollection ScrollbarLeftButtons { get; }
    Property Value
    Type Description
    ControlsCollection

    ScrollbarRightButtons

    Gets the buttons on the right of vertical scrollbar.

    Declaration
    public ControlsCollection ScrollbarRightButtons { get; }
    Property Value
    Type Description
    ControlsCollection

    ScrollbarTopButtons

    Gets the buttons on the top of vertical scrollbar.

    Declaration
    public ControlsCollection ScrollbarTopButtons { get; }
    Property Value
    Type Description
    ControlsCollection

    ScrollColorScheme

    Gets or sets the scrollbar color scheme when Office2007 or Office2007Generic style is set.

    Declaration
    public Office2007ColorScheme ScrollColorScheme { get; set; }
    Property Value
    Type Description
    Office2007ColorScheme

    ScrollOffsetBottom

    Gets the bottom offset value of scroller position in EditControl.

    Declaration
    public int ScrollOffsetBottom { get; set; }
    Property Value
    Type Description
    System.Int32

    ScrollOffsetLeft

    Gets the left offset value of scroller position in EditControl.

    Declaration
    public int ScrollOffsetLeft { get; set; }
    Property Value
    Type Description
    System.Int32

    ScrollOffsetRight

    Gets the right offset value of scroller position in EditControl.

    Declaration
    public int ScrollOffsetRight { get; set; }
    Property Value
    Type Description
    System.Int32

    ScrollOffsetTop

    Gets the top offset value of scroller position in EditControl.

    Declaration
    public int ScrollOffsetTop { get; set; }
    Property Value
    Type Description
    System.Int32

    ScrollPosition

    Gets or sets the scroll position of EditControl.

    Declaration
    public Point ScrollPosition { get; set; }
    Property Value
    Type Description
    System.Drawing.Point

    ScrollVisualStyle

    Gets or sets the visual style of scrollbar.

    Declaration
    public ScrollBarCustomDrawStyles ScrollVisualStyle { get; set; }
    Property Value
    Type Description
    ScrollBarCustomDrawStyles

    SelectedText

    Gets or sets the selected text in EditControl.

    Declaration
    public string SelectedText { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    If there is no text selected and you are setting new selected text, it will be inserted in the position of the cursor. Otherwise, when there is some text selected, it will be deleted and new text will be inserted.

    Selection

    Gets the selected text range in EditControl.

    Declaration
    public ITextRange Selection { get; }
    Property Value
    Type Description
    ITextRange

    SelectionMarginBackgroundColor

    Gets or sets the background color for selection margin that enables the user to select the contents of the entire line in the EditControl, by simply clicking on the corresponding selection margin area of the line.

    Declaration
    public Color SelectionMarginBackgroundColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    SelectionMarginForegroundColor

    Gets or sets the foreground color for selection margin area that displays on the left side of the EditControl.

    Declaration
    public Color SelectionMarginForegroundColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    SelectionMarginWidth

    Gets or sets the width of the selection margin that enables the user to select the contents of the entire line in the EditControl, by simply clicking on the corresponding selection margin area of the line.

    Declaration
    public int SelectionMarginWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    SelectionMode

    Gets or sets the EditControl Selection Mode.

    Declaration
    public SelectionModes SelectionMode { get; set; }
    Property Value
    Type Description
    SelectionModes

    SelectionTextColor

    Gets or sets the color for the selected text in EditControl.

    Declaration
    public Color SelectionTextColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    SelectOnLineNumberClick

    Gets or sets a value indicating whether selection is performed while clicking on line numbers.

    Declaration
    public bool SelectOnLineNumberClick { get; set; }
    Property Value
    Type Description
    System.Boolean

    SelectTextAfterDragDrop

    Gets or sets a value indicating whether text should be selected after drag or drop operation is performed in EditControl.

    Declaration
    public bool SelectTextAfterDragDrop { get; set; }
    Property Value
    Type Description
    System.Boolean

    SetMarkerOnEncodingChanged

    Gets or sets a value indicating whether the changed lines should be marked once encoding changed at run-time.

    Declaration
    public bool SetMarkerOnEncodingChanged { get; set; }
    Property Value
    Type Description
    System.Boolean

    SharedFileMode

    Gets or sets a value indicating whether the file should be opened in shared mode or not.

    Declaration
    public bool SharedFileMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowBookmarkTooltip

    Gets or sets a value indicating whether bookmark tooltips should be shown or not.

    Declaration
    public bool ShowBookmarkTooltip { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowCollapse

    Gets or sets a value indicating whether collapsers should be shown in EditControl.

    Declaration
    public bool ShowCollapse { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowColumnGuides

    Gets or sets a value indicating whether column guides should be drawn or not.

    Declaration
    public bool ShowColumnGuides { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowContentDividers

    Gets or sets a value indicating whether content dividers should be shown in EditControl.

    Declaration
    public bool ShowContentDividers { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowContextTooltip

    Gets or sets a value indicating whether context tooltips should be shown while placing the cursor over the word.

    Declaration
    public bool ShowContextTooltip { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowEndOfLine

    Declaration
    public bool ShowEndOfLine { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowFileDropNotification

    Gets or sets a value indicating whether the notification is shown when drag and dropped file into EditControl. When this property is to false, error message will not occurred The error message will shows when InsertDroppedFileIntoText property is to false.

    Declaration
    public bool ShowFileDropNotification { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowHorizontalScroller

    Gets or sets a value indicating whether the horizontal scroller are shown in EditControl when text is longer than the width of the control.

    Declaration
    public bool ShowHorizontalScroller { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowHorizontalSplitters

    Gets or sets a value indicating whether the files in the EditControl are separated with horizontal splitter.

    Declaration
    public bool ShowHorizontalSplitters { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowIndentationBlockBorders

    Gets or sets a value indicating whether indentation block borders should be drawn in EditControl.

    Declaration
    public bool ShowIndentationBlockBorders { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowIndentationGuidelines

    Gets or sets a value indicating whether indentation guidelines should be shown in EditControl.

    Declaration
    public bool ShowIndentationGuidelines { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowIndicatorMargin

    Gets or sets a value indicating whether bookmarks and indicator margin should be visible in EditControl.

    Declaration
    public bool ShowIndicatorMargin { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowLineNumbers

    Gets or sets a value indicating whether line numbers should be shown in EditControl.

    Declaration
    public bool ShowLineNumbers { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowMarkers

    Gets or sets a value indicating whether the line markers should be visible in EditControl.

    Declaration
    public bool ShowMarkers { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowOutliningCollapsers

    Gets or sets a value indicating whether outlining collapsers should be shown in EditControl.

    Declaration
    public bool ShowOutliningCollapsers { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowOutliningTooltip

    Gets or sets a value indicating whether collapsed text is shown in tooltip when mouse hovers over collapsed section.

    Declaration
    public bool ShowOutliningTooltip { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowRightUserMargin

    Gets or sets a value indicating whether the right user margin should be visible in EditControl.

    Declaration
    [Obsolete("This property was renamed to ShowUserMargin.")]
    public bool ShowRightUserMargin { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowSelectionMargin

    Gets or sets a value indicating whether selection margin area should be visible or not in EditControl.

    Declaration
    public bool ShowSelectionMargin { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowUserMargin

    Gets or sets a value indicating whether the user margin should be visible in EditControl.

    Declaration
    public bool ShowUserMargin { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowVerticalScroller

    Gets or sets a value indicating whether the vertical scroller are shown in EditControl when text is longer than the height of the control.

    Declaration
    public bool ShowVerticalScroller { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowVerticalSplitters

    Gets or sets a value indicating whether the files in the EditControl are separated with vertical splitter.

    Declaration
    public bool ShowVerticalSplitters { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowWhitespaces

    Gets or sets a value indicating whether whitespaces should be shown as special symbols in EditControl.

    Declaration
    public bool ShowWhitespaces { get; set; }
    Property Value
    Type Description
    System.Boolean

    SingleLineMode

    Gets or sets a value indicating whether the single-line mode (like a regular TextBox) should be enabled in EditControl.

    Declaration
    public bool SingleLineMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    SpaceBetweenLines

    Gets or sets the space between lines in pixels.

    Declaration
    public int SpaceBetweenLines { get; set; }
    Property Value
    Type Description
    System.Int32

    SplitterBackgroundBrush

    Gets or sets the brush which is used for drawing the Splitter background.

    Declaration
    public Brush SplitterBackgroundBrush { get; set; }
    Property Value
    Type Description
    System.Drawing.Brush

    StatusBarSettings

    Gets the settings of status bar that contains many sub properties, which can be used to customize the appearance and visibility of the status bar and its panels.

    Declaration
    public StatusBarSettings StatusBarSettings { get; }
    Property Value
    Type Description
    StatusBarSettings

    Style

    Gets or sets the style value to customize the appearance of the EditControl

    Declaration
    public EditControlStyle Style { get; set; }
    Property Value
    Type Description
    EditControlStyle

    TabSize

    Gets or sets the count of spaces to be placed instead tabulation symbol.

    Declaration
    public int TabSize { get; set; }
    Property Value
    Type Description
    System.Int32

    TabStopsArray

    Gets or sets the array of tab stops.

    Declaration
    public int[] TabStopsArray { get; set; }
    Property Value
    Type Description
    System.Int32[]

    Text

    Gets or sets the editable text of the control.

    Declaration
    public string Text { get; set; }
    Property Value
    Type Description
    System.String

    TextAreaWidth

    Gets or sets the width of wordwrap margin. In EditControl, word-wrap margin is visible only while setting WordWrapMarginVisible property to true.

    Declaration
    public int TextAreaWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    ThemeName

    Gets or sets the theme name of the control.

    Declaration
    public string ThemeName { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null.

    Remarks

    This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

    ThemeStyle

    Gets or sets the GroupBarVisualStyle value used to customize the appearance of the EditControl.

    Declaration
    public EditControlVisualStyle ThemeStyle { get; set; }
    Property Value
    Type Description
    EditControlVisualStyle
    Remarks

    This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

    ToolTipDelay

    Gets or sets the delay time for showing the tooltips in milliseconds.

    Declaration
    public int ToolTipDelay { get; set; }
    Property Value
    Type Description
    System.Int32

    TopVerticalSplitterPosition

    Gets or sets the position of the top vertical splitter in EditControl.

    Declaration
    public int TopVerticalSplitterPosition { get; set; }
    Property Value
    Type Description
    System.Int32

    TransferFocusOnTab

    Gets or sets a value indicating whether control should transfer focus to the next control when user presses tab key, or it should insert tab symbol instead.

    Declaration
    public bool TransferFocusOnTab { get; set; }
    Property Value
    Type Description
    System.Boolean

    TransparentSelection

    Gets or sets a value indicating whether the transparent selection should be used or not in EditControl.

    Declaration
    public bool TransparentSelection { get; set; }
    Property Value
    Type Description
    System.Boolean

    UpdateContextChoiceList

    Gets or sets a value indicating whether the context choice should be updated when it is active and user types something.

    Declaration
    [Obsolete("This property will be removed in next release.")]
    public bool UpdateContextChoiceList { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseAutoreplaceTriggers

    Gets or sets a value indicating whether auto replace triggers should be used in EditControl.

    Declaration
    public bool UseAutoreplaceTriggers { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseCustomSizeContextPrompt

    Gets or sets a value indicating whether the custom context prompt size should be used or not.

    Declaration
    public bool UseCustomSizeContextPrompt { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseNativeDrawing

    Gets or sets a value indicating whether native GDI should be used for text output.

    Declaration
    public bool UseNativeDrawing { get; set; }
    Property Value
    Type Description
    System.Boolean

    UserMarginBackgroundColor

    Gets or sets brush info object that is used to draw user margin background color.

    Declaration
    public BrushInfo UserMarginBackgroundColor { get; set; }
    Property Value
    Type Description
    BrushInfo

    UserMarginBorderColor

    Gets or sets the border color of user margin.

    Declaration
    public Color UserMarginBorderColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    UserMarginPlacement

    Gets or sets the placement of user margin in EditControl.

    Declaration
    public MarginPlacement UserMarginPlacement { get; set; }
    Property Value
    Type Description
    MarginPlacement

    UserMarginRightWidth

    Gets or sets the width of the right user margin in EditControl.

    Declaration
    [Obsolete("Property was renamed. Use UserMarginWidth instead.")]
    public int UserMarginRightWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    UserMarginTextColor

    Gets or sets the color of user margin text.

    Declaration
    public Color UserMarginTextColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    UserMarginTextFont

    Gets or sets the font of user margin text.

    Declaration
    public Font UserMarginTextFont { get; set; }
    Property Value
    Type Description
    System.Drawing.Font

    UserMarginWidth

    Gets or sets the width of the user margin that helps to displays additional information regarding the contents in the EditControl. Information can also be displayed on a line-by-line basis.

    Declaration
    public int UserMarginWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    UseTabs

    Gets or sets a value indicating whether tab symbols should be used, or spaces should be used instead.

    Declaration
    public bool UseTabs { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseTabStops

    Gets or sets a value indicating whether tab stops should be used in EditControl.

    Declaration
    public bool UseTabStops { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseXPStyle

    Gets or sets value indicating whether XP style should be used in EditControl.

    Declaration
    public bool UseXPStyle { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseXPStyleBorder

    Gets or sets value indicating whether XPStyle border should be used in EditControl.

    Declaration
    public bool UseXPStyleBorder { get; set; }
    Property Value
    Type Description
    System.Boolean

    VirtualLineNumberOffset

    Gets or sets the virtual line number start value.

    Declaration
    public int VirtualLineNumberOffset { get; set; }
    Property Value
    Type Description
    System.Int32

    VirtualSize

    Gets the virtual size of control.

    Declaration
    public Size VirtualSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size
    Remarks

    If control's client area is smaller then virtual size, then scrollers will be visible.

    VirtualSpaceMode

    Gets or sets a value indicating whether virtual space mode is enabled or not in EditControl.

    Declaration
    public bool VirtualSpaceMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    VisibleLineCount

    Gets the number of visible lines on the screen in EditControl.

    Declaration
    public int VisibleLineCount { get; }
    Property Value
    Type Description
    System.Int32

    VisualColumn

    Gets or sets the current virtual column in EditControl. Virtual column is visual position of character on the screen.

    Declaration
    public int VisualColumn { get; set; }
    Property Value
    Type Description
    System.Int32

    VScrollBar

    Gets a reference to an object with vertical scrollbar settings of the control.

    Declaration
    public ScrollBarWrapper VScrollBar { get; }
    Property Value
    Type Description
    ScrollBarWrapper

    VScrollMode

    Specifies how the control process vertical scrolling.

    Declaration
    public ScrollMode VScrollMode { get; set; }
    Property Value
    Type Description
    ScrollMode

    WhiteSpaceIndicators

    Gets the properties of show white spaces mode.

    Declaration
    public ShowWhiteSpaceProperties WhiteSpaceIndicators { get; }
    Property Value
    Type Description
    ShowWhiteSpaceProperties

    WordWrap

    Gets or sets a value indicating whether word-wrapping should be enabled in EditControl or not.

    Declaration
    public bool WordWrap { get; set; }
    Property Value
    Type Description
    System.Boolean

    WordWrapColumn

    Gets or sets the column for wrapping text and it is applicable only when WordWrapMode is set to SpecifiedColumn.

    Declaration
    public int WordWrapColumn { get; set; }
    Property Value
    Type Description
    System.Int32

    WordWrapColumnMeasuringFont

    Gets or sets the font that is used while calculating position of WordWrapColumn.

    Declaration
    public Font WordWrapColumnMeasuringFont { get; set; }
    Property Value
    Type Description
    System.Drawing.Font

    WordWrapMarginBrush

    Gets or sets BrushInfo object that is used when area situated after text area is drawn.

    Declaration
    public BrushInfo WordWrapMarginBrush { get; set; }
    Property Value
    Type Description
    BrushInfo

    WordWrapMarginLineColor

    Gets or sets the color for the line that is drawn at the border of the wordwrap margin.

    Declaration
    public Color WordWrapMarginLineColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    WordWrapMarginLineStyle

    Gets or sets the style of line that is drawn at the border of the word-wrap margin.

    Declaration
    public DashStyle WordWrapMarginLineStyle { get; set; }
    Property Value
    Type Description
    System.Drawing.Drawing2D.DashStyle

    WordWrapMarginVisible

    Gets or sets a value indicating whether word wrapping should be visible in EditControl.

    Declaration
    public bool WordWrapMarginVisible { get; set; }
    Property Value
    Type Description
    System.Boolean

    WordWrapMode

    Gets or sets the state of the word wrapping mode. Different types of wrapping mode in EditControl are Control, SpecifiedColumn and WordWrapMargin.

    Declaration
    public WordWrapMode WordWrapMode { get; set; }
    Property Value
    Type Description
    WordWrapMode

    WordWrapType

    Gets or sets the different types for wrapping the word in the EditControl.

    Declaration
    public WordWrapType WordWrapType { get; set; }
    Property Value
    Type Description
    WordWrapType

    WrapAroundSearch

    Gets or sets a value indicating whether to stop searching the word at the page end.

    Declaration
    public bool WrapAroundSearch { get; set; }
    Property Value
    Type Description
    System.Boolean

    WrappedLinesOffset

    Gets or sets the offset of wrapped lines.

    Declaration
    public int WrappedLinesOffset { get; set; }
    Property Value
    Type Description
    System.Int32

    ZoomFactor

    Gets or sets a value of ZoomFactor for zoom-in and zoom-out operations in EditControl.

    Declaration
    public float ZoomFactor { get; set; }
    Property Value
    Type Description
    System.Single

    Methods

    AddCodeSnippet(String, ArrayList, String)

    Helps to adds new code snippet to the current language of EditControl.

    Declaration
    public void AddCodeSnippet(string title, ArrayList literals, string code)
    Parameters
    Type Name Description
    System.String title

    Snippet title.

    System.Collections.ArrayList literals

    List of literals.

    System.String code

    Snippet code.

    AddTabsToSelection()

    Adds leading tab symbol to the selected lines, or just inserts tab symbol.

    Declaration
    public virtual void AddTabsToSelection()

    AppendText(String)

    Appends the specified text to the end of the existing contents of the EditControl.

    Declaration
    public void AppendText(string text)
    Parameters
    Type Name Description
    System.String text

    The text to be appended.

    ApplyConfiguration(KnownLanguages)

    Applies coloring of the specified language from the prefined configuration settings to the text in EditControl.

    Declaration
    public void ApplyConfiguration(KnownLanguages language)
    Parameters
    Type Name Description
    KnownLanguages language

    Known language to apply.

    ApplyConfiguration(IConfigLanguage)

    Applies coloring of the specified language from the predefined configuration settings to the text in EditControl.

    Declaration
    public void ApplyConfiguration(IConfigLanguage lang)
    Parameters
    Type Name Description
    IConfigLanguage lang

    New language configuration to be set.

    ApplyConfiguration(String)

    Applies coloring of the specified language from the prefined configuration settings to the text in EditControl.

    Declaration
    public void ApplyConfiguration(string languageName)
    Parameters
    Type Name Description
    System.String languageName

    Name of the language to apply.

    ApplySettingFromIsolatedStorage()

    Helps to applies context options settings from the isolated storage.

    Declaration
    public void ApplySettingFromIsolatedStorage()

    AttachToEvents()

    Attaches event reraisers to edit control.

    Declaration
    protected void AttachToEvents()

    AutoFormatText(Int32, Int32)

    Autoformats the given range of text.

    Declaration
    public void AutoFormatText(int iStartLineIndex, int iEndLineIndex)
    Parameters
    Type Name Description
    System.Int32 iStartLineIndex

    Index of first line of range to autoformat.

    System.Int32 iEndLineIndex

    Index of last line of range to autoformat.

    BeginInit()

    Stub for compatibility reasons.

    Declaration
    public void BeginInit()

    BindKeyboard()

    Shows keys binding form. Obsolete, use ShowKeysBindingEditor method now.

    Declaration
    [Obsolete]
    public void BindKeyboard()

    BookmarkAdd(Int32)

    Sets bookmark at the specified line for quick access to any part of the contents in EditControl.

    Declaration
    public IBookmark BookmarkAdd(int line)
    Parameters
    Type Name Description
    System.Int32 line

    Line index.

    Returns
    Type Description
    IBookmark

    Added bookmark.

    BookmarkAdd(Int32, BrushInfo)

    Sets bookmark at the specified line for quick access to any part of the contents in EditControl.

    Declaration
    public IBookmark BookmarkAdd(int line, BrushInfo brushinfo)
    Parameters
    Type Name Description
    System.Int32 line

    Line index.

    BrushInfo brushinfo

    BrushInfo object to fill bookmark area.

    Returns
    Type Description
    IBookmark

    Added bookmark.

    BookmarkAdd(Int32, BrushInfo, Color)

    Sets bookmark at the specified line for quick access to any part of the contents in EditControl.

    Declaration
    public IBookmark BookmarkAdd(int line, BrushInfo brushinfo, Color borderColor)
    Parameters
    Type Name Description
    System.Int32 line

    Line index.

    BrushInfo brushinfo

    BrushInfo object to fill bookmark area.

    System.Drawing.Color borderColor

    Color of bookmark border.

    Returns
    Type Description
    IBookmark

    Added bookmark.

    BookmarkClear()

    Clears all bookmarks in EditControl.

    Declaration
    public void BookmarkClear()

    BookmarkClear(Boolean)

    Clears all bookmarks in EditControl.

    Declaration
    public void BookmarkClear(bool clearCustom)
    Parameters
    Type Name Description
    System.Boolean clearCustom

    Specifies whether custom bookmarks should be cleared, too.

    BookmarkGet(Int32)

    Gets bookmark at the specified line.

    Declaration
    public IBookmark BookmarkGet(int line)
    Parameters
    Type Name Description
    System.Int32 line

    Line index.

    Returns
    Type Description
    IBookmark

    Bookmark at the specified line

    BookmarkNext()

    Moves the cursor position towards the next bookmark in EditControl.

    Declaration
    public virtual void BookmarkNext()

    BookmarkPrevious()

    Moves the cursor position towards the previous bookmark in EditControl.

    Declaration
    public virtual void BookmarkPrevious()

    BookmarkRemove(IBookmark)

    Removes bookmark at the specified line.

    Declaration
    public void BookmarkRemove(IBookmark bookmark)
    Parameters
    Type Name Description
    IBookmark bookmark

    Bookmark to be removed.

    BookmarkRemove(Int32)

    Removes bookmark at the specified line.

    Declaration
    public void BookmarkRemove(int line)
    Parameters
    Type Name Description
    System.Int32 line

    Line index.

    BookmarkToggle()

    Sets bookmark to the current line for quick access to any part of the contents in EditControl.

    Declaration
    public void BookmarkToggle()

    ChangeSnippetTemplateText(String, String)

    Changes text of all template members with defined name of currently activated code snippet.

    Declaration
    public void ChangeSnippetTemplateText(string memberName, string newText)
    Parameters
    Type Name Description
    System.String memberName

    Name of template member.

    System.String newText

    New text.

    ClearClipboard()

    Clears all contents in the clipboard associated with EditControl.

    Declaration
    public void ClearClipboard()

    Close()

    Helps to close the stream and makes the control readonly.

    Declaration
    public bool Close()
    Returns
    Type Description
    System.Boolean

    True is user did not canceled the operation; otherwise false.

    CloseContextChoice()

    Helps to Close the context choice popup window.

    Declaration
    public void CloseContextChoice()

    CloseContextPrompt()

    Helps to close the context prompt popup window.

    Declaration
    public void CloseContextPrompt()

    CloseContextTooltip()

    Helps to close the context tooltip popup window.

    Declaration
    public void CloseContextTooltip()

    CloseFindDialog()

    Closes the currently opened find dialog window.

    Declaration
    public void CloseFindDialog()

    CloseReplaceDialog()

    Closes the currently opened replace dialog window.

    Declaration
    public void CloseReplaceDialog()

    Collapse()

    Collapses all collapsible regions in currently selected area or in the current line.

    Declaration
    public void Collapse()

    CollapseAll()

    Helps to collapses all collapsible regions in EditControl.

    Declaration
    public void CollapseAll()

    CommentLine()

    Helps to comment the current line.

    Declaration
    public void CommentLine()

    CommentLine(Int32)

    Helps to comments the specified line.

    Declaration
    public void CommentLine(int iLineIndex)
    Parameters
    Type Name Description
    System.Int32 iLineIndex

    Index of line to comment.

    CommentSelection()

    Helps to comments the selected text.

    Declaration
    public void CommentSelection()

    CommentText(Point, Point)

    Helps to comments the text in the specified range.

    Declaration
    public void CommentText(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Beginning of range (physical coordinates).

    System.Drawing.Point pointEnd

    End of rage (physical coordinates).

    ConvertOffsetToVirtualPosition(Int64)

    Converts in-stream offset to virtual coordinates.

    Declaration
    public Point ConvertOffsetToVirtualPosition(long offset)
    Parameters
    Type Name Description
    System.Int64 offset

    In-Stream offset.

    Returns
    Type Description
    System.Drawing.Point

    Virtual position.

    ConvertVirtualPointToCoordinatePoint(Point)

    Converts point in virtual coordinates to coordinate point.

    Declaration
    public CoordinatePoint ConvertVirtualPointToCoordinatePoint(Point point)
    Parameters
    Type Name Description
    System.Drawing.Point point

    Point in virtual coordinates.

    Returns
    Type Description
    CoordinatePoint

    Coordinate point that corresponds to the specified virtual point.

    ConvertVirtualPointToCoordinatePoint(Int32, Int32)

    Converts point in virtual coordinates to coordinate point.

    Declaration
    public CoordinatePoint ConvertVirtualPointToCoordinatePoint(int column, int line)
    Parameters
    Type Name Description
    System.Int32 column

    Virtual column index.

    System.Int32 line

    Virtual line index.

    Returns
    Type Description
    CoordinatePoint

    Coordinate point that corresponds to the specified virtual point.

    ConvertVirtualPositionToOffset(Point)

    Converts virtual position in text to the offset in stream.

    Declaration
    public long ConvertVirtualPositionToOffset(Point point)
    Parameters
    Type Name Description
    System.Drawing.Point point

    Virtual position.

    Returns
    Type Description
    System.Int64

    Offset in the file or stream or -1 if such virtual position is not present in stream.

    ConvertVirtualPositionToPhysical(Point)

    Converts virtual coordinates to physical.

    Declaration
    public Point ConvertVirtualPositionToPhysical(Point point)
    Parameters
    Type Name Description
    System.Drawing.Point point

    Point in virtual coordinates.

    Returns
    Type Description
    System.Drawing.Point

    Point in physical coordinates or (0,0) if given virtual position is not present in the stream.

    Copy()

    Copies the selected text into the clipboard.

    Declaration
    public virtual void Copy()

    CreateAccessibilityInstance()

    New Instance for EditControl AccessibleObject

    Declaration
    protected override AccessibleObject CreateAccessibilityInstance()
    Returns
    Type Description
    System.Windows.Forms.AccessibleObject

    EditControlAccessibleObject

    CreateBitmap()

    Helps to creates the snapshot of the control. The bitmap image looks exactly like an actual snapshot of a live instance of EditControl.

    Declaration
    public Bitmap CreateBitmap()
    Returns
    Type Description
    System.Drawing.Bitmap

    Bitmap instance with actual snapshot of the control.

    Cut()

    Cuts the selected text contents from EditControl and maintains it in the clipboard.

    Declaration
    public virtual void Cut()

    DeleteAll()

    Helps to deletes all the text in document.

    Declaration
    public void DeleteAll()

    DeleteChar()

    Deletes one character to the right from the cursor position in EditControl.

    Declaration
    public void DeleteChar()

    DeleteCharLeft()

    Deletes one character to the left from the cursor position in EditControl.

    Declaration
    public void DeleteCharLeft()

    DeleteText(CoordinatePoint, CoordinatePoint)

    Helps to deletes the text at specified position.

    Declaration
    public void DeleteText(CoordinatePoint start, CoordinatePoint end)
    Parameters
    Type Name Description
    CoordinatePoint start

    Start coordinate point of text that has to be deleted.

    CoordinatePoint end

    End coordinate point of text that has to be deleted.

    DeleteText(Point, Point)

    Helps to deletes the text at specified position.

    Declaration
    public void DeleteText(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Start coordinate point of text that has to be deleted (physical coordinates).

    System.Drawing.Point pointEnd

    End coordinate point of text that has to be deleted (physical coordinates).

    DeleteWord()

    Deletes one word to the right from the cursor position in EditControl.

    Declaration
    public void DeleteWord()

    DeleteWordLeft()

    Deletes one word to the left from the cursor position in EditControl.

    Declaration
    public void DeleteWordLeft()

    DiscardChanges()

    Discards all changes made to the contents of the EditControl.

    Declaration
    public void DiscardChanges()

    Dispose(Boolean)

    Clean up any resources being used.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    True to release both managed and unmanaged resources; false to release only unmanaged resources.

    EndInit()

    Performs operations needed after initialization.

    Declaration
    public void EndInit()

    Expand()

    Expands all collapsed regions in currently selected area or in the current line.

    Declaration
    public void Expand()

    ExpandAll()

    Helps to expands all collapsed regions in EditControl.

    Declaration
    public void ExpandAll()

    FindCurrentText()

    Searches text under cursor, or selected text.

    Declaration
    public bool FindCurrentText()
    Returns
    Type Description
    System.Boolean

    True if text was found.

    FindDialog()

    Shows GoTo dialog window that allow the user to navigate to any line in EditControl.

    Declaration
    [Obsolete("This method is obsolete. Please use ShowFindDialog method instead.")]
    public void FindDialog()

    FindNext()

    Searches text under cursor, or selected text.

    Declaration
    public bool FindNext()
    Returns
    Type Description
    System.Boolean

    True if text was found.

    FindRange(String, CoordinatePoint)

    Searches the specified text and returns text range of first found occurrence in EditControl.

    Declaration
    public ITextRange FindRange(string searchString, CoordinatePoint startLocation)
    Parameters
    Type Name Description
    System.String searchString

    Text to find.

    CoordinatePoint startLocation

    Start point of search range.

    Returns
    Type Description
    ITextRange

    Text range of first found occurance or null if no match was found.

    FindRange(String, CoordinatePoint, CoordinatePoint, Boolean)

    Searches the specified text and returns text range of first found occurrence in EditControl.

    Declaration
    public ITextRange FindRange(string searchString, CoordinatePoint startLocation, CoordinatePoint endLocation, bool searchUp)
    Parameters
    Type Name Description
    System.String searchString

    Text to find.

    CoordinatePoint startLocation

    Start point of search range.

    CoordinatePoint endLocation

    End point of search range.

    System.Boolean searchUp

    Indicates whether search should be performed in up direction.

    Returns
    Type Description
    ITextRange

    Text range of first found occurance or null if no match was found.

    FindRange(String, CoordinatePoint, CoordinatePoint, Boolean, Boolean, Boolean, Boolean)

    Searches the specified text and returns text range of first found occurance in EditControl.

    Declaration
    public ITextRange FindRange(string searchString, CoordinatePoint startLocation, CoordinatePoint endLocation, bool matchWholeWord, bool searchHiddenText, bool searchUp, bool useRegex)
    Parameters
    Type Name Description
    System.String searchString

    Text to find.

    CoordinatePoint startLocation

    Start point of search range.

    CoordinatePoint endLocation

    End point of search range.

    System.Boolean matchWholeWord

    Indicates whether whole word should be found.

    System.Boolean searchHiddenText

    Indicates whether hidden text should be searched.

    System.Boolean searchUp

    Indicates whether search should be performed in up direction.

    System.Boolean useRegex

    Indicates whether regex should be used.

    Returns
    Type Description
    ITextRange

    Text range of first found occurance or null if no match was found.

    FindRange(String, CoordinatePoint, Boolean)

    Searches the specified text and returns text range of first found occurrence in EditControl.

    Declaration
    public ITextRange FindRange(string searchString, CoordinatePoint startLocation, bool searchUp)
    Parameters
    Type Name Description
    System.String searchString

    Text to find.

    CoordinatePoint startLocation

    Start point of search range.

    System.Boolean searchUp

    Indicates whether search should be performed in up direction.

    Returns
    Type Description
    ITextRange

    Text range of first found occurance or null if no match was found.

    FindRegex(Int32, Int32, String, Boolean, Boolean)

    Finds the specified expression in the loaded contents of EditControl.

    Declaration
    public FindResult FindRegex(int startLine, int startColumn, string expression, bool bSearchInCollapsed, bool searchUp)
    Parameters
    Type Name Description
    System.Int32 startLine

    Start line for the search.

    System.Int32 startColumn

    Start column for the search.

    System.String expression

    Expression to be found.

    System.Boolean bSearchInCollapsed

    Flag, that specifies whether text can be found in collapsed region.

    System.Boolean searchUp

    Value indicating whether search should be performed in bottom-up destination.

    Returns
    Type Description
    FindResult

    Search result.

    FindText(String)

    Searches specified string in the text including hidden text and find the whole words. Searching is case-insensitive.

    Declaration
    public bool FindText(string text)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    FindText(String, Boolean)

    Searches specified string in the text (including hidden text) in EditControl. Just whole words would be found.

    Declaration
    public bool FindText(string text, bool caseSensitive)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    FindText(String, Boolean, Boolean)

    Helps to searches the specified text in the file which was loaded in EditControl (Including hidden text).

    Declaration
    public bool FindText(string text, bool caseSensitive, bool wholeWord)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.Boolean wholeWord

    Specifies whether only whole words should be searched.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    FindText(String, Boolean, Boolean, Boolean)

    Searches the specified text in the file which was loaded in EditControl.

    Declaration
    public bool FindText(string text, bool caseSensitive, bool wholeWord, bool searchInHidden)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.Boolean wholeWord

    Specifies whether only whole words should be searched.

    System.Boolean searchInHidden

    Specifies whether search should be performed inside collapsed blocks.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    FindText(String, Boolean, Boolean, Boolean, Boolean)

    Searches the specified text in the file which was loaded in EditControl.

    Declaration
    public bool FindText(string text, bool caseSensitive, bool wholeWord, bool searchInHidden, bool searchUp)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.Boolean wholeWord

    Specifies whether only whole words should be searched.

    System.Boolean searchInHidden

    Specifies whether search should be performed inside collapsed blocks.

    System.Boolean searchUp

    Specifies whether search should be performed in the up direction.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    FindText(String, Boolean, Boolean, Boolean, Boolean, IParsePoint)

    Searches the specified text in the file which was loaded in EditControl.

    Declaration
    public bool FindText(string text, bool caseSensitive, bool wholeWord, bool searchInHidden, bool searchUp, IParsePoint startPoint)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.Boolean wholeWord

    Specifies whether only whole words should be searched.

    System.Boolean searchInHidden

    Specifies whether search should be performed inside collapsed blocks.

    System.Boolean searchUp

    Specifies whether search should be performed in the up direction.

    IParsePoint startPoint

    Point to start search from. If null, search is performed from current cursor position.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    FlushChanges()

    Saves changes made to the contents of the EditControl into the current stream.

    Declaration
    public void FlushChanges()

    GetActiveThemeName()

    Gets the active theme name of the control.

    Declaration
    public virtual string GetActiveThemeName()
    Returns
    Type Description
    System.String

    Returns the active theme name.

    GetControlName(String)

    Helps to override the ThemeName property settings

    Declaration
    public virtual string GetControlName(string controlName)
    Parameters
    Type Name Description
    System.String controlName

    ThemeName

    Returns
    Type Description
    System.String

    GetControlState()

    Creates control state store.

    Declaration
    public ControlStateStore GetControlState()
    Returns
    Type Description
    ControlStateStore

    ControlStateStore instance with info about control state.

    GetCurrentCharacter()

    Gets the current character under cursor.

    Declaration
    public char GetCurrentCharacter()
    Returns
    Type Description
    System.Char

    Character.

    GetCurrentStack()

    Gets copy of the parser's stack at the current position.

    Declaration
    public ConfigStack GetCurrentStack()
    Returns
    Type Description
    ConfigStack

    Parser stack at the position of the cursor.

    GetCurrentWord()

    Gets the current word under cursor position in EditControl.

    Declaration
    public string GetCurrentWord()
    Returns
    Type Description
    System.String

    Lexem under cursor.

    GetCurrentWordColumn()

    Gets the column number of the current word at where its starts.

    Declaration
    public int GetCurrentWordColumn()
    Returns
    Type Description
    System.Int32

    Index of the column of the word start.

    GetEncoding()

    Helps to gets the current text encoding.

    Declaration
    public Encoding GetEncoding()
    Returns
    Type Description
    System.Text.Encoding

    Current encoding.

    GetLexemsInsideCurrentStack(Boolean)

    Gets list of the lexems that are inside current stack.

    Declaration
    public IList GetLexemsInsideCurrentStack(bool entireRegion)
    Parameters
    Type Name Description
    System.Boolean entireRegion

    If true, all lexems will be retrieved; otherwise just those, that are before the cursor.

    Returns
    Type Description
    System.Collections.IList

    List of the lexems.

    GetLine(Int32)

    Gets line's instance in EditControl.

    Declaration
    public ILexemLine GetLine(int iLineIndex)
    Parameters
    Type Name Description
    System.Int32 iLineIndex

    Index of the line.

    Returns
    Type Description
    ILexemLine

    Instance of the line.

    GetLineBackColorFormats(Int32)

    Gets line back color format, used for the specified line.

    Declaration
    public IDynamicFormat[] GetLineBackColorFormats(int iLine)
    Parameters
    Type Name Description
    System.Int32 iLine

    Line number.

    Returns
    Type Description
    IDynamicFormat[]

    Format, used for drawing background of the line.

    GetLineText(Int32)

    Gets the text of the specified line in EditControl.

    Declaration
    public string GetLineText(int iLineIndex)
    Parameters
    Type Name Description
    System.Int32 iLineIndex

    Line index.

    Returns
    Type Description
    System.String

    Text of the line.

    GetNewLineStyle()

    Gets the style of new line of current stream.

    Declaration
    public NewLineStyle GetNewLineStyle()
    Returns
    Type Description
    NewLineStyle

    Style of new line of current stream.

    GetParsePoint(Point)

    Gets parse point by physical coordinates in the stream.

    Declaration
    public IParsePoint GetParsePoint(Point p)
    Parameters
    Type Name Description
    System.Drawing.Point p

    Point in the stream..

    Returns
    Type Description
    IParsePoint

    Resulting parse point.

    GetParsePoint(Int32, Int32)

    Gets parse point by physical coordinates in the stream.

    Declaration
    public IParsePoint GetParsePoint(int x, int y)
    Parameters
    Type Name Description
    System.Int32 x

    X-coordinate.

    System.Int32 y

    Y-coordinate.

    Returns
    Type Description
    IParsePoint

    Resulting parse point.

    GetRealCursorPosition()

    Gets the current cursor position in EditControl.

    Declaration
    public IParsePoint GetRealCursorPosition()
    Returns
    Type Description
    IParsePoint

    IParsePoint with current position.

    GetSnippetByTitle(String)

    Gets code snippet by its title.

    Declaration
    public CodeSnippet GetSnippetByTitle(string title)
    Parameters
    Type Name Description
    System.String title

    Title of code snippet that has to be found.

    Returns
    Type Description
    CodeSnippet

    Needed code snippet or null if there's no snippet with given title.

    GetTextAsHTML()

    Gets the source code to generate HTML document for the text in the EditControl.

    Declaration
    public string GetTextAsHTML()
    Returns
    Type Description
    System.String

    String with text represented as HTML.

    GetTextAsHTML(CoordinatePoint, CoordinatePoint)

    Gets the source code to generate HTML document for the text in the EditControl.

    Declaration
    public string GetTextAsHTML(CoordinatePoint start, CoordinatePoint end)
    Parameters
    Type Name Description
    CoordinatePoint start

    Point representing start of the text.

    CoordinatePoint end

    Point representing end of the text.

    Returns
    Type Description
    System.String

    String with desired text represented as HTML.

    GetTextAsHTML(Point, Point)

    Gets the source code to generate HTML document for the text in the EditControl.

    Declaration
    public string GetTextAsHTML(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Point representing start of the text (physical coordinates).

    System.Drawing.Point pointEnd

    Point representing end of the text (physical coordinates).

    Returns
    Type Description
    System.String

    String with desired text represented as HTML.

    GetTextAsRTF()

    Gets the source code to generate RTF document for the text in the EditControl.

    Declaration
    public string GetTextAsRTF()
    Returns
    Type Description
    System.String

    String with text represented as RTF.

    GetTextAsRTF(CoordinatePoint, CoordinatePoint)

    Gets the source code to generate RTF document for the text in the EditControl.

    Declaration
    public string GetTextAsRTF(CoordinatePoint start, CoordinatePoint end)
    Parameters
    Type Name Description
    CoordinatePoint start

    Point representing start of the text.

    CoordinatePoint end

    Point representing end of the text.

    Returns
    Type Description
    System.String

    String with desired text represented as RTF.

    GetTextAsRTF(Point, Point)

    Gets the source code to generate RTF document for the text in the EditControl.

    Declaration
    public string GetTextAsRTF(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Point representing start of the text (physical coordinates).

    System.Drawing.Point pointEnd

    Point representing end of the text (physical coordinates).

    Returns
    Type Description
    System.String

    String with desired text represented as RTF.

    GetTextAsXML()

    Gets the source code to generate XML document for the text in the EditControl.

    Declaration
    public string GetTextAsXML()
    Returns
    Type Description
    System.String

    String with text represented as XML.

    GetTextAsXML(CoordinatePoint, CoordinatePoint)

    Gets the source code to generate XML document for the text in the EditControl.

    Declaration
    public string GetTextAsXML(CoordinatePoint start, CoordinatePoint end)
    Parameters
    Type Name Description
    CoordinatePoint start

    Point representing start of the text.

    CoordinatePoint end

    Point representing end of the text.

    Returns
    Type Description
    System.String

    String with desired text represented as XML.

    GetTextAsXML(Point, Point)

    Gets the source code to generate XML document for the text in the EditControl.

    Declaration
    public string GetTextAsXML(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Point representing start of the text (physical coordinates).

    System.Drawing.Point pointEnd

    Point representing end of the text (physical coordinates).

    Returns
    Type Description
    System.String

    String with desired text represented as XML.

    GetTextWithNewLineStyle()

    Gets the text with current new line style.

    Declaration
    public string GetTextWithNewLineStyle()
    Returns
    Type Description
    System.String

    String containing EditControl text with current new line style.

    GetTextWithNewLineStyle(NewLineStyle)

    Gets the text with current new line style.

    Declaration
    public string GetTextWithNewLineStyle(NewLineStyle newLineStyle)
    Parameters
    Type Name Description
    NewLineStyle newLineStyle

    New line style for text.

    Returns
    Type Description
    System.String

    String containing EditControl text with given new line style.

    GoTo(Int32)

    Places the cursor at the beginning of the given line number.

    Declaration
    public void GoTo(int lineNumber)
    Parameters
    Type Name Description
    System.Int32 lineNumber

    Number of the line in which the cursor should be set to.

    GoTo(Int32, Int32)

    Places the cursor at the beginning of the given line number.

    Declaration
    public bool GoTo(int iLineNumber, int iLinesAbove)
    Parameters
    Type Name Description
    System.Int32 iLineNumber

    Number of line to set cursor position to.

    System.Int32 iLinesAbove

    Number of lines to leave above cursor.

    Returns
    Type Description
    System.Boolean

    Bool indicating success.

    GoToDialog()

    Shows GoTo dialog window.

    Declaration
    [Obsolete("This method is obsolete. Please use ShowGoToDialog method instead.")]
    public void GoToDialog()

    HideCaret()

    Helps to hides the cursor caret.

    Declaration
    public void HideCaret()

    HideIndentGuideline()

    Hides indentation guideline of the current region.

    Declaration
    public void HideIndentGuideline()

    IndentSelection()

    Indents selected text.

    Declaration
    public void IndentSelection()

    IndentText(CoordinatePoint, CoordinatePoint)

    Indents text in the specified range.

    Declaration
    public void IndentText(CoordinatePoint p1, CoordinatePoint p2)
    Parameters
    Type Name Description
    CoordinatePoint p1

    Beginning of range.

    CoordinatePoint p2

    End of rage.

    IndentText(Point, Point)

    Indents text in the specified range.

    Declaration
    public void IndentText(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Beginning of range (physical coordinates).

    System.Drawing.Point pointEnd

    End of rage (physical coordinates).

    InsertFile()

    Shows the insert file dialog to user and insert the selected file into the EditControl.

    Declaration
    public void InsertFile()

    InsertFile(String)

    Appends the file text into EditControl by using its file name.

    Declaration
    public void InsertFile(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    Name of the file to load.

    InsertText(Int32, Int32, String)

    Inserts a piece of text at any desired position in the EditControl.

    Declaration
    public void InsertText(int line, int column, string text)
    Parameters
    Type Name Description
    System.Int32 line

    Line in virtual coordinates where text should be inserted.

    System.Int32 column

    Column in virtual coordinates where text should be inserted.

    System.String text

    Text to be inserted.

    InvalidateNonClientArea()

    Redraws nonclient area of the control.

    Declaration
    protected void InvalidateNonClientArea()

    IsRTLChangeRequired(Int32, Int32)

    Checks if RTL to change as the results of pressing ctl+shift's

    Declaration
    protected bool? IsRTLChangeRequired(int iKeyCode, int iFlags)
    Parameters
    Type Name Description
    System.Int32 iKeyCode
    System.Int32 iFlags
    Returns
    Type Description
    System.Nullable<System.Boolean>

    JumpToIndentBlockEnd()

    Helps to position the caret to the end of the indentation block.

    Declaration
    public void JumpToIndentBlockEnd()

    JumpToIndentBlockStart()

    Helps to position the caret to the beginning of the indentation block.

    Declaration
    public void JumpToIndentBlockStart()

    LoadConfig(Stream)

    Loads the configuration settings from the specified stream.

    Declaration
    public void LoadConfig(Stream configStream)
    Parameters
    Type Name Description
    System.IO.Stream configStream

    Stream to load config from.

    LoadConfig(String, String)

    Loads the configuration settings from file by using the specified file path.

    Declaration
    public void LoadConfig(string fileName, string currentFilePath)
    Parameters
    Type Name Description
    System.String fileName

    Name of the file with configuration.

    System.String currentFilePath

    Name of the file that is currently loaded, or empty string.

    LoadFile()

    Loads the content of any desired file and its configuration into the EditControl, instead of typing the code in it.

    Declaration
    public bool LoadFile()
    Returns
    Type Description
    System.Boolean

    True if file was successfully loaded.

    LoadFile(String)

    Loads the content of any desired file and its configuration into the EditControl, instead of typing the code in it.

    Declaration
    public bool LoadFile(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    Name of the file to load.

    Returns
    Type Description
    System.Boolean

    LoadFile(String, Encoding)

    Loads the content of any desired file and its configuration into the EditControl, instead of typing the code in it.

    Declaration
    public bool LoadFile(string fileName, Encoding encoding)
    Parameters
    Type Name Description
    System.String fileName

    Name of file to load.

    System.Text.Encoding encoding

    Encoding to use for file reading.

    Returns
    Type Description
    System.Boolean

    True if file was successfully loaded.

    LoadStream(Stream)

    Loads the stream in EditControl.

    Declaration
    public bool LoadStream(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    Stream to load.

    Returns
    Type Description
    System.Boolean

    True, if user has not canceled loading, otherwise false.

    LoadStream(Stream, IConfigLanguage)

    Loads the stream and its configuration in EditControl.

    Declaration
    public bool LoadStream(Stream stream, IConfigLanguage lang)
    Parameters
    Type Name Description
    System.IO.Stream stream

    Stream to load.

    IConfigLanguage lang

    Configuration to apply to loaded stream.

    Returns
    Type Description
    System.Boolean

    True, if user has not canceled loading, otherwise false.

    MarkAsReadOnly(CoordinatePoint, CoordinatePoint, Color, Color)

    Sets text as read-only.

    Declaration
    public void MarkAsReadOnly(CoordinatePoint start, CoordinatePoint end, Color backColor, Color textColor)
    Parameters
    Type Name Description
    CoordinatePoint start

    Start of text to set as readonly.

    CoordinatePoint end

    End of text to set as readonly.

    System.Drawing.Color backColor

    Color of text background. Empty if no changes needed.

    System.Drawing.Color textColor

    Color of text. Empty if no changes needed.

    MarkAsReadOnly(Point, Point, Color, Color)

    Helps to specify a read-only region.

    Declaration
    public void MarkAsReadOnly(Point pointStart, Point pointEnd, Color backColor, Color textColor)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Start of text to set as readonly (physical coordinates).

    System.Drawing.Point pointEnd

    End of text to set as readonly (physical coordinates).

    System.Drawing.Color backColor

    Color of text background. Empty if no changes needed.

    System.Drawing.Color textColor

    Color of text. Empty if no changes needed.

    MarkSearchResult(FindResult)

    Marks the search result and sets cursor to the end of the selection.

    Declaration
    public void MarkSearchResult(FindResult result)
    Parameters
    Type Name Description
    FindResult result

    Find result that must be marked.

    MoveDown()

    Moves cursor to the downwards position in EditControl.

    Declaration
    public void MoveDown()

    MoveLeft()

    Moves cursor to the left position in EditControl.

    Declaration
    public void MoveLeft()

    MoveLeftWord()

    Moves caret to left by one word, or to the beginning of the current.

    Declaration
    public void MoveLeftWord()

    MovePageDown()

    Moves caret one page down in EditControl.

    Declaration
    public void MovePageDown()

    MovePageUp()

    Moves caret one page up in EditControl.

    Declaration
    public void MovePageUp()

    MoveRight()

    Moves cursor to the right position in EditControl.

    Declaration
    public void MoveRight()

    MoveRightWord()

    Moves caret to the right by one word of the current line in EditControl.

    Declaration
    public void MoveRightWord()

    MoveToBeginning()

    Moves caret to the beginning of the file in EditControl.

    Declaration
    public void MoveToBeginning()

    MoveToEnd()

    Moves caret to the end of file in EditControl.

    Declaration
    public void MoveToEnd()

    MoveToLineEnd()

    Moves caret to the end of line in EditControl.

    Declaration
    public void MoveToLineEnd()

    MoveToLineStart()

    Moves caret to the beginning of line. First whitespaces will be skipped.

    Declaration
    public void MoveToLineStart()

    MoveUp()

    Move cursor to the upwards position in EditControl.

    Declaration
    public void MoveUp()

    New()

    Creates an empty stream and makes editor to edit it in EditControl.

    Declaration
    public virtual bool New()
    Returns
    Type Description
    System.Boolean

    True if new empty stream was successfully created and loaded; otherwise false.

    New(IConfigLanguage)

    Creates a empty stream and makes editor to edit it in EditControl.

    Declaration
    public virtual bool New(IConfigLanguage lang)
    Parameters
    Type Name Description
    IConfigLanguage lang

    Language configuration to be set

    Returns
    Type Description
    System.Boolean

    True if new empty stream was successfully created and loaded.

    NewFile()

    Creates a new empty file with default coloring.

    Declaration
    public bool NewFile()
    Returns
    Type Description
    System.Boolean

    True if file was created, otherwise false.

    NewFile(IConfigLanguage)

    Creates a new empty file with specified coloring.

    Declaration
    public bool NewFile(IConfigLanguage lang)
    Parameters
    Type Name Description
    IConfigLanguage lang

    Language to be used for text coloring.

    Returns
    Type Description
    System.Boolean

    True if file was created, otherwise false.

    OnCanApplyThemeChanged(Boolean)

    Helps to override the CanApplyTheme property settings

    Declaration
    public virtual void OnCanApplyThemeChanged(bool canApplyTheme)
    Parameters
    Type Name Description
    System.Boolean canApplyTheme

    OnCanOverrideStyleChanged(Boolean)

    Helps to override the CanOverriderStyle property settings

    Declaration
    public virtual void OnCanOverrideStyleChanged(bool canOverrideStyle)
    Parameters
    Type Name Description
    System.Boolean canOverrideStyle

    OnDragDrop(DragEventArgs)

    Inserts text from the dropped to the control file.

    Declaration
    protected override void OnDragDrop(DragEventArgs drgevent)
    Parameters
    Type Name Description
    System.Windows.Forms.DragEventArgs drgevent

    DragEventArgs.

    OnDragOver(DragEventArgs)

    Changes drag effect to copy if some file is dragged over the control.

    Declaration
    protected override void OnDragOver(DragEventArgs drgevent)
    Parameters
    Type Name Description
    System.Windows.Forms.DragEventArgs drgevent

    DragEventArgs.

    OnFindRegex(EditControl.RegexCaseInsenstiveArgs)

    To create the search expression as ignorecase or casesenstive option

    Declaration
    protected virtual void OnFindRegex(EditControl.RegexCaseInsenstiveArgs e)
    Parameters
    Type Name Description
    EditControl.RegexCaseInsenstiveArgs e

    OnKeyDown(KeyEventArgs)

    Overriden OnKeyDown

    Declaration
    protected override void OnKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.KeyEventArgs e

    OnLayout(LayoutEventArgs)

    Realligns controls after relayouting control.

    Declaration
    protected override void OnLayout(LayoutEventArgs levent)
    Parameters
    Type Name Description
    System.Windows.Forms.LayoutEventArgs levent

    LayoutEventArgs.

    OnPaintBackground(PaintEventArgs)

    Paints the background of the control.

    Declaration
    protected override void OnPaintBackground(PaintEventArgs pevent)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs pevent

    PaintEventArgs.

    OnParsingModeChanged()

    Updates parser's text parsing mode.

    Declaration
    protected void OnParsingModeChanged()

    OnThemeNameChanged(String)

    Helps to override the ThemeName property settings

    Declaration
    public virtual void OnThemeNameChanged(string themeName)
    Parameters
    Type Name Description
    System.String themeName

    ThemeName

    OutdentSelection()

    Outdents selected text.

    Declaration
    public void OutdentSelection()

    OutdentText(CoordinatePoint, CoordinatePoint)

    Outdents text in the specified range.

    Declaration
    public void OutdentText(CoordinatePoint p1, CoordinatePoint p2)
    Parameters
    Type Name Description
    CoordinatePoint p1

    Beginning of range.

    CoordinatePoint p2

    End of rage.

    OutdentText(Point, Point)

    Outdents text in the specified range.

    Declaration
    public void OutdentText(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Beginning of range (physical coordinates).

    System.Drawing.Point pointEnd

    End of rage (physical coordinates).

    Paste()

    Retrieves copied contents from the clipboard and pastes it into EditControl.

    Declaration
    public virtual void Paste()

    PointToPhysicalPosition(Point)

    Converts point in client coordinates to the physical position in text.

    Declaration
    public Point PointToPhysicalPosition(Point point)
    Parameters
    Type Name Description
    System.Drawing.Point point

    Point in client coordinates.

    Returns
    Type Description
    System.Drawing.Point

    Physical position in the text.

    PointToVirtualPosition(Point)

    Converts the point in client coordinates to the virtual position in text.

    Declaration
    public Point PointToVirtualPosition(Point point)
    Parameters
    Type Name Description
    System.Drawing.Point point

    Point in client coordinates.

    Returns
    Type Description
    System.Drawing.Point

    Virtual position in the text.

    PointToVirtualPosition(Point, Boolean)

    Converts point in client coordinates to the virtual position in text.

    Declaration
    public Point PointToVirtualPosition(Point point, bool bUseScrollers)
    Parameters
    Type Name Description
    System.Drawing.Point point

    Point in client coordinates.

    System.Boolean bUseScrollers

    Specifies whether scrollers information should be used.

    Returns
    Type Description
    System.Drawing.Point

    Virtual position in the text.

    Print()

    Displays the print dialog and gives user ability to start printing.

    Declaration
    public void Print()

    PrintCurrentPage()

    Prints the current page on default printer.

    Declaration
    public void PrintCurrentPage()

    PrintNoDialog()

    Prints the entire document on default printer.

    Declaration
    public void PrintNoDialog()

    PrintPages(Int32, Int32)

    Prints the pages in the specified range.

    Declaration
    public void PrintPages(int startPageNumber, int endPageNumber)
    Parameters
    Type Name Description
    System.Int32 startPageNumber

    Start page in range.

    System.Int32 endPageNumber

    End page in range.

    PrintPreview()

    Displays the print preview dialog.

    Declaration
    public void PrintPreview()

    PrintSelection()

    Prints the selected area on default printer.

    Declaration
    public void PrintSelection()

    ProcessCmdKey(ref Message, Keys)

    Overrides the Processcmdkey

    Declaration
    protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
    Parameters
    Type Name Description
    System.Windows.Forms.Message msg
    System.Windows.Forms.Keys keyData
    Returns
    Type Description
    System.Boolean

    RaiseThemeChanged(Object, ThemeChangedEventArgs)

    Raises the ThemeNameChanged event when theme name changed.

    Declaration
    protected virtual void RaiseThemeChanged(object sender, ThemeChangedEventArgs args)
    Parameters
    Type Name Description
    System.Object sender

    The sender value.

    ThemeChangedEventArgs args

    A ThemeChangedEventArgs contains the event data.

    Redo()

    Performs Redo operation that helps to reinsert the last change made in EditControl.

    Declaration
    public void Redo()

    Refresh()

    Refreshes the screen, frees up memory and deletes a lot of parse points.

    Declaration
    public override void Refresh()

    RegisterBackColorFormat(Color, Color)

    Registers line backcolor format.

    Declaration
    public IBackgroundFormat RegisterBackColorFormat(Color colorBackGround, Color colorBorder)
    Parameters
    Type Name Description
    System.Drawing.Color colorBackGround

    Line background color.

    System.Drawing.Color colorBorder

    Line border color.

    Returns
    Type Description
    IBackgroundFormat

    Newly created format.

    RegisterBackColorFormat(Color, Color, Color, HatchStyle, Boolean)

    Registers format used for filling the background of the selection or line.

    Declaration
    public IBackgroundFormat RegisterBackColorFormat(Color colorBackGround, Color colorForeGround, Color colorBorder, HatchStyle style, bool useHatchFill)
    Parameters
    Type Name Description
    System.Drawing.Color colorBackGround

    Specifies background color.

    System.Drawing.Color colorForeGround

    Specifies foreground color, used only if hatchstyle is used.

    System.Drawing.Color colorBorder

    Specifies border color.

    System.Drawing.Drawing2D.HatchStyle style

    Specifies hatch style of the background.

    System.Boolean useHatchFill

    Specifies whether hatchstyle value should be used for drawing background.

    Returns
    Type Description
    IBackgroundFormat

    Newly created format.

    RegisterBackColorFormat(Color, Color, HatchStyle, Boolean)

    Registers line backcolor format.

    Declaration
    public IBackgroundFormat RegisterBackColorFormat(Color colorBackGround, Color colorBorder, HatchStyle style, bool useHatchFill)
    Parameters
    Type Name Description
    System.Drawing.Color colorBackGround

    Line background color.

    System.Drawing.Color colorBorder

    Line border color.

    System.Drawing.Drawing2D.HatchStyle style

    Hatch style of the background.

    System.Boolean useHatchFill

    Specifies whether hatchstyle value should be used for drawing background.

    Returns
    Type Description
    IBackgroundFormat

    Newly created format.

    RegisterUnderlineFormat(Color, UnderlineStyle, UnderlineWeight)

    Registers custom underline format, that can be used when setting region's underlining.

    Declaration
    public ISnippetFormat RegisterUnderlineFormat(Color color, UnderlineStyle style, UnderlineWeight weight)
    Parameters
    Type Name Description
    System.Drawing.Color color

    Color of the underlining.

    UnderlineStyle style

    Style of the underlining.

    UnderlineWeight weight

    Weight of the underlining.

    Returns
    Type Description
    ISnippetFormat

    Newly created format.

    RemoveCustomBookmark(Int32, BookmarkPaintEventHandler)

    Removes the custom bookmark from the specified line.

    Declaration
    public void RemoveCustomBookmark(int iLine, BookmarkPaintEventHandler painter)
    Parameters
    Type Name Description
    System.Int32 iLine

    Physical line index.

    BookmarkPaintEventHandler painter

    Paint handler.

    RemoveLineBackColor(Int32)

    Removes the line back color.

    Declaration
    public void RemoveLineBackColor(int iLine)
    Parameters
    Type Name Description
    System.Int32 iLine

    Line number.

    RemovePageBorder()

    Removes border drawing in page preview.

    Declaration
    public void RemovePageBorder()

    RemoveReadOnly(CoordinatePoint, CoordinatePoint)

    Removes read-only status of specified region.

    Declaration
    public void RemoveReadOnly(CoordinatePoint start, CoordinatePoint end)
    Parameters
    Type Name Description
    CoordinatePoint start

    Start of text to remove readonly status.

    CoordinatePoint end

    End of text to remove readonly status.

    RemoveReadOnly(Point, Point)

    Removes readonly status of specified region.

    Declaration
    public void RemoveReadOnly(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Start of text to remove readonly status (physical coordinates).

    System.Drawing.Point pointEnd

    End of text to remove readonly status (physical coordinates).

    RemoveSelectionBackColor()

    Removes background color from the selected text.

    Declaration
    public void RemoveSelectionBackColor()

    RemoveTabsFromSelection()

    Removes leading tab symbol (or its spaces equivalent) from selected lines.

    Declaration
    public virtual void RemoveTabsFromSelection()

    RemoveTextBorder(CoordinatePoint, CoordinatePoint)

    Removes border around text with given coordinates.

    Declaration
    public void RemoveTextBorder(CoordinatePoint start, CoordinatePoint end)
    Parameters
    Type Name Description
    CoordinatePoint start

    Start of the text.

    CoordinatePoint end

    End of the text.

    RemoveTextBorder(Point, Point)

    Removes border around text with given coordinates.

    Declaration
    public void RemoveTextBorder(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Start of text to draw border around (physical coordinates).

    System.Drawing.Point pointEnd

    End of text to draw border around (physical coordinates).

    RemoveUnderline(CoordinatePoint, CoordinatePoint)

    Removes underlining in the specified region.

    Declaration
    public void RemoveUnderline(CoordinatePoint pointStart, CoordinatePoint pointEnd)
    Parameters
    Type Name Description
    CoordinatePoint pointStart

    Starting point.

    CoordinatePoint pointEnd

    End point.

    RemoveUnderline(Point, Point)

    Removes underlining in the specified region.

    Declaration
    public void RemoveUnderline(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Starting point (physical coordinates).

    System.Drawing.Point pointEnd

    End point (physical coordinates).

    ReplaceAll(String, Boolean, Boolean, Boolean, String)

    Searches the specified text in EditControl and replace all the specified text with the replacement text.

    Declaration
    public int ReplaceAll(string text, bool caseSensitive, bool wholeWord, bool searchInHidden, string replacetext)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.Boolean wholeWord

    Specifies whether only whole words should be searched.

    System.Boolean searchInHidden

    Specifies whether search should be performed inside collapsed blocks.

    System.String replacetext

    Specified the string, found text should be replaced to.

    Returns
    Type Description
    System.Int32

    Number of occurances replaced.

    ReplaceAll(String, Boolean, Boolean, String)

    Searches the specified text and replaces it with the replacement text in EditControl. Searching is also done inside collapsed blocks.

    Declaration
    public int ReplaceAll(string text, bool caseSensitive, bool wholeWord, string replacetext)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.Boolean wholeWord

    Specifies whether only whole words should be searched.

    System.String replacetext

    Specified the string, found text should be replaced to.

    Returns
    Type Description
    System.Int32

    Number of occurances replaced.

    ReplaceAll(String, Boolean, String)

    Searches the specified text and replaces it with the replacement text in EditControl. Searching is also done inside collapsed blocks.

    Declaration
    public int ReplaceAll(string text, bool caseSensitive, string replacetext)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.String replacetext

    Specified the string, found text should be replaced to.

    Returns
    Type Description
    System.Int32

    Number of occurances replaced.

    ReplaceAll(String, String)

    Searches the specified text and replaces it with the replacement text in EditControl. Searching is also done inside collapsed blocks.

    Declaration
    public int ReplaceAll(string text, string replacetext)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.String replacetext

    Specified the string, found text should be replaced to.

    Returns
    Type Description
    System.Int32

    Number of occurances replaced.

    ReplaceDialog()

    Shows Replace dialog window that helps to replace specified text with replacement text as per the conditions specified in EditControl.

    Declaration
    [Obsolete("This method is obsolete. Please use ShowReplaceDialog method instead.")]
    public void ReplaceDialog()

    ReplaceText(String, Boolean, Boolean, Boolean, Boolean, String)

    Searches the specified text and replaces it with the replacement text in EditControl.

    Declaration
    public bool ReplaceText(string text, bool caseSensitive, bool wholeWord, bool searchInHidden, bool searchUp, string replacetext)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.Boolean wholeWord

    Specifies whether only whole words should be searched.

    System.Boolean searchInHidden

    Specifies whether search should be performed inside collapsed blocks.

    System.Boolean searchUp

    Specifies whether search should be performed in the up direction.

    System.String replacetext

    Specified the string, found text should be replaced to.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    ReplaceText(String, Boolean, Boolean, Boolean, String)

    Searches the specified text and replaces it with the replacement text in EditControl.

    Declaration
    public bool ReplaceText(string text, bool caseSensitive, bool wholeWord, bool searchInHidden, string replacetext)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.Boolean wholeWord

    Specifies whether only whole words should be searched.

    System.Boolean searchInHidden

    Specifies whether search should be performed inside collapsed blocks.

    System.String replacetext

    Specified the string, found text should be replaced to.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    ReplaceText(String, Boolean, Boolean, String)

    Searches the specified text and replaces it with the replacement text in EditControl. Searching is also done inside collapsed blocks.

    Declaration
    public bool ReplaceText(string text, bool caseSensitive, bool wholeWord, string replacetext)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.Boolean wholeWord

    Specifies whether only whole words should be searched.

    System.String replacetext

    Specified the string, found text should be replaced to.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    ReplaceText(String, Boolean, String)

    Searches the specified text and replaces it with the replacement text in EditControl. Searching is also done inside collapsed blocks.

    Declaration
    public bool ReplaceText(string text, bool caseSensitive, string replacetext)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.Boolean caseSensitive

    Specifies whether case sensitive search should be performed.

    System.String replacetext

    Specified the string, found text should be replaced to.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    ReplaceText(String, String)

    Searches the specified text and replaces it with the replacement text in EditControl. Searching is also done inside collapsed blocks.

    Declaration
    public bool ReplaceText(string text, string replacetext)
    Parameters
    Type Name Description
    System.String text

    String to be found in the text.

    System.String replacetext

    Specified the string, found text should be replaced to.

    Returns
    Type Description
    System.Boolean

    True if text was found, otherwise false.

    ResetColoring(IConfigLanguage)

    Resets the parser.

    Declaration
    [Obsolete("This method is obsolete, it will be removed in the next release. \r\n\t\t\tPlease use one of the ApplyConfiguration method overloads instead.")]
    public void ResetColoring(IConfigLanguage lang)
    Parameters
    Type Name Description
    IConfigLanguage lang

    New language configuration to be set.

    ResetSelection()

    Helps to reset the selected region in EditControl.

    Declaration
    public void ResetSelection()

    ResetSetMarkerOnEncodingChanged()

    Resets the SetMarkerOnEncodingChanged back to its default value.

    Declaration
    public void ResetSetMarkerOnEncodingChanged()

    ResetShowFileDropNotification()

    Resets the ShowFileDropNotification property to it's default value.

    Declaration
    public void ResetShowFileDropNotification()

    ResetUndoInfo()

    Resets undo information.

    Declaration
    public void ResetUndoInfo()

    RestoreControlState(ControlStateStore)

    Restores control state.

    Declaration
    public void RestoreControlState(ControlStateStore state)
    Parameters
    Type Name Description
    ControlStateStore state

    Control state store to get data from.

    RestoreControlState(ControlStateStore, Boolean)

    Restores control state.

    Declaration
    public void RestoreControlState(ControlStateStore state, bool append)
    Parameters
    Type Name Description
    ControlStateStore state

    Control state store to get data from.

    System.Boolean append

    Specifies whether settings from the state should be applied without clearing currently used settings.

    ResumePainting()

    Resumes painting of the control EditControl.

    Declaration
    public void ResumePainting()

    Save()

    Saves the text to file loaded in EditControl.

    Declaration
    public bool Save()
    Returns
    Type Description
    System.Boolean

    True if file was successfully saved. False is returned only if user has cancelled saving somehow.

    SaveAs()

    Displays the SaveAs dialog and saves data to specified file.

    Declaration
    public bool SaveAs()
    Returns
    Type Description
    System.Boolean

    True if file was successfully saved. False is returned only if user has cancelled saving somehow.

    SaveAsHTML(String)

    Export the EditControl contents into HTML format and save it into any desired HTML file.

    Declaration
    public void SaveAsHTML(string filename)
    Parameters
    Type Name Description
    System.String filename

    Name of the file, the document should be saved to.

    SaveAsHTML(String, Boolean)

    Export the EditControl contents into HTML format and save it into any desired HTML file.

    Declaration
    public void SaveAsHTML(string filename, bool bUseLineBreakTags)
    Parameters
    Type Name Description
    System.String filename

    Name of the file, the document should be saved to.

    System.Boolean bUseLineBreakTags

    Indicates whether line break tags should be used.

    SaveAsRTF(String)

    Export the EditControl contents into RTF format and save it into any desired RTF file.

    Declaration
    public void SaveAsRTF(string filename)
    Parameters
    Type Name Description
    System.String filename

    Name of the file, the document should be saved to.

    SaveAsXML(String)

    Export the EditControl contents into XML format and save it into any desired XML file.

    Declaration
    public void SaveAsXML(string filename)
    Parameters
    Type Name Description
    System.String filename

    Name of the file, the document should be saved to.

    SaveFile(String)

    Saves the content to the specified file in EditControl.

    Declaration
    public void SaveFile(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    Name of the file to which the text has to be saved.

    SaveFile(String, NewLineStyle)

    Saves content to the specified file with new line style in EditControl.

    Declaration
    public void SaveFile(string fileName, NewLineStyle newLineStyle)
    Parameters
    Type Name Description
    System.String fileName

    Name of the file to which the text has to be saved.

    NewLineStyle newLineStyle

    Style of new line in saved file.

    SaveFile(String, Encoding, NewLineStyle)

    Saves content to the specified file with new line style in EditControl.

    Declaration
    public void SaveFile(string fileName, Encoding encoding, NewLineStyle newLineStyle)
    Parameters
    Type Name Description
    System.String fileName

    Name of the file to which the text has to be saved.

    System.Text.Encoding encoding

    Encoding of saved file.

    NewLineStyle newLineStyle

    Style of new line in saved file.

    SaveModified()

    Saves the file only if it was modified and prompts for filename if needed. This is especially useful when the application is about to be closed or a new file is being loaded into the EditControl.

    Declaration
    public bool SaveModified()
    Returns
    Type Description
    System.Boolean

    False if file was changed but user decided not to save file, otherwise true.

    SaveSettingToIsolatedStorage()

    Helps to saves the settings from context options dialog to the isolated storage.

    Declaration
    public void SaveSettingToIsolatedStorage()

    SaveStream(Stream, Encoding, NewLineStyle)

    Saves content to the specified stream using specified encoding and line end style.

    Declaration
    public void SaveStream(Stream stream, Encoding encoding, NewLineStyle newLineStyle)
    Parameters
    Type Name Description
    System.IO.Stream stream

    Stream to save to.

    System.Text.Encoding encoding

    Encoding to use when saving to stream.

    NewLineStyle newLineStyle

    Line end style used when saving to stream.

    SaveToStream()

    Flushes changes to the current stream in EditControl.

    Declaration
    [Obsolete("This method is obsolete. Please use Flushchanges() method instead.")]
    public void SaveToStream()

    SaveToStream(Stream)

    Saves the data from current stream to the specified output stream.

    Declaration
    public void SaveToStream(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    Output stream.

    ScrollControlIntoView(Control)

    Hides ScrollControlIntoView method.

    Declaration
    protected void ScrollControlIntoView(Control ctrl)
    Parameters
    Type Name Description
    System.Windows.Forms.Control ctrl

    Control.

    ScrollToCaret()

    Helps to scrolls the contents of the control to the current caret position.

    Declaration
    public virtual void ScrollToCaret()

    SelectAll()

    Selects all text in EditControl.

    Declaration
    public void SelectAll()

    SelectionCancel()

    Removes selection and causes invalidation of the area that was selected.

    Declaration
    public void SelectionCancel()

    SelectLine(Int32)

    Selects line with specified index.

    Declaration
    public void SelectLine(int lineNumber)
    Parameters
    Type Name Description
    System.Int32 lineNumber

    Index of line to select.

    SetBackgroundColor(CoordinatePoint, CoordinatePoint, Color)

    Helps to sets the background color of text.

    Declaration
    public void SetBackgroundColor(CoordinatePoint start, CoordinatePoint end, Color color)
    Parameters
    Type Name Description
    CoordinatePoint start

    Start of text to set color.

    CoordinatePoint end

    End of text to set color.

    System.Drawing.Color color

    Color to set.

    SetBackgroundColor(Point, Point, Color)

    Helps to sets the background color of text.

    Declaration
    public void SetBackgroundColor(Point pointStart, Point pointEnd, Color color)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Start of text to set color (physical coordinates).

    System.Drawing.Point pointEnd

    End of text to set color (physical coordinates).

    System.Drawing.Color color

    Color to set.

    SetCustomBookmark(Int32, BookmarkPaintEventHandler)

    Creates a custom bookmark that allows the users to locate a section or a line of a document for quick access to any part of the contents

    Declaration
    public ICustomBookmark SetCustomBookmark(int iLine, BookmarkPaintEventHandler painter)
    Parameters
    Type Name Description
    System.Int32 iLine

    Physical line index.

    BookmarkPaintEventHandler painter

    Paint handler.

    Returns
    Type Description
    ICustomBookmark

    Interface that represents custom bookmark.

    SetEncoding(Encoding)

    Helps to sets the current text encoding.

    Declaration
    public void SetEncoding(Encoding encoding)
    Parameters
    Type Name Description
    System.Text.Encoding encoding

    SetFindAndReplaceDialogLocation(Point)

    Helps to sets find and replace dialog box location of the EditControl.

    Declaration
    public void SetFindAndReplaceDialogLocation(Point location)
    Parameters
    Type Name Description
    System.Drawing.Point location

    Display Location

    SetLineBackColor(Int32, Boolean, IBackgroundFormat)

    Sets the background color of the line.

    Declaration
    public void SetLineBackColor(int iLine, bool bFullLine, IBackgroundFormat format)
    Parameters
    Type Name Description
    System.Int32 iLine

    Line number.

    System.Boolean bFullLine

    Specifies if full line should be selected or just text.

    IBackgroundFormat format

    Format with background color.

    SetNewLineStyle(NewLineStyle)

    Sets the style of new line of current stream.

    Declaration
    public void SetNewLineStyle(NewLineStyle style)
    Parameters
    Type Name Description
    NewLineStyle style

    New style of new line of current stream.

    SetPageBorder(FrameBorderStyle, Color)

    Sets parameters of border that is drawing in page preview. Weight is set to Thin.

    Declaration
    public void SetPageBorder(FrameBorderStyle style, Color color)
    Parameters
    Type Name Description
    FrameBorderStyle style

    Style of border.

    System.Drawing.Color color

    Color of border.

    SetPageBorder(FrameBorderStyle, Color, BorderWeight)

    Sets parameters of border that is drawing in page preview.

    Declaration
    public void SetPageBorder(FrameBorderStyle style, Color color, BorderWeight weight)
    Parameters
    Type Name Description
    FrameBorderStyle style

    Style of border.

    System.Drawing.Color color

    Color of border.

    BorderWeight weight

    Weight of border line.

    SetPageBorder(Color)

    Helps to sets the color of border which was drawing in page preview. Its weight is set to thick, style is set to Solid.

    Declaration
    public void SetPageBorder(Color color)
    Parameters
    Type Name Description
    System.Drawing.Color color

    Color of border.

    SetRegexAsNone()

    Sets the regex as none in EditControl.

    Declaration
    public void SetRegexAsNone()

    SetSelection(Int32, Int32, Int32, Int32)

    Sets the selected area of the text.

    Declaration
    public void SetSelection(int columnStart, int lineStart, int columnEnd, int lineEnd)
    Parameters
    Type Name Description
    System.Int32 columnStart

    Column index of the selection start.

    System.Int32 lineStart

    Line index of the selection start.

    System.Int32 columnEnd

    Column index of the selection end, should point to the symbol that is next the last selected symbol.

    System.Int32 lineEnd

    Line index of the selection end, should point to the symbol that is next the last selected symbol.

    SetSelectionBackColor(IBackgroundFormat)

    Sets the background color for the selected area.

    Declaration
    public void SetSelectionBackColor(IBackgroundFormat format)
    Parameters
    Type Name Description
    IBackgroundFormat format

    Formatting to be set.

    SetSelectionEnd(CoordinatePoint)

    Sets the end of the selection.

    Declaration
    public void SetSelectionEnd(CoordinatePoint cPoint)
    Parameters
    Type Name Description
    CoordinatePoint cPoint

    CoordinatePoint of end of selection.

    Remarks

    Note: Selection must be already present.

    Old selection will be simply removed.

    SetSelectionStart(CoordinatePoint)

    Removes the current selection and sets new with start and end in given point. Later it can be changed using SetSelectionEnd(CoordinatePoint) method.

    Declaration
    public void SetSelectionStart(CoordinatePoint cPoint)
    Parameters
    Type Name Description
    CoordinatePoint cPoint

    CoordinatePoint with position of selection start.

    Remarks

    Note: If you just use SetSelectionStart method, no selection will be visible, but it will be created, and all commands will work as if selection is set.

    SetSplitWindowFocus(Int32)

    Sets focus on the EditControl loaded in split view with the given input.

    Declaration
    public void SetSplitWindowFocus(int FocusedEditControl)
    Parameters
    Type Name Description
    System.Int32 FocusedEditControl

    Integer variable which is set as focused EditControl loaded in split view.

    SetTextBorder(CoordinatePoint, CoordinatePoint, Color, FrameBorderStyle, BorderWeight)

    Sets border around text with given coordinates.

    Declaration
    public void SetTextBorder(CoordinatePoint start, CoordinatePoint end, Color color, FrameBorderStyle style, BorderWeight weight)
    Parameters
    Type Name Description
    CoordinatePoint start

    Start of text to draw border around.

    CoordinatePoint end

    End of text to draw border around.

    System.Drawing.Color color

    Color of border.

    FrameBorderStyle style

    Style of border.

    BorderWeight weight

    Weight of border line.

    SetTextBorder(Point, Point, Color, FrameBorderStyle, BorderWeight)

    Sets border around text with given coordinates.

    Declaration
    public void SetTextBorder(Point pointStart, Point pointEnd, Color color, FrameBorderStyle style, BorderWeight weight)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Start of text to draw border around (physical coordinates).

    System.Drawing.Point pointEnd

    End of text to draw border around (physical coordinates).

    System.Drawing.Color color

    Color of border.

    FrameBorderStyle style

    Style of border.

    BorderWeight weight

    Weight of border line.

    SetTextColor(CoordinatePoint, CoordinatePoint, Color)

    Helps to sets the color of text.

    Declaration
    public void SetTextColor(CoordinatePoint start, CoordinatePoint end, Color color)
    Parameters
    Type Name Description
    CoordinatePoint start

    Start of text to set color.

    CoordinatePoint end

    End of text to set color.

    System.Drawing.Color color

    Color to set.

    SetTextColor(Point, Point, Color)

    Helps to sets the color of text.

    Declaration
    public void SetTextColor(Point pointStart, Point pointEnd, Color color)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Start of text to set color (physical coordinates).

    System.Drawing.Point pointEnd

    End of text to set color (physical coordinates).

    System.Drawing.Color color

    Color to set.

    SetUnderline(CoordinatePoint, CoordinatePoint, ISnippetFormat)

    Sets underlining of the specified text region.

    Declaration
    public void SetUnderline(CoordinatePoint pointStart, CoordinatePoint pointEnd, ISnippetFormat format)
    Parameters
    Type Name Description
    CoordinatePoint pointStart

    Starting point.

    CoordinatePoint pointEnd

    End point.

    ISnippetFormat format

    Format to be used.

    SetUnderline(Point, Point, ISnippetFormat)

    Sets underlining of the specified text region.

    Declaration
    public void SetUnderline(Point pointStart, Point pointEnd, ISnippetFormat format)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Starting point (physical coordinates).

    System.Drawing.Point pointEnd

    End point (physical coordinates).

    ISnippetFormat format

    Format to be used.

    ShouldSerializeSetMarkerOnEncodingChanged()

    Determines whether SetMarkerOnEncodingChanged has been modified and its contents should be serialized at design-time.

    Declaration
    public bool ShouldSerializeSetMarkerOnEncodingChanged()
    Returns
    Type Description
    System.Boolean

    True if SetMarkerOnEncodingChanged were changed; False otherwise.

    ShouldSerializeShowFileDropNotification()

    Indicates whether the current value of the ShowFileDropNotification property is to be serialized.

    Declaration
    protected bool ShouldSerializeShowFileDropNotification()
    Returns
    Type Description
    System.Boolean

    ShowCaret()

    Helps to shows the cursor caret.

    Declaration
    public void ShowCaret()

    ShowCodeSnippets()

    Shows the code snippets choice list.

    Declaration
    public virtual void ShowCodeSnippets()

    ShowContextChoice()

    Shows the context choice popup window that helps to speed up coding by reducing typos and other common mistakes.

    Declaration
    public void ShowContextChoice()

    ShowContextPrompt()

    Shows the context prompt popup window that helps to add the content easily in EditControl.

    Declaration
    public void ShowContextPrompt()

    ShowFindDialog()

    Shows GoTo dialog window that allow the user to navigate to any line in EditControl.

    Declaration
    public void ShowFindDialog()

    ShowFormatsCustomizationDialog()

    Shows formats customization dialog that helps to customize the font, foreground, operator, keyword color of EditControl contents

    Declaration
    public void ShowFormatsCustomizationDialog()

    ShowGoToDialog()

    Shows GoTo dialog window.

    Declaration
    public void ShowGoToDialog()

    ShowIndentGuideline()

    Shows indent guideline of the current region.

    Declaration
    public void ShowIndentGuideline()

    ShowKeysBindingEditor()

    Gets the key binder that provides advanced customization of keystroke bindings for all editing and navigation operations.

    Declaration
    public void ShowKeysBindingEditor()

    ShowReplaceDialog()

    Shows Replace dialog window.

    Declaration
    public void ShowReplaceDialog()

    SplitFourQuadrants()

    Helps to splits the EditControl into 4 equal parts.

    Declaration
    public void SplitFourQuadrants()

    SplitHorizontally()

    Helps to splits the EditControl into 2 equal horizontal halves.

    Declaration
    public void SplitHorizontally()

    SplitVertically()

    Helps to splits the EditControl into 2 equal vertical halves.

    Declaration
    public void SplitVertically()

    StartSelection()

    Specifies start position for selecting text.

    Declaration
    public void StartSelection()

    StartSelection(Int32, Int32)

    Sets the selection start at the specified position in text.

    Declaration
    public void StartSelection(int column, int line)
    Parameters
    Type Name Description
    System.Int32 column

    Column index of the selection start.

    System.Int32 line

    Line index of the selection start.

    StopSelection()

    Specifies end position for selecting text.

    Declaration
    public void StopSelection()

    StopSelection(Int32, Int32)

    Sets the selection end at the specified position in text.

    Declaration
    public void StopSelection(int column, int line)
    Parameters
    Type Name Description
    System.Int32 column

    Column index of the selection end, should point to the symbol that is next the last selected symbol.

    System.Int32 line

    Line index of the selection end, should point to the symbol that is next the last selected symbol.

    StrikeThrough(CoordinatePoint, CoordinatePoint, Color)

    Helps to strikes out the text that contain within the given specified range.

    Declaration
    public void StrikeThrough(CoordinatePoint start, CoordinatePoint end, Color color)
    Parameters
    Type Name Description
    CoordinatePoint start

    Start location of the text to strike out.

    CoordinatePoint end

    End location of the text to strike out.

    System.Drawing.Color color

    Color of the text strike out. It you set it to Color.Empty, strikeout will be removed.

    StrikeThrough(Point, Point, Color)

    Helps to strikes out the text that contain within the given specified range.

    Declaration
    public void StrikeThrough(Point pointStart, Point pointEnd, Color color)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Start location of the text to strike out (physical coordinates).

    System.Drawing.Point pointEnd

    End location of the text to strike out (physical coordinates).

    System.Drawing.Color color

    Color of the text strike out. It you set it to Color.Empty, strikeout will be removed.

    StrikeThrough(Int32, Color)

    Helps to strikes out the text that contain within the given specified range.

    Declaration
    public void StrikeThrough(int linenumber, Color color)
    Parameters
    Type Name Description
    System.Int32 linenumber

    Lumber of the line to strikeout.

    System.Drawing.Color color

    Color of the strike out.

    SuspendPainting()

    Suspends painting of the control EditControl.

    Declaration
    public void SuspendPainting()

    SwitchCollapsingOff()

    Turns off collapsing the region functionality in EditControl.

    Declaration
    public void SwitchCollapsingOff()

    SwitchCollapsingOn()

    Turns on collapsing the region functionality in .

    Declaration
    public void SwitchCollapsingOn()

    SwitchIndexedBookmark0()

    Switches bookmark with index 0.

    Declaration
    public virtual void SwitchIndexedBookmark0()

    SwitchIndexedBookmark1()

    Switches bookmark with index 1.

    Declaration
    public virtual void SwitchIndexedBookmark1()

    SwitchIndexedBookmark2()

    Switches bookmark with index 2.

    Declaration
    public virtual void SwitchIndexedBookmark2()

    SwitchIndexedBookmark3()

    Switches bookmark with index 3.

    Declaration
    public virtual void SwitchIndexedBookmark3()

    SwitchIndexedBookmark4()

    Switches bookmark with index 4.

    Declaration
    public virtual void SwitchIndexedBookmark4()

    SwitchIndexedBookmark5()

    Switches bookmark with index 5.

    Declaration
    public virtual void SwitchIndexedBookmark5()

    SwitchIndexedBookmark6()

    Switches bookmark with index 6.

    Declaration
    public virtual void SwitchIndexedBookmark6()

    SwitchIndexedBookmark7()

    Switches bookmark with index 7.

    Declaration
    public virtual void SwitchIndexedBookmark7()

    SwitchIndexedBookmark8()

    Switches bookmark with index 8.

    Declaration
    public virtual void SwitchIndexedBookmark8()

    SwitchIndexedBookmark9()

    Switches bookmark with index 9.

    Declaration
    public virtual void SwitchIndexedBookmark9()

    TabifySelection()

    Changes spaces sequences to tabs.

    Declaration
    public virtual void TabifySelection()

    ToggleIndexedBookmark0()

    Toggles cursor position towards the bookmark with index 0 in EditControl.

    Declaration
    public virtual void ToggleIndexedBookmark0()

    ToggleIndexedBookmark1()

    Toggles cursor position towards the bookmark with index 1 in EditControl.

    Declaration
    public virtual void ToggleIndexedBookmark1()

    ToggleIndexedBookmark2()

    Toggles cursor position towards the bookmark with index 2 in EditControl.

    Declaration
    public virtual void ToggleIndexedBookmark2()

    ToggleIndexedBookmark3()

    Toggles cursor position towards the bookmark with index 3 in EditControl.

    Declaration
    public virtual void ToggleIndexedBookmark3()

    ToggleIndexedBookmark4()

    Toggles cursor position towards the bookmark with index 4 in EditControl.

    Declaration
    public virtual void ToggleIndexedBookmark4()

    ToggleIndexedBookmark5()

    Toggles cursor position towards the bookmark with index 5 in EditControl.

    Declaration
    public virtual void ToggleIndexedBookmark5()

    ToggleIndexedBookmark6()

    Toggles cursor position towards the bookmark with index 6 in EditControl.

    Declaration
    public virtual void ToggleIndexedBookmark6()

    ToggleIndexedBookmark7()

    Toggles cursor position towards the bookmark with index 7 in EditControl.

    Declaration
    public virtual void ToggleIndexedBookmark7()

    ToggleIndexedBookmark8()

    Toggles cursor position towards the bookmark with index 8 in EditControl.

    Declaration
    public virtual void ToggleIndexedBookmark8()

    ToggleIndexedBookmark9()

    Toggles cursor position towards the bookmark with index 9 in EditControl.

    Declaration
    public virtual void ToggleIndexedBookmark9()

    ToggleInsertMode()

    Toggles insert mode.

    Declaration
    public void ToggleInsertMode()

    ToggleLineCollapsing()

    Toggles collapsing for current line.

    Declaration
    public void ToggleLineCollapsing()

    ToggleShowingWhiteSpaces()

    Toggles showing of whitespaces in EditControl.

    Declaration
    public virtual void ToggleShowingWhiteSpaces()

    UnCommentLine()

    Helps to uncomments the current line.

    Declaration
    public void UnCommentLine()

    UnCommentLine(Int32)

    Helps to uncomments the specified line.

    Declaration
    public void UnCommentLine(int iLineIndex)
    Parameters
    Type Name Description
    System.Int32 iLineIndex

    Index of line to uncomment.

    UncommentSelection()

    Helps to uncomments the selected text.

    Declaration
    public void UncommentSelection()

    UncommentText(Point, Point)

    Helps to uncomments the text in the specified range.

    Declaration
    public void UncommentText(Point pointStart, Point pointEnd)
    Parameters
    Type Name Description
    System.Drawing.Point pointStart

    Beginning of range (physical coordinates).

    System.Drawing.Point pointEnd

    End of rage (physical coordinates).

    Undo()

    Performs Undo operation that erase the last change made in the document of EditControl.

    Declaration
    public void Undo()

    UndoGroupCancel()

    Cancels the undo grouping operation in EditControl.

    Declaration
    public void UndoGroupCancel()

    UndoGroupClose()

    Saves and closes the undo group action which had been performed in EditControl.

    Declaration
    public void UndoGroupClose()

    UndoGroupOpen()

    Opens the undo group. All further text changes can be undone with open undo operation.

    Declaration
    public void UndoGroupOpen()

    UntabifySelection()

    Changes tabs sequences to spaces.

    Declaration
    public virtual void UntabifySelection()

    UpdateSizeInAutoSizeMode()

    Updates control size in autosize mode.

    Declaration
    protected void UpdateSizeInAutoSizeMode()

    UpdateStatusBarEncodingPanel()

    Updates information regarding currently used encoding in the status bar.

    Declaration
    protected void UpdateStatusBarEncodingPanel()

    WndProc(ref Message)

    Processes Windows messages.

    Declaration
    protected override void WndProc(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m

    The Windows Message to process.

    Events

    BeforeLineNumberPaint

    Occurs before the line number has been drawn.

    Declaration
    public event OnBeforeLineNumberPaintEventHandler BeforeLineNumberPaint
    Event Type
    Type Description
    OnBeforeLineNumberPaintEventHandler

    CanUndoRedoChanged

    Occurs when CanUndoRedo state has changed in EditControl.

    Declaration
    public event EventHandler CanUndoRedoChanged
    Event Type
    Type Description
    System.EventHandler

    ChangingStream

    Occurs when underlying stream of the control is about to change.

    Declaration
    [Obsolete("Later this event will not be exposed to the user.", false)]
    public virtual event ChangingStreamEventHandler ChangingStream
    Event Type
    Type Description
    ChangingStreamEventHandler

    Closing

    Occurs when edited stream is about to be closed and changes should be saved.

    Declaration
    public event StreamCloseEventHandler Closing
    Event Type
    Type Description
    StreamCloseEventHandler

    CodeSnippetActivating

    Occurs before code snippet is activated.

    Declaration
    public event CancellableCodeSnippetsEventHandler CodeSnippetActivating
    Event Type
    Type Description
    CancellableCodeSnippetsEventHandler

    CodeSnippetDeactivating

    Occurs after code snippet is deactivated.

    Declaration
    public event CodeSnippetsEventHandler CodeSnippetDeactivating
    Event Type
    Type Description
    CodeSnippetsEventHandler

    CodeSnippetTemplateTextChanging

    Occurs when text of code snippet template member is to be changed.

    Declaration
    public event CodeSnippetTemplateTextChangingEventHandler CodeSnippetTemplateTextChanging
    Event Type
    Type Description
    CodeSnippetTemplateTextChangingEventHandler

    CollapsedAll

    Raised when CollapseAll method is called.

    Declaration
    public event EventHandler CollapsedAll
    Event Type
    Type Description
    System.EventHandler

    CollapsingAll

    Raised when CollapsingAll method is called.

    Declaration
    public event CancelEventHandler CollapsingAll
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler

    ConfigurationChanged

    Occurs after configuration has changed.

    Declaration
    public event EventHandler ConfigurationChanged
    Event Type
    Type Description
    System.EventHandler

    ContextChoiceBeforeOpen

    Occurs before the ContextChoice dialog is shown to user.

    Declaration
    public event CancelEventHandler ContextChoiceBeforeOpen
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler

    ContextChoiceClose

    Occurs when context choice window has been closed.

    Declaration
    public event ContextChoiceCloseEventHandler ContextChoiceClose
    Event Type
    Type Description
    ContextChoiceCloseEventHandler

    ContextChoiceItemSelected

    Occurs when context choice item has been selected.

    Declaration
    public event ContextChoiceItemSelectedEventHandler ContextChoiceItemSelected
    Event Type
    Type Description
    ContextChoiceItemSelectedEventHandler

    ContextChoiceOpen

    Occurs when context choice window has been opened.

    Declaration
    public event ContextChoiceEventHandler ContextChoiceOpen
    Event Type
    Type Description
    ContextChoiceEventHandler

    ContextChoiceRightClick

    Occurs when context choice item is right clicked.

    Declaration
    public event ContextChoiceItemEventHandler ContextChoiceRightClick
    Event Type
    Type Description
    ContextChoiceItemEventHandler

    ContextChoiceSelectedTextInsert

    Occurs when editor is about to insert text of the selected context choice item.

    Declaration
    public event ContextChoiceTextInsertEventHandler ContextChoiceSelectedTextInsert
    Event Type
    Type Description
    ContextChoiceTextInsertEventHandler

    ContextChoiceUpdate

    Occurs when context choice list should be updated.

    Declaration
    public event ContextChoiceEventHandler ContextChoiceUpdate
    Event Type
    Type Description
    ContextChoiceEventHandler

    ContextPromptBeforeOpen

    Occurs before context prompt dialog should be shown to user.

    Declaration
    public event CancelEventHandler ContextPromptBeforeOpen
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler

    ContextPromptClose

    Occurs when context prompt window has been closed.

    Declaration
    public event ContextPromptCloseEventHandler ContextPromptClose
    Event Type
    Type Description
    ContextPromptCloseEventHandler

    ContextPromptOpen

    Occurs when context prompt dialog has been opened.

    Declaration
    public event ContextPromptUpdateEventHandler ContextPromptOpen
    Event Type
    Type Description
    ContextPromptUpdateEventHandler

    ContextPromptSelectionChanged

    Occurs when context prompt item has been selected.

    Declaration
    public event ContextPromptSelectionChangedEventHandler ContextPromptSelectionChanged
    Event Type
    Type Description
    ContextPromptSelectionChangedEventHandler

    ContextPromptUpdate

    Occurs when the context prompt list has been updated.

    Declaration
    public event ContextPromptUpdateEventHandler ContextPromptUpdate
    Event Type
    Type Description
    ContextPromptUpdateEventHandler

    CursorPositionChanged

    Occurs after the current cursor position has changed in EditControl.

    Declaration
    public event EventHandler CursorPositionChanged
    Event Type
    Type Description
    System.EventHandler

    DrawLineMark

    Occurs when custom line mark should be drawn.

    Declaration
    public event DrawLineMarkEventHandler DrawLineMark
    Event Type
    Type Description
    DrawLineMarkEventHandler

    DrawUserMarginText

    Occurs when user margin area text is ready to be drawn.

    Declaration
    public event DrawUserMarginTextEventHandler DrawUserMarginText
    Event Type
    Type Description
    DrawUserMarginTextEventHandler

    ExpandedAll

    Raised when ExpandAll method is called.

    Declaration
    public event EventHandler ExpandedAll
    Event Type
    Type Description
    System.EventHandler

    ExpandingAll

    Raised when ExpandingAll method is called.

    Declaration
    public event CancelEventHandler ExpandingAll
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler

    Find

    Occurs when a new match is found in FindAndReplaceDialogBox through FindNext Button.

    Declaration
    public event EventHandler Find
    Event Type
    Type Description
    System.EventHandler

    HorizontalScroll

    Occurs when horizontal scrolling takes place in EditControl.

    Declaration
    public event ScrollEventHandler HorizontalScroll
    Event Type
    Type Description
    System.Windows.Forms.ScrollEventHandler

    IndicatorMarginClick

    Occurs when user clicks on the indicator margin area.

    Declaration
    public event IndicatorClickEventHandler IndicatorMarginClick
    Event Type
    Type Description
    IndicatorClickEventHandler

    IndicatorMarginDoubleClick

    Occurs when user double-clicks on the indicator margin area.

    Declaration
    public event IndicatorClickEventHandler IndicatorMarginDoubleClick
    Event Type
    Type Description
    IndicatorClickEventHandler

    InsertModeChanged

    Occurs after the InsertMode property has changed in EditControl.

    Declaration
    public event EventHandler InsertModeChanged
    Event Type
    Type Description
    System.EventHandler

    LanguageChanged

    Occurs when current parser language of the control has been changed.

    Declaration
    public event EventHandler LanguageChanged
    Event Type
    Type Description
    System.EventHandler

    LineChanged

    Occurs when line has been changed.

    Declaration
    public event TextChangedEventHandler LineChanged
    Event Type
    Type Description
    TextChangedEventHandler

    LineDeleted

    Occurs when line Deleted in EditControl.

    Declaration
    public event LineDeletedEventHandler LineDeleted
    Event Type
    Type Description
    LineDeletedEventHandler

    LineInserted

    Occurs when line inserted in EditControl.

    Declaration
    public event LineInsertedEventHandler LineInserted
    Event Type
    Type Description
    LineInsertedEventHandler

    MenuFill

    Occurs when context menu is about to open. User can handle this event to add custom menu items.

    Declaration
    public event EventHandler MenuFill
    Event Type
    Type Description
    System.EventHandler

    NewSnippetMemberHighlighting

    Occurs when new code snippet member must be highlighted.

    Declaration
    public event NewSnippetMemberHighlightingEventHandler NewSnippetMemberHighlighting
    Event Type
    Type Description
    NewSnippetMemberHighlightingEventHandler

    OperationStarted

    Occurs when an operation starts like while collapsing and expanding block of code.

    Declaration
    public event LongOperationEventHandler OperationStarted
    Event Type
    Type Description
    LongOperationEventHandler

    OperationStopped

    Occurs on the end of the long operation.

    Declaration
    public event LongOperationEventHandler OperationStopped
    Event Type
    Type Description
    LongOperationEventHandler

    OutliningBeforeCollapse

    Occurs before region is about to collapse.

    Declaration
    public event OutliningCancellableEventHandler OutliningBeforeCollapse
    Event Type
    Type Description
    OutliningCancellableEventHandler

    OutliningBeforeExpand

    Occurs before region is about to expand.

    Declaration
    public event OutliningCancellableEventHandler OutliningBeforeExpand
    Event Type
    Type Description
    OutliningCancellableEventHandler

    OutliningCollapse

    Occurs while collapsing the specific region in EditControl.

    Declaration
    public event OutliningEventHandler OutliningCollapse
    Event Type
    Type Description
    OutliningEventHandler

    OutliningExpand

    Occurs when region expands.

    Declaration
    public event OutliningEventHandler OutliningExpand
    Event Type
    Type Description
    OutliningEventHandler

    OutliningTooltipBeforePopup

    Occurs when outlining tooltip is about to be shown.

    Declaration
    public event OutliningTooltipBeforePopupEventHandler OutliningTooltipBeforePopup
    Event Type
    Type Description
    OutliningTooltipBeforePopupEventHandler

    OutliningTooltipClose

    Occurs when outlining tooltip is closed.

    Declaration
    public event CollapsedRegionRelatedEventHandler OutliningTooltipClose
    Event Type
    Type Description
    CollapsedRegionRelatedEventHandler

    OutliningTooltipPopup

    Occurs when outlining tooltip is shown.

    Declaration
    public event CollapsedRegionRelatedEventHandler OutliningTooltipPopup
    Event Type
    Type Description
    CollapsedRegionRelatedEventHandler

    PaintUserMargin

    Occurs when a user margin display line number has been painted.

    Declaration
    public event PaintEventHandler PaintUserMargin
    Event Type
    Type Description
    System.Windows.Forms.PaintEventHandler

    PrintFooter

    Occurs when page footer need to be printed.

    Declaration
    public event PrintHeadlineEventHandler PrintFooter
    Event Type
    Type Description
    PrintHeadlineEventHandler

    PrintHeader

    Occurs when page header needs to be printed.

    Declaration
    public event PrintHeadlineEventHandler PrintHeader
    Event Type
    Type Description
    PrintHeadlineEventHandler

    ReadOnlyChanged

    Occurs when ReadOnly mode of EditControl changes.

    Declaration
    public event EventHandler ReadOnlyChanged
    Event Type
    Type Description
    System.EventHandler

    RegisteringDefaultKeyBindings

    Occurs when default key bindings should be added.

    Declaration
    public event EventHandler RegisteringDefaultKeyBindings
    Event Type
    Type Description
    System.EventHandler

    RegisteringKeyCommands

    Occurs when custom key-binding command should be registered.

    Declaration
    public event EventHandler RegisteringKeyCommands
    Event Type
    Type Description
    System.EventHandler

    SaveFileWithDataLoss

    Occurs when user tries to save file with data loosing.

    Declaration
    public event SaveWithDataLosingEventHandler SaveFileWithDataLoss
    Event Type
    Type Description
    SaveWithDataLosingEventHandler

    SaveStreamWithDataLoss

    Occurs when user tries to save stream with data loosing.

    Declaration
    public event SaveWithDataLosingEventHandler SaveStreamWithDataLoss
    Event Type
    Type Description
    SaveWithDataLosingEventHandler

    SearchRegex

    It's an Event Handler for RegexCaseInsenstiveArgs

    Declaration
    public event EventHandler<EditControl.RegexCaseInsenstiveArgs> SearchRegex
    Event Type
    Type Description
    System.EventHandler<EditControl.RegexCaseInsenstiveArgs>

    SelectionChanged

    Occurs after the text selection has changed.

    Declaration
    public event EventHandler SelectionChanged
    Event Type
    Type Description
    System.EventHandler

    SingleLineChanged

    Occurs when SingleLineMode property value has been changed.

    Declaration
    public event EventHandler SingleLineChanged
    Event Type
    Type Description
    System.EventHandler

    TextChanged

    Occurs when text has been changed.

    Declaration
    public event EventHandler TextChanged
    Event Type
    Type Description
    System.EventHandler

    TextChanging

    Occurs when text is about to change.

    Declaration
    public event TextChangingEventHandler TextChanging
    Event Type
    Type Description
    TextChangingEventHandler

    ThemeNameChanged

    Occurs when theme name of the control has changed.

    Declaration
    public event ThemeChangedEventHandler ThemeNameChanged
    Event Type
    Type Description
    ThemeChangedEventHandler

    UnreachableTextFound

    Occurs when text in hidden block is found and this block can't be expanded due to user's cancelling.

    Declaration
    public event UnreachableTextFoundEventHandler UnreachableTextFound
    Event Type
    Type Description
    UnreachableTextFoundEventHandler

    UpdateBookmarkToolTip

    Occurs while updating bookmark tooltip text.

    Declaration
    public event UpdateBookmarkTooltipEventHandler UpdateBookmarkToolTip
    Event Type
    Type Description
    UpdateBookmarkTooltipEventHandler

    UpdateContextToolTip

    Occurs while updating the context tooltip text.

    Declaration
    public event UpdateTooltipEventHandler UpdateContextToolTip
    Event Type
    Type Description
    UpdateTooltipEventHandler

    VerticalScroll

    Occurs when vertical scrolling takes place in EditControl.

    Declaration
    public event ScrollEventHandler VerticalScroll
    Event Type
    Type Description
    System.Windows.Forms.ScrollEventHandler

    WordWrapChanged

    Occurs when WordWrap property value has been changed.

    Declaration
    public event EventHandler WordWrapChanged
    Event Type
    Type Description
    System.EventHandler

    ZoomFactorChanged

    Occurs when the ZoomFactor value of EditControl is changed.

    Declaration
    public virtual event ValueChangedEventHandler ZoomFactorChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    ZoomFactorChanging

    Occurs before the ZoomFactor value of EditControl gets changed. This can be handled to cancel the state changes.

    Declaration
    public virtual event ValueChangingEventHandler ZoomFactorChanging
    Event Type
    Type Description
    ValueChangingEventHandler

    Explicit Interface Implementations

    IVisualStyle.VisualTheme

    Gets or sets the VisualTheme of the control.

    Declaration
    string IVisualStyle.VisualTheme { get; set; }
    Returns
    Type Description
    System.String

    IThemeProvider.BaseThemeName

    Gets or sets the Base Theme name of the theme

    Declaration
    string IThemeProvider.BaseThemeName { get; set; }
    Returns
    Type Description
    System.String

    Implements

    ILocalizableTypeDescriptor
    System.ComponentModel.ICustomTypeDescriptor
    System.ComponentModel.ISupportInitialize
    IThemeProvider
    IVisualStyle
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved