Documentation

Class SyntaxEditorPresenter

Editing, Scrolling, Layers.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
UIElement
FrameworkElement
ContentControl
SyntaxEditorPresenter
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Controls.SyntaxEditor.UI
Assembly: Telerik.WinControls.SyntaxEditor.dll

Syntax

public class SyntaxEditorPresenter : ContentControl, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDrop, ISyntaxEditorPresenter

Constructors

SyntaxEditorPresenter()

Initializes a new instance of the SyntaxEditorPresenter class.

Declaration
public SyntaxEditorPresenter()

Fields

DragMargin

The drag margin.

Declaration
protected static readonly double DragMargin
Field Value
System.Double

MaxSize

The maximum size constant.

Declaration
public static readonly SizeF MaxSize
Field Value
SizeF

Properties

Caret

Gets the caret.

Declaration
public Caret Caret { get; }
Property Value
Caret

The caret.

CaretColor

Gets or sets the caret color.

Declaration
public Color CaretColor { get; set; }
Property Value
System.Drawing.Color

The caret display mode.

CaretDisplayMode

Gets or sets the caret display mode.

Declaration
public CaretDisplayMode CaretDisplayMode { get; set; }
Property Value
CaretDisplayMode

The caret display mode.

CaretWidth

Gets or sets the caret width when the DisplayMode is set to Normal.

Declaration
public double CaretWidth { get; set; }
Property Value
System.Double

The caret display mode.

HorizontalScrollOffset

Gets or sets the horizontal scroll offset.

Declaration
public double HorizontalScrollOffset { get; protected set; }
Property Value
System.Double

The horizontal scroll offset.

IsPresenterFocused

Gets a value indicating whether this instance is presenter focused.

Declaration
public bool IsPresenterFocused { get; }
Property Value
System.Boolean

true if this instance is presenter focused; otherwise, false.

Owner

Gets or sets the owner.

Declaration
public RadSyntaxEditorElement Owner { get; set; }
Property Value
RadSyntaxEditorElement

The owner.

VerticalScrollOffset

Gets or sets the vertical scroll offset.

Declaration
public double VerticalScrollOffset { get; protected set; }
Property Value
System.Double

The vertical scroll offset.

Viewport

Gets the viewport.

Declaration
public Rect Viewport { get; }
Property Value
Rect

The viewport.
Implements

Methods

ArrangeOverride(SizeF)

When overridden in a derived class, positions child elements and determines a size for a System.Windows.FrameworkElement derived class.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final area within the parent that this element should use to arrange itself and its children.
Returns
System.Drawing.SizeF

The actual size used.
Overrides

FocusCaret()

Focuses the caret.

Declaration
public void FocusCaret()

GetDocumentPointFromPosition(CaretPosition)

Gets the document point from position.

Declaration
public Point GetDocumentPointFromPosition(CaretPosition position)
Parameters
CaretPosition position

The position.
Returns
Point

Point.
Implements

GetDocumentPointFromViewPoint(Point)

Gets the document point from view point.

Declaration
public Point GetDocumentPointFromViewPoint(Point point)
Parameters
Point point

The point.
Returns
Point

Point.
Implements

GetPositionFromViewPoint(Point)

Gets the position from view point.

Declaration
public CaretPosition GetPositionFromViewPoint(Point point)
Parameters
Point point

The position.
Returns
CaretPosition

CaretPosition.
Implements

GetScrollMax(RadScrollBarElement)

Declaration
protected virtual int GetScrollMax(RadScrollBarElement scrollBarElement)
Parameters
RadScrollBarElement scrollBarElement

Returns
System.Int32

GetViewPointFromDocumentPoint(Point)

Gets the view point from document point.

Declaration
public Point GetViewPointFromDocumentPoint(Point point)
Parameters
Point point

The point.
Returns
Point

Point.
Implements

GetViewPointFromPosition(CaretPosition)

Gets the view point from position.

Declaration
public Point GetViewPointFromPosition(CaretPosition position)
Parameters
CaretPosition position

The position.
Returns
Point

Point.
Implements

HideDropMarker()

Hides the drop marker.

Declaration
public void HideDropMarker()
Implements

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

InvalidateAndUpdateLayout()

Invalidates the and update layout.

Declaration
protected void InvalidateAndUpdateLayout()

InvalidateLayout()

Invalidates the layout.

Declaration
protected void InvalidateLayout()

InvalidateLayout(Boolean)

Invalidates the layout.

Declaration
public void InvalidateLayout(bool force)
Parameters
System.Boolean force

MeasureOverride(SizeF)

When overridden in a derived class, measures the size in layout required for child elements and determines a size for the System.Windows.FrameworkElement-derived class.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.
Returns
System.Drawing.SizeF

The size that this element determines it needs during layout, based on its calculations of child element sizes.
Overrides

MoveCaretToPositionInView(CaretPosition, Point, Boolean)

Moves the caret to position in view.

Declaration
public void MoveCaretToPositionInView(CaretPosition caretPosition, Point positionInView, bool moveToNextIfOutOfBox)
Parameters
CaretPosition caretPosition

The caret position.
Point positionInView

The position in view.
System.Boolean moveToNextIfOutOfBox

If set to true [move to next if out of box].
Implements

MoveDropMarker(CaretPosition)

Moves the drop marker.

Declaration
public void MoveDropMarker(CaretPosition position)
Parameters
CaretPosition position

The position.
Implements

OnGotFocus(EventArgs)

Invoked whenever an unhandled System.Windows.UIElement.GotFocus event reaches this element in its route.

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.
Overrides

OnMouseDown(MouseEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseLeftButtonDown routed event is raised on this element. Implement this method to add class handling for this event.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was pressed.
Overrides

OnMouseLeftButtonUp(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseLeftButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
MouseButtonEventArgs e

The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was released.
Overrides

OnMouseMove(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Input.MouseEventArgs that contains the event data.
Overrides

OnViewportChanged()

Called when [viewport changed].

Declaration
protected virtual void OnViewportChanged()

PerformPaintTransformation(ref RadMatrix)

Declaration
protected override bool PerformPaintTransformation(ref RadMatrix matrix)
Parameters
RadMatrix matrix

Returns
System.Boolean

Overrides

SetHorizontalOffset(Double)

Sets the horizontal offset.

Declaration
public void SetHorizontalOffset(double offset)
Parameters
System.Double offset

The offset.

SetVerticalOffset(Double)

Sets the vertical offset.

Declaration
public void SetVerticalOffset(double offset)
Parameters
System.Double offset

The offset.

ShowDropMarker(CaretPosition)

Shows the drop marker.

Declaration
public void ShowDropMarker(CaretPosition position)
Parameters
CaretPosition position

The position.
Implements

UpdateScrollBar(Double, Double, RadScrollBarElement, ScrollBarVisibility)

Updates the scroll bar.

Declaration
protected virtual void UpdateScrollBar(double viewportSize, double max, RadScrollBarElement scrollBar, ScrollBarVisibility suggestedVisibility)
Parameters
System.Double viewportSize

Size of the viewport.
System.Double max

The maximum.
RadScrollBarElement scrollBar

The scroll bar.
ScrollBarVisibility suggestedVisibility

The suggested visibility.

Events

ViewportChanged

Occurs when [viewport changed].

Declaration
public event EventHandler ViewportChanged
Event Type
System.EventHandler

Implements

Explicit Interface Implementations

ISyntaxEditorPresenter.Editor

Gets the editor.

Declaration
RadSyntaxEditorElement ISyntaxEditorPresenter.Editor { get; }
Returns
RadSyntaxEditorElement

The editor.
Implements

ISyntaxEditorPresenter.HorizontalScrollOffset

Gets the horizontal scroll offset.

Declaration
double ISyntaxEditorPresenter.HorizontalScrollOffset { get; }
Returns
System.Double

The horizontal scroll offset.
Implements

ISyntaxEditorPresenter.VerticalScrollOffset

Gets the vertical scroll offset.

Declaration
double ISyntaxEditorPresenter.VerticalScrollOffset { get; }
Returns
System.Double

The vertical scroll offset.
Implements

Extension Methods