ClassEditableHeaderedItemsControl
A base class for the editable headered items control. The does not include all the editable logic and needs to be inherited.
Definition
Namespace:Telerik.Windows.Controls.TreeView
Assembly:Telerik.Windows.Controls.Navigation.dll
Syntax:
public abstract class EditableHeaderedItemsControl : HeaderedItemsControlInheritance: objectEditableHeaderedItemsControl
Derived Classes:
Constructors
EditableHeaderedItemsControl()
Declaration
protected EditableHeaderedItemsControl()Fields
EditCanceledEvent
Identifies the EditCanceled routed event.
Declaration
public static readonly RoutedEvent EditCanceledEventField Value
RoutedEvent
EditStartedEvent
Identifies the EditStarted routed event.
Declaration
public static readonly RoutedEvent EditStartedEventField Value
RoutedEvent
EditedEvent
Identifies the Edit routed event.
Declaration
public static readonly RoutedEvent EditedEventField Value
RoutedEvent
EditorPrepareEvent
Identifies the EditorPrepare routed event.
Declaration
public static readonly RoutedEvent EditorPrepareEventField Value
RoutedEvent
HeaderEditTemplateProperty
Identifies the HeaderEditTemplate dependency property.
Declaration
public static readonly DependencyProperty HeaderEditTemplatePropertyField Value
DependencyProperty
HeaderEditTemplateSelectorProperty
Identifies the HeaderEditTemplate dependency property.
Declaration
public static readonly DependencyProperty HeaderEditTemplateSelectorPropertyField Value
DependencyProperty
IsEditableProperty
Identifies the IsEditable dependency property.
Declaration
public static readonly DependencyProperty IsEditablePropertyField Value
DependencyProperty
IsInEditModeProperty
Identifies the IsInEditMode dependency property.
Declaration
public static readonly DependencyProperty IsInEditModePropertyField Value
DependencyProperty
PreviewEditCanceledEvent
Identifies the EditCanceled routed event.
Declaration
public static readonly RoutedEvent PreviewEditCanceledEventField Value
RoutedEvent
PreviewEditStartedEvent
Identifies the PreviewEditStarted routed event.
Declaration
public static readonly RoutedEvent PreviewEditStartedEventField Value
RoutedEvent
PreviewEditedEvent
Identifies the PreviewEdited routed event.
Declaration
public static readonly RoutedEvent PreviewEditedEventField Value
RoutedEvent
PreviewEditorPrepareEvent
Identifies the PreviewEditorPrepare routed event.
Declaration
public static readonly RoutedEvent PreviewEditorPrepareEventField Value
RoutedEvent
Properties
HeaderEditPresenterElement
Gets the content presenter used for editing.
Declaration
protected ContentPresenter HeaderEditPresenterElement { get; }Property Value
ContentPresenter
HeaderEditTemplate
Gets or sets the header edit template.
Declaration
public DataTemplate HeaderEditTemplate { get; set; }Property Value
DataTemplate
The header edit template.
HeaderEditTemplateSelector
Gets or sets the header edit template selector.
Declaration
public DataTemplateSelector HeaderEditTemplateSelector { get; set; }Property Value
DataTemplateSelector
The header edit template selector.
IsEditable
Gets or sets a value indicating whether the control is editable.
IsInEditMode
Gets or sets a value indicating whether this instance is in edit mode.
Declaration
public bool IsInEditMode { get; set; }Property Value
True if this instance is in edit mode, otherwise false.
Methods
AddEditCanceledHandler(UIElement, RadTreeViewItemEditedEventHandler)
Adds a handler for the EditCanceled routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void AddEditCanceledHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)Parameters
target
UIElement
The element to add a handler to.
handler
RadTreeViewItemEditedEventHandler
The routed event handler.
AddEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)
Adds a handler for the EditStarted routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void AddEditStartedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)Parameters
target
UIElement
The element to add a handler to.
handler
RadTreeViewItemEditedEventHandler
The routed event handler.
AddEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)
Adds a handler for the Edited routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void AddEditedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)Parameters
target
UIElement
The element to add a handler to.
handler
RadTreeViewItemEditedEventHandler
The routed event handler.
AddEditorPrepareHandler(UIElement, EditorPrepareEventHandler)
Removes a handler for the EditorPrepare routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void AddEditorPrepareHandler(UIElement target, EditorPrepareEventHandler handler)Parameters
target
UIElement
The element to remove handler from.
handler
The handler to be removed.
AddPreviewEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)
Adds a handler for the PreviewEditStarted routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void AddPreviewEditStartedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)Parameters
target
UIElement
The element to add a handler to.
handler
RadTreeViewItemEditedEventHandler
The routed event handler.
AddPreviewEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)
Adds a handler for the PreviewEdited routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void AddPreviewEditedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)Parameters
target
UIElement
The element to add a handler to.
handler
RadTreeViewItemEditedEventHandler
The routed event handler.
AddPreviewEditorPrepareHandler(UIElement, EditorPrepareEventHandler)
Adds a handler for the PreviewEditorPrepare routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void AddPreviewEditorPrepareHandler(UIElement target, EditorPrepareEventHandler handler)Parameters
target
UIElement
The element to add a handler to.
handler
The routed event handler.
BeginEdit()
Entry point for editing.
Declaration
public virtual bool BeginEdit()Returns
Returns true if editing can begin.
CancelEdit()
Tries to cancel editing.
Declaration
public virtual bool CancelEdit()Returns
Returns true if successful, false otherwise.
ChangeVisualState(bool)
Updates the visual states of the control.
Declaration
protected virtual void ChangeVisualState(bool useTransitions)Parameters
useTransitions
Specifies whether transitions should be used.
CommitEdit()
Tries to Commit edit.
Declaration
public virtual bool CommitEdit()Returns
Returns true if successful, false otherwise.
GetEditValue()
Extracts a value that will be edited. This is normally the header of the control.
Declaration
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate", Justification = "This may be an expensive operation, better leave it as a method")]
protected virtual object GetEditValue()Returns
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 event.
Declaration
protected virtual bool OnEditCanceled(RadTreeViewItemEditedEventArgs e)Parameters
e
RadTreeViewItemEditedEventArgs
The event data.
Returns
OnEditStarted(RadTreeViewItemEditedEventArgs)
Raises the event.
Declaration
protected virtual void OnEditStarted(RadTreeViewItemEditedEventArgs e)Parameters
e
RadTreeViewItemEditedEventArgs
The RadTreeViewItemEditedEventArgs instance containing the event data.
OnEdited(RadTreeViewItemEditedEventArgs)
Raises the event.
Declaration
protected virtual void OnEdited(RadTreeViewItemEditedEventArgs e)Parameters
e
RadTreeViewItemEditedEventArgs
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
e
The arguments for the event.
OnHeaderEditTemplateChanged(DataTemplate, DataTemplate)
Called when the HeaderEditTemplate changes.
Declaration
protected virtual void OnHeaderEditTemplateChanged(DataTemplate oldTemplate, DataTemplate newTemplate)Parameters
oldTemplate
DataTemplate
The old HeaderEditTemplate.
newTemplate
DataTemplate
The new HeaderEditTemplate.
OnHeaderEditTemplateSelectorChanged(DataTemplateSelector, DataTemplateSelector)
Called when the HeaderEditTemplateSelector changes.
Declaration
protected virtual void OnHeaderEditTemplateSelectorChanged(DataTemplateSelector oldTemplateSelector, DataTemplateSelector newTemplateSelector)Parameters
oldTemplateSelector
DataTemplateSelector
The old HeaderEditTemplateSelector.
newTemplateSelector
DataTemplateSelector
The new HeaderEditTemplateSelector.
OnIsInEditModeChanged(bool, bool)
Called when the value of the IsInEditMode property changes.
OnPreviewEditCanceled(RadTreeViewItemEditedEventArgs)
Raises the event.
Declaration
protected virtual bool OnPreviewEditCanceled(RadTreeViewItemEditedEventArgs e)Parameters
e
RadTreeViewItemEditedEventArgs
The the event data.
Returns
OnPreviewEditStarted(RadTreeViewItemEditedEventArgs)
Raises the event.
Declaration
protected virtual bool OnPreviewEditStarted(RadTreeViewItemEditedEventArgs e)Parameters
e
RadTreeViewItemEditedEventArgs
The RadTreeViewItemEditedEventArgs instance containing the event data.
Returns
OnPreviewEdited(RadTreeViewItemEditedEventArgs)
Raises the event.
Declaration
protected virtual bool OnPreviewEdited(RadTreeViewItemEditedEventArgs e)Parameters
e
RadTreeViewItemEditedEventArgs
The RadTreeViewItemEditedEventArgs instance containing the event data.
Returns
OnPreviewEditorPrepare(EditorPrepareEventArgs)
Called when the PreviewEditorPrepare event is raised.
Declaration
protected virtual void OnPreviewEditorPrepare(EditorPrepareEventArgs e)Parameters
e
The event arguments.
PrepareEditor(RadTreeViewItemEditedEventArgs)
Called when the editor for the edit operation is begin prepared.
Declaration
protected virtual void PrepareEditor(RadTreeViewItemEditedEventArgs e)Parameters
e
RadTreeViewItemEditedEventArgs
The arguments for the event.
RemoveEditCanceledHandler(UIElement, RadTreeViewItemEditedEventHandler)
Removes a handler for the EditCanceled routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void RemoveEditCanceledHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)Parameters
target
UIElement
The element to remove handler from.
handler
RadTreeViewItemEditedEventHandler
The handler to be removed.
RemoveEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)
Removes a handler for the EditStarted routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void RemoveEditStartedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)Parameters
target
UIElement
The element to remove handler from.
handler
RadTreeViewItemEditedEventHandler
The handler to be removed.
RemoveEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)
Removes a handler for the Edited routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void RemoveEditedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)Parameters
target
UIElement
The element to remove handler from.
handler
RadTreeViewItemEditedEventHandler
The handler to be removed.
RemoveEditorPrepareHandler(UIElement, EditorPrepareEventHandler)
Removes a handler for the EditorPrepare routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void RemoveEditorPrepareHandler(UIElement target, EditorPrepareEventHandler handler)Parameters
target
UIElement
The element to remove handler from.
handler
The handler to be removed.
RemovePreviewEditStartedHandler(UIElement, RadTreeViewItemEditedEventHandler)
Removes a handler for the PreviewEditStarted routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void RemovePreviewEditStartedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)Parameters
target
UIElement
The element to remove handler from.
handler
RadTreeViewItemEditedEventHandler
The handler to be removed.
RemovePreviewEditedHandler(UIElement, RadTreeViewItemEditedEventHandler)
Removes a handler for the PreviewEdited routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void RemovePreviewEditedHandler(UIElement target, RadTreeViewItemEditedEventHandler handler)Parameters
target
UIElement
The element to remove handler from.
handler
RadTreeViewItemEditedEventHandler
The handler to be removed.
RemovePreviewEditorPrepareHandler(UIElement, EditorPrepareEventHandler)
Removes a handler for the PreviewEditorPrepare routed event.
Declaration
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")]
public static void RemovePreviewEditorPrepareHandler(UIElement target, EditorPrepareEventHandler handler)Parameters
target
UIElement
The element to remove handler from.
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
editValue
The new value.
Events
EditCanceled
Occurs after an edit has been cancelled.
Declaration
public event RadTreeViewItemEditedEventHandler EditCanceledEvent Value
EditStarted
Occurs after edit of the control has started.
Declaration
public event RadTreeViewItemEditedEventHandler EditStartedEvent Value
Edited
Occurs when a item has been edited.
Declaration
public event RadTreeViewItemEditedEventHandler EditedEvent Value
EditorPrepare
The event is raised when an editor needs to be prepared.
Declaration
public event EditorPrepareEventHandler EditorPrepareEvent Value
PreviewEditCanceled
Occurs just before an edit has been cancelled.
Declaration
public event RadTreeViewItemEditedEventHandler PreviewEditCanceledEvent Value
PreviewEditStarted
Occurs before the edit has begun.
Declaration
public event RadTreeViewItemEditedEventHandler PreviewEditStartedEvent Value
PreviewEdited
Occurs before the edit is committed.
Declaration
public event RadTreeViewItemEditedEventHandler PreviewEditedEvent Value
PreviewEditorPrepare
Raised before an editor for an edit operation needs to be prepared.
Declaration
public event EditorPrepareEventHandler PreviewEditorPrepareEvent Value