Class EditableHeaderedItemsControl

A base class for the editable headered items control. The does not include all the editable logic and needs to be inherited.

Inheritance
System.Object
EditableHeaderedItemsControl
RadTreeViewItem
Namespace: Telerik.Windows.Controls.TreeView
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

public abstract class EditableHeaderedItemsControl : HeaderedItemsControl

Constructors

EditableHeaderedItemsControl()

Declaration
protected EditableHeaderedItemsControl()

Fields

EditCanceledEvent

Identifies the EditCanceled routed event.

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

EditedEvent

Identifies the Edit routed event.

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

EditorPrepareEvent

Identifies the EditorPrepare routed event.

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

EditStartedEvent

Identifies the EditStarted routed event.

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

HeaderEditTemplateProperty

Identifies the HeaderEditTemplate dependency property.

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

HeaderEditTemplateSelectorProperty

Identifies the HeaderEditTemplate dependency property.

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

IsEditableProperty

Identifies the IsEditable dependency property.

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

IsInEditModeProperty

Identifies the IsInEditMode dependency property.

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

PreviewEditCanceledEvent

Identifies the EditCanceled routed event.

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

PreviewEditedEvent

Identifies the PreviewEdited routed event.

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

PreviewEditorPrepareEvent

Identifies the PreviewEditorPrepare routed event.

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

PreviewEditStartedEvent

Identifies the PreviewEditStarted routed event.

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

Properties

HeaderEditPresenterElement

Gets the content presenter used for editing.

Declaration
protected ContentPresenter HeaderEditPresenterElement { get; }
Property Value
System.Windows.Controls.ContentPresenter

HeaderEditTemplate

Gets or sets the header edit template.

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

The header edit template.

HeaderEditTemplateSelector

Gets or sets the header edit template selector.

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

The header edit template selector.

IsEditable

Gets or sets a value indicating whether the control is editable.

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

IsInEditMode

Gets or sets a value indicating whether this instance is in edit mode.

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

True if this instance is in edit mode, otherwise false.

Methods

add_EditCanceled(RadTreeViewItemEditedEventHandler)

Declaration
public void add_EditCanceled(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

add_Edited(RadTreeViewItemEditedEventHandler)

Declaration
public void add_Edited(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

add_EditorPrepare(EditorPrepareEventHandler)

Declaration
public void add_EditorPrepare(EditorPrepareEventHandler value)
Parameters
EditorPrepareEventHandler value

add_EditStarted(RadTreeViewItemEditedEventHandler)

Declaration
public void add_EditStarted(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

add_PreviewEditCanceled(RadTreeViewItemEditedEventHandler)

Declaration
public void add_PreviewEditCanceled(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

add_PreviewEdited(RadTreeViewItemEditedEventHandler)

Declaration
public void add_PreviewEdited(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

add_PreviewEditorPrepare(EditorPrepareEventHandler)

Declaration
public void add_PreviewEditorPrepare(EditorPrepareEventHandler value)
Parameters
EditorPrepareEventHandler value

add_PreviewEditStarted(RadTreeViewItemEditedEventHandler)

Declaration
public void add_PreviewEditStarted(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

AddEditCanceledHandler(UIElement, RadTreeViewItemEditedEventHandler)

Adds a handler for the EditCanceled routed event.

Declaration
public static void AddEditCanceledHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)
Parameters
System.Windows.UIElement target

The element to add a handler to.
RadTreeViewItemEditedEventHandler handler

The routed event handler.

AddEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)

Adds a handler for the Edited routed event.

Declaration
public static void AddEditedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)
Parameters
System.Windows.UIElement target

The element to add a handler to.
RadTreeViewItemEditedEventHandler handler

The routed event handler.

AddEditorPrepareHandler(UIElement, EditorPrepareEventHandler)

Removes a handler for the EditorPrepare routed event.

Declaration
public static void AddEditorPrepareHandler(UIElement target, EditorPrepareEventHandler handler)
Parameters
System.Windows.UIElement target

The element to remove handler from.
EditorPrepareEventHandler handler

The handler to be removed.

AddEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)

Adds a handler for the EditStarted routed event.

Declaration
public static void AddEditStartedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)
Parameters
System.Windows.UIElement target

The element to add a handler to.
RadTreeViewItemEditedEventHandler handler

The routed event handler.

AddPreviewEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)

Adds a handler for the PreviewEdited routed event.

Declaration
public static void AddPreviewEditedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)
Parameters
System.Windows.UIElement target

The element to add a handler to.
RadTreeViewItemEditedEventHandler handler

The routed event handler.

AddPreviewEditorPrepareHandler(UIElement, EditorPrepareEventHandler)

Adds a handler for the PreviewEditorPrepare routed event.

Declaration
public static void AddPreviewEditorPrepareHandler(UIElement target, EditorPrepareEventHandler handler)
Parameters
System.Windows.UIElement target

The element to add a handler to.
EditorPrepareEventHandler handler

The routed event handler.

AddPreviewEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)

Adds a handler for the PreviewEditStarted routed event.

Declaration
public static void AddPreviewEditStartedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)
Parameters
System.Windows.UIElement target

The element to add a handler to.
RadTreeViewItemEditedEventHandler handler

The routed event handler.

BeginEdit()

Entry point for editing.

Declaration
public virtual bool BeginEdit()
Returns
System.Boolean

Returns true if editing can begin.

CancelEdit()

Tries to cancel editing.

Declaration
public virtual bool CancelEdit()
Returns
System.Boolean

Returns true if successful, false otherwise.

ChangeVisualState(Boolean)

Updates the visual states of the control.

Declaration
protected virtual void ChangeVisualState(bool useTransitions)
Parameters
System.Boolean useTransitions

Specifies whether transitions should be used.

CommitEdit()

Tries to Commit edit.

Declaration
public virtual bool CommitEdit()
Returns
System.Boolean

Returns true if successful, false otherwise.

GetEditValue()

Extracts a value that will be edited. This is normally the header of the control.

Declaration
protected virtual object GetEditValue()
Returns
System.Object

A value that will be edited.

OnApplyTemplate()

Called when the template of the control is being applied.

Declaration
public override void OnApplyTemplate()

OnEditCanceled(RadTreeViewItemEditedEventArgs)

Raises the EditCanceled event.

Declaration
protected virtual bool OnEditCanceled(RadTreeViewItemEditedEventArgs e)
Parameters
RadTreeViewItemEditedEventArgs e

The event data.
Returns
System.Boolean

OnEdited(RadTreeViewItemEditedEventArgs)

Raises the Edited event.

Declaration
protected virtual void OnEdited(RadTreeViewItemEditedEventArgs e)
Parameters
RadTreeViewItemEditedEventArgs e

The RadTreeViewItemEditedEventArgs instance containing the event data.

OnEditorPrepare(EditorPrepareEventArgs)

Called when the item editor has been prepared.

Declaration
protected virtual void OnEditorPrepare(EditorPrepareEventArgs e)
Parameters
EditorPrepareEventArgs e

The arguments for the event.

OnEditStarted(RadTreeViewItemEditedEventArgs)

Raises the Edited event.

Declaration
protected virtual void OnEditStarted(RadTreeViewItemEditedEventArgs e)
Parameters
RadTreeViewItemEditedEventArgs e

The RadTreeViewItemEditedEventArgs instance containing the event data.

OnHeaderEditTemplateChanged(DataTemplate, DataTemplate)

Called when the HeaderEditTemplate changes.

Declaration
protected virtual void OnHeaderEditTemplateChanged(DataTemplate oldTemplate, DataTemplate newTemplate)
Parameters
System.Windows.DataTemplate oldTemplate

The old HeaderEditTemplate.
System.Windows.DataTemplate newTemplate

The new HeaderEditTemplate.

OnHeaderEditTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)

Called when the HeaderEditTemplateSelector changes.

Declaration
protected virtual void OnHeaderEditTemplateSelectorChanged(DataTemplateSelector oldTemplateSelector, DataTemplateSelector newTemplateSelector)
Parameters
System.Windows.Controls.DataTemplateSelector oldTemplateSelector

The old HeaderEditTemplateSelector.
System.Windows.Controls.DataTemplateSelector newTemplateSelector

The new HeaderEditTemplateSelector.

OnIsInEditModeChanged(Boolean, Boolean)

Called when the value of the IsInEditMode property changes.

Declaration
protected virtual void OnIsInEditModeChanged(bool oldValue, bool newValue)
Parameters
System.Boolean oldValue

System.Boolean newValue

OnPreviewEditCanceled(RadTreeViewItemEditedEventArgs)

Raises the PreviewEditCanceled event.

Declaration
protected virtual bool OnPreviewEditCanceled(RadTreeViewItemEditedEventArgs e)
Parameters
RadTreeViewItemEditedEventArgs e

The the event data.
Returns
System.Boolean

OnPreviewEdited(RadTreeViewItemEditedEventArgs)

Raises the PreviewEdited event.

Declaration
protected virtual bool OnPreviewEdited(RadTreeViewItemEditedEventArgs e)
Parameters
RadTreeViewItemEditedEventArgs e

The RadTreeViewItemEditedEventArgs instance containing the event data.
Returns
System.Boolean

OnPreviewEditorPrepare(EditorPrepareEventArgs)

Called when the PreviewEditorPrepare event is raised.

Declaration
protected virtual void OnPreviewEditorPrepare(EditorPrepareEventArgs e)
Parameters
EditorPrepareEventArgs e

The event arguments.

OnPreviewEditStarted(RadTreeViewItemEditedEventArgs)

Raises the Edited event.

Declaration
protected virtual bool OnPreviewEditStarted(RadTreeViewItemEditedEventArgs e)
Parameters
RadTreeViewItemEditedEventArgs e

The RadTreeViewItemEditedEventArgs instance containing the event data.
Returns
System.Boolean

PrepareEditor(RadTreeViewItemEditedEventArgs)

Called when the editor for the edit operation is begin prepared.

Declaration
protected virtual void PrepareEditor(RadTreeViewItemEditedEventArgs e)
Parameters
RadTreeViewItemEditedEventArgs e

The arguments for the event.

remove_EditCanceled(RadTreeViewItemEditedEventHandler)

Declaration
public void remove_EditCanceled(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

remove_Edited(RadTreeViewItemEditedEventHandler)

Declaration
public void remove_Edited(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

remove_EditorPrepare(EditorPrepareEventHandler)

Declaration
public void remove_EditorPrepare(EditorPrepareEventHandler value)
Parameters
EditorPrepareEventHandler value

remove_EditStarted(RadTreeViewItemEditedEventHandler)

Declaration
public void remove_EditStarted(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

remove_PreviewEditCanceled(RadTreeViewItemEditedEventHandler)

Declaration
public void remove_PreviewEditCanceled(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

remove_PreviewEdited(RadTreeViewItemEditedEventHandler)

Declaration
public void remove_PreviewEdited(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

remove_PreviewEditorPrepare(EditorPrepareEventHandler)

Declaration
public void remove_PreviewEditorPrepare(EditorPrepareEventHandler value)
Parameters
EditorPrepareEventHandler value

remove_PreviewEditStarted(RadTreeViewItemEditedEventHandler)

Declaration
public void remove_PreviewEditStarted(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

RemoveEditCanceledHandler(UIElement, RadTreeViewItemEditedEventHandler)

Removes a handler for the EditCanceled routed event.

Declaration
public static void RemoveEditCanceledHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)
Parameters
System.Windows.UIElement target

The element to remove handler from.
RadTreeViewItemEditedEventHandler handler

The handler to be removed.

RemoveEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)

Removes a handler for the Edited routed event.

Declaration
public static void RemoveEditedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)
Parameters
System.Windows.UIElement target

The element to remove handler from.
RadTreeViewItemEditedEventHandler handler

The handler to be removed.

RemoveEditorPrepareHandler(UIElement, EditorPrepareEventHandler)

Removes a handler for the EditorPrepare routed event.

Declaration
public static void RemoveEditorPrepareHandler(UIElement target, EditorPrepareEventHandler handler)
Parameters
System.Windows.UIElement target

The element to remove handler from.
EditorPrepareEventHandler handler

The handler to be removed.

RemoveEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)

Removes a handler for the EditStarted routed event.

Declaration
public static void RemoveEditStartedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)
Parameters
System.Windows.UIElement target

The element to remove handler from.
RadTreeViewItemEditedEventHandler handler

The handler to be removed.

RemovePreviewEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)

Removes a handler for the PreviewEdited routed event.

Declaration
public static void RemovePreviewEditedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)
Parameters
System.Windows.UIElement target

The element to remove handler from.
RadTreeViewItemEditedEventHandler handler

The handler to be removed.

RemovePreviewEditorPrepareHandler(UIElement, EditorPrepareEventHandler)

Removes a handler for the PreviewEditorPrepare routed event.

Declaration
public static void RemovePreviewEditorPrepareHandler(UIElement target, EditorPrepareEventHandler handler)
Parameters
System.Windows.UIElement target

The element to remove handler from.
EditorPrepareEventHandler handler

The handler to be removed.

RemovePreviewEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)

Removes a handler for the PreviewEditStarted routed event.

Declaration
public static void RemovePreviewEditStartedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)
Parameters
System.Windows.UIElement target

The element to remove handler from.
RadTreeViewItemEditedEventHandler handler

The handler to be removed.

SetEditValue(Object)

Sets the new value after a successful edit. By default it sets the header.

Declaration
protected virtual void SetEditValue(object editValue)
Parameters
System.Object editValue

The new value.

Events

EditCanceled

Occurs after an edit has been cancelled.

Declaration
[ScriptableMember]
public event RadTreeViewItemEditedEventHandler EditCanceled
Event Type
RadTreeViewItemEditedEventHandler

Edited

Occurs when a item has been edited.

Declaration
[ScriptableMember]
public event RadTreeViewItemEditedEventHandler Edited
Event Type
RadTreeViewItemEditedEventHandler

EditorPrepare

The event is raised when an editor needs to be prepared.

Declaration
[ScriptableMember]
public event EditorPrepareEventHandler EditorPrepare
Event Type
EditorPrepareEventHandler

EditStarted

Occurs after edit of the control has started.

Declaration
[ScriptableMember]
public event RadTreeViewItemEditedEventHandler EditStarted
Event Type
RadTreeViewItemEditedEventHandler

PreviewEditCanceled

Occurs just before an edit has been cancelled.

Declaration
[ScriptableMember]
public event RadTreeViewItemEditedEventHandler PreviewEditCanceled
Event Type
RadTreeViewItemEditedEventHandler

PreviewEdited

Occurs before the edit is committed.

Declaration
[ScriptableMember]
public event RadTreeViewItemEditedEventHandler PreviewEdited
Event Type
RadTreeViewItemEditedEventHandler

PreviewEditorPrepare

Raised before an editor for an edit operation needs to be prepared.

Declaration
[ScriptableMember]
public event EditorPrepareEventHandler PreviewEditorPrepare
Event Type
EditorPrepareEventHandler

PreviewEditStarted

Occurs before the edit has begun.

Declaration
[ScriptableMember]
public event RadTreeViewItemEditedEventHandler PreviewEditStarted
Event Type
RadTreeViewItemEditedEventHandler

Extension Methods