Class
RadMarkupDialog

A dialog that allows users to edit and apply markup formatting to text.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.RadMarkupEditor.dll

Syntax:

cs-api-definition

[TelerikToolboxCategory("Dialogs")]
public class RadMarkupDialog : CommonDialog, IComponent, IDisposable

Inheritance: objectMarshalByRefObjectComponentCommonDialogRadMarkupDialog

Implements: IComponentIDisposable

Inherited Members CommonDialog.HookProc(IntPtr, int, IntPtr, IntPtr)CommonDialog.OnHelpRequest(EventArgs)CommonDialog.OwnerWndProc(IntPtr, int, IntPtr, IntPtr)CommonDialog.ShowDialog()CommonDialog.ShowDialog(IWin32Window)CommonDialog.TagCommonDialog.HelpRequestComponent.Dispose()Component.GetService(Type)Component.ToString()Component.CanRaiseEventsComponent.EventsComponent.SiteComponent.ContainerComponent.DesignModeComponent.DisposedMarshalByRefObject.MemberwiseClone(bool)MarshalByRefObject.GetLifetimeService()MarshalByRefObject.InitializeLifetimeService()MarshalByRefObject.CreateObjRef(Type)

Constructors

RadMarkupDialog()

Initializes a new instance of the RadMarkupDialog class.

Declaration

cs-api-definition

public RadMarkupDialog()

Gets or sets the default font used when the editor is started. No formatting tags are added for this font as it is considered the default. Users can still explicitly set font name and size using the editor controls.

Declaration

cs-api-definition

public Font DefaultFont { get; set; }

Property Value

Font

Editor

Gets the RadMarkupEditor instance used within the dialog.

Declaration

cs-api-definition

public RadMarkupEditor Editor { get; }

Property Value

RadMarkupEditor

Form

Gets the ShapedForm instance used to host the markup editor.

Declaration

cs-api-definition

public ShapedForm Form { get; }

Property Value

ShapedForm

ThemeName

Gets or sets the name of the theme applied to the dialog.

Declaration

cs-api-definition

public string ThemeName { get; set; }

Property Value

string

Value

Gets or sets the markup text being edited. Set this property before showing the dialog to provide initial content, and retrieve it after the dialog closes to get the user's changes. Use the DialogResult to determine if the user applied changes or canceled.

Declaration

cs-api-definition

public string Value { get; set; }

Property Value

string

Methods

Dispose(bool)

Releases the resources used by the RadMarkupDialog.

Declaration

cs-api-definition

protected override void Dispose(bool disposing)

Parameters

disposing

bool

A value indicating whether the method was invoked by a Dispose() call.

Overrides Component.Dispose(bool)

Reset()

Resets the dialog by clearing the markup text value.

Declaration

cs-api-definition

public override void Reset()

Overrides CommonDialog.Reset()

RunDialog(IntPtr)

Displays the modal dialog box.

Declaration

cs-api-definition

protected override bool RunDialog(IntPtr hwndOwner)

Parameters

hwndOwner

IntPtr

The window handle of the owner window for the dialog.

Returns

bool

true if the user clicked OK or Apply in the dialog; otherwise, false.

Overrides CommonDialog.RunDialog(IntPtr)

ClassRadMarkupDialog

Class
RadMarkupDialog