Table of Contents

Class Gutter

Namespace
Alternet.Editor
Assembly
Alternet.Editor.v10.dll

Represents gutter at the left side of the Edit control.

public class Gutter : IGutter, IUpdate, IDisposable
Inheritance
Gutter
Implements

Constructors

Gutter()

Initializes a new instance of the Gutter class with default settings.

Gutter(ISyntaxEdit)

Initializes a new instance of the Gutter class with a specified owner.

Properties

AlphaImages

Gets or sets an AlphaImageList object that contains collection of images for gutter.

AlphaImagesHighDpi

Gets or sets an AlphaImageList object that contains collection of images for gutter for high DPI.

BookMarkImageIndex

Gets or sets a value that specifies index of item in the image collection used to paint bookmark.

Brush

Gets or sets a Brush object used to paint gutter.

BrushColor

Gets or sets background color of the gutter.

CodeActionImageIndex

Gets or sets a value that specifies index of item in the image collection used to paint light bulb for code action.

CodeActionPosition

Gets or sets code action position within the text.

DisplayArea

Gets display width of the gutter, including line numbers and outlining area, but not including line modificators if they're painted outside gutter.

DisplayWidth

Gets display width of the gutter, including line numbers and outlining area.

DrawLineBookmarks

Gets or sets a value indicating whether Edit control should draw triangle at bookmark position inside line.

HighlightBlockAreaColor

Gets or sets a background color of the highlighted block area.

HighlightOutlineAreaColor

Gets or sets a background color of the highlighted outline area.

Images

Gets or sets an ImageList object that contains collection of images for gutter.

ImagesHighDpi

Gets or sets an ImageList object that contains collection of images for gutter for high DPI.

ImagesResourceNameSuffix

Gets or sets the image resource name suffix.

LineBookmarksColor

Gets or sets a color of the line bookmarks.

LineModificatorChangedColor

Gets or sets a color of the line modificators(color stitch that indicates that the line content is unmodified, modified or saved) in the modified state.

LineModificatorSavedColor

Gets or sets a color of the line modificators(color stitch that indicates that the line content is unmodified, modified or saved) in the saved state.

LineNumbersAlignment

Gets or sets line numbers alignment information.

LineNumbersBackColor

Gets or sets background color for the line numbers.

LineNumbersForeColor

Gets or sets foreground color for the line numbers.

LineNumbersLeftIndent

Gets or sets line numbers indentation from the left gutter border. When auto scaling enabled, measured in DIP.

LineNumbersLeftIndentInPixels

Gets line numbers indentation from the left gutter border in pixels.

LineNumbersRightIndent

Gets or sets line numbers indentation from the right gutter border. When auto scaling enabled, measured in DIP.

LineNumbersRightIndentInPixels

Gets line numbers indentation from the right gutter border in pixels.

LineNumbersStart

Gets or sets number of the first line being painted on the gutter.

MaxLineNumberLength

Gets or sets maximum count of numbers in the line number.

Options

Gets or sets a GutterOptions that determine gutter appearance and behaviour.

OutlineImageBackColor

Gets or sets an outline image back color.

OutlineRect

Gets the rectangle that represents an outline section area.

OutliningLeftIndent

Gets or sets outlining indentation from the left gutter border. When auto scaling enabled, measured in DIP.

OutliningLeftIndentInPixels

Gets outlining indentation from the left gutter border in pixels.

OutliningRightIndent

Gets or sets outlining indentation from the right gutter border. When auto scaling enabled, measured in DIP.

OutliningRightIndentInPixels

Gets outlining indentation from the right gutter border in pixels.

Pen

Gets or sets a Pen object used to paint gutter line.

PenColor

Gets or sets color of the gutter line.

Rect

Gets the rectangle that represents gutter area.

ShowBookmarkHints

Gets or sets a value indicating whether Edit control should display text describing bookmark in form of tooltip window when mouse pointer is over the gutter bookmark.

Transparent
UpdateCount

Keeps track of calls to BeginUpdate and EndUpdate so that they can be nested.

UserMarginBackColor

Gets or sets background color of the user margin.

UserMarginForeColor

Gets or sets foreground color of the line numbers.

UserMarginRegex
UserMarginText

Gets or sets text of the user margin.

UserMarginWidth

Gets or sets the width of the user margin area. When auto scaling enabled, measured in DIP.

UserMarginWidthInPixels

Gets the width of the user margin area in pixels.

Visible

Gets or sets a value indicating whether the gutter area is visible.

Width

Gets or sets the width of the gutter. When auto scaling enabled, measured in DIP.

WidthInPixels

Gets the width of the gutter in pixels.

WrapImageIndex

Gets or sets a value that specifies index of item in the image collection used to paint special mark indicating the wrapped line.

Methods

Assign(IGutter)

Copies the contents from another IGutter object.

BeginUpdate()

Prevents gutter updating until calling Gutter.EndUpdate method.

CanDrawImage(AlphaImageList, int)
CanDrawImage(AlphaImageList, int, double, double)
CanDrawImage(AlphaImageList, int, int, int)
CanDrawImage(ImageList, int)
CanDrawImage(ImageList, int, int, int)
DisableUpdate()

Prevents gutter updating until calling Gutter.EndUpdate method.

Dispose()

Disposes this Gutter and frees resources associated with it.

Dispose(bool)
DrawLineOnUserMargin(IPainter, int, int, double, double)
DrawLineOnUserMargin(IPainter, int, int, int, int)
EnableUpdate()

Re-enables gutter updating, that was turn of by calling Gutter.BeginUpdate method.

EndUpdate()

Re-enables gutter updating, that was turn of by calling Gutter.BeginUpdate method.

~Gutter()

Destroys the instance of the Gutter class.

GetDisplayScaledImages()
GetDisplayWidth(bool)
GetHitTest(double, double, IHitTestInfo)
GetHitTest(int, int, IHitTestInfo)

Fills hitTestInfo parameter by information about a part of the control at specified coordinate.

GetImage(int)

When implemented by a class, gets image from the images collection

InvalidateLineNumberArea(bool)

Invalidates line number area if it needs to be altered.

Specifies whether line number width needs to be recalculated.
IsMouseOnGutter(double, double, bool)
IsMouseOnGutter(int, int, bool)
IsMouseOnGutterImage(double, double, out int, out int, out int, out bool, out RectD)
IsMouseOnGutterImage(int, int, out int, out int, out int, out bool, out Rectangle)
IsMouseOnLineModificatorArea(double, double)
IsMouseOnLineModificatorArea(int, int)
IsMouseOnLineNumberArea(double, double)
IsMouseOnLineNumberArea(int, int)
IsMouseOnOutlineArea(double, double)
IsMouseOnOutlineArea(int, int)
IsMouseOnOutlineButton(double, double, out IOutlineRange)
IsMouseOnOutlineButton(int, int, out IOutlineRange)

Indicates whether mouse point is within the outline button area.

IsMouseOnOutlineImage(double, double, ref Point)
IsMouseOnOutlineImage(int, int, ref Point)
OnBookMarkImageIndexChanged()
OnBrushChanged()
OnBrushColorChanged()
OnClick(EventArgs)

Raises the Click event.

OnCodeActionImageIndexChanged()
OnCodeActionPositionChanged()
OnDoubleClick(EventArgs)

Raises the DoubleClick event.

OnDrawLineBookmarksChanged()
OnDrawUserMargin(double, double, double, double)
OnDrawUserMargin(int, int, int, int)
OnDrawUserMargin(ref string, int)
OnHighlightBlockAreaColorChanged()
OnHighlightMatchRangeAreaColorChanged()
OnHighlightOutlineAreaColorChanged()
OnImagesChanged()
OnImagesHighDpiChanged()
OnLineBookmarksColorChanged()
OnLineModificatorChangedColorChanged()
OnLineModificatorSavedColorChanged()
OnLineNumbersAlignmentChanged()
OnLineNumbersBackColorChanged()
OnLineNumbersForeColorChanged()
OnLineNumbersLeftIndentChanged()
OnLineNumbersRightIndentChanged()
OnLineNumbersStartChanged()
OnMaxLineNumberLengthChanged()
OnOptionsChanged()
OnOutlineImageBackColorChanged()
OnOutliningLeftIndentChanged()
OnOutliningRightIndentChanged()
OnPenChanged()
OnPenColorChanged()
OnShowBookmarkHintsChanged()
OnUserMarginBackColorChanged()
OnUserMarginForeColorChanged()
OnUserMarginTextChanged()
OnUserMarginWidthChanged()
OnVisibleChanged()
OnWidthChanged()
OnWrapImageIndexChanged()
Paint(IPainter, RectD)
Paint(IPainter, RectD, int)
Paint(IPainter, Rectangle)

Draws gutter on the specified graphic surface.

Paint(IPainter, Rectangle, int)

Draws gutter on the specified graphic surface.

ResetActionImageIndex()

Resets the actionImageIndex to the default value.

ResetBookMarkImageIndex()

Resets the BookMarkImageIndex to the default value.

ResetBrushColor()

Resets the BrushColor to the default value.

ResetDrawLineBookmarks()

Resets the DrawLineBookmarks to the default value.

ResetHighlightBlockAreaColor()

Resets the HighlightBlockAreaColor to the default value.

ResetHighlightOutlineAreaColor()

Resets the HighlightOutlineAreaColor to the default value.

ResetLineBookmarksColor()

Resets the LineBookmarksColor to the default value.

ResetLineModificatorChangedColor()

Resets the LineModificatorChangedColor to the default value.

ResetLineModificatorSavedColor()

Resets the LineModificatorSavedColor to the default value.

ResetLineNumbersAlignment()

Resets the LineNumbersAlignment to the default value.

ResetLineNumbersBackColor()

Resets the LineNumbersBackColor to the default value.

ResetLineNumbersForeColor()

Resets the LineNumbersForeColor to the default value.

ResetLineNumbersLeftIndent()

Resets the LineNumbersLeftIndent to the default value.

ResetLineNumbersRightIndent()

Resets the LineNumbersRightIndent to the default value.

ResetLineNumbersStart()

Resets the LineNumbersStart to the default value.

ResetOptions()

Resets the Options to the default value.

ResetOutlineImageBackColor()

Resets the OutlineImageBackColor to the default value.

ResetOutliningLeftIndent()

Resets the OutliningLeftIndent to the default value.

ResetOutliningRightIndent()

Resets the OutliningRightIndent to the default value.

ResetPenColor()

Resets the PenColor to the default value.

ResetShowBookmarkHints()

Resets the ShowBookmarkHints to the default value.

ResetUserMarginBackColor()

Resets the UserMarginBackColor to the default value.

ResetUserMarginForeColor()

Resets the UserMarginForeColor to the default value.

ResetUserMarginText()

Resets the UserMarginText to the default value.

ResetUserMarginWidth()

Resets the UserMarginWidth to the default value.

ResetVisible()

Resets the Visible to the default value.

ResetWidth()

Resets the Width to the default value.

ResetWrapImageIndex()

Resets the WrapImageIndex to the default value.

ShouldSerializeBookMarkImageIndex()

Indicates whether the BookMarkImageIndex property should be persisted.

ShouldSerializeBrushColor()

Indicates whether the BrushColor property should be persisted.

ShouldSerializeCodeActionImageIndex()

Indicates whether the CodeActionImageIndex property should be persisted.

ShouldSerializeHighlightBlockAreaColor()

Indicates whether the HighlightBlockAreaColor property should be persisted.

ShouldSerializeHighlightOutlineAreaColor()

Indicates whether the HighlightOutlineAreaColor property should be persisted.

ShouldSerializeLineBookmarksColor()

Indicates whether the LineBookmarksColor property should be persisted.

ShouldSerializeLineModificatorChangedColor()

Indicates whether the LineModificatorChangedColor property should be persisted.

ShouldSerializeLineModificatorSavedColor()

Indicates whether the LineModificatorSavedColor property should be persisted.

ShouldSerializeLineNumbersBackColor()

Indicates whether the LineNumbersBackColor property should be persisted.

ShouldSerializeLineNumbersForeColor()

Indicates whether the LineNumbersForeColor property should be persisted.

ShouldSerializeLineNumbersLeftIndent()

Indicates whether the LineNumbersLeftIndent property should be persisted.

ShouldSerializeLineNumbersRightIndent()

Indicates whether the LineNumbersRightIndent property should be persisted.

ShouldSerializeLineNumbersStart()

Indicates whether the LineNumbersStart property should be persisted.

ShouldSerializeOptions()

Indicates whether the Options property should be persisted.

ShouldSerializeOutlineImageBackColor()

Indicates whether the OutlineImageBackColor property should be persisted.

ShouldSerializeOutliningLeftIndent()

Indicates whether the OutliningLeftIndent property should be persisted.

ShouldSerializeOutliningRightIndent()

Indicates whether the OutliningRightIndent property should be persisted.

ShouldSerializePenColor()

Indicates whether the PenColor property should be persisted.

ShouldSerializeUserMarginBackColor()

Indicates whether the UserMarginBackColor property should be persisted.

ShouldSerializeUserMarginForeColor()

Indicates whether the UserMarginForeColor property should be persisted.

ShouldSerializeUserMarginText()

Indicates whether the UserMarginText property should be persisted.

ShouldSerializeUserMarginWidth()

Indicates whether the UserMarginWidth property should be persisted.

ShouldSerializeWidth()

Indicates whether the Width property should be persisted.

ShouldSerializeWrapImageIndex()

Indicates whether the WrapImageIndex property should be persisted.

Update()

Causes the edit control to invalidate it's content.

Update(bool)

Causes the edit control to invalidate it's content.

Events

Click

Occurs when the Gutter clicked.

DoubleClick

Occurs when the Gutter double-clicked.

DrawUserMargin

Occurs when user margin part of each line is drawing.