Interface IMinimap

Namespace

Alternet.Editor

Assembly

Alternet.Editor.v9.dll

Represents properties and methods specifying the appearance of the minimap in the Edit control.

public interface IMinimap : IUpdate, IDisposable

Properties

AllowDrag

When implemented by a class, indicates whether drag operation can performed to IMinimap.

AllowScroll

When implemented by a class, indicates whether scroll operation can performed to IMinimap.

BackgroundColor

When implemented by a class, gets or sets the color of the minimap background.

BorderColor

When implemented by a class, gets or sets the color of the minimap border.

BoundsRect

When implemented by a class, gets the rectangle that represents minimap area.

CurrentFrameBorderColor

When implemented by a class, 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

When implemented by a class, 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

When implemented by a class, gets the rectangle that represents the current frame area.

DisplayWidth

When implemented by a class, gets the display width of the minimap depending on its state.

DragBorderColor

When implemented by a class, gets or sets the color of the minimap dragged border.

InPaint

When implemented by a class, gets or sets a value indicating whether minimap is being painted.

IsDragging

When implemented by a class, indicates whether IMinimap is in dragging state.

IsScrolling

When implemented by a class, indicates whether IMinimap is in scrolling state.

Options

When implemented by a class, gets or sets a MinimapOptions that determine minimap appearance and behaviour.

Scale

When implemented by a class, gets or sets the scale of the minimap.

Visible

When implemented by a class, gets or sets a value indicating whether minimap area should be painted.

Width

When implemented by a class, gets or sets the width of the minimap. When auto scaling enabled, measured in DIP.

Methods

CancelDragging()

When implemented by a class, cancels dragging the minimap.

CancelScrolling()

When implemented by a class, cancels scrolling the minimap.

Contains(int, int)

When implemented by a class, indicates whether IMinimap area contains given position.

ContainsBorder(int, int)

When implemented by a class, indicates whether left border of IMinimap area contains given position.

DragTo(int, int)

When implemented by a class, moves IMinimap left border to specified position.

GetDisplayPoint(int)

When implemented by a class, gets a display position at minimap y-position

GetHint(int, int)

When implemented by a class, gets a text under the cursor to be displayed in the hint

OnClick(Point)

When implemented by a class, handles IMinimap click.

Paint(Rectangle)

When implemented by a class, draws minimap on the specified graphic surface.

ScrollTo(int, int)

When implemented by a class, scrolls IMinimap to specified position.