Table of Contents

Class Minimap

Namespace
Alternet.Editor
Assembly
Alternet.Editor.v9.dll

Represents the minimap at the right side of the Edit control.

public class Minimap : IMinimap, IUpdate, IDisposable
Inheritance
Minimap
Implements

Constructors

Minimap()

Initializes a new instance of the Minimap with default settings.

Minimap(ISyntaxEdit)

Initializes a new instance of the Minimap with specified owner.

Properties

AllowDrag

Indicates whether drag operation can performed to Minimap.

AllowScroll

Indicates whether scroll operation can performed to Minimap.

BackgroundColor

Gets or sets the color of the minimap background.

BorderColor

Gets or sets the color of the minimap border.

BoundsRect

Gets the rectangle that represents minimap area.

CurrentFrameBorderColor

Gets or sets the color of the minimap's current frame border, i.e., the rectangular area corresponding to the currently visible part of the code.

CurrentFrameColor

Gets or sets the color of the minimap's current frame, i.e., the rectangular area corresponding to the currently visible part of the code.

CurrentFrameRect

Gets the rectangle that represents the current frame area.

DisplayWidth

Gets the display width of the minimap depending on its state.

DragBorderColor

Gets or sets the color of the minimap dragged border.

InPaint

Gets a value indicating whether minimap is being painted.

IsDragging

Indicates whether Minimap is in dragging state.

IsScrolling

Indicates whether Minimap is in scrolling state.

Options

Gets or sets a MinimapOptions that determine minimap appearance and behaviour.

Scale

Gets or sets the scale of the minimap.

UpdateCount

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

Visible

Gets or sets a value indicating whether minimap area should be painted.

Width

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

Methods

BeginUpdate()

Prevents Margin updating until calling Minimap.EndUpdate method.

CancelDragging()

Cancels dragging the minimap.

CancelScrolling()

Cancels scrolling the minimap.

Contains(int, int)

Indicates whether Minimap area contains given position.

ContainsBorder(int, int)

Indicates whether left border of Minimap area contains given position.

DisableUpdate()

Prevents Minimap updating until calling Minimap.EndUpdate method.

Dispose()

Disposes this Minimap and frees resources associated with it.

Dispose(bool)
DragTo(int, int)

Moves Minimap left border to specified position.

DrawDragLine(int, int, bool)
EnableUpdate()

Re-enables Minimap updating, that was turn of by calling Minimap.DisableUpdate method.

EndUpdate()

Re-enables page updating, that was turn of by calling Minimap.BeginUpdate method.

~Minimap()

Destroys the instance of the Minimap class.

GetDisplayLine(int)

Gets a line to be displayed at y-position

GetDisplayPoint(int)

Gets a display position at minimap y-position

GetHint(int, int)

Gets a text under the cursor to be displayed in the hint

OnAllowDragChanged()
OnAllowScrollChanged()
OnBackgroundColorChanged()
OnBorderColorChanged()
OnClick(Point)

Handles IMinimap click.

OnCurrentFrameBorderColorChanged()
OnCurrentFrameColorChanged()
OnDragBorderColorChanged()
OnHintBorderColorChanged()
OnIsDragingChanged()
OnIsScrollingChanged()
OnOptionsChanged()
OnScaleChanged()
OnVisibleChanged()
OnWidthChanged()
Paint(Rectangle)

Draws minimap on the specified graphic surface.

ScrollTo(int, int)

Scrolls Minimap to specified position.

ShouldSerializeBackgroundColor()

Indicates whether the BackgroundColor property should be persisted.

ShouldSerializeBorderColor()

Indicates whether the BorderColor property should be persisted.

ShouldSerializeCurrentFrameBorderColor()

Indicates whether the CurrentFrameBorderColor property should be persisted.

ShouldSerializeCurrentFrameColor()

Indicates whether the CurrentFrameColor property should be persisted.

ShouldSerializeDragBorderColor()

Indicates whether the DragBorderColor property should be persisted.

ShouldSerializeOptions()

Indicates whether the Options property should be persisted.

ShouldSerializeScale()

Indicates whether the Scale property should be persisted.

ShouldSerializeVisible()

Indicates whether the Visible property should be persisted.

ShouldSerializeWidth()

Indicates whether the Width property should be persisted.

Update()

Forces editor control to invalidate it's area.