Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

EditorViewMarginBase Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.SyntaxEditor.Primitives
Assembly:
ActiproSoftware.SyntaxEditor.WinForms.dll

Provides the abstract base class for an editor view margin.

public abstract class EditorViewMarginBase : UIElement, IInputElement, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IEditorViewMargin, ITextViewMargin, IOrderable, IKeyedObject
Inheritance:
object MarshalByRefObject DisposableObject LogicalTreeNodeBase UIElement object
Derived:
EditorIndicatorMargin EditorLineNumberMargin EditorOutliningMargin EditorRulerMargin EditorSelectionMargin EditorWordWrapGlyphMargin
Implements:
IInputElement IUIElement ILogicalTreeNode IDpiAwareElement IDisposable IEditorViewMargin ITextViewMargin IOrderable IKeyedObject

Constructors

EditorViewMarginBase(IEditorView, string, EditorViewMarginPlacement, IEnumerable<Ordering>)

Initializes an instance of the EditorViewMarginBase class.

protected EditorViewMarginBase(IEditorView view, string key, EditorViewMarginPlacement placement, IEnumerable<Ordering> orderings)
Parameter Type Description
view IEditorView

The IEditorView that will host the margin.
key string

The string-based key that identifies the margin.
placement EditorViewMarginPlacement

A EditorViewMarginPlacement indicating the placement of the margin within its parent IEditorView.
orderings IEnumerable<Ordering>

The collection of Ordering objects, used to determine how this object is positioned relative to other objects.

Properties

Key

Gets the string-based key that identifies the margin.

public string Key { get; }

Property Value

string:

The string-based key that identifies the margin.

Orderings

Gets the collection of Ordering objects, used to determine how this object is positioned relative to other objects.

public IEnumerable<Ordering> Orderings { get; }

Property Value

IEnumerable<Ordering>:

The collection of Ordering objects, used to determine how this object is positioned relative to other objects.

Placement

Gets a EditorViewMarginPlacement indicating the placement of the margin within its parent IEditorView.

public EditorViewMarginPlacement Placement { get; }

Property Value

EditorViewMarginPlacement:

A EditorViewMarginPlacement indicating the placement of the margin within its parent IEditorView.

View

Gets the IEditorView that contains this margin.

public IEditorView View { get; }

Property Value

IEditorView:

The IEditorView that contains this margin.

Visibility

Gets the element's visibility.

public Visibility Visibility { get; }

Property Value

Visibility:

A Visibility that specifies the element's visibility.

VisualElement

Gets the IUIElement that is used to render this margin in the user interface.

public IUIElement VisualElement { get; }

Property Value

IUIElement:

The IUIElement that is used to render this margin in the user interface.

Methods

Draw(TextViewDrawContext)

Draws the margin and its content.

public virtual void Draw(TextViewDrawContext context)
Parameter Type Description
context TextViewDrawContext

The TextViewDrawContext to use for rendering.

UpdateVisibility()

Updates the visibility of the margin.

public virtual void UpdateVisibility()

Inherited Members