New to Telerik UI for WinForms? Start a free 30-day trial

RadMarkupDialog

Class

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

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.RadMarkupEditor.dll

Syntax:

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

Inheritance: objectMarshalByRefObjectComponentCommonDialogRadMarkupDialog

Implements: IComponentIDisposable

Constructors

RadMarkupDialog()

Initializes a new instance of the RadMarkupDialog class.

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.

public Font DefaultFont { get; set; }

Editor

RadMarkupEditor

Gets the RadMarkupEditor instance used within the dialog.

public RadMarkupEditor Editor { get; }

Form

ShapedForm

Gets the ShapedForm instance used to host the markup editor.

public ShapedForm Form { get; }

ThemeName

string

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

public string ThemeName { get; set; }

Value

string

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.

public string Value { get; set; }

Methods

Dispose(bool)

Releases the resources used by the RadMarkupDialog.

protected override void Dispose(bool disposing)

Parameters:disposingbool

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.

public override void Reset()

Overrides: CommonDialog.Reset()

RunDialog(IntPtr)

Displays the modal dialog box.

protected override bool RunDialog(IntPtr hwndOwner)

Parameters:hwndOwnerIntPtr

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)