Class StreamEditControl

Represents a control that helps to edit the source files and loads the language configuration from file.

Inheritance
System.Object
ScrollControl
HybridScrollControl
IntelliScrollableControl
StreamEditControl
FileEditControl
Implements
System.ComponentModel.ISupportInitialize
Inherited Members
Namespace: Syncfusion.Windows.Forms.Edit
Assembly: Syncfusion.Edit.Windows.dll
Syntax
public class StreamEditControl : IntelliScrollableControl, IKeyBinderContainer, ILongOperationControllerInternal, ILongOperationController, ISupportInitialize

Constructors

StreamEditControl()

Initializes a new instance of the StreamEditControl class.

Declaration
public StreamEditControl()

Fields

ccount

initiates ccount to be zero

Declaration
public int ccount
Field Value
Type
System.Int32

m_bClosing

True when parent form is being closed.

Declaration
protected bool m_bClosing
Field Value
Type
System.Boolean

m_bEncodingForcedlyChanged

Indicates whether encoding was changed forcibly because of inserting some not supported symbols and user should be prompted on save.

Declaration
protected bool m_bEncodingForcedlyChanged
Field Value
Type
System.Boolean

m_bModified

Indicates whether text was modified after the last save.

Declaration
protected bool m_bModified
Field Value
Type
System.Boolean

m_savedLinesPoints

List of parse points for marking lines that were changed and saved.

Declaration
protected ArrayList m_savedLinesPoints
Field Value
Type
System.Collections.ArrayList

readOnly_layer

Defines the readOnly_layer

Declaration
public IDynamicFormatsLayer readOnly_layer
Field Value
Type
IDynamicFormatsLayer

Properties

AfterTextAreaBrush

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

Declaration
public BrushInfo AfterTextAreaBrush { get; set; }
Property Value
Type
BrushInfo

AllowDeleteReadOnlyRegion

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

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

AllowInsertBeforeReadonlyNewLine

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

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

AllowMouseCursorChange

Gets or sets a value indicating whether mouse cursor should be changed by control when needed.

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

AllowShiftSelectionOld

Gets or sets value indicating whether selection should be performed when shift button is pressed.

Declaration
protected bool AllowShiftSelectionOld { get; set; }
Property Value
Type
System.Boolean

AlwaysShowScrollers

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

Declaration
public bool AlwaysShowScrollers { get; set; }
Property Value
Type
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
System.Boolean

AutoFormattingManager

Gets the autoformatting manager of EditControl.

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

AutoIndentGuideline

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

Declaration
public bool AutoIndentGuideline { get; set; }
Property Value
Type
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 edito

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

AutoScrollPosition

Works with autoscroll position in single line mode.

Declaration
public override Point AutoScrollPosition { get; set; }
Property Value
Type
System.Drawing.Point
Overrides

AutoScrollRectangle

Gets autoscroll rectangle.

Declaration
protected override Rectangle AutoScrollRectangle { get; }
Property Value
Type
System.Drawing.Rectangle
Overrides

BackgroundColor

Gets or sets the background color of EditControl.

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

The GradientPanel control provides this property to enable specialized custom gradient backgrounds.

Bookmarks

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

Declaration
public BookmarksHelper Bookmarks { get; }
Property Value
Type
BookmarksHelper

BookmarkTooltipBackgroundBrush

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

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

BookmarkTooltipBorderColor

Gets or sets the border color of bookmark tooltip form.

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

CanCopy

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

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

CanCut

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

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

CanPaste

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

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

CanRedo

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

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

CanUndo

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

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

ChangedLinesMarkingLineColor

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

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

CodeSnipptSize

Gets or sets the size of Codesnippet block.

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

CollapsingAreaOffset

Gets offset of the collapsing area.

Declaration
protected int CollapsingAreaOffset { get; }
Property Value
Type
System.Int32

ColumnGuideItems

Gets or sets the array of ColumnGuideItem objects.

Declaration
public ColumnGuideItem[] ColumnGuideItems { get; set; }
Property Value
Type
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
System.Drawing.Font

Commands

Gets the list of commands that are used in EditControl.

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

Configurator

Gets or sets the language configurator in EditControl.

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

ContextChoiceOn

Gets value indicating whether autocomplete dialog is opened and ready for keyboard processing.

Declaration
protected bool ContextChoiceOn { get; }
Property Value
Type
System.Boolean

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
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
ContextMenuManager

ContextMenuOptionsForm

Gets or Sets the context menu options form

Declaration
public Form ContextMenuOptionsForm { get; set; }
Property Value
Type
System.Windows.Forms.Form

ContextPromptBackgroundBrush

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

Declaration
public BrushInfo ContextPromptBackgroundBrush { get; set; }
Property Value
Type
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
System.Drawing.Color

ContextPromptOn

Gets value indicating whether ContextPrompt dialog is opened.

Declaration
protected bool ContextPromptOn { get; }
Property Value
Type
System.Boolean

ContextPromptSize

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 ContextPromptSize { get; set; }
Property Value
Type
System.Drawing.Size

ContextTooltipBackgroundBrush

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

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

ContextTooltipBorderColor

Gets or sets the border color of context tooltip form.

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

CurrentColumn

Gets or sets the current column in EditControl.

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

CurrentLine

Gets or sets the current line in EditControl.

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

CurrentLineHighlightColor

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

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

CurrentLineInstance

Gets the instance of the current line in EditControl.

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

CurrentLineText

Gets the text of the current line in EditControl.

Declaration
public string CurrentLineText { get; }
Property Value
Type
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
System.Drawing.Point

CursorGraphicalLocation

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

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

CursorManager

Gets cursor manager.

Declaration
protected CursorManager CursorManager { get; }
Property Value
Type
CursorManager

CustomLineWrappingMarkingImage

Gets or sets custom image that marks lines wrapping.

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

CustomWrappedLinesMarkingImage

Gets or sets the custom image that marks wrapped lines.

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

DefaultGraphics

Default Graphics object. Used for measuring.

Declaration
protected static Graphics DefaultGraphics { get; }
Property Value
Type
System.Drawing.Graphics

DefaultNewLineStyle

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

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

DisableScrollers

Gets or sets value that indicates whether scrollers are disabled.

Declaration
protected bool DisableScrollers { get; set; }
Property Value
Type
System.Boolean

DragDropRectangle

Gets or sets rectangle that show position at which dragged object will be inserted.

Declaration
protected RectangleF DragDropRectangle { get; set; }
Property Value
Type
System.Drawing.RectangleF

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
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
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 NormalSelection.

Declaration
public bool EnableBlockSelection { get; set; }
Property Value
Type
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
System.Boolean

EnableMD5

Gets or sets a value indicating whether control support MD5.

Declaration
public bool EnableMD5 { get; set; }
Property Value
Type
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
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
System.Boolean

FakeEditArea

Gets or sets the client rectangle of the FakeEdit control

Declaration
public Rectangle FakeEditArea { get; set; }
Property Value
Type
System.Drawing.Rectangle

FileEditLikeVisualStduioSearch

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

Declaration
public bool FileEditLikeVisualStduioSearch { get; set; }
Property Value
Type
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
System.String[]

FindDialogLocation

Gets or sets Find and Replace dialog display location

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

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 flushed.

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

FromIndentClick

Gets or sets a value indicating whether indent button is clicked or not.

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

GraphicsCompositingQuality

Gets or sets the image composition quality in EditControl.

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

GraphicsInterpolationMode

Gets or sets the interpolation mode in EditControl.

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

GraphicsSmoothingMode

Gets or sets the rendering quality for the EditControl.

Declaration
public SmoothingMode GraphicsSmoothingMode { get; set; }
Property Value
Type
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
System.Drawing.Text.TextRenderingHint

GroupUndo

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

Declaration
public bool GroupUndo { get; set; }
Property Value
Type
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
System.Boolean

IndentationBlockBackgroundBrush

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

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

IndentationBlockBorderColor

Gets or sets the color of indentation block border line.

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

IndentationBlockBorderStyle

Gets or sets the style of indentation block border line.

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

IndentBlockHighlightingColor

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

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

IndentLineColor

Gets or sets the color for block indentation line.

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

IndicatorMarginColor

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

Declaration
public Color IndicatorMarginColor { get; set; }
Property Value
Type
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
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
System.Boolean

IsBlockSelecting

Gets value that indicates whether control is currently in block text-selection mode.

Declaration
protected bool IsBlockSelecting { get; }
Property Value
Type
System.Boolean

IsCursorChangingAllowed

Indicates whether cursor changing is allowed.

Declaration
protected override bool IsCursorChangingAllowed { get; }
Property Value
Type
System.Boolean
Overrides

IsModified

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

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

IsSelecting

Gets or sets value that indicates whether control is currently in text-selection mode.

Declaration
protected bool IsSelecting { get; set; }
Property Value
Type
System.Boolean

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
IKeyCommandListBinder

KeyBindingProcessor

Gets or sets key binding processor.

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

Language

Gets or sets the currently used configuration language in EditControl.

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

Languages

Gets the list of available languages in EditControl.

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

LeftUserMarginOffset

Gets offset of the user margin for it's positioning on the left.

Declaration
protected int LeftUserMarginOffset { get; }
Property Value
Type
System.Int32

LineNumbersAlignment

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

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

LineNumbersAreaOffset

Gets offset of the line-numbers area.

Declaration
protected int LineNumbersAreaOffset { get; }
Property Value
Type
System.Int32

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
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
System.Drawing.Font

LoadConfigFile

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

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

LockSaveLineMarkerUpdate

Gets or sets a value indicating whether to lock or unlock the SaveLineMarker for Collapsed Region

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

MarkChangedLines

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

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

MarkerAreaWidth

Gets or sets the width of marker area.

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

MarkLineWrapping

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

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

MarkWrappedLines

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

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

NewLineStyle

Gets or sets style of new line.

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

OnlyHighlightMatchingBraces

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

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

ParagraphOffset

Gets or sets offset of paragraphs.

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

Parser

Gets the parser for internal usage

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

PhysicalLineCount

Gets the number of lines in the files of EditControl.

Declaration
public int PhysicalLineCount { get; }
Property Value
Type
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
System.Drawing.Printing.PrintDocument

PrintHeaderAndFooter

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

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

ReadOnly

Gets or sets a value indicating whether changes can be done to the input stream.

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

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
System.Boolean

SavedLinesMarkingLineColor

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

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

SelectedText

Gets or sets the selected text in EditControl.

Declaration
public string SelectedText { get; set; }
Property Value
Type
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 IComplexTextRange Selection { get; }
Property Value
Type
IComplexTextRange

SelectionLineNumberOffset

Gets offset of the selection line number area.

Declaration
protected int SelectionLineNumberOffset { get; }
Property Value
Type
System.Int32

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
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
System.Drawing.Color

SelectionMarginOffset

Gets offset of the selection margin area.

Declaration
protected int SelectionMarginOffset { get; }
Property Value
Type
System.Int32

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
System.Int32

SelectionMode

Gets or sets the EditControl Selection Mode.

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

SelectLineCursor

Gets cursor that shows four directions all together.

Declaration
public static Cursor SelectLineCursor { get; }
Property Value
Type
System.Windows.Forms.Cursor

SelectOnLineNumbersClick

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

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

SelectTextAfterDragDrop

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

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

ShowBookmarkTooltips

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

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

ShowCollapse

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

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

ShowColumnGuides

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

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

ShowContentDividers

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

Declaration
public bool ShowContentDividers { get; set; }
Property Value
Type
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
System.Boolean

ShowFileDropNotification

Gets or sets a value indicating whether the notification is shown when drag and dropped file into EditControl.

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

ShowIndentationBlockBorders

Gets or sets a value indicating whether the indentation block borders should be drawn or not.

Declaration
public bool ShowIndentationBlockBorders { get; set; }
Property Value
Type
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
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
System.Boolean

ShowMarkers

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

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

ShowOutliningCollapsers

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

Declaration
public bool ShowOutliningCollapsers { get; set; }
Property Value
Type
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
System.Boolean

ShowSelectionMargin

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

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

ShowTextArea

Gets or sets a value indicating whether text area should be visible in EditControl.

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

ShowUserMargin

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

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

ShowWhiteSpaceProperties

Get the properties of Show white spaces mode.

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

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
System.Boolean

SingleLineMode

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

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

SpaceBetweenLines

Gets or sets the space between lines in pixels.

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

TabSize

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

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

TabStopsArray

Gets or sets array of tab stops.

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

Text

Gets or sets the editable text of the control.

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

TextAreaLineColor

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

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

TextAreaLineStyle

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

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

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
System.Int32

ToolTipDelay

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

Declaration
public int ToolTipDelay { get; set; }
Property Value
Type
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
System.Boolean

TransparentSelection

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

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

UpdateContextChoiceList

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

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

UseAutoreplaceTriggers

Gets or sets a value indicating whether autoreplace triggers should be used.

Declaration
public bool UseAutoreplaceTriggers { get; set; }
Property Value
Type
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
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
System.Boolean

UserMarginBackgroundColor

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

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

UserMarginBorderColor

Gets or sets the boder color of user margin.

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

UserMarginPlacement

Gets or sets the placement of user margin in EditControl.

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

UserMarginTextColor

Gets or sets the color of user margin text.

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

UserMarginTextFont

Gets or sets the font of user margin text.

Declaration
public Font UserMarginTextFont { get; set; }
Property Value
Type
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
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
System.Boolean

UseTabStops

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

Declaration
public bool UseTabStops { get; set; }
Property Value
Type
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
System.Boolean

UseXPStyleBorder

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

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

VirtualLineNumberOffset

Gets or sets the virtual line number start value.

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

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
System.Boolean

VisibleLineCount

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

Declaration
public int VisibleLineCount { get; }
Property Value
Type
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
System.Int32

VScrollMode

Specifies how the control process vertical scrolling.

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

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
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
System.Int32

WordWrapColumnMeasuringFont

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

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

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
System.Boolean

WrapMarkingImage

Gets lines wrapping marking image.

Declaration
public Image WrapMarkingImage { get; }
Property Value
Type
System.Drawing.Image

WrapMode

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 WrapMode { get; set; }
Property Value
Type
WordWrapMode

WrappedLinesMarkingImage

Gets wrapped lines marking image.

Declaration
public Image WrappedLinesMarkingImage { get; }
Property Value
Type
System.Drawing.Image

WrappedLinesOffset

Gets or sets offset of wrapped lines.

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

WrapType

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

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

Methods

AcceptAutoComplete()

Accepts auto complete string and updates context choice list.

Declaration
public void AcceptAutoComplete()

AddGuidingTabs(Int32, Int32)

Adds guiding tabs at the beginning of lines in the specified range.

Declaration
protected void AddGuidingTabs(int iBeginLine, int iEndLine)
Parameters
Type Name Description
System.Int32 iBeginLine

Index of first line to add guiding tab to.
System.Int32 iEndLine

Index of last line to add guiding tab to.

AddTabsToSelection()

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

Declaration
[Command("Edit.AddLeadingTab")]
[KeysBinding]
public virtual void AddTabsToSelection()

AddTabsToSelection(Boolean)

Adds tabs at the beginning of selected lines.

Declaration
public void AddTabsToSelection(bool bForce)
Parameters
Type Name Description
System.Boolean bForce

Indicates whether tab should be added if single line is selected.

AfterAutoScroll()

Called before scrolling by timer on every timer tick.

Declaration
protected override void AfterAutoScroll()
Overrides

AfterPrinting()

This methods is called after any printing operation ends. Control update is unlocked, word wrapping is turned off if needed.

Declaration
protected void AfterPrinting()

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.

AttachLayoutEventsToParents()

Attaches event handlers to Move and Resize events.

Declaration
protected void AttachLayoutEventsToParents()

AutoFormatText(Int32, Int32)

Autoformats 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.

BeforePrinting()

This methods is called before any printing operation starts. Control update is locked, word wrapping is turned on if needed.

Declaration
protected void BeforePrinting()

BeginConfigurationChange()

Helps to locks processing of the configuration changed events.

Declaration
public void BeginConfigurationChange()

BeginInit()

Performs actions needed before initialization.

Declaration
public void BeginInit()

BeginSelectionUpdate()

Locks SelectionChanged event raising. Increases lock counter by one.

Declaration
protected void BeginSelectionUpdate()

BindKeyboard()

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

Declaration
[KeysBinding]
[Command("Configuration.BindKeyboard")]
public virtual void BindKeyboard()

ChangeEncoding(Encoding, Boolean)

Changes encoding of the underlying stream.

Declaration
protected virtual void ChangeEncoding(Encoding newEncoding, bool bForced)
Parameters
Type Name Description
System.Text.Encoding newEncoding

New encoding.
System.Boolean bForced

Indicates whether encoding is being changed forcibly due to inserting unsupported symbols.

CheckControlState()

Checks whether control is in workable state, if not, throws an exception.

Declaration
protected void CheckControlState()

CheckForGripper(Control)

Checks whether gripper should be drawn.

Declaration
protected bool CheckForGripper(Control control)
Parameters
Type Name Description
System.Windows.Forms.Control control

True if gripper should be drawn; otherwise false.
Returns
Type
System.Boolean

CheckForSupportedData(IDataObject)

Checks whether there is some supported data format in given data object.

Declaration
protected bool CheckForSupportedData(IDataObject data)
Parameters
Type Name Description
System.Windows.Forms.IDataObject data

Object, that keeps data in different formats.
Returns
Type Description
System.Boolean

True if given data object contains data in one of the supported formats, otherwise false.

Close()

Closes stream, makes control read-only.

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

True if user did not cancel the operation, otherwise false.

CloseContextPrompt()

Closes context prompt popup.

Declaration
public void CloseContextPrompt()

CloseContextTooltip()

Closes context tooltip.

Declaration
public void CloseContextTooltip()

CloseFindDialog()

Closes the currently opened find dialog window in EditControl.

Declaration
public void CloseFindDialog()

CloseReplaceDialog()

Closes the currently opened replace dialog window in EditControl.

Declaration
public void CloseReplaceDialog()

CloseStream()

Closes input stream wrapper. Does not close underlying stream.

Declaration
protected virtual bool CloseStream()
Returns
Type Description
System.Boolean

True if operation succeeds.

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(Int32)

Comments single line.

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

Index of line to comment.

CommentText(CoordinatePoint, CoordinatePoint)

Comments text in the specified range.

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

Beginning of range.
CoordinatePoint p2

End of rage.

ContextChoiceCheckCursorPosition()

Checks weather cursor position belongs to the word, that was under cursor when context choice was opened.

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

False if context choice should be closed.

ConvertEncodingAndNewLine(Stream, Encoding, String, out Boolean)

Converts encoding and new line style of the input stream; returns result stream. Input stream is closed.

Declaration
public Stream ConvertEncodingAndNewLine(Stream stream, Encoding encoding, string lineEndString, out bool bDataLost)
Parameters
Type Name Description
System.IO.Stream stream

Input stream.
System.Text.Encoding encoding

Encoding to use when saving to stream.
System.String lineEndString

String representing line end style.
System.Boolean bDataLost

bool indicating whether data lost happened.
Returns
Type Description
System.IO.Stream

Resulting stream or null if no recoding is done.

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.

ConvertStream(Stream, out Boolean)

Sets the same new-line style for the entire stream.

Declaration
protected Stream ConvertStream(Stream textStream, out bool bDataLost)
Parameters
Type Name Description
System.IO.Stream textStream

Input stream.
System.Boolean bDataLost

Indicates whether some data was lost during recoding.
Returns
Type Description
System.IO.Stream

Newly created stream, or null if no changes where done.

ConvertStream(Stream, String, out Boolean)

Changes new-line style of the content of the stream.

Declaration
protected Stream ConvertStream(Stream textStream, string newLine, out bool bDataLost)
Parameters
Type Name Description
System.IO.Stream textStream

Input stream.
System.String newLine

New new-line style.
System.Boolean bDataLost

Indicates whether some data was lst during recoding.
Returns
Type Description
System.IO.Stream

Newly created stream, or null if no changes where done.

ConvertStream(Stream, String, Encoding, out Boolean)

Changes encoding and new-line style of the content of the stream.

Declaration
protected Stream ConvertStream(Stream textStream, string newLine, Encoding encoding, out bool bDataLost)
Parameters
Type Name Description
System.IO.Stream textStream

Input stream.
System.String newLine

New new-line style.
System.Text.Encoding encoding

New encoding.
System.Boolean bDataLost

Indicates whether some data was lst during recoding.
Returns
Type Description
System.IO.Stream

Newly created stream, or null if no changes where done.

ConvertStream(Stream, Encoding, out Boolean)

Changes encoding and new-line style of the content of the stream.

Declaration
protected Stream ConvertStream(Stream textStream, Encoding encoding, out bool bDataLost)
Parameters
Type Name Description
System.IO.Stream textStream

Input stream.
System.Text.Encoding encoding

New encoding, can be null to leave the previous one.
System.Boolean bDataLost

Indicates whether some data was lst during recoding.
Returns
Type Description
System.IO.Stream

Newly created stream, or null if no changes where done.

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
[KeysBinding]
[Command("Clipboard.Copy")]
[KeysBinding]
public virtual void Copy()

CreateAccessibilityInstance()

New instance for StreamEditControl AccessibleObject

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

StreamEditControlAccessibleObject

CreateParser(StreamsWrapper, IConfigLanguage)

Creates new lexem parser and disposes old one.

Declaration
protected virtual void CreateParser(StreamsWrapper newWrapper, IConfigLanguage newLang)
Parameters
Type Name Description
StreamsWrapper newWrapper
IConfigLanguage newLang

Cut()

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

Declaration
[Command("Clipboard.Cut")]
[KeysBinding]
[KeysBinding]
public virtual void Cut()

DeclineAutoComplete()

Declines auto complete string.

Declaration
public void DeclineAutoComplete()

DeleteAll()

Deletes all text in document.

Declaration
public void DeleteAll()

DeleteChar()

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

Declaration
[KeysBinding]
[Command("Edit.DeleteChar")]
public virtual void DeleteChar()

DeleteCharLeft()

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

Declaration
[KeysBinding]
[Command("Edit.Backspace")]
[KeysBinding]
public virtual void DeleteCharLeft()

DeleteSelected()

Removes selected text.

Declaration
protected virtual bool DeleteSelected()
Returns
Type
System.Boolean

DeleteText(CoordinatePoint, CoordinatePoint)

Deletes 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.

DeleteWord()

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

Declaration
[Command("Edit.DeleteWord")]
[KeysBinding]
public virtual void DeleteWord()

DeleteWordLeft()

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

Declaration
[KeysBinding]
[Command("Edit.DeleteWordLeft")]
public virtual void DeleteWordLeft()

DestroyParser()

Destroys parser.

Declaration
protected void DestroyParser()

DetachLayoutEventsToParents()

Detaches event handlers from Move and Resize events.

Declaration
protected void DetachLayoutEventsToParents()

Dispose(Boolean)

Disposes object and frees all used resources and suppresses object's finalization.

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.
Overrides

DisposeType(Type, Boolean)

Disposes current instance members using the specified type information.

Declaration
protected void DisposeType(Type typeToDispose, bool setNull)
Parameters
Type Name Description
System.Type typeToDispose

Type info to be used.
System.Boolean setNull

Value that indicates whether nullable variable should be set to null.

DoubleClickFromMouseDown(EventArgs)

Processes double-click, selects word.

Declaration
protected virtual void DoubleClickFromMouseDown(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.

DrawArea(Graphics, RectangleF, Single, out Single, Boolean, Boolean, Boolean, Int32, Single, Size)

Draws some part of the text area.

Declaration
protected virtual RenderedLine DrawArea(Graphics g, RectangleF rect, float xScroll, out float iMaxLineWidthInArea, bool drawDynamicFormatting, bool drawIncompleteLines, bool bForPrint, int autoScrollY, float scale, Size margins)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics, text should be drawn on.
System.Drawing.RectangleF rect

Rectangle in the area to be drawn.
System.Single xScroll

Shows how much text should be scrolled to the left.
System.Single iMaxLineWidthInArea

Width of the longest line in the drawn area.
System.Boolean drawDynamicFormatting

Specifies whether dynamic formatting can be drawn.
System.Boolean drawIncompleteLines

Specifies whether just complete lines should be drawn.
System.Boolean bForPrint

Indicates whether g is printer's graphics.
System.Int32 autoScrollY

Y autoscroll position. Used for proper native drawing.
System.Single scale

Scale value for output. Used in printing for resolving printing problems related to native methods.
System.Drawing.Size margins

Margin offsets for text output. Used in printing.
Returns
Type Description
RenderedLine

Last rendered line or null if no lines where rendered.
Remarks

Given area will be drawn without using information about scrollers. To scroll area use transformation matrices of the Graphics object.

DrawAreaBackground(Graphics, Rectangle, RectangleF, Boolean)

Draws background of the control area.

Declaration
protected virtual void DrawAreaBackground(Graphics g, Rectangle rectClient, RectangleF rect, bool bForPrint)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics, text should be drawn on.
System.Drawing.Rectangle rectClient

Client rectangle.
System.Drawing.RectangleF rect

Rectangle in the area to be drawn.
System.Boolean bForPrint

Indicates whether drawing isbeing performed for printing.

DrawCollapseIcon(Graphics, Rectangle, Boolean, Boolean)

Draws collapse icon using XP style id possible.

Declaration
protected virtual void DrawCollapseIcon(Graphics g, Rectangle rect, bool bPlus, bool bForPrint)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object to draw.
System.Drawing.Rectangle rect

Rectangle where icon should be drawn.
System.Boolean bPlus

true if plus should be drawn, false if minus.
System.Boolean bForPrint

Indicates whether g is printer's graphics.

DrawCollapseRect(RenderedLine, Graphics, Boolean)

Draws rectangle with plus or minus sign in the collapsers area if line supports collapsing.

Declaration
protected virtual void DrawCollapseRect(RenderedLine line, Graphics g, bool bForPrint)
Parameters
Type Name Description
RenderedLine line

Line, to draw sign for.
System.Drawing.Graphics g

Graphics object, where sign can be drawn.
System.Boolean bForPrint

Indicates whether g is printer's graphics.

DrawColumnGuides(Graphics)

Draws column guide lines.

Declaration
protected virtual void DrawColumnGuides(Graphics g)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object to draw.

DrawCorner(Graphics, Pen, RectangleF, Boolean, Boolean)

Draws corner of the selection margin.

Declaration
protected virtual void DrawCorner(Graphics g, Pen pen, RectangleF rect, bool bRight, bool bBottom)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object.
System.Drawing.Pen pen

Pen to be used for drawing.
System.Drawing.RectangleF rect

Selection margin rectangle.
System.Boolean bRight

True of corner is on the right.
System.Boolean bBottom

True of corner is on the bottom..

DrawIndentationBlockBackground(Graphics, Single)

Draws indentation block background.

Declaration
protected void DrawIndentationBlockBackground(Graphics g, float xOffset)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics.
System.Single xOffset

X offset.

DrawIndentGuideline(Graphics, Single)

Draw indent Guideline.

Declaration
protected virtual void DrawIndentGuideline(Graphics g, float xOffset)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object.
System.Single xOffset

xOffset of the Guidelines.

DrawLexemLine(Graphics, RenderedLine, Single, Single, Boolean, Int32, Single, Size)

Draws PreRenderedLine on the given graphics object. Line must be previously measured, or it will not be rendered correctly.

Declaration
protected virtual float DrawLexemLine(Graphics g, RenderedLine line, float x, float y, bool drawDynamicFormatting, int autoScrollY, float scale, Size margins)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object, line must be rendered to.
RenderedLine line

Line, to be rendered.
System.Single x

X Position of the rendering.
System.Single y

Y Position of the rendering.
System.Boolean drawDynamicFormatting

Indicates whether dynamic formatting should be drawn.
System.Int32 autoScrollY

Y autoscroll position. Used for proper native drawing.
System.Single scale

Scale value for output. Used in printing for resolving printing problems related to native methods.
System.Drawing.Size margins

Margin offsets for text output. Used in printing.
Returns
Type
System.Single

DrawLineBorders(Graphics, Single, RenderedLine)

Draws line background.

Declaration
protected virtual void DrawLineBorders(Graphics g, float xOffset, RenderedLine line)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object.
System.Single xOffset

X coordinate of the line.
RenderedLine line

Line, the background should be rendered.

DrawTextArea(Graphics, Rectangle)

Draws text area line and area situated after that line.

Declaration
protected virtual void DrawTextArea(Graphics g, Rectangle rectToDraw)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object to draw things.
System.Drawing.Rectangle rectToDraw

Rectangle to draw.

DrawTransparentSelection(Graphics, Single, Region, Region)

Draws transparent selection.

Declaration
protected virtual void DrawTransparentSelection(Graphics g, float xScroll, Region regionText, Region regionUtility)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics.
System.Single xScroll

Shows how much text should be scrolled to the left.
System.Drawing.Region regionText

Region, used for drawing text.
System.Drawing.Region regionUtility

Region used for drawing line numbers, bookmarks and collapsers.

DrawUserMarginArea(Graphics, Rectangle)

Draws user margin area.

Declaration
protected virtual Rectangle DrawUserMarginArea(Graphics g, Rectangle clientrect)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object, margin area should be drawn on.
System.Drawing.Rectangle clientrect

Client rectangle of the control, user margin should be drawn on.
Returns
Type
System.Drawing.Rectangle

DrawWaveLines(Graphics, CoordinatePoint, CoordinatePoint, Single)

Draws WaveLines.

Declaration
protected virtual void DrawWaveLines(Graphics g, CoordinatePoint start, CoordinatePoint end, float xScroll)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object.
CoordinatePoint start

Start coordinate of the line.
CoordinatePoint end

End coordinate of the line.
System.Single xScroll

X coordinate of the line start.

EndConfigurationChange(Boolean)

Helps to unlocks processing of the configuration changed events.

Declaration
public void EndConfigurationChange(bool update)
Parameters
Type Name Description
System.Boolean update

Indicates whether control should be updated.

EndInit()

Initializes key bindings.

Declaration
public void EndInit()

EndSelectionUpdate()

Unlock SelectionChanged event raising. Decreases lock counter by one.

Declaration
protected void EndSelectionUpdate()

EscapeKeyProcess()

Cancels the selection in EditControl.

Declaration
[Command("Edit.SelectionCancel")]
[KeysBinding]
public void EscapeKeyProcess()

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()

ExpandCurrentLine()

Expands all collapsing on the current line.

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

True if user didn't cancel expanding; otherwise false.

FillLineCollapsers(RenderedLine, IList, IList)

Fills lists of collapsed and uncollapsed regions from specified line.

Declaration
protected void FillLineCollapsers(RenderedLine line, IList collapsed, IList notCollapsed)
Parameters
Type Name Description
RenderedLine line

Line to be inspected.
System.Collections.IList collapsed

List of collapsed regions.(Must be empty)
System.Collections.IList notCollapsed

List of uncollapsed regions.(Must be empty)

FillRectWithBorder(Graphics, Brush, Pen, RectangleF)

Fills rectangle using specified brush and draws it's border using specified pen.

Declaration
protected virtual void FillRectWithBorder(Graphics g, Brush brush, Pen pen, RectangleF rect)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics object.
System.Drawing.Brush brush

Brush to be used for filling rectangle.
System.Drawing.Pen pen

Pen to be used for drawing border.
System.Drawing.RectangleF rect

Rectangle to be filled and bordered.

FindCurrentText()

Searches text under cursor, or selected text.

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

FindCurrentTextKeyBinder()

Searches text under cursor, or selected text. Used for key bindings.

Declaration
[KeysBinding]
[Command("Edit.FindSelected")]
protected void FindCurrentTextKeyBinder()

FindDialog()

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

Declaration
[KeysBinding]
[Command("Edit.Find")]
public virtual void FindDialog()

FindNext()

Searches text under cursor, or selected text.

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

FindNextKeyBinder()

Searches text under cursor, or selected text.

Declaration
[KeysBinding]
[Command("Edit.FindNext")]
public void FindNextKeyBinder()

FindRange(String, CoordinatePoint, CoordinatePoint, Boolean, Boolean, Boolean, 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 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.

FindRegex(IParsePoint, Regex, Boolean, Boolean)

Looks for specified expression in text.

Declaration
public FindResult FindRegex(IParsePoint start, Regex expression, bool bSearchInCollapsed, bool searchUp)
Parameters
Type Name Description
IParsePoint start

Start position for the search.
System.Text.RegularExpressions.Regex expression

Expression to be found.
System.Boolean bSearchInCollapsed

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

Indicates whether search should be per
Returns
Type Description
FindResult

Search results.

FixLineRenderingPositions()

Updates line rendering positions, updates indentation guideline info.

Declaration
protected void FixLineRenderingPositions()

GenerateDebugKeyMap()

Generates parsing map of the file.

Declaration
[Command("General.KeyMap")]
[KeysBinding]
public void GenerateDebugKeyMap()

GenerateDebugMap()

Generates parsing map of the file.

Declaration
[Conditional("DEBUG")]
[KeysBinding]
[Command("General.Map")]
public void GenerateDebugMap()

GenerateHTML()

Generates HTML document and puts it to the clipboard.

Declaration
[KeysBinding]
[Command("Tools.GenerateHTML")]
public void GenerateHTML()

GetAndConvertFormattings(CoordinatePoint, CoordinatePoint, out ISnippetFormat)

Searches additional formatting for specified region and converts it to array of AdditionalFormatting objects.

Declaration
protected AdditionalFormatting[] GetAndConvertFormattings(CoordinatePoint startPoint, CoordinatePoint endPoint, out ISnippetFormat afterTextFormat)
Parameters
Type Name Description
CoordinatePoint startPoint

Start of the region.
CoordinatePoint endPoint

End of the region.
ISnippetFormat afterTextFormat

OUT format that continues after region end.
Returns
Type Description
AdditionalFormatting[]

Array of AdditionalFormatting objects.

GetCurrentIndentGuidelinedRegionStack()

Gets stack for current IndentGuideline region.

Declaration
protected ConfigStack GetCurrentIndentGuidelinedRegionStack()
Returns
Type Description
ConfigStack

Stack or null.

GetCurrentStack()

Gets copy of the parsers 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.

GetCurrentWord(out Int32)

Gets word under cursor.

Declaration
protected string GetCurrentWord(out int iWordColumn)
Parameters
Type Name Description
System.Int32 iWordColumn

OUT start column of the word.
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.

GetDesiredSize()

Calculates desired size of the control.

Declaration
public Size GetDesiredSize()
Returns
Type Description
System.Drawing.Size

Desired size.

GetDistance(Single, Single)

Calculates distance using dx and dy values.

Declaration
protected float GetDistance(float dx, float dy)
Parameters
Type Name Description
System.Single dx

Dx
System.Single dy

Dy
Returns
Type Description
System.Single

Distance.

GetFileLanguage(String)

Get language configuration by given filename. Filename can include path. If there is not special configuration for such type of files, then Default configuration will be used.

Declaration
protected IConfigLanguage GetFileLanguage(string fileName)
Parameters
Type Name Description
System.String fileName

Path to the file.
Returns
Type Description
IConfigLanguage

Language configuration.

GetLexemCollapsingType(ILexem)

Gets lexem collapsing type. Lexem collapsing type determines lexem's relation to the collapsible regions.

Declaration
protected LexemCollapsingType GetLexemCollapsingType(ILexem lexem)
Parameters
Type Name Description
ILexem lexem

Lexem to be checked.
Returns
Type Description
LexemCollapsingType

Value of LexemCollapsingType type.

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.

GetLexemsInsideStack(ConfigStack, Boolean)

Gets list of the lexems that are inside current stack.

Declaration
public IList GetLexemsInsideStack(ConfigStack stack, bool entireRegion)
Parameters
Type Name Description
ConfigStack stack

Stack we should use.
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.

GetLexemUnderCursor()

Gets lexem under cursor.

Declaration
protected IRenderedLexem GetLexemUnderCursor()
Returns
Type Description
IRenderedLexem

IRenderedLexem instance.

GetLexemUnderCursor(Boolean)

Gets lexem under cursor.

Declaration
protected IRenderedLexem GetLexemUnderCursor(bool correct)
Parameters
Type Name Description
System.Boolean correct

Specifies whether function should return nearest lexem if there is no lexem under cursor.
Returns
Type Description
IRenderedLexem

IRenderedLexem instance.

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 backcolor 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.

GetLineBackColors(Int32)

Gets dynamic formatting range for the line.

Declaration
protected IList GetLineBackColors(int iLine)
Parameters
Type Name Description
System.Int32 iLine

Line number.
Returns
Type Description
System.Collections.IList

Dynamic formatting range.

GetLineIndicatorRectangle(RenderedLine)

Gets rectangle, the line's indicator margin is drawn to.

Declaration
protected Rectangle GetLineIndicatorRectangle(RenderedLine line)
Parameters
Type Name Description
RenderedLine line

Line to get the indicator margin rectangle for.
Returns
Type Description
System.Drawing.Rectangle

Rectangle for indicator margin or Rectangle.Empty if ShowMerkers is set to false.

GetLineLength(Int32)

Gets length of the line.

Declaration
protected int GetLineLength(int iLine)
Parameters
Type Name Description
System.Int32 iLine

Index of the line, to be measured.
Returns
Type Description
System.Int32

Length 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.

GetNearestParsePointLeft(Int32, Int32)

Searches for the IParsePoint at the given position.

Declaration
protected CoordinatePoint GetNearestParsePointLeft(int iLine, int iColumn)
Parameters
Type Name Description
System.Int32 iLine

Line index the ParsePoint is needed for.
System.Int32 iColumn

Column index the ParsePoint is needed for. Can be 0.
Returns
Type Description
CoordinatePoint

ParsePoint to the given position.
Remarks

If it can not be found ( or column is 0), and if it is in virtual space, then you will get parse point to the end of given line; If column is 0, then you will get parse point to the end of the previous line( if it is one ).

GetNearestParsePointRight(Int32, Int32)

Searches for the IParsePoint at the given position.

Declaration
protected CoordinatePoint GetNearestParsePointRight(int iLine, int iColumn)
Parameters
Type Name Description
System.Int32 iLine

Line index, the ParsePoint is needed for.
System.Int32 iColumn

Column index, the ParsePoint is needed for. Can be 0.
Returns
Type Description
CoordinatePoint

ParsePoint to the given position.
Remarks

If it can not be found (it is in virtual space), then you will get parse point, pointing to the beginning of the next line. If it can not be done, ParsePoint, pointing to the end of current line will be returned.

GetNextPreRenderedLine(RenderedLine)

Gets line that is next to the given one.

Declaration
protected RenderedLine GetNextPreRenderedLine(RenderedLine line)
Parameters
Type Name Description
RenderedLine line

Current line.
Returns
Type Description
RenderedLine

RenderedLine object.

GetRealCursorPosition()

Gets the current cursor position in EditControl.

Declaration
public IParsePoint GetRealCursorPosition()
Returns
Type Description
IParsePoint

IParsePoint with current position.

GetSelectedTextDrawPath()

Calculates region, used to draw selected text.

Declaration
protected GraphicsPath GetSelectedTextDrawPath()
Returns
Type Description
System.Drawing.Drawing2D.GraphicsPath

Path of selected text.

GetSelectedTextDrawRegion()

Calculates region, used to draw selected text.

Declaration
protected Region GetSelectedTextDrawRegion()
Returns
Type Description
System.Drawing.Region

Region of selected text.

GetTextAsHTML()

Returns text represented as HTML.

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

String with text represented as HTML.

GetTextAsHTML(CoordinatePoint, CoordinatePoint)

Returns text situated between specified coordinate points represented as HTML.

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.

GetTextAsRTF()

Returns text represented as RTF.

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

String with text represented as RTF.

GetTextAsRTF(CoordinatePoint, CoordinatePoint)

Returns text situated between specified coordinate points represented as RTF.

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.

GetTextAsXML()

Returns text represented as XML.

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

String with text represented as XML.

GetTextAsXML(CoordinatePoint, CoordinatePoint)

Returns text situated between specified coordinate points represented as XML.

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.

GetTextDrawPath(CoordinatePoint, CoordinatePoint)

Calculates region that is used to display text within specified range.

Declaration
protected GraphicsPath GetTextDrawPath(CoordinatePoint startPoint, CoordinatePoint endPoint)
Parameters
Type Name Description
CoordinatePoint startPoint

Start of the range.
CoordinatePoint endPoint

End of the range.
Returns
Type Description
System.Drawing.Drawing2D.GraphicsPath

Region that is used to display text within specified range.

GetTextDrawPath(CoordinatePoint, CoordinatePoint, Boolean)

Calculates region that is used to display text within specified range.

Declaration
protected GraphicsPath GetTextDrawPath(CoordinatePoint startPoint, CoordinatePoint endPoint, bool bInfinityRightLimit)
Parameters
Type Name Description
CoordinatePoint startPoint

Start of the range.
CoordinatePoint endPoint

End of the range.
System.Boolean bInfinityRightLimit

Indicates whether right limit should be set to infinity.
Returns
Type Description
System.Drawing.Drawing2D.GraphicsPath

Region that is used to display text within specified range.

GetTextDrawPath(RectangleF, RectangleF)

Calculates region that is used to display text within specified range.

Declaration
protected GraphicsPath GetTextDrawPath(RectangleF rectStart, RectangleF rectEnd)
Parameters
Type Name Description
System.Drawing.RectangleF rectStart

Start of the range.
System.Drawing.RectangleF rectEnd

End of the range.
Returns
Type Description
System.Drawing.Drawing2D.GraphicsPath

Region that is used to display text within specified range.

GetTextDrawPath(RectangleF, RectangleF, Boolean)

Calculates region that is used to display text within specified range.

Declaration
protected GraphicsPath GetTextDrawPath(RectangleF rectStart, RectangleF rectEnd, bool bInfinityRightLimit)
Parameters
Type Name Description
System.Drawing.RectangleF rectStart

Start of the range.
System.Drawing.RectangleF rectEnd

End of the range.
System.Boolean bInfinityRightLimit

Indicates whether right limit should be set to infinity.
Returns
Type Description
System.Drawing.Drawing2D.GraphicsPath

Region that is used to display text within specified range.

GetTextDrawPathWithoutRightExtending(RectangleF, RectangleF, Boolean)

Calculates region that is used to display text within specified range.

Declaration
protected GraphicsPath GetTextDrawPathWithoutRightExtending(RectangleF rectStart, RectangleF rectEnd, bool bInfinityRightLimit)
Parameters
Type Name Description
System.Drawing.RectangleF rectStart

Start of the range.
System.Drawing.RectangleF rectEnd

End of the range.
System.Boolean bInfinityRightLimit

Indicates whether right limit should be set to infinity.
Returns
Type Description
System.Drawing.Drawing2D.GraphicsPath

Region that is used to display text within specified range.

GetTextDrawRegion(CoordinatePoint, CoordinatePoint)

Calculates region that is used to display text within specified range.

Declaration
protected Region GetTextDrawRegion(CoordinatePoint startPoint, CoordinatePoint endPoint)
Parameters
Type Name Description
CoordinatePoint startPoint

Start of the range.
CoordinatePoint endPoint

End of the range.
Returns
Type Description
System.Drawing.Region

Region that is used to display text within specified range.

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
[Command("Edit.GoTo")]
[KeysBinding]
public virtual void GoToDialog()

GoToLine(Int32)

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

Declaration
public bool GoToLine(int iLine)
Parameters
Type Name Description
System.Int32 iLine

Number of desired line.
Returns
Type Description
System.Boolean

Bool indicating success.

HideCaret()

Hides the cursor caret.

Declaration
public void HideCaret()

HideIndentGuideline()

Hides indentation Guideline.

Declaration
public void HideIndentGuideline()

IndentTest()

Proceeds with some tests.

Declaration
[KeysBinding]
[Command("General.Test.Indent")]
public void IndentTest()

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.

InsertChar(Char)

Inserts typed character in to the text at the current position.

Declaration
protected void InsertChar(char key)
Parameters
Type Name Description
System.Char key

Character to insert.

InsertCodeSnippet()

Inserts code snippet into text.

Declaration
protected void InsertCodeSnippet()

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

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.

InvalidateAll()

Invalidates client area of control and all attached fake edit controls.

Declaration
protected void InvalidateAll()

InvalidateAll(Rectangle)

Invalidates specified area of control and all attached fake edit controls.

Declaration
protected void InvalidateAll(Rectangle rect)
Parameters
Type Name Description
System.Drawing.Rectangle rect

Rectangle to invalidate.

InvalidateRelativeRect(Rectangle)

Redraws rectangle specified in coordinates relative to the text start, when TextDrawOffset is not taken into account.

Declaration
protected void InvalidateRelativeRect(Rectangle rect)
Parameters
Type Name Description
System.Drawing.Rectangle rect

Rectangle to be redrawn.

InvalidateRelativeRect(RectangleF)

Redraws rectangle specified in coordinates relative to the text start, when TextDrawOffset is not taken into account.

Declaration
protected void InvalidateRelativeRect(RectangleF rect)
Parameters
Type Name Description
System.Drawing.RectangleF rect

Rectangle to be redrawn.

IsInputKey(Keys)

Checks whether given key can be processed by control.

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
Type Name Description
System.Windows.Forms.Keys keyData

Keys to check.
Returns
Type Description
System.Boolean

True if keyData is input key; otherwise false.

IsRedrawingRequiredBackground()

Checks whether control has background that requires redraw.

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

bool indicating whether redraw is needed.

JumpToIndentBlockEnd()

Jumps to the end of the block.

Declaration
[Command("Navigation.JumpBlockEnd")]
[KeysBinding]
public void JumpToIndentBlockEnd()

JumpToIndentBlockStart()

Jumps to the start of the block.

Declaration
[Command("Navigation.JumpBlockStart")]
[KeysBinding]
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 with config.

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(String)

Load file and configuration for it.

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

Name of the file to load.
Returns
Type Description
System.Boolean

True if operation succeeds.

LoadStream(Stream)

Loads the stream in EditControl.

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

Name of the file 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

Name of the file to load.
IConfigLanguage lang

Config language.
Returns
Type Description
System.Boolean

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

LoadStream(Stream, IConfigLanguage, Encoding)

Helps to loads stream and configuration for it.

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

Name of the file to load.
IConfigLanguage lang

Config language.
System.Text.Encoding encoding

Encoding to use.
Returns
Type Description
System.Boolean

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

LockCollapseRegionMarkerUpdate()

Makes OnPaint to Render SaveMarker on CollapsedRegion

Declaration
protected void LockCollapseRegionMarkerUpdate()

LockPaint()

Makes OnPaint to draw a bitmap image of the control.

Declaration
protected void LockPaint()

LockSelection()

Locks text selection selection.

Declaration
protected void LockSelection()

LockUpdate()

Locks control drawing.

Declaration
protected void LockUpdate()

MarkAsReadOnly(CoordinatePoint, CoordinatePoint, Color, Color)

Set 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.

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.

MarkSearchResult(FindResult, Boolean)

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

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

Find result that must be marked.
System.Boolean bSearchUp

Indicates whether search process was being performed bottom-up. Used for proper cursor positioning if empty string was found.

MenuHandlerOpen(Object, EventArgs)

Handles File->Open context menu item.

Declaration
protected virtual void MenuHandlerOpen(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender

Sender.
System.EventArgs e

EventArgs.

MenuHandlerSave(Object, EventArgs)

Handles File->Save context menu item.

Declaration
protected virtual void MenuHandlerSave(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender

Sender.
System.EventArgs e

EventArgs.

MenuHandlerSaveAs(Object, EventArgs)

Handles File->SaveAs context menu item.

Declaration
protected virtual void MenuHandlerSaveAs(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender

Sender.
System.EventArgs e

EventArgs.

MirrorGraphicsPath(ref GraphicsPath, Int32)

Flips the GraphicsPath against X axis.

Declaration
protected void MirrorGraphicsPath(ref GraphicsPath path, int width)
Parameters
Type Name Description
System.Drawing.Drawing2D.GraphicsPath path

The GraphicsPath to transform
System.Int32 width

Width of the area to be transformed
Remarks

This will flip the GraphicsPath againts the X axis. Use ShiftGraphicsPath to relocate the GraphicsPath

MouseOverSelection()

Indicates whether mouse pointer is situated over selected text.

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

True if mouse pointer is situated over selected text; otherwise false.

MoveDown()

Moves cursor down if possible.

Declaration
[KeysBinding]
[Command("Navigation.MoveDown")]
[KeysBinding]
[KeysBinding]
public virtual void MoveDown()

MoveLeft()

Moves cursor left, if possible.

Declaration
[Command("Navigation.MoveLeft")]
[KeysBinding]
[KeysBinding]
[KeysBinding]
public virtual void MoveLeft()

MoveLeftWord()

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

Declaration
[KeysBinding]
[Command("Navigation.MoveLeftWord")]
[KeysBinding]
public virtual void MoveLeftWord()

MovePageDown()

Moves caret one page down in EditControl.

Declaration
[KeysBinding]
[Command("Navigation.MovePageDown")]
[KeysBinding]
public virtual void MovePageDown()

MovePageUp()

Moves caret one page up in EditControl.

Declaration
[KeysBinding]
[Command("Navigation.MovePageUp")]
[KeysBinding]
public virtual void MovePageUp()

MoveRight()

Moves cursor right if possible.

Declaration
[Command("Navigation.MoveRight")]
[KeysBinding]
[KeysBinding]
[KeysBinding]
public virtual void MoveRight()

MoveRightWord()

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

Declaration
[KeysBinding]
[KeysBinding]
[Command("Navigation.MoveRightWord")]
public virtual void MoveRightWord()

MoveToBeginning()

Moves caret to the beginning of the file in EditControl.

Declaration
[Command("Navigation.DocumentStart")]
[KeysBinding]
[KeysBinding]
public virtual void MoveToBeginning()

MoveToEnd()

Moves caret to the end of file in EditControl.

Declaration
[KeysBinding]
[Command("Navigation.DocumentEnd")]
[KeysBinding]
public virtual void MoveToEnd()

MoveToLineEnd()

Moves caret to the end of line in EditControl.

Declaration
[Command("Navigation.MoveToLineEnd")]
[KeysBinding]
[KeysBinding]
public virtual void MoveToLineEnd()

MoveToLineStart()

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

Declaration
[KeysBinding]
[KeysBinding]
[Command("Navigation.MoveToLineStart")]
public virtual void MoveToLineStart()

MoveUp()

Move cursor up, if possible.

Declaration
[KeysBinding]
[Command("Navigation.MoveUp")]
[KeysBinding]
[KeysBinding]
public virtual void MoveUp()

New()

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

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

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

Config language.
Returns
Type Description
System.Boolean

True if operation succeeds.

OnBackColorChanged(EventArgs)

Updates background brush.

Declaration
protected override void OnBackColorChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.

OnClick(EventArgs)

Processes mouse clicks.

Declaration
protected override void OnClick(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.

OnConfigurationChanged()

Executes some actions after changing configuration.

Declaration
protected virtual void OnConfigurationChanged()

OnDisableScrollersChanged()

Processes changes of the DisableScrollers property value.

Declaration
protected void OnDisableScrollersChanged()

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.

OnDragLeave(EventArgs)

Sets m_rectDragOverPosition to empty rectangle.

Declaration
protected override void OnDragLeave(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.

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.

OnFakeControlBinded(FakeEditControl)

Puts newly-binded fake edit control to the list and disables word wrapping.

Declaration
protected void OnFakeControlBinded(FakeEditControl control)
Parameters
Type Name Description
FakeEditControl control

Fake edit control, binded to this control.

OnFakeControlUnbinded(FakeEditControl)

Removes binded fake edit control from the list.

Declaration
protected void OnFakeControlUnbinded(FakeEditControl control)
Parameters
Type Name Description
FakeEditControl control

OnGotFocus(EventArgs)

Raised when control gets input focus.

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.
Overrides

OnHScroll(Object, ScrollEventArgs)

Processes horizontal scroll event.

Declaration
protected override void OnHScroll(object sender, ScrollEventArgs se)
Parameters
Type Name Description
System.Object sender

Sender.
System.Windows.Forms.ScrollEventArgs se

ScrollEventArgs.
Overrides

OnInsertModeChanged()

Called when Insert Mode changed.

Declaration
protected virtual void OnInsertModeChanged()

OnKeyDown(KeyEventArgs)

Raised when user pushes down some key. All key-presses should be processed by KeyBinder.

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

KeyEventArgs.

OnKeyPress(KeyPressEventArgs)

Raised when user presses some key.

Declaration
protected override void OnKeyPress(KeyPressEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyPressEventArgs e

System.Windows.Forms.KeyPressEventArgs instance with information about key-press.

OnKeyUp(KeyEventArgs)

Raised when some pressed key was released.

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

KeyEventArgs.

OnLanguageChanged()

Executes some actions after changing configuration language.

Declaration
protected virtual void OnLanguageChanged()

OnLayout(LayoutEventArgs)

Updates line wrapping info.

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

LayoutEventArgs.

OnLostFocus(EventArgs)

Raised when control loses input focus.

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.
Overrides

OnMouseClick(MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseClick event.

Declaration
protected override void OnMouseClick(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

MouseEventArgs

OnMouseDown(MouseEventArgs)

Called when mouse button is pressed.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

MouseEventArgs.
Overrides

OnMouseEnter(EventArgs)

Changes cursor to IBeam.

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.

OnMouseMove(MouseEventArgs)

Raised when mouse is moved over the control.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

System.Windows.Forms.MouseEventArgs with information about mouse movement.
Overrides

OnMouseUp(MouseEventArgs)

Raised when mouse button is released.

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

System.Windows.Forms.MouseEventArgs with information about mouse.
Overrides

OnPaint(PaintEventArgs)

Paints foreground of the control

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

PaintEventArgs.
Overrides

OnPrintFooter(Graphics, Rectangle)

Raises PrintFooter event.

Declaration
protected virtual int OnPrintFooter(Graphics g, Rectangle bounds)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics.
System.Drawing.Rectangle bounds

Bounds of footer.
Returns
Type Description
System.Int32

Height of footer.

OnPrintHeader(Graphics, Rectangle)

Raises PrintHeader event.

Declaration
protected virtual int OnPrintHeader(Graphics g, Rectangle bounds)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics.
System.Drawing.Rectangle bounds

Bounds of header.
Returns
Type Description
System.Int32

Height of header.

OnRightToLeftChanged(EventArgs)

Overrides the OnRightToLeftChanged event

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnSelectionChanged()

Raises SelectionChanged event.

Declaration
protected virtual void OnSelectionChanged()

OnSingeLineChanged()

Raises SingleLineChanged event and updates form size if needed.

Declaration
protected virtual void OnSingeLineChanged()

OnSizeChanged(EventArgs)

Performs size changing-related operations.

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.
Overrides

OnSystemColorsChanged(EventArgs)

Called when system colors changed.

Declaration
protected override void OnSystemColorsChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.

OnUnprocessedKeyPress(Keys)

Handler of the UnprocessedKey event of the KeyCommandBinder.

Declaration
protected virtual void OnUnprocessedKeyPress(Keys key)
Parameters
Type Name Description
System.Windows.Forms.Keys key

Key, that was pressed.

OnVScroll(Object, ScrollEventArgs)

Processes vertical scroll event.

Declaration
protected override void OnVScroll(object sender, ScrollEventArgs se)
Parameters
Type Name Description
System.Object sender

Sender.
System.Windows.Forms.ScrollEventArgs se

ScrollEventArgs.
Overrides

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.

Paste()

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

Declaration
[KeysBinding]
[Command("Clipboard.Paste")]
[KeysBinding]
public virtual void Paste()

PasteData(IDataObject)

Inserts data from data object if it contains any supported format.

Declaration
protected void PasteData(IDataObject data)
Parameters
Type Name Description
System.Windows.Forms.IDataObject data

Object, that keeps data in different formats.

PointBelongsToSelection(Point)

Checks, whether given client coordinates belong to the selected area.

Declaration
protected bool PointBelongsToSelection(Point mousePoint)
Parameters
Type Name Description
System.Drawing.Point mousePoint

Point in client coordinates.
Returns
Type Description
System.Boolean

True, if there is some area selected and given coordinates belong to the selection, otherwise - false.

PointBelongToIndicatorMargin(Point)

Checks whether point belongs to the indicator margin.

Declaration
protected bool PointBelongToIndicatorMargin(Point point)
Parameters
Type Name Description
System.Drawing.Point point

Point (in client coordinates) to be checked.
Returns
Type Description
System.Boolean

True if the selection margin is visible and point belongs to it, otherwise false.

PointBelongToSelectionArea(Point)

Checks whether point belongs to the selection margin.

Declaration
protected bool PointBelongToSelectionArea(Point point)
Parameters
Type Name Description
System.Drawing.Point point

Point (in client coordinates) to be checked.
Returns
Type Description
System.Boolean

True if point belongs to client coordinates.

PointBelongToTextArea(Point)

Checks whether the specified point belongs to the text area.

Declaration
protected bool PointBelongToTextArea(Point point)
Parameters
Type Name Description
System.Drawing.Point point

The point in the client coordinates.
Returns
Type Description
System.Boolean

True is the point belong the text area, otherwise false.

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
[Command("Printing.Print")]
[KeysBinding]
public void Print()

PrintCurrentPage()

Prints current page on default printer.

Declaration
[Command("Printing.PrintCurrentPage")]
public void PrintCurrentPage()

PrintNoDialog()

Prints the entire document on default printer.

Declaration
[Command("Printing.PrintNoDialog")]
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
[Command("Printing.PrintPreview")]
public void PrintPreview()

PrintSelection()

Prints selected area on default printer.

Declaration
[Command("Printing.PrintSelected")]
public void PrintSelection()

ProcessClickOnLineCollapse(ILexemLine)

Processes click on collapse rectangle of some line.

Declaration
protected virtual void ProcessClickOnLineCollapse(ILexemLine line)
Parameters
Type Name Description
ILexemLine line

Clicked line.

ProcessCollapsing(IList, Boolean)

Collapses and expands specified regions in specified line.

Declaration
protected bool ProcessCollapsing(IList toCollapse, bool bCollapse)
Parameters
Type Name Description
System.Collections.IList toCollapse

List of CollapsableRegion to be collapsed.
System.Boolean bCollapse

If true, regions will be collapsed, otherwise - uncollapsed.
Returns
Type Description
System.Boolean

Bool indicating whether changes were not cancelled by user.

ProcessIntellisenseKey(KeyPressEventArgs)

Processes keypress of the intellisense keys.

Declaration
protected void ProcessIntellisenseKey(KeyPressEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyPressEventArgs e

KeyPressEventArgs.

ProcessOperationEnd(ILongOperation)

Handler of OperationStopped event of parser.

Declaration
protected void ProcessOperationEnd(ILongOperation operation)
Parameters
Type Name Description
ILongOperation operation

Operation.

ProcessOperationStart(ILongOperation)

Handler of OperationStarted event of parser.

Declaration
protected void ProcessOperationStart(ILongOperation operation)
Parameters
Type Name Description
ILongOperation operation

Operation.

RaiseChangingStreamEvent()

Raises ChangingStream event.

Declaration
protected virtual bool RaiseChangingStreamEvent()
Returns
Type
System.Boolean

RaiseConfigurationChangedEvent()

Raises ConfigurationChanged event.

Declaration
protected void RaiseConfigurationChangedEvent()

RaiseCursorPositionChangedEvent()

Raises CursorPositionChanged event

Declaration
protected void RaiseCursorPositionChangedEvent()

RaiseInsertModeChangedEvent()

Raises InsertModeChanged event

Declaration
protected void RaiseInsertModeChangedEvent()

RaiseLanguageChangedEvent()

Raises LanguageChanged event.

Declaration
protected void RaiseLanguageChangedEvent()

RaisePaintUserMarginEvent(Graphics, Rectangle)

Raises PaintUserMargin event.

Declaration
protected void RaisePaintUserMarginEvent(Graphics g, Rectangle clip)
Parameters
Type Name Description
System.Drawing.Graphics g
System.Drawing.Rectangle clip

RaiseReadOnlyChangedEvent()

Raises ReadOnlyChanged event.

Declaration
protected void RaiseReadOnlyChangedEvent()

RaiseUpdateChangedStateEvent()

Raises CanUndoRedoChanged event.

Declaration
protected void RaiseUpdateChangedStateEvent()

RecalculateSpaces(Int32)

Recalculates space, needed for drawing line index.

Declaration
protected void RecalculateSpaces(int lineCount)
Parameters
Type Name Description
System.Int32 lineCount

Line count.

RectangleToRTL(RectangleF)

RectangleToRTL method returns result

Declaration
protected RectangleF RectangleToRTL(RectangleF rect)
Parameters
Type Name Description
System.Drawing.RectangleF rect
Returns
Type
System.Drawing.RectangleF

Redo()

Undoes last operation.

Declaration
[KeysBinding]
[Command("Edit.Redo")]
public virtual void Redo()

Refresh()

Refreshes screen, frees up memory, deletes a lot of parsepoints.

Declaration
[KeysBinding]
[Command("Edit.Refresh")]
public override void Refresh()

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

Registers line backcolor format.

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

Line background color.
System.Drawing.Color colorForeGround
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.

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.

RegisterDefaultKeyBindings()

Registers default commands.

Declaration
public void RegisterDefaultKeyBindings()

RegisterKeyCommands()

Registers default commands.

Declaration
public void RegisterKeyCommands()

RegisterUnderlineFormat(Color, UnderlineStyle, UnderlineWeight)

Register 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.

RemeasureLinesWrapping()

Updates line widths in word-wrap mode.

Declaration
public void RemeasureLinesWrapping()

RemoveGuidingTabs(Int32, Int32)

Removes guiding tabs at the beginning of lines in the specified range.

Declaration
protected void RemoveGuidingTabs(int iBeginLine, int iEndLine)
Parameters
Type Name Description
System.Int32 iBeginLine

Index of first line to remove guiding tab from.
System.Int32 iEndLine

Index of last line to remove guiding tab from.

RemoveLineBackColor(Int32)

Removes line back color.

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

Line number.

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.

RemoveSelectionBackColor()

Removes background coloring from the selected text.

Declaration
public void RemoveSelectionBackColor()

RemoveTabsFromSelection()

Removes leading tab symbol (or it's spaces equivalent) from selected lines.

Declaration
[Command("Edit.RemoveLeadingTab")]
[KeysBinding]
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.

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.

RemoveWaveLines()

Removes wave underlining from selection.

Declaration
[Command("View.RemoveWaveline")]
[KeysBinding]
public void RemoveWaveLines()

ReplaceDialog()

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

Declaration
[KeysBinding]
[Command("Edit.Replace")]
public virtual void ReplaceDialog()

ReplaceLexemsInRegion(IParsePoint, IParsePoint, FormatType, LexemReplaceEventHandler)

Replaces text of all lexems of the specified type in the specified region.

Declaration
protected void ReplaceLexemsInRegion(IParsePoint start, IParsePoint end, FormatType filterType, LexemReplaceEventHandler replacer)
Parameters
Type Name Description
IParsePoint start

Start position of the region.
IParsePoint end

End position of the region.
FormatType filterType

Type of the lexems to process.
LexemReplaceEventHandler replacer

Event handler used for lexem text replacement.

ReplaceLexemsInSelection(FormatType, LexemReplaceEventHandler)

Replaces text of all lexems of the specified type in selection.

Declaration
protected void ReplaceLexemsInSelection(FormatType filterType, LexemReplaceEventHandler replacer)
Parameters
Type Name Description
FormatType filterType

Type of the lexems to process.
LexemReplaceEventHandler replacer

Event handler used for lexem text replacement.

ReplaceNewLineKey(String)

Checks weather given string is equal to "\r" and if it is equal and control is not in single line mode and AutoIndent is enabled, than it will be replaced with indentation spaces.

Declaration
protected string ReplaceNewLineKey(string str)
Parameters
Type Name Description
System.String str

String to change to indentation spaces.
Returns
Type Description
System.String

Resulting string.

ResetColoring(IConfigLanguage)

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

Declaration
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
[Command("Edit.ResetSelection")]
[KeysBinding]
public virtual void ResetSelection()

ResetUndoInfo()

Resets undo information.

Declaration
public void ResetUndoInfo()

RestoreViewInfo(StreamEditControl.SavedViewInfo)

Restores view info.

Declaration
protected void RestoreViewInfo(StreamEditControl.SavedViewInfo info)
Parameters
Type Name Description
StreamEditControl.SavedViewInfo info

Structure with saved info.

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.

SaveCurrentViewInfo()

Saves current information about selection and top-visible line.

Declaration
protected StreamEditControl.SavedViewInfo SaveCurrentViewInfo()
Returns
Type Description
StreamEditControl.SavedViewInfo

Saved info.

SaveToStream()

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

Declaration
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.

SaveToStream(Stream, Encoding, String)

Saves data from current stream to the specified one.

Declaration
public bool SaveToStream(Stream stream, Encoding encoding, string newLineString)
Parameters
Type Name Description
System.IO.Stream stream

Output stream.
System.Text.Encoding encoding

Encoding to use when saving to stream.
System.String newLineString

String representing line end style used when saving to stream.
Returns
Type Description
System.Boolean

Bool indicating whether saving succeeded.

ScrollLines(HybridScrollControl.ScrollDirection, Single)

Scrolls control vertically by specified amount of lines.

Declaration
protected override void ScrollLines(HybridScrollControl.ScrollDirection direction, float fLinesCount)
Parameters
Type Name Description
HybridScrollControl.ScrollDirection direction

Direction of scrolling.
System.Single fLinesCount

Count of lines to scroll.
Overrides

ScrollToCaret()

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

Declaration
public virtual void ScrollToCaret()

SelectAll()

Selects all text.

Declaration
[Command("Edit.SelectAll")]
[KeysBinding]
public virtual void SelectAll()

SelectionCancel()

Removes selection and causes invalidation of the previously selected area.

Declaration
public virtual void SelectionCancel()

SerializeCollapse()

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

Declaration
public void SerializeCollapse()

SetBackgroundColor(CoordinatePoint, CoordinatePoint, Color)

Set color of text background.

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.

SetCursorToClientPoint(Int32, Int32)

Sets caret to given (x, y) position. Position is in coordinates of client area.

Declaration
protected virtual void SetCursorToClientPoint(int x, int y)
Parameters
Type Name Description
System.Int32 x

X coordinate
System.Int32 y

Y coordinate

SetCursorToPoint(Int32, Int32)

Sets caret to given (x, y) position. Position is in coordinates of entire control area.

Declaration
protected virtual void SetCursorToPoint(int x, int y)
Parameters
Type Name Description
System.Int32 x

X coordinate
System.Int32 y

Y coordinate

SetLineBackColor(Int32, Boolean, IBackgroundFormat)

Sets 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.

SetPageBorder(FrameBorderStyle, Color, BorderWeight)

Sets parameters of border that's 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.

SetRangeBackcolor(CoordinatePoint, CoordinatePoint, ISnippetFormat)

Adds background formatting for the range and invalidates control.

Declaration
protected void SetRangeBackcolor(CoordinatePoint start, CoordinatePoint end, ISnippetFormat format)
Parameters
Type Name Description
CoordinatePoint start

Start point of the range.
CoordinatePoint end

End point of the range.
ISnippetFormat format

Format of the range.

SetSelection(Int32, Int32, Int32, Int32)

Sets 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 background format for the selected area.

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

Formatting to be set.

SetSelectionBackColor(Color)

Sets color of selected text background.

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

Color to set.

SetSelectionBorder(Color, FrameBorderStyle, BorderWeight)

Sets border to selected text.

Declaration
public void SetSelectionBorder(Color color, FrameBorderStyle style, BorderWeight weight)
Parameters
Type Name Description
System.Drawing.Color color

Color of border.
FrameBorderStyle style

Style of border.
BorderWeight weight

Weight of border line.

SetSelectionEnd(CoordinatePoint)

Sets end of the selection.

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

ParsePoint of end of selection.
Remarks

Note: Selection must be already present.

Old selection will be simply removed.

SetSelectionRanges(IList)

Sets complex selection ranges.

Declaration
public void SetSelectionRanges(IList ranges)
Parameters
Type Name Description
System.Collections.IList ranges

Collection of ranges.

SetSelectionReadOnly()

Sets selection to readonly with default color settings.

Declaration
public void SetSelectionReadOnly()

SetSelectionStart(CoordinatePoint)

Removes 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 point)
Parameters
Type Name Description
CoordinatePoint point

ParsePoint 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.

SetSelectionStrikeout(Color)

Strikeout selected text.

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

Color of strikeout line.

SetSelectionTextColor(Color)

Sets color of selected text.

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

Color to set.

SetSelectionUnderline(Color, FrameBorderStyle, BorderWeight)

Sets underline to selection.

Declaration
public void SetSelectionUnderline(Color color, FrameBorderStyle style, BorderWeight weight)
Parameters
Type Name Description
System.Drawing.Color color

Color of underline.
FrameBorderStyle style

Style of underline.
BorderWeight weight

Weight of underline.

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

Sets border around text.

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.

SetTextColor(CoordinatePoint, CoordinatePoint, Color)

Set 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.

SetTextStrikeOut(CoordinatePoint, CoordinatePoint, Color)

Strikes out text.

Declaration
public void SetTextStrikeOut(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. If you set it to Color.Empty, strikeout will be removed.

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.

SetWaveLines()

Underlines selection with wave line.

Declaration
[Command("View.SetWaveline")]
[KeysBinding]
public void SetWaveLines()

ShiftGraphicsPath(ref GraphicsPath, Single, Single)

Moves the Graphics path by the specified amount.

Declaration
protected Matrix ShiftGraphicsPath(ref GraphicsPath path, float OffsetX, float OffsetY)
Parameters
Type Name Description
System.Drawing.Drawing2D.GraphicsPath path

The GraphicsPath to shift
System.Single OffsetX

Offset for the X axis
System.Single OffsetY

Offset for the Y axis
Returns
Type
System.Drawing.Drawing2D.Matrix

ShowCaret()

Shows the cursor caret.

Declaration
public void ShowCaret()

ShowCodeSnippets()

Shows the code snippets choice list.

Declaration
[Command("Editor.CodeSnippets")]
[KeysBinding]
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
[KeysBinding]
[Command("Editor.ContextChoice")]
public virtual void ShowContextChoice()

ShowContextPrompt()

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

Declaration
[Command("Editor.ContextPrompt")]
[KeysBinding]
public virtual void ShowContextPrompt()

ShowIndentGuideline()

If possible, shows indent Guideline of the current region.

Declaration
[KeysBinding]
[Command("View.ShowIndentationGuideline")]
public void ShowIndentGuideline()

SmartGetCurrentText()

If there is some text selected, then check whether it matches (\w|\s|\d)+ mask, or if there is no selected text, then just get current lexem.

Declaration
protected string SmartGetCurrentText()
Returns
Type Description
System.String

String.

StartOperation(String)

Starts new operation.

Declaration
public ILongOperation StartOperation(string name)
Parameters
Type Name Description
System.String name

Name of the operation.
Returns
Type Description
ILongOperation

Operation.

StartSelection()

Specifies start position for selecting text.

Declaration
public virtual void StartSelection()

StartSelection(Int32, Int32)

Sets 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
[Command("Edit.StopSelection")]
public virtual void StopSelection()

StopSelection(Int32, Int32)

Sets 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.

StrikeOutSelectedText()

Strikes out selection.

Declaration
[Command("View.StrikeOutSelection")]
[KeysBinding]
public void StrikeOutSelectedText()

SwitchCollapsingOff()

Turns off collapsing the region functionality in EditControl.

Declaration
[Command("Edit.Collapsing.Off")]
[KeysBinding]
public virtual void SwitchCollapsingOff()

SwitchCollapsingOn()

Turns on collapsing the region functionality in .

Declaration
[Command("Edit.Collapsing.On")]
[KeysBinding]
public virtual void SwitchCollapsingOn()

TabifySelection()

Changes spaces sequences to tabs.

Declaration
[Command("Edit.TabifySelection")]
[KeysBinding]
public void TabifySelection()

TestProc()

Proceeds with some tests.

Declaration
[KeysBinding]
[Command("General.Test")]
public void TestProc()

ToggleInsertMode()

Changes insert mode.

Declaration
[Command("Edit.ToggleInsertMode")]
[KeysBinding]
public virtual void ToggleInsertMode()

ToggleLineCollapsing()

Toggles collapsing for current line.

Declaration
[Command("Edit.Collapsing.Toggle")]
[KeysBinding]
public virtual void ToggleLineCollapsing()

ToggleShowingWhiteSpaces()

Toggles showing of whitespaces.

Declaration
[KeysBinding]
[Command("View.ShowWhiteSpaces")]
public virtual void ToggleShowingWhiteSpaces()

TryToCompleteWord()

Tries to complete word.

Declaration
protected void TryToCompleteWord()

UnCommentLine(Int32)

Uncomments single line.

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

Index of line to uncomment.

UncommentText(CoordinatePoint, CoordinatePoint)

Uncomments text (if possible) in the specified range.

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

Beginning of range.
CoordinatePoint p2

End of rage.

Undo()

Undoes last operation.

Declaration
[Command("Edit.Undo")]
[KeysBinding]
public virtual 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()

UnLockCollapseRegionMarkerUpdate()

Makes OnPaint to update SaveMarker on CollapsedRegion

Declaration
protected void UnLockCollapseRegionMarkerUpdate()

UnlockPaint()

Restores normal work of OnPaint.

Declaration
protected void UnlockPaint()

UnlockSelection()

Unlocks text selection.

Declaration
protected void UnlockSelection()

UnlockUpdate()

Unlocks control drawing.

Declaration
protected void UnlockUpdate()

UntabifySelection()

Changes tabs sequences to spaces.

Declaration
[Command("Edit.UntabifySelection")]
[KeysBinding]
public void UntabifySelection()

UpdateContextChoice()

Updates auto-complete dialog.

Declaration
protected void UpdateContextChoice()

UpdateContextPrompt()

Updates context prompt.

Declaration
protected void UpdateContextPrompt()

UpdateIndentation()

Unindents last lexem of block if needed.

Declaration
protected void UpdateIndentation()

UpdateIndentationGuideLineEnd()

Updates information regarding ending of the indentation guideline.

Declaration
protected void UpdateIndentationGuideLineEnd()

UpdateLastCursorPosition()

Sets last cursor X position to the current one.

Declaration
protected void UpdateLastCursorPosition()

UpdateMeasuringInfo()

Drops measuring info for lines, if it is incorrect according to the current maxwidth.

Declaration
protected void UpdateMeasuringInfo()

UpdateScrollBarsSize()

Updates scrollbar sizes.

Declaration
protected override void UpdateScrollBarsSize()
Overrides

UpdateScrollBarsVisibility()

Updates visibility of the ScrollBars.

Declaration
protected override void UpdateScrollBarsVisibility()
Overrides

UpdateScrollerOffsets(IntelliScrollableControl)

Updates offsets of the scrollable area.

Declaration
protected void UpdateScrollerOffsets(IntelliScrollableControl control)
Parameters
Type Name Description
IntelliScrollableControl control

IntelliScrollableControl.

UpdateScrollerVerticalSize()

Updates vertical scroller size.

Declaration
protected void UpdateScrollerVerticalSize()

UpdateScrollerVerticalSize(IntelliScrollableControl, Boolean)

Updates vertical scroller size.

Declaration
protected void UpdateScrollerVerticalSize(IntelliScrollableControl control, bool bUpdateCursor)
Parameters
Type Name Description
IntelliScrollableControl control
System.Boolean bUpdateCursor

If true, cursor and it's position will be updated.

UpdateScrollInfo()

Updates scrollbars positions to ensure that caret is visible.

Declaration
protected virtual void UpdateScrollInfo()

WndProc(ref Message)

Windows Messages Handler.

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

Message.
Overrides

Events

CanUndoRedoChanged

Occurs when CanUndoRedo state has changed.

Declaration
public event EventHandler CanUndoRedoChanged
Event Type
Type
System.EventHandler

ChangingStream

Occurs when underlying stream of the control is about to change

Declaration
public virtual event ChangingStreamEventHandler ChangingStream
Event Type
Type
ChangingStreamEventHandler

CollapsedAll

Raised when CollapseAll method was called.

Declaration
public event EventHandler CollapsedAll
Event Type
Type
System.EventHandler

CollapsingAll

Raised when CollapsingAll method is called.

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

ConfigurationChanged

Occurs after configuration has changed.

Declaration
public event EventHandler ConfigurationChanged
Event Type
Type
System.EventHandler

ContextChoiceSelectedTextInsert

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

Declaration
public event ContextChoiceTextInsertEventHandler ContextChoiceSelectedTextInsert
Event Type
Type
ContextChoiceTextInsertEventHandler

ContextPromptBeforeOpen

Occurs before context prompt dialog should be shown to user.

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

ContextPromptClose

Occurs when context prompt window has been closed.

Declaration
public event ContextPromptCloseEventHandler ContextPromptClose
Event Type
Type
ContextPromptCloseEventHandler

ContextPromptOpen

Occurs when context prompt dialog has been opened.

Declaration
public event ContextPromptUpdateEventHandler ContextPromptOpen
Event Type
Type
ContextPromptUpdateEventHandler

ContextPromptSelectionChanged

Occurs when context prompt item has been selected.

Declaration
public event ContextPromptSelectionChangedEventHandler ContextPromptSelectionChanged
Event Type
Type
ContextPromptSelectionChangedEventHandler

ContextPromptUpdate

Occurs when the context prompt list has been updated.

Declaration
public event ContextPromptUpdateEventHandler ContextPromptUpdate
Event Type
Type
ContextPromptUpdateEventHandler

CursorPositionChanged

Occurs after the current cursor position has changed.

Declaration
public event EventHandler CursorPositionChanged
Event Type
Type
System.EventHandler

DisableScrollersChanged

Occurs when DisableScrollers property value has changed.

Declaration
public event EventHandler DisableScrollersChanged
Event Type
Type
System.EventHandler

DrawUserMarginText

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

Declaration
public event DrawUserMarginTextEventHandler DrawUserMarginText
Event Type
Type
DrawUserMarginTextEventHandler

EncodingChanged

Occurs after encoding has changed.

Declaration
public event EncodingChangedEventHandler EncodingChanged
Event Type
Type
EncodingChangedEventHandler

ExpandedAll

Raised when ExpandeAll method was called.

Declaration
public event EventHandler ExpandedAll
Event Type
Type
System.EventHandler

ExpandingAll

Raised when ExpandingAll method is called.

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

Find

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

Declaration
public event EventHandler Find
Event Type
Type
System.EventHandler

GetMinimalWidth

Occurs when minimal width of every fake control should be retrieved.

Declaration
public event ChangeValueEventHandler GetMinimalWidth
Event Type
Type
ChangeValueEventHandler

IndicatorMarginClick

Occurs when user clicks on the indicator margin area.

Declaration
public event IndicatorClickEventHandler IndicatorMarginClick
Event Type
Type
IndicatorClickEventHandler

IndicatorMarginDoubleClick

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

Declaration
public event IndicatorClickEventHandler IndicatorMarginDoubleClick
Event Type
Type
IndicatorClickEventHandler

InsertModeChanged

Occurs when the value of the InsertMode property changed.

Declaration
public event EventHandler InsertModeChanged
Event Type
Type
System.EventHandler

LanguageChanged

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

Declaration
public event EventHandler LanguageChanged
Event Type
Type
System.EventHandler

LineChanged

Occurs when line has been changed.

Declaration
public event TextChangedEventHandler LineChanged
Event Type
Type
TextChangedEventHandler

LineDeleted

Occurs when line Deleted in EditControl.

Declaration
public event LineDeletedEventHandler LineDeleted
Event Type
Type
LineDeletedEventHandler

LineInserted

Occurs when line inserted in EditControl.

Declaration
public event LineInsertedEventHandler LineInserted
Event Type
Type
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
System.EventHandler

NewDocCreated

Raised when new document is created within editor.

Declaration
public event EventHandler NewDocCreated
Event Type
Type
System.EventHandler

OnBeforeLineNumberPaint

Occurs before the line number has been drawn.

Declaration
public event OnBeforeLineNumberPaintEventHandler OnBeforeLineNumberPaint
Event Type
Type
OnBeforeLineNumberPaintEventHandler

OperationStarted

Occurs when an operation starts like while collapsing and expanding block of code.

Declaration
public event LongOperationEventHandler OperationStarted
Event Type
Type
LongOperationEventHandler

OperationStopped

Occurs on the end of the long operation.

Declaration
public event LongOperationEventHandler OperationStopped
Event Type
Type
LongOperationEventHandler

OutliningTooltipBeforePopup

Occurs when outlining tooltip is about to be shown.

Declaration
public event OutliningTooltipBeforePopupEventHandler OutliningTooltipBeforePopup
Event Type
Type
OutliningTooltipBeforePopupEventHandler

OutliningTooltipClose

Occurs when outlining tooltip is closed.

Declaration
public event CollapsedRegionRelatedEventHandler OutliningTooltipClose
Event Type
Type
CollapsedRegionRelatedEventHandler

OutliningTooltipPopup

Occurs when outlining tooltip is shown.

Declaration
public event CollapsedRegionRelatedEventHandler OutliningTooltipPopup
Event Type
Type
CollapsedRegionRelatedEventHandler

PaintUserMargin

Occurs when a user margin display line has to be painted.

Declaration
public event PaintEventHandler PaintUserMargin
Event Type
Type
System.Windows.Forms.PaintEventHandler

ParserCreated

Occurs when parser is created.

Declaration
public event EventHandler ParserCreated
Event Type
Type
System.EventHandler

ParserDestroyed

Occurs when parser is destroyed.

Declaration
public event EventHandler ParserDestroyed
Event Type
Type
System.EventHandler

PrintFooter

Occurs when page footer need to be printed.

Declaration
public event PrintHeadlineEventHandler PrintFooter
Event Type
Type
PrintHeadlineEventHandler

PrintHeader

Occurs when page header needs to be printed.

Declaration
public event PrintHeadlineEventHandler PrintHeader
Event Type
Type
PrintHeadlineEventHandler

ReadOnlyChanged

Occurs when ReadOnly mode of EditControl changes.

Declaration
public event EventHandler ReadOnlyChanged
Event Type
Type
System.EventHandler

RegisteringDefaultKeyBindings

Occurs when default key bindings should be added.

Declaration
public event EventHandler RegisteringDefaultKeyBindings
Event Type
Type
System.EventHandler

RegisteringKeyCommands

Occurs when custom key-binding command should be registered.

Declaration
public event EventHandler RegisteringKeyCommands
Event Type
Type
System.EventHandler

SaveStreamWithDataLoss

Occurs when user tries to save stream with data loosing.

Declaration
public event SaveWithDataLosingEventHandler SaveStreamWithDataLoss
Event Type
Type
SaveWithDataLosingEventHandler

SelectionChanged

Occurs after the text selection has changed.

Declaration
public event EventHandler SelectionChanged
Event Type
Type
System.EventHandler

SingleLineChanged

Occurs when SingleLineMode property value has been changed.

Declaration
public event EventHandler SingleLineChanged
Event Type
Type
System.EventHandler

TextChanged

Occurs when text has been changed.

Declaration
public event EventHandler TextChanged
Event Type
Type
System.EventHandler

TextChanging

Occurs when text is about to change.

Declaration
public event TextChangingEventHandler TextChanging
Event Type
Type
TextChangingEventHandler

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
UnreachableTextFoundEventHandler

UpdateBookmarkToolTip

Occurs while updating the bookmark tooltip text.

Declaration
public event UpdateBookmarkTooltipEventHandler UpdateBookmarkToolTip
Event Type
Type
UpdateBookmarkTooltipEventHandler

UpdateContextToolTip

Occurs while updating the context tooltip text.

Declaration
public event UpdateTooltipEventHandler UpdateContextToolTip
Event Type
Type
UpdateTooltipEventHandler

WordWrapChanged

Occurs when WordWrap property value has been changed.

Declaration
public event EventHandler WordWrapChanged
Event Type
Type
System.EventHandler

Implements

System.ComponentModel.ISupportInitialize