Class
RadMarkupEditor

A rich text markup editor control that provides a ribbon-based user interface for text formatting and HTML editing.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.RadMarkupEditor.dll

Syntax:

cs-api-definition
public class RadMarkupEditor : UserControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IRadMarkupEditor

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlUserControlRadMarkupEditor

Implements: IBindableComponentIComponentIContainerControlIDisposableIDropTargetIRadMarkupEditorISynchronizeInvokeIWin32Window

Inherited Members UserControl.ValidateChildren()UserControl.ValidateChildren(ValidationConstraints)UserControl.OnCreateControl()UserControl.OnLoad(EventArgs)UserControl.OnResize(EventArgs)UserControl.OnMouseDown(MouseEventArgs)UserControl.WndProc(ref Message)UserControl.AutoSizeUserControl.AutoSizeModeUserControl.AutoValidateUserControl.BorderStyleUserControl.CreateParamsUserControl.DefaultSizeUserControl.AutoSizeChangedUserControl.AutoValidateChangedUserControl.LoadContainerControl.AdjustFormScrollbars(bool)ContainerControl.OnAutoValidateChanged(EventArgs)ContainerControl.OnFontChanged(EventArgs)ContainerControl.OnLayout(LayoutEventArgs)ContainerControl.OnParentChanged(EventArgs)ContainerControl.PerformAutoScale()ContainerControl.ProcessDialogChar(char)ContainerControl.ProcessDialogKey(Keys)ContainerControl.ProcessCmdKey(ref Message, Keys)ContainerControl.ProcessMnemonic(char)ContainerControl.ProcessTabKey(bool)ContainerControl.Select(bool, bool)ContainerControl.UpdateDefaultButton()ContainerControl.Validate()ContainerControl.Validate(bool)ContainerControl.AutoScaleDimensionsContainerControl.AutoScaleFactorContainerControl.AutoScaleModeContainerControl.BindingContextContainerControl.CanEnableImeContainerControl.ActiveControlContainerControl.CurrentAutoScaleDimensionsContainerControl.ParentFormScrollableControl.ScrollStateAutoScrollingScrollableControl.ScrollStateHScrollVisibleScrollableControl.ScrollStateVScrollVisibleScrollableControl.ScrollStateUserHasScrolledScrollableControl.ScrollStateFullDragScrollableControl.GetScrollState(int)ScrollableControl.OnMouseWheel(MouseEventArgs)ScrollableControl.OnRightToLeftChanged(EventArgs)ScrollableControl.OnPaintBackground(PaintEventArgs)ScrollableControl.OnPaddingChanged(EventArgs)ScrollableControl.OnVisibleChanged(EventArgs)ScrollableControl.ScaleControl(SizeF, BoundsSpecified)ScrollableControl.SetDisplayRectLocation(int, int)ScrollableControl.ScrollControlIntoView(Control)ScrollableControl.ScrollToControl(Control)ScrollableControl.OnScroll(ScrollEventArgs)ScrollableControl.SetAutoScrollMargin(int, int)ScrollableControl.SetScrollState(int, bool)ScrollableControl.AutoScrollScrollableControl.AutoScrollMarginScrollableControl.AutoScrollPositionScrollableControl.AutoScrollMinSizeScrollableControl.DisplayRectangleScrollableControl.HScrollScrollableControl.HorizontalScrollScrollableControl.VScrollScrollableControl.VerticalScrollScrollableControl.ScrollControl.GetAccessibilityObjectById(int)Control.SetAutoSizeMode(AutoSizeMode)Control.GetAutoSizeMode()Control.GetPreferredSize(Size)Control.AccessibilityNotifyClients(AccessibleEvents, int)Control.AccessibilityNotifyClients(AccessibleEvents, int, int)Control.BeginInvoke(Delegate)Control.BeginInvoke(Delegate, params object[])Control.BringToFront()Control.Contains(Control)Control.CreateAccessibilityInstance()Control.CreateControlsInstance()Control.CreateGraphics()Control.CreateHandle()Control.CreateControl()Control.DefWndProc(ref Message)Control.DestroyHandle()Control.DoDragDrop(object, DragDropEffects)Control.DrawToBitmap(Bitmap, Rectangle)Control.EndInvoke(IAsyncResult)Control.FindForm()Control.GetTopLevel()Control.RaiseKeyEvent(object, KeyEventArgs)Control.RaiseMouseEvent(object, MouseEventArgs)Control.Focus()Control.FromChildHandle(IntPtr)Control.FromHandle(IntPtr)Control.GetChildAtPoint(Point, GetChildAtPointSkip)Control.GetChildAtPoint(Point)Control.GetContainerControl()Control.GetScaledBounds(Rectangle, SizeF, BoundsSpecified)Control.GetNextControl(Control, bool)Control.GetStyle(ControlStyles)Control.Hide()Control.InitLayout()Control.Invalidate(Region)Control.Invalidate(Region, bool)Control.Invalidate()Control.Invalidate(bool)Control.Invalidate(Rectangle)Control.Invalidate(Rectangle, bool)Control.Invoke(Delegate)Control.Invoke(Delegate, params object[])Control.InvokePaint(Control, PaintEventArgs)Control.InvokePaintBackground(Control, PaintEventArgs)Control.IsKeyLocked(Keys)Control.IsInputChar(char)Control.IsInputKey(Keys)Control.IsMnemonic(char, string)Control.LogicalToDeviceUnits(int)Control.LogicalToDeviceUnits(Size)Control.ScaleBitmapLogicalToDevice(ref Bitmap)Control.NotifyInvalidate(Rectangle)Control.InvokeOnClick(Control, EventArgs)Control.OnAutoSizeChanged(EventArgs)Control.OnBackColorChanged(EventArgs)Control.OnBackgroundImageChanged(EventArgs)Control.OnBackgroundImageLayoutChanged(EventArgs)Control.OnBindingContextChanged(EventArgs)Control.OnCausesValidationChanged(EventArgs)Control.OnContextMenuChanged(EventArgs)Control.OnContextMenuStripChanged(EventArgs)Control.OnCursorChanged(EventArgs)Control.OnDockChanged(EventArgs)Control.OnEnabledChanged(EventArgs)Control.OnForeColorChanged(EventArgs)Control.OnNotifyMessage(Message)Control.OnParentBackColorChanged(EventArgs)Control.OnParentBackgroundImageChanged(EventArgs)Control.OnParentBindingContextChanged(EventArgs)Control.OnParentCursorChanged(EventArgs)Control.OnParentEnabledChanged(EventArgs)Control.OnParentFontChanged(EventArgs)Control.OnParentForeColorChanged(EventArgs)Control.OnParentRightToLeftChanged(EventArgs)Control.OnParentVisibleChanged(EventArgs)Control.OnPrint(PaintEventArgs)Control.OnTabIndexChanged(EventArgs)Control.OnTabStopChanged(EventArgs)Control.OnTextChanged(EventArgs)Control.OnClick(EventArgs)Control.OnClientSizeChanged(EventArgs)Control.OnControlAdded(ControlEventArgs)Control.OnControlRemoved(ControlEventArgs)Control.OnHandleCreated(EventArgs)Control.OnLocationChanged(EventArgs)Control.OnHandleDestroyed(EventArgs)Control.OnDoubleClick(EventArgs)Control.OnDragEnter(DragEventArgs)Control.OnDragOver(DragEventArgs)Control.OnDragLeave(EventArgs)Control.OnDragDrop(DragEventArgs)Control.OnGiveFeedback(GiveFeedbackEventArgs)Control.OnEnter(EventArgs)Control.InvokeGotFocus(Control, EventArgs)Control.OnGotFocus(EventArgs)Control.OnHelpRequested(HelpEventArgs)Control.OnInvalidated(InvalidateEventArgs)Control.OnKeyDown(KeyEventArgs)Control.OnKeyPress(KeyPressEventArgs)Control.OnKeyUp(KeyEventArgs)Control.OnLeave(EventArgs)Control.InvokeLostFocus(Control, EventArgs)Control.OnLostFocus(EventArgs)Control.OnMarginChanged(EventArgs)Control.OnMouseDoubleClick(MouseEventArgs)Control.OnMouseClick(MouseEventArgs)Control.OnMouseCaptureChanged(EventArgs)Control.OnMouseEnter(EventArgs)Control.OnMouseLeave(EventArgs)Control.OnDpiChangedBeforeParent(EventArgs)Control.OnDpiChangedAfterParent(EventArgs)Control.OnMouseHover(EventArgs)Control.OnMouseMove(MouseEventArgs)Control.OnMouseUp(MouseEventArgs)Control.OnMove(EventArgs)Control.OnPaint(PaintEventArgs)Control.OnQueryContinueDrag(QueryContinueDragEventArgs)Control.OnRegionChanged(EventArgs)Control.OnPreviewKeyDown(PreviewKeyDownEventArgs)Control.OnSizeChanged(EventArgs)Control.OnChangeUICues(UICuesEventArgs)Control.OnStyleChanged(EventArgs)Control.OnSystemColorsChanged(EventArgs)Control.OnValidating(CancelEventArgs)Control.OnValidated(EventArgs)Control.RescaleConstantsForDpi(int, int)Control.PerformLayout()Control.PerformLayout(Control, string)Control.PointToClient(Point)Control.PointToScreen(Point)Control.PreProcessMessage(ref Message)Control.PreProcessControlMessage(ref Message)Control.ProcessKeyEventArgs(ref Message)Control.ProcessKeyMessage(ref Message)Control.ProcessKeyPreview(ref Message)Control.RaiseDragEvent(object, DragEventArgs)Control.RaisePaintEvent(object, PaintEventArgs)Control.RecreateHandle()Control.RectangleToClient(Rectangle)Control.RectangleToScreen(Rectangle)Control.ReflectMessage(IntPtr, ref Message)Control.Refresh()Control.ResetMouseEventArgs()Control.ResetText()Control.ResumeLayout()Control.ResumeLayout(bool)Control.Scale(SizeF)Control.Select()Control.SelectNextControl(Control, bool, bool, bool, bool)Control.SendToBack()Control.SetBounds(int, int, int, int)Control.SetBounds(int, int, int, int, BoundsSpecified)Control.SetBoundsCore(int, int, int, int, BoundsSpecified)Control.SetClientSizeCore(int, int)Control.SizeFromClientSize(Size)Control.SetStyle(ControlStyles, bool)Control.SetTopLevel(bool)Control.SetVisibleCore(bool)Control.RtlTranslateAlignment(HorizontalAlignment)Control.RtlTranslateAlignment(LeftRightAlignment)Control.RtlTranslateAlignment(ContentAlignment)Control.RtlTranslateHorizontal(HorizontalAlignment)Control.RtlTranslateLeftRight(LeftRightAlignment)Control.RtlTranslateContent(ContentAlignment)Control.Show()Control.SuspendLayout()Control.Update()Control.UpdateBounds()Control.UpdateBounds(int, int, int, int)Control.UpdateBounds(int, int, int, int, int, int)Control.UpdateZOrder()Control.UpdateStyles()Control.OnImeModeChanged(EventArgs)Control.AccessibilityObjectControl.AccessibleDefaultActionDescriptionControl.AccessibleDescriptionControl.AccessibleNameControl.AccessibleRoleControl.AllowDropControl.AnchorControl.AutoScrollOffsetControl.LayoutEngineControl.BackColorControl.BackgroundImageControl.BackgroundImageLayoutControl.BottomControl.BoundsControl.CanFocusControl.CanRaiseEventsControl.CanSelectControl.CaptureControl.CausesValidationControl.CheckForIllegalCrossThreadCallsControl.ClientRectangleControl.ClientSizeControl.CompanyNameControl.ContainsFocusControl.ContextMenuControl.ContextMenuStripControl.ControlsControl.CreatedControl.CursorControl.DataBindingsControl.DefaultBackColorControl.DefaultCursorControl.DefaultForeColorControl.DefaultMarginControl.DefaultMaximumSizeControl.DefaultMinimumSizeControl.DefaultPaddingControl.DeviceDpiControl.IsDisposedControl.DisposingControl.DockControl.DoubleBufferedControl.EnabledControl.FocusedControl.FontControl.FontHeightControl.ForeColorControl.HandleControl.HasChildrenControl.HeightControl.IsHandleCreatedControl.InvokeRequiredControl.IsAccessibleControl.IsMirroredControl.LeftControl.LocationControl.MarginControl.MaximumSizeControl.MinimumSizeControl.ModifierKeysControl.MouseButtonsControl.MousePositionControl.NameControl.ParentControl.ProductNameControl.ProductVersionControl.RecreatingHandleControl.RegionControl.RenderRightToLeftControl.ResizeRedrawControl.RightControl.RightToLeftControl.ScaleChildrenControl.SiteControl.SizeControl.TabIndexControl.TabStopControl.TagControl.TextControl.TopControl.TopLevelControlControl.ShowKeyboardCuesControl.ShowFocusCuesControl.UseWaitCursorControl.VisibleControl.WidthControl.PreferredSizeControl.PaddingControl.DefaultImeModeControl.ImeModeControl.ImeModeBaseControl.PropagatingImeModeControl.BackColorChangedControl.BackgroundImageChangedControl.BackgroundImageLayoutChangedControl.BindingContextChangedControl.CausesValidationChangedControl.ClientSizeChangedControl.ContextMenuChangedControl.ContextMenuStripChangedControl.CursorChangedControl.DockChangedControl.EnabledChangedControl.FontChangedControl.ForeColorChangedControl.LocationChangedControl.MarginChangedControl.RegionChangedControl.RightToLeftChangedControl.SizeChangedControl.TabIndexChangedControl.TabStopChangedControl.TextChangedControl.VisibleChangedControl.ClickControl.ControlAddedControl.ControlRemovedControl.DragDropControl.DragEnterControl.DragOverControl.DragLeaveControl.GiveFeedbackControl.HandleCreatedControl.HandleDestroyedControl.HelpRequestedControl.InvalidatedControl.PaddingChangedControl.PaintControl.QueryContinueDragControl.QueryAccessibilityHelpControl.DoubleClickControl.EnterControl.GotFocusControl.KeyDownControl.KeyPressControl.KeyUpControl.LayoutControl.LeaveControl.LostFocusControl.MouseClickControl.MouseDoubleClickControl.MouseCaptureChangedControl.MouseDownControl.MouseEnterControl.MouseLeaveControl.DpiChangedBeforeParentControl.DpiChangedAfterParentControl.MouseHoverControl.MouseMoveControl.MouseUpControl.MouseWheelControl.MoveControl.PreviewKeyDownControl.ResizeControl.ChangeUICuesControl.StyleChangedControl.SystemColorsChangedControl.ValidatingControl.ValidatedControl.ParentChangedControl.ImeModeChangedComponent.Dispose()Component.GetService(Type)Component.ToString()Component.EventsComponent.ContainerComponent.DesignModeComponent.DisposedMarshalByRefObject.MemberwiseClone(bool)MarshalByRefObject.GetLifetimeService()MarshalByRefObject.InitializeLifetimeService()MarshalByRefObject.CreateObjRef(Type)

Constructors

RadMarkupEditor()

Initializes a new instance of the RadMarkupEditor class.

Declaration

cs-api-definition
public RadMarkupEditor()

Properties

ApplyButton

Gets the main apply button element that commits changes and closes the editor.

Declaration

cs-api-definition
public RadButtonElement ApplyButton { get; }

Property Value

RadButtonElement

BackColorButton

Gets the button element for changing text background color.

Declaration

cs-api-definition
public RadButtonElement BackColorButton { get; }

Property Value

RadButtonElement

BoldButton

Gets the button element for applying bold formatting.

Declaration

cs-api-definition
public RadButtonElement BoldButton { get; }

Property Value

RadButtonElement

CopyButton

Gets the copy button element in the design view.

Declaration

cs-api-definition
public RadButtonElement CopyButton { get; }

Property Value

RadButtonElement

CopyButton2

Gets the copy button element in the markup view.

Declaration

cs-api-definition
public RadButtonElement CopyButton2 { get; }

Property Value

RadButtonElement

CutButton

Gets the cut button element in the design view.

Declaration

cs-api-definition
public RadButtonElement CutButton { get; }

Property Value

RadButtonElement

CutButton2

Gets the cut button element in the markup view.

Declaration

cs-api-definition
public RadButtonElement CutButton2 { get; }

Property Value

RadButtonElement

DefaultFont

Gets or sets the default font used for text in the markup editor.

Declaration

cs-api-definition
public Font DefaultFont { get; set; }

Property Value

Font

DesignViewDomDocument

Gets the underlying HTML document object model of the design view.

Declaration

cs-api-definition
public IHTMLDocument2 DesignViewDomDocument { get; }

Property Value

IHTMLDocument2

Implements IRadMarkupEditor.DesignViewDomDocument

FontFamilyDropDownList

Gets the dropdown list element for selecting font families.

Declaration

cs-api-definition
public RadDropDownListElement FontFamilyDropDownList { get; }

Property Value

RadDropDownListElement

FontSizeDropDownList

Gets the dropdown list element for selecting font sizes.

Declaration

cs-api-definition
public RadDropDownListElement FontSizeDropDownList { get; }

Property Value

RadDropDownListElement

ForeColorButton

Gets the button element for changing text color.

Declaration

cs-api-definition
public RadButtonElement ForeColorButton { get; }

Property Value

RadButtonElement

HyperlinkButton

Gets the button element for inserting or editing a hyperlink.

Declaration

cs-api-definition
public RadButtonElement HyperlinkButton { get; }

Property Value

RadButtonElement

IsValueSaved

Gets a value indicating whether the current content has been saved.

Declaration

cs-api-definition
public bool IsValueSaved { get; }

Property Value

bool

ItalicButton

Gets the button element for applying italic formatting.

Declaration

cs-api-definition
public RadButtonElement ItalicButton { get; }

Property Value

RadButtonElement

OrderedListButton

Gets the button element for creating or formatting an ordered (numbered) list.

Declaration

cs-api-definition
public RadButtonElement OrderedListButton { get; }

Property Value

RadButtonElement

PasteButton

Gets the paste button element in the design view.

Declaration

cs-api-definition
public RadButtonElement PasteButton { get; }

Property Value

RadButtonElement

PasteButton2

Gets the paste button element in the markup view.

Declaration

cs-api-definition
public RadButtonElement PasteButton2 { get; }

Property Value

RadButtonElement

RawValue

Gets the complete HTML content including root HTML tags, with all symbols properly escaped.

Declaration

cs-api-definition
public string RawValue { get; }

Property Value

string

RedoButton

Gets the button element for redoing the last undone operation.

Declaration

cs-api-definition
public RadButtonElement RedoButton { get; }

Property Value

RadButtonElement

RibbonBar

Gets the ribbon bar control used in the editor's interface.

Declaration

cs-api-definition
public RadRibbonBar RibbonBar { get; }

Property Value

RadRibbonBar

SmallApplyButton

Gets the small apply button element in the quick access toolbar.

Declaration

cs-api-definition
public RadButtonElement SmallApplyButton { get; }

Property Value

RadButtonElement

UnderlineButton

Gets the button element for applying underline formatting.

Declaration

cs-api-definition
public RadButtonElement UnderlineButton { get; }

Property Value

RadButtonElement

UndoButton

Gets the button element for undoing the last operation.

Declaration

cs-api-definition
public RadButtonElement UndoButton { get; }

Property Value

RadButtonElement

UnorderedListButton

Gets the button element for creating or formatting an unordered (bulleted) list.

Declaration

cs-api-definition
public RadButtonElement UnorderedListButton { get; }

Property Value

RadButtonElement

Value

Gets or sets the HTML content being edited in the markup editor.

Declaration

cs-api-definition
public string Value { get; set; }

Property Value

string

Implements IRadMarkupEditor.Value

Methods

ChangeModeInternal(EditorMode)

Changes the internal editing mode of the editor.

Declaration

cs-api-definition
public void ChangeModeInternal(EditorMode value)

Parameters

value

EditorMode

The editing mode to set.

Implements IRadMarkupEditor.ChangeModeInternal(EditorMode)

Dispose(bool)

Clean up any resources being used.

Declaration

cs-api-definition
protected override void Dispose(bool disposing)

Parameters

disposing

bool

true if managed resources should be disposed; otherwise, false.

Overrides ContainerControl.Dispose(bool)

InsertHtml(string)

Inserts HTML content at the current cursor position.

Declaration

cs-api-definition
public void InsertHtml(string html)

Parameters

html

string

The HTML content to insert.

Exceptions

NotImplementedException

This method is not currently implemented.

Implements IRadMarkupEditor.InsertHtml(string)

InvokeUpdateUI()

Refreshes the user interface elements based on the current state of the editor.

Declaration

cs-api-definition
public void InvokeUpdateUI()

Implements IRadMarkupEditor.InvokeUpdateUI()

LocalizeForm()

Applies the current localization settings to all UI elements in the editor.

Declaration

cs-api-definition
protected virtual void LocalizeForm()

Events

EditorClosed

Occurs when the editor is closed after applying changes.

Declaration

cs-api-definition
public event EventHandler EditorClosed

Event Value

EventHandler