Documentation

Class RadFilePathPicker

Control used for choosing a valid file / folder path via file / folder dialog or via typing in watermark text box.

Inheritance
System.Object
RadFilePathPicker
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.FileDialogs.dll

Syntax

[TelerikToolboxCategory("File Dialogs")]
public class RadFilePathPicker : Control, IThemable

Constructors

RadFilePathPicker()

Initializes a new instance of the RadFilePathPicker class.

Declaration
public RadFilePathPicker()

Fields

ClearButtonContentProperty

Identifies the ClearButtonContent dependency property.

Declaration
public static readonly DependencyProperty ClearButtonContentProperty
Field Value
System.Windows.DependencyProperty

ClearButtonTemplateProperty

Identifies the ClearButtonTemplate dependency property.

Declaration
public static readonly DependencyProperty ClearButtonTemplateProperty
Field Value
System.Windows.DependencyProperty

DialogTypeProperty

Initializes the DialogType property.

Declaration
public static readonly DependencyProperty DialogTypeProperty
Field Value
System.Windows.DependencyProperty

EditorVisibilityProperty

Identifies the EditorVisibility dependency property.

Declaration
public static readonly DependencyProperty EditorVisibilityProperty
Field Value
System.Windows.DependencyProperty

FilePathChangedEvent

Registers the FilePathChanged routed event.

Declaration
public static readonly RoutedEvent FilePathChangedEvent
Field Value
System.Windows.RoutedEvent

FilePathChangingEvent

Registers the FilePathChanging routed event.

Declaration
public static readonly RoutedEvent FilePathChangingEvent
Field Value
System.Windows.RoutedEvent

FilePathProperty

Initializes the FilePath property.

Declaration
public static readonly DependencyProperty FilePathProperty
Field Value
System.Windows.DependencyProperty

IconTemplateSelectorProperty

Identifies the IconTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty IconTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

IconVisibilityProperty

Identifies the IconVisibility dependency property.

Declaration
public static readonly DependencyProperty IconVisibilityProperty
Field Value
System.Windows.DependencyProperty

IsReadOnlyProperty

Identifies the IsReadOnly dependency property.

Declaration
public static readonly DependencyProperty IsReadOnlyProperty
Field Value
System.Windows.DependencyProperty

ShowDialogButtonContentProperty

Identifies the ShowDialogButtonContent dependency property.

Declaration
public static readonly DependencyProperty ShowDialogButtonContentProperty
Field Value
System.Windows.DependencyProperty

ShowDialogButtonTemplateProperty

Identifies the ShowDialogButtonTemplate dependency property.

Declaration
public static readonly DependencyProperty ShowDialogButtonTemplateProperty
Field Value
System.Windows.DependencyProperty

TextProperty

Identifies the Text dependency property.

Declaration
public static readonly DependencyProperty TextProperty
Field Value
System.Windows.DependencyProperty

WatermarkContentProperty

Identifies the WatermarkContent dependency property.

Declaration
public static readonly DependencyProperty WatermarkContentProperty
Field Value
System.Windows.DependencyProperty

WatermarkTemplateProperty

Identifies the WatermarkTemplate dependency property.

Declaration
public static readonly DependencyProperty WatermarkTemplateProperty
Field Value
System.Windows.DependencyProperty

Properties

ClearButtonContent

Gets or sets the content of the clear button.

Declaration
public object ClearButtonContent { get; set; }
Property Value
System.Object

ClearButtonTemplate

Gets or sets the content template of the clear button.

Declaration
public DataTemplate ClearButtonTemplate { get; set; }
Property Value
System.Windows.DataTemplate

DialogType

Gets or sets a value indicating the type of the dialog that is opened by the show dialog button.

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

EditorVisibility

Gets or sets a value indicating the visibility of the watermark textbox.

Declaration
public Visibility EditorVisibility { get; set; }
Property Value
System.Windows.Visibility

FilePath

Gets or sets the path to a given file or folder. This property accepts only a valid (existing) file / folder path.

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

IconTemplateSelector

Gets or sets the System.Windows.Controls.DataTemplateSelector which chooses icon template based on the given FilePath.

Declaration
public DataTemplateSelector IconTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

IconVisibility

Gets or sets a value indicating the visibility of the file path icon.

Declaration
public Visibility IconVisibility { get; set; }
Property Value
System.Windows.Visibility

IsReadOnly

Gets or sets a value indicating whether the watermark textbox is in read-only mode.

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

ShowDialogButtonContent

Gets or sets the content of the show dialog button.

Declaration
public object ShowDialogButtonContent { get; set; }
Property Value
System.Object

ShowDialogButtonTemplate

Gets or sets the content template of the show dialog button.

Declaration
public DataTemplate ShowDialogButtonTemplate { get; set; }
Property Value
System.Windows.DataTemplate

Text

Gets or sets the text of the textbox. If the text is a valid file / folder path, FilePath property will be updated. Otherwise FilePath is set to empty string.

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

WatermarkContent

Gets or sets the content to be shown when the TextBox is empty and not focused.

Declaration
public object WatermarkContent { get; set; }
Property Value
System.Object

WatermarkTemplate

Gets or sets the template for presenting the content, shown when the TextBox is empty and not focused.

Declaration
public DataTemplate WatermarkTemplate { get; set; }
Property Value
System.Windows.DataTemplate

Methods

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

OnFilePathChanged()

Called when FilePath property is changed.

Declaration
protected virtual void OnFilePathChanged()

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

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

The System.Windows.RoutedEventArgs that contains the event data.

OnShowDialog()

Called when the file dialog is about to be opened.

Declaration
protected virtual void OnShowDialog()

ShowDialog()

Opens the file / folder dialog for choosing a file path.

Declaration
public void ShowDialog()

Events

DialogClosed

Occurs when the file dialog is closed.

Declaration
public event EventHandler<WindowClosedEventArgs> DialogClosed
Event Type
System.EventHandler<WindowClosedEventArgs>

DialogOpening

Occurs when the file dialog for is about to be opened.

Declaration
public event EventHandler<DialogOpeningEventArgs> DialogOpening
Event Type
System.EventHandler<DialogOpeningEventArgs>

FilePathChanged

Occurs when a new valid file path is selected via file browser, via typing or via programmatic change of the property FilePath.

Declaration
public event EventHandler<FilePathChangedEventArgs> FilePathChanged
Event Type
System.EventHandler<FilePathChangedEventArgs>

FilePathChanging

Occurs when a new file path is about to be selected. User can cancel it and / or override its ImageSource used for the file path icon.

Declaration
public event EventHandler<FilePathChangingEventArgs> FilePathChanging
Event Type
System.EventHandler<FilePathChangingEventArgs>

Extension Methods