Class RadRichTextEditorRuler

Provides a ruler control for RadRichTextEditor that displays horizontal and vertical measurement guides with paragraph formatting controls for precise document layout.

Inheritance
System.Object
RadControl
RadRichTextEditorRuler
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

[TelerikToolboxCategory("RichTextEditor")]
public class RadRichTextEditorRuler : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadRichTextEditorRuler()

Initializes a new instance of the RadRichTextEditorRuler class, creating a ruler control for precise document layout and paragraph formatting.

Declaration
public RadRichTextEditorRuler()

Properties

AssociatedRichTextBox

Gets or sets the RadRichTextEditor control that this ruler is associated with, enabling synchronized measurement and formatting operations.

Declaration
public RadRichTextEditor AssociatedRichTextBox { get; set; }
Property Value
RadRichTextEditor

AutoSize

This property is not relevant for this class.

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

BackColor

This property is not relevant for this class.

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

Overrides

DefaultSize

Gets the default size for the ruler control, providing reasonable initial dimensions for ruler display.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

DocumentRulerElement

Gets the document ruler element that handles the visual representation and interaction logic for the ruler functionality.

Declaration
public DocumentRulerElement DocumentRulerElement { get; }
Property Value
DocumentRulerElement

ForeColor

This property is not relevant for this class.

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

Overrides

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

Methods

CreateBehavior()

Creates the input behavior for handling user interactions with the ruler, including drag operations for margins and indents.

Declaration
protected override ComponentInputBehavior CreateBehavior()
Returns
ComponentInputBehavior

A new RadRichTextEditorComponentInputBehavior instance for handling ruler interactions.
Overrides

CreateChildItems(RadElement)

Creates and initializes the child elements of the ruler control, including the main DocumentRulerElement that provides ruler functionality.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent RadElement that will contain the ruler element.
Overrides

OnControlAdded(ControlEventArgs)

Handles the control added event to automatically associate a RadRichTextEditor when it is added to the same container as this ruler.

Declaration
protected override void OnControlAdded(ControlEventArgs e)
Parameters
System.Windows.Forms.ControlEventArgs e

The control event arguments containing information about the added control.

OnLayout(LayoutEventArgs)

Handles layout changes by positioning the associated RadRichTextEditor to account for ruler dimensions and ensuring proper alignment with ruler measurements.

Declaration
protected override void OnLayout(LayoutEventArgs e)
Parameters
System.Windows.Forms.LayoutEventArgs e

The layout event arguments containing information about the layout change.
Overrides

OnMouseMove(MouseEventArgs)

Handles mouse move events to update the cursor based on the element under the mouse pointer, providing visual feedback for interactive ruler elements.

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

The mouse event arguments containing position and button information.
Overrides

Extension Methods