Class RadPopupEditor

Represents a popup editor control that provides a text editor with an associated popup container for hosting custom content.

Inheritance
System.Object
RadControl
RadEditorControl
RadPopupEditor
RadFontDropDownList
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Editors")]
public class RadPopupEditor : RadEditorControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadPopupEditor()

Initializes a new instance of the RadPopupEditor class.

Declaration
public RadPopupEditor()

Properties

AssociatedControl

Gets or sets the associated popup container control.

Declaration
public virtual RadPopupContainer AssociatedControl { get; set; }
Property Value
RadPopupContainer

AutoSize

Gets or sets whether the edit control is auto-sized

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

Overrides

DefaultSize

Gets the default size for the popup editor control.

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

DropDownMaxSize

Gets or sets the drop down maximal size.

Declaration
public Size DropDownMaxSize { get; set; }
Property Value
System.Drawing.Size

DropDownMinSize

Gets or sets the drop down minimal size.

Declaration
public Size DropDownMinSize { get; set; }
Property Value
System.Drawing.Size

DropDownSizingMode

Gets or sets a value of the SizingMode enumeration. This value determines how the pop-up form can be resized: vertically, horizontally or both.

Declaration
public SizingMode DropDownSizingMode { get; set; }
Property Value
SizingMode

DropDownStyle

Gets or sets a value specifying the style of the DropDownList

Declaration
public virtual RadDropDownStyle DropDownStyle { get; set; }
Property Value
RadDropDownStyle

EditableAreaElement

Gets the RadDropDownListEditableAreaElement that represents the editable area.

Declaration
public RadDropDownListEditableAreaElement EditableAreaElement { get; }
Property Value
RadDropDownListEditableAreaElement

Popup

Declaration
public RadPopupControlBase Popup { get; }
Property Value
RadPopupControlBase

PopupEditorElement

Gets the RadPopupEditorElement that represents the element hierarchy.

Declaration
public RadPopupEditorElement PopupEditorElement { get; set; }
Property Value
RadPopupEditorElement

PopupForm

Gets the popup form that contains the associated control.

Declaration
public RadPopupControlBase PopupForm { get; }
Property Value
RadPopupControlBase

ShowTextBox

Gets or sets the TextBox visibility.

Declaration
public virtual bool ShowTextBox { get; set; }
Property Value
System.Boolean

TabStop

Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.

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

true if the user can give the focus to the control using the TAB key;otherwise, false. The default is true.

Text

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

Overrides

TextBoxElement

Represents the TextBox that is hosted inside.

Declaration
public virtual RadTextBoxElement TextBoxElement { get; }
Property Value
RadTextBoxElement

ThemeClassName

Gets or sets the theme class name for this control.

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

Overrides

Methods

CreateChildItems(RadElement)

Creates the child items for the popup editor control.

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

The parent element to add the child items to.
Overrides

CreateElement()

Creates the popup editor element for this control.

Declaration
protected virtual RadPopupEditorElement CreateElement()
Returns
RadPopupEditorElement

A new instance of RadPopupEditorElement.

Dispose(Boolean)

Releases the unmanaged resources used by the RadPopupEditor and optionally releases the managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

OnBindingContextChanged(EventArgs)

Called when the binding context changes and updates the popup form's binding context accordingly.

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

The System.EventArgs that contains the event data.
Overrides

OnGotFocus(EventArgs)

Called when the control gains focus and triggers invalidation for visual updates.

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

The System.EventArgs that contains the event data.
Overrides

OnLoad(Size)

Called when the control is loaded with the specified desired size.

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

The desired size for the control.
Overrides

OnLostFocus(EventArgs)

Called when the control loses focus and triggers invalidation for visual updates.

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

The System.EventArgs that contains the event data.
Overrides

OnThemeChanged()

Called when the theme is changed and applies the theme to the popup form.

Declaration
protected override void OnThemeChanged()
Overrides

OnVisibleChanged(EventArgs)

Called when the control's visibility changes and updates the associated control's visibility accordingly.

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

The System.EventArgs that contains the event data.
Overrides

ProcessAutoSizeChanged(Boolean)

Processes auto-size changes by adjusting the stretch behavior of the root element.

Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
System.Boolean value

true if auto-size is enabled; otherwise, false.
Overrides

ProcessCmdKey(ref Message, Keys)

Processes command keys and handles popup closing for certain key combinations.

Declaration
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameters
System.Windows.Forms.Message msg

The window message to process.
System.Windows.Forms.Keys keyData

The key data associated with the message.
Returns
System.Boolean

true if the command key was processed; otherwise, false.

ResetBackColorThemeOverrides()

Resets the background color theme overrides for the popup editor elements.

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

ResetForeColorThemeOverrides()

Resets the foreground color theme overrides for the popup editor elements.

Declaration
protected override void ResetForeColorThemeOverrides()
Overrides

SetAssociatedControlRuntime(RadPopupContainer)

Sets the associated control at runtime for the popup editor.

Declaration
public virtual void SetAssociatedControlRuntime(RadPopupContainer associatedControl)
Parameters
RadPopupContainer associatedControl

The RadPopupContainer to associate with this editor.

SetBackColorThemeOverrides()

Sets the background color theme overrides for the popup editor elements.

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SetForeColorThemeOverrides()

Sets the foreground color theme overrides for the popup editor elements.

Declaration
protected override void SetForeColorThemeOverrides()
Overrides

UnwireHostEvents()

Unwires the host events for the popup editor control.

Declaration
protected virtual void UnwireHostEvents()

WireHostEvents()

Wires the host events for the popup editor control.

Declaration
protected virtual void WireHostEvents()

Events

PopupClosed

Occurs when the popup is closed.

Declaration
public event RadPopupClosedEventHandler PopupClosed
Event Type
RadPopupClosedEventHandler

PopupClosing

Occurs when the popup is closing.

Declaration
public event RadPopupClosingEventHandler PopupClosing
Event Type
RadPopupClosingEventHandler

PopupOpened

Occurs when the popup is opened.

Declaration
public event EventHandler PopupOpened
Event Type
System.EventHandler

PopupOpening

Occurs before the popup is opened. This event can be cancelled.

Declaration
public event CancelEventHandler PopupOpening
Event Type
System.ComponentModel.CancelEventHandler

Extension Methods