Class Margin

Namespace: Alternet.Editor

Assembly: Alternet.Editor.v9.dll

Represents an appearance of the margin in Edit control.

public class Margin : IMargin, IUpdate, IDisposable

Inheritance: object

Margin

Implements: IMargin

IUpdate

IDisposable

Constructors

Margin(): Initializes a new instance of the Margin with default settings.

Margin(ISyntaxEdit): Initializes a new instance of the Margin with specified owner.

Properties

AllowDrag: Indicates whether drag operation can performed to Margin.

ColumnPen: Gets or sets Pen object that describes the color and pattern of Margin line.

ColumnPenColor: Gets or sets a color of the column margin line.

ColumnPositions: Gets or sets the character columns where additional column margin will be drawn.

ColumnsVisible: Gets or sets a value indicating whether column margins should be painted.

IsDragging: Indicates whether Margin is in dragging state.

Pen: Gets or sets Pen object that describes the color and pattern of Margin line.

PenColor: Gets or sets a color of the margin line.

Position: Gets or sets value indicating position, in characters, of the vertical line within the text portion of the control.

ShowHints: Gets or sets a value indicating whether Margin should display some hint when mouse pointer is over the margin area.

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

Visible: Gets or sets a value indicating whether vertical line should be painted.

Methods

Assign(IMargin): Copies the contents from another IMargin object.

BeginUpdate(): Prevents Margin updating until calling Margin.EndUpdate method.

CancelDragging(): Cancels dragging the margin.

Contains(int, int): Indicates whether Margin area contains given position.

DisableUpdate(): Prevents Margin updating until calling Margin.EndUpdate method.

Dispose(): Disposes this Margin and frees resources associated with it.

Dispose(bool)

DragTo(int, int): Moves Margin to specified position.

DrawLine(int, int, bool)

EnableUpdate(): Re-enables Margin updating, that was turn of by calling Margin.BeginUpdate method.

EndUpdate(): Re-enables page updating, that was turn of by calling Margin.BeginUpdate method.

~Margin(): Destroys the instance of the Margin class.

GetColumnPosition(int)

OnAllowDrawChanged()

OnColumnPenChanged()

OnColumnPenColorChanged()

OnColumnPositionsChanged()

OnColumnsVisibleChanged()

OnIsDragingChanged()

OnPenChanged()

OnPenColorChanged()

OnPositionChanged()

OnShowHintsChanged()

OnVisibleChanged()

Paint(IPainter, Rectangle): Draws Margin object on the specified graphic surface.

PaintColumn(IPainter, Rectangle): Draws margin column on the specified graphic surface.

ResetAllowDrag(): Resets the AllowDrag to the default value.

ResetColumnPositions(): Resets the Position to the default value.

ResetColumnsPenColor(): Resets the ColumnPenColor to the default value.

ResetColumnsVisible(): Resets the ColumnsVisible to the default value.

ResetPenColor(): Resets the PenColor to the default value.

ResetPosition(): Resets the Position to the default value.

ResetShowHints(): Resets the ShowHints to the default value.

ResetVisible(): Resets the Visible to the default value.

ShouldSerializeColumnPenColor(): Indicates whether the ColumnPenColor property should be persisted.

ShouldSerializeColumnPositions(): Indicates whether the ColumnPositions property should be persisted.

ShouldSerializePenColor(): Indicates whether the PenColor property should be persisted.

ShouldSerializePosition(): Indicates whether the Position property should be persisted.

Update(): Forces editor control to invalidate it's area.

Update(bool): Invalidates editor if needed.