Class RadBrowseEditorElement

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
RadEditorElement
RadTextBoxElement
RadBrowseEditorElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadBrowseEditorElement : RadTextBoxElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode

Constructors

RadBrowseEditorElement()

Creates a new instance of the RadBrowseEditorElement.

Declaration
public RadBrowseEditorElement()

Properties

BrowseButton

Gets the RadButtonElement that opens the Dialog.

Declaration
public BrowseEditorButton BrowseButton { get; }
Property Value
BrowseEditorButton

BrowseDialog

Gets the dialog component that will open upon pressing the browse button. The actual type depends on the DialogType property.

Declaration
public Component BrowseDialog { get; }
Property Value
System.ComponentModel.Component

Dialog

This property is not relevant for this class.

Declaration
[Obsolete("Use the BrowseDialog property and and cast it to the actual dialog type.")]
public CommonDialog Dialog { get; }
Property Value
System.Windows.Forms.CommonDialog

DialogType

Gets or sets the type of dialog to be opened when the browse button is pressed.

Declaration
public virtual BrowseEditorDialogType DialogType { get; set; }
Property Value
BrowseEditorDialogType

ReadOnly

Determines if users can input text directly into the text field.

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

Value

Gets or sets the value of the browse editor. This represents the selected file path, folder path, or font name depending on the DialogType.

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

Methods

ChangeDialogType(BrowseEditorDialogType)

Changes the dialog type and creates the appropriate dialog instance.

Declaration
protected virtual void ChangeDialogType(BrowseEditorDialogType dialogType)
Parameters
BrowseEditorDialogType dialogType

The new dialog type to set.

CreateChildElements()

Creates the child elements of the RadBrowseEditorElement.

Declaration
protected override void CreateChildElements()
Overrides

CreateDialogButtonElement()

Creates the BrowseEditorButton that will be placed in the browse editor and will be used to open the dialog.

Declaration
protected virtual BrowseEditorButton CreateDialogButtonElement()
Returns
BrowseEditorButton

A BrowseEditorButton.

CreateFolderBrowserDialog()

Creates the System.Windows.Forms.FolderBrowserDialog that will be opened when the browse button is clicked.

Declaration
protected virtual FolderBrowserDialog CreateFolderBrowserDialog()
Returns
System.Windows.Forms.FolderBrowserDialog

A System.Windows.Forms.FolderBrowserDialog.

CreateFontDialog()

Creates the System.Windows.Forms.FontDialog that will be opened when the browse button is clicked.

Declaration
protected virtual FontDialog CreateFontDialog()
Returns
System.Windows.Forms.FontDialog

A System.Windows.Forms.FontDialog.

CreateOpenFileDialog()

Creates the System.Windows.Forms.OpenFileDialog that will be opened when the browse button is clicked.

Declaration
protected virtual OpenFileDialog CreateOpenFileDialog()
Returns
System.Windows.Forms.OpenFileDialog

A System.Windows.Forms.OpenFileDialog.

CreateRadFolderBrowserDialog()

Creates the RadOpenFolderDialog that will be opened when the browse button is clicked.

Declaration
protected virtual RadOpenFolderDialog CreateRadFolderBrowserDialog()
Returns
RadOpenFolderDialog

A RadOpenFolderDialog.

CreateRadOpenFileDialog()

Creates the RadOpenFileDialog that will be opened when the browse button is clicked.

Declaration
protected virtual RadOpenFileDialog CreateRadOpenFileDialog()
Returns
RadOpenFileDialog

A RadOpenFileDialog.

CreateRadSaveFileDialog()

Creates the RadSaveFileDialog that will be opened when the browse button is clicked.

Declaration
protected virtual RadSaveFileDialog CreateRadSaveFileDialog()
Returns
RadSaveFileDialog

A RadSaveFileDialog.

CreateSaveFileDialog()

Creates the System.Windows.Forms.SaveFileDialog that will be opened when the browse button is clicked.

Declaration
protected virtual SaveFileDialog CreateSaveFileDialog()
Returns
System.Windows.Forms.SaveFileDialog

A System.Windows.Forms.SaveFileDialog.

DisposeManagedResources()

Disposes managed resources and unwires event handlers.

Declaration
protected override void DisposeManagedResources()
Overrides

InitializeDialog()

Initializes the dialog with the current value and appropriate settings based on the DialogType.

Declaration
protected virtual void InitializeDialog()

InitializeFields()

Initializes the fields of the RadBrowseEditorElement.

Declaration
protected override void InitializeFields()
Overrides

OnBrowseButtonClick(EventArgs)

Fires when the BrowseEditorButton is clicked.

Declaration
protected virtual void OnBrowseButtonClick(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

OnDialogClosed(DialogClosedEventArgs)

Fires after the dialog is closed.

Declaration
protected virtual void OnDialogClosed(DialogClosedEventArgs e)
Parameters
DialogClosedEventArgs e

The event arguments.

OnKeyDown(KeyEventArgs)

Handles key down events and sets the editor value when Enter is pressed.

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

The event arguments.
Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Handles property changed events and updates the RightToLeft property for shapes when necessary.

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

The event arguments.
Overrides

OnPropertyChanging(RadPropertyChangingEventArgs)

Handles property changing events. Filters out text property changes during value changes.

Declaration
protected override void OnPropertyChanging(RadPropertyChangingEventArgs args)
Parameters
RadPropertyChangingEventArgs args

The event arguments.
Overrides

OnTextChanged(EventArgs)

Handles the text changed event. Does not fire the event when value is being changed programmatically.

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

The event arguments.
Overrides

OnTextChanging(TextChangingEventArgs)

Handles the text changing event. Cancels the event if the editor is read-only.

Declaration
protected override void OnTextChanging(TextChangingEventArgs e)
Parameters
TextChangingEventArgs e

The event arguments.
Overrides

OnValueChanged(EventArgs)

Fires right after the editor value is changed.

Declaration
protected virtual void OnValueChanged(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

OnValueChanging(ValueChangingEventArgs)

Fires right before the editor value is changed.

Declaration
protected virtual void OnValueChanging(ValueChangingEventArgs e)
Parameters
ValueChangingEventArgs e

The event arguments.

SaveValueFromDialog()

Saves the value from the dialog to the editor's Value property based on the DialogType.

Declaration
protected virtual void SaveValueFromDialog()

SetEditorValue(String)

Sets the value of the editor.

Declaration
protected virtual void SetEditorValue(string newValue)
Parameters
System.String newValue

The new value to set.

UnwireEvents()

Unwires the event handlers for the browse button and text box.

Declaration
protected virtual void UnwireEvents()

WireEvents()

Wires the event handlers for the browse button and text box.

Declaration
protected virtual void WireEvents()

Events

DialogClosed

Fires after the dialog window is closed.

Declaration
public event DialogClosedEventHandler DialogClosed
Event Type
DialogClosedEventHandler

ValueChanged

Fires after the editor value is changed.

Declaration
public event EventHandler ValueChanged
Event Type
System.EventHandler

ValueChanging

Fires right before the value is changed. Cancelable event.

Declaration
public event ValueChangingEventHandler ValueChanging
Event Type
ValueChangingEventHandler

Extension Methods