public class RadDataFilterElement : RadTreeViewElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, IDataItemSource

Constructors

RadDataFilterElement()

Declaration

public RadDataFilterElement()

Fields

currentNodeEditorType

Declaration

protected Type currentNodeEditorType

Field Value

System.Type

Properties

AllowAdd

Gets or sets a value indicating whether [allow edit].

Declaration

public override bool AllowAdd { get; set; }

Property Value

System.Boolean `true` if [allow edit]; otherwise, `false`.

Overrides

RadTreeViewElement.AllowAdd

AllowAlternatingRowColor

Declaration

public override bool AllowAlternatingRowColor { get; set; }

Property Value

System.Boolean

Overrides

RadTreeViewElement.AllowAlternatingRowColor

AllowArbitraryItemHeight

Declaration

public override bool AllowArbitraryItemHeight { get; set; }

Property Value

System.Boolean

Overrides

RadTreeViewElement.AllowArbitraryItemHeight

AllowDragDrop

Gets or sets a value indicating whether [allow drag drop].

Declaration

public override bool AllowDragDrop { get; set; }

Property Value

System.Boolean `true` if [allow drag drop]; otherwise, `false`.

Overrides

RadTreeViewElement.AllowDragDrop

AllowRemove

Gets or sets a value indicating whether [allow edit].

Declaration

public override bool AllowRemove { get; set; }

Property Value

System.Boolean `true` if [allow edit]; otherwise, `false`.

Overrides

RadTreeViewElement.AllowRemove

AlternatingRowColor

Declaration

public override Color AlternatingRowColor { get; set; }

Property Value

System.Drawing.Color

Overrides

RadTreeViewElement.AlternatingRowColor

AutoCheckChildNodes

Declaration

public override bool AutoCheckChildNodes { get; set; }

Property Value

System.Boolean

Overrides

RadTreeViewElement.AutoCheckChildNodes

AutoGenerateDescriptorItems

Gets or sets the auto generate descriptor items.

Declaration

public bool AutoGenerateDescriptorItems { get; set; }

Property Value

System.Boolean The auto generate descriptor items.

CheckBoxes

Declaration

public override bool CheckBoxes { get; set; }

Property Value

System.Boolean

Overrides

RadTreeViewElement.CheckBoxes

CheckedMember

Declaration

public override string CheckedMember { get; set; }

Property Value

System.String

Overrides

RadTreeViewElement.CheckedMember

CheckedNodes

Declaration

public override CheckedTreeNodeCollection CheckedNodes { get; }

Property Value

CheckedTreeNodeCollection

Overrides

RadTreeViewElement.CheckedNodes

ChildMember

Declaration

public override string ChildMember { get; set; }

Property Value

System.String

Overrides

RadTreeViewElement.ChildMember

DataMember

Declaration

public override string DataMember { get; set; }

Property Value

System.String

Overrides

RadTreeViewElement.DataMember

DataSource

Gets or sets the data source that the RadDataFilter is displaying filters for.

Declaration

public override object DataSource { get; set; }

Property Value

System.Object

Overrides

RadTreeViewElement.DataSource

DefaultCustomDateEditorFormat

Gets or sets the default custom date editor format.

Declaration

public string DefaultCustomDateEditorFormat { get; set; }

Property Value

System.String The default custom date editor format.

DefaultDateEditorFormat

Gets or sets the default date editor format.

Declaration

public DateTimePickerFormat DefaultDateEditorFormat { get; set; }

Property Value

System.Windows.Forms.DateTimePickerFormat The default date editor format.

Descriptors

A collection of descriptor items used to identify the property names and their corresponding types.

Declaration

public DataFilterItemOwnerCollection Descriptors { get; }

Property Value

DataFilterItemOwnerCollection

DisplayMember

Declaration

public override string DisplayMember { get; set; }

Property Value

System.String

Overrides

RadTreeViewElement.DisplayMember

EditMode

Declaration

public override TreeNodeEditMode EditMode { get; set; }

Property Value

TreeNodeEditMode

Overrides

RadTreeViewElement.EditMode

Expression

Gets or sets the expression.

Declaration

public virtual string Expression { get; set; }

Property Value

System.String The expression.

FieldNamesSortStyle

Gets or sets a value indicating how the field names are sorted when SortFieldNames is true.

Declaration

public SortStyle FieldNamesSortStyle { get; set; }

Property Value

SortStyle

Filter

Declaration

public override object Filter { get; set; }

Property Value

System.Object

Overrides

RadTreeViewElement.Filter

FilterDescriptors

Declaration

public override FilterDescriptorCollection FilterDescriptors { get; }

Property Value

FilterDescriptorCollection

Overrides

RadTreeViewElement.FilterDescriptors

FilterPredicate

Declaration

public override Predicate<RadTreeNode> FilterPredicate { get; set; }

Property Value

System.Predicate<RadTreeNode>

Overrides

RadTreeViewElement.FilterPredicate

FindStringComparer

Declaration

public override IFindStringComparer FindStringComparer { get; set; }

Property Value

IFindStringComparer

Overrides

RadTreeViewElement.FindStringComparer

FullRowSelect

Declaration

public override bool FullRowSelect { get; set; }

Property Value

System.Boolean

Overrides

RadTreeViewElement.FullRowSelect

HideSelection

Declaration

public override bool HideSelection { get; set; }

Property Value

System.Boolean

Overrides

RadTreeViewElement.HideSelection

HotTracking

Declaration

public override bool HotTracking { get; set; }

Property Value

System.Boolean

Overrides

RadTreeViewElement.HotTracking

ImageIndex

Declaration

public override int ImageIndex { get; set; }

Property Value

System.Int32

Overrides

RadTreeViewElement.ImageIndex

ImageKey

Declaration

public override string ImageKey { get; set; }

Property Value

System.String

Overrides

RadTreeViewElement.ImageKey

KeyboardSearchEnabled

Declaration

public override bool KeyboardSearchEnabled { get; set; }

Property Value

System.Boolean

Overrides

RadTreeViewElement.KeyboardSearchEnabled

KeyboardSearchResetInterval

Declaration

public override int KeyboardSearchResetInterval { get; set; }

Property Value

System.Int32

Overrides

RadTreeViewElement.KeyboardSearchResetInterval

MultiSelect

Declaration

public override bool MultiSelect { get; set; }

Property Value

System.Boolean

Overrides

RadTreeViewElement.MultiSelect

ParentMember

Declaration

public override string ParentMember { get; set; }

Property Value

System.String

Overrides

RadTreeViewElement.ParentMember

PathSeparator

Declaration

public override string PathSeparator { get; set; }

Property Value

System.String

Overrides

RadTreeViewElement.PathSeparator

Provider

Gets or sets the provider.

Declaration

public IDataFilterProvider Provider { get; set; }

Property Value

IDataFilterProvider The provider.

SelectedNode

Declaration

public override RadTreeNode SelectedNode { get; set; }

Property Value

RadTreeNode

Overrides

RadTreeViewElement.SelectedNode

SelectedNodes

Declaration

public override SelectedTreeNodeCollection SelectedNodes { get; }

Property Value

SelectedTreeNodeCollection

Overrides

RadTreeViewElement.SelectedNodes

SortFieldNames

Gets or sets a value indicating whether the name of fields in fields drop down should be sorted.

Declaration

public bool SortFieldNames { get; set; }

Property Value

System.Boolean

TimeSpanEditorFormat

Gets or sets the format of TimeSpan editor.

Declaration

public string TimeSpanEditorFormat { get; set; }

Property Value

System.String The timespan editor format.

TriStateMode

Declaration

public override bool TriStateMode { get; set; }

Property Value

System.Boolean

Overrides

RadTreeViewElement.TriStateMode

ValueMember

Declaration

public override string ValueMember { get; set; }

Property Value

System.String

Overrides

RadTreeViewElement.ValueMember

Methods

AddChildNodes(FilterDescriptor, RadTreeNode)

Adds child nodes, based on the given filter descriptor and its child descriptors.

Declaration

public void AddChildNodes(FilterDescriptor filter, RadTreeNode node)

Parameters

FilterDescriptor filter The filter.
RadTreeNode node The node, that will be the parent of created nodes.

AddChildNodes(FilterDescriptor, RadTreeNode, Boolean)

Declaration

public void AddChildNodes(FilterDescriptor filter, RadTreeNode node, bool updateDescriptors)

Parameters

FilterDescriptor filter
RadTreeNode node
System.Boolean updateDescriptors

AddDescriptorsFromProvider()

Declaration

protected virtual void AddDescriptorsFromProvider()

AddNodeByPath(String)

Declaration

public override RadTreeNode AddNodeByPath(string path)

Parameters

System.String path

Returns

RadTreeNode

Overrides

RadTreeViewElement.AddNodeByPath(String)

AddNodeByPath(String, String)

Declaration

public override RadTreeNode AddNodeByPath(string path, string pathSeparator)

Parameters

System.String path
System.String pathSeparator

Returns

RadTreeNode

Overrides

RadTreeViewElement.AddNodeByPath(String, String)

ApplyFilter()

Applies the filter to the DataSource.

Declaration

public void ApplyFilter()

BeginEdit()

Puts the current node in edit mode.

Declaration

public override bool BeginEdit()

Returns

System.Boolean

Overrides

RadTreeViewElement.BeginEdit()

BuildTree()

Builds the tree based on the collection of filter descriptors.

Declaration

protected virtual void BuildTree()

ClearChildNodes(DataFilterGroupNode)

Clears the child nodes of given group node.

Declaration

public void ClearChildNodes(DataFilterGroupNode node)

Parameters

DataFilterGroupNode node The node.

ClearSelection()

Declaration

public override void ClearSelection()

Overrides

RadTreeViewElement.ClearSelection()

CreateAddNode()

Declaration

protected virtual DataFilterAddNode CreateAddNode()

Returns

DataFilterAddNode

CreateCriteriaNode()

Declaration

protected virtual DataFilterCriteriaNode CreateCriteriaNode()

Returns

DataFilterCriteriaNode

CreateDragDropService()

Declaration

protected override TreeViewDragDropService CreateDragDropService()

Returns

TreeViewDragDropService

Overrides

RadTreeViewElement.CreateDragDropService()

CreateElementProvider()

Declaration

protected override IVirtualizedElementProvider<RadTreeNode> CreateElementProvider()

Returns

IVirtualizedElementProvider<RadTreeNode>

Overrides

RadTreeViewElement.CreateElementProvider()

CreateGroupNode()

Declaration

protected virtual DataFilterGroupNode CreateGroupNode()

Returns

DataFilterGroupNode

DisposeManagedResources()

Declaration

protected override void DisposeManagedResources()

Overrides

RadTreeViewElement.DisposeManagedResources()

EndEditCore(Boolean)

Declaration

protected override bool EndEditCore(bool commitChanges)

Parameters

System.Boolean commitChanges

Returns

System.Boolean

Overrides

RadTreeViewElement.EndEditCore(Boolean)

EndInit()

Ends the init.

Declaration

public override void EndInit()

Overrides

RadTreeViewElement.EndInit()

EnsureNodeVisibleHorizontal(RadTreeNode, TreeNodeElement)

Declaration

protected override void EnsureNodeVisibleHorizontal(RadTreeNode node, TreeNodeElement nodeElement)

Parameters

RadTreeNode node
TreeNodeElement nodeElement

Overrides

RadTreeViewElement.EnsureNodeVisibleHorizontal(RadTreeNode, TreeNodeElement)

Find(String)

Declaration

public override RadTreeNode Find(string text)

Parameters

System.String text

Returns

RadTreeNode

Overrides

RadTreeViewElement.Find(String)

FindNodes(String)

Declaration

public override RadTreeNode[] FindNodes(string text)

Parameters

System.String text

Returns

RadTreeNode[]

Overrides

RadTreeViewElement.FindNodes(String)

GetDefaultPropertyName()

Gets the default name of field property.

Declaration

protected virtual string GetDefaultPropertyName()

Returns

System.String

GetDescriptorItemByName(String)

Declaration

protected virtual DataFilterDescriptorItem GetDescriptorItemByName(string name)

Parameters

System.String name

Returns

DataFilterDescriptorItem

GetEditor(Type)

Gets the editor.

Declaration

protected override IInputEditor GetEditor(Type editorType)

Parameters

System.Type editorType Type of the editor.

Returns

IInputEditor

Overrides

RadTreeViewElement.GetEditor(Type)

GetEditorType(Type)

Gets the type of the editor.

Declaration

public virtual Type GetEditorType(Type valueType)

Parameters

System.Type valueType Type of the value.

Returns

System.Type

GetFieldNames()

Gets the field names.

Declaration

public IEnumerable<string> GetFieldNames()

Returns

System.Collections.Generic.IEnumerable<System.String>

GetFieldType(String)

Gets the type of the field by given property name.

Declaration

public virtual Type GetFieldType(string propertyName)

Parameters

System.String propertyName Name of the property.

Returns

System.Type

GetNodeByPath(String)

Declaration

public override RadTreeNode GetNodeByPath(string path)

Parameters

System.String path

Returns

RadTreeNode

Overrides

RadTreeViewElement.GetNodeByPath(String)

GetNodeByPath(String, String)

Declaration

public override RadTreeNode GetNodeByPath(string path, string pathSeparator)

Parameters

System.String path
System.String pathSeparator

Returns

RadTreeNode

Overrides

RadTreeViewElement.GetNodeByPath(String, String)

InitializeDefaultContextMenu(RadTreeNode)

Declaration

protected override RadContextMenu InitializeDefaultContextMenu(RadTreeNode node)

Parameters

RadTreeNode node

Returns

RadContextMenu

Overrides

RadTreeViewElement.InitializeDefaultContextMenu(RadTreeNode)

InitializeEditor(Type, IValueEditor)

Initializes the editor.

Declaration

protected virtual void InitializeEditor(Type valueType, IValueEditor editor)

Parameters

System.Type valueType Type of the value.
IValueEditor editor The editor.

InitializeFieldEditor(IInputEditor, DataFilterCriteriaElement)

Declaration

protected virtual void InitializeFieldEditor(IInputEditor editor, DataFilterCriteriaElement editingElement)

Parameters

IInputEditor editor
DataFilterCriteriaElement editingElement

InitializeFields()

Declaration

protected override void InitializeFields()

Overrides

RadTreeViewElement.InitializeFields()

InitializeOperatorEditor(IInputEditor, DataFilterCriteriaElement)

Declaration

protected virtual void InitializeOperatorEditor(IInputEditor editor, DataFilterCriteriaElement editingElement)

Parameters

IInputEditor editor
DataFilterCriteriaElement editingElement

InitializeSpinEditor(TreeViewSpinEditor, Type)

Initializes the spin editor.

Declaration

protected virtual void InitializeSpinEditor(TreeViewSpinEditor spinEditor, Type valueType)

Parameters

TreeViewSpinEditor spinEditor The spin editor.
System.Type valueType Type of the value.

InitializeValueEditor(IInputEditor, DataFilterCriteriaElement)

Declaration

protected virtual void InitializeValueEditor(IInputEditor editor, DataFilterCriteriaElement editingElement)

Parameters

IInputEditor editor
DataFilterCriteriaElement editingElement

NormalizeChildDescriptor(CompositeFilterDescriptor)

Normalizes the child descriptor.

Declaration

protected virtual void NormalizeChildDescriptor(CompositeFilterDescriptor compositeDescriptor)

Parameters

CompositeFilterDescriptor compositeDescriptor The composite descriptor.

NormalizeExpression()

Normalizes the expression.

Declaration

protected virtual void NormalizeExpression()

OnDragEnded(RadTreeViewDragEventArgs)

Declaration

protected override void OnDragEnded(RadTreeViewDragEventArgs e)

Parameters

RadTreeViewDragEventArgs e

Overrides

RadTreeViewElement.OnDragEnded(RadTreeViewDragEventArgs)

OnEditing(Object, TreeNodeEditingEventArgs)

Raises the Editing event.

Declaration

protected override void OnEditing(object sender, TreeNodeEditingEventArgs e)

Parameters

System.Object sender The sender.
TreeNodeEditingEventArgs e The TreeNodeEditingEventArgs instance containing the event data.

Overrides

RadTreeViewElement.OnEditing(Object, TreeNodeEditingEventArgs)

OnEditorRequired(Object, TreeNodeEditorRequiredEventArgs)

Called when [editor required].

Declaration

protected override void OnEditorRequired(object sender, TreeNodeEditorRequiredEventArgs e)

Parameters

System.Object sender The sender.
TreeNodeEditorRequiredEventArgs e The TreeNodeEditorRequiredEventArgs instance containing the event data.

Overrides

RadTreeViewElement.OnEditorRequired(Object, TreeNodeEditorRequiredEventArgs)

OnLoaded()

Declaration

protected override void OnLoaded()

Overrides

RadTreeViewElement.OnLoaded()

OnNodeCheckedChanged(TreeNodeCheckedEventArgs)

Declaration

protected override void OnNodeCheckedChanged(TreeNodeCheckedEventArgs e)

Parameters

TreeNodeCheckedEventArgs e

Overrides

RadTreeViewElement.OnNodeCheckedChanged(TreeNodeCheckedEventArgs)

OnNodeCheckedChanging(RadTreeViewCancelEventArgs)

Declaration

protected override void OnNodeCheckedChanging(RadTreeViewCancelEventArgs e)

Parameters

RadTreeViewCancelEventArgs e

Overrides

RadTreeViewElement.OnNodeCheckedChanging(RadTreeViewCancelEventArgs)

OnNodeRemoving(RadTreeViewCancelEventArgs)

Declaration

protected override void OnNodeRemoving(RadTreeViewCancelEventArgs e)

Parameters

RadTreeViewCancelEventArgs e

Overrides

RadTreeViewElement.OnNodeRemoving(RadTreeViewCancelEventArgs)

OnPropertyDisplayNameNeeded(Object, PropertyDisplayNameNeededEventArgs)

Fires the PropertyDisplayNameNeeded event.

Declaration

protected virtual void OnPropertyDisplayNameNeeded(object sender, PropertyDisplayNameNeededEventArgs e)

Parameters

System.Object sender
PropertyDisplayNameNeededEventArgs e

OnSelectedNodeChanged(RadTreeViewEventArgs)

Declaration

protected override void OnSelectedNodeChanged(RadTreeViewEventArgs args)

Parameters

RadTreeViewEventArgs args

Overrides

RadTreeViewElement.OnSelectedNodeChanged(RadTreeViewEventArgs)

OnSelectedNodeChanging(RadTreeViewCancelEventArgs)

Declaration

protected override void OnSelectedNodeChanging(RadTreeViewCancelEventArgs args)

Parameters

RadTreeViewCancelEventArgs args

Overrides

RadTreeViewElement.OnSelectedNodeChanging(RadTreeViewCancelEventArgs)

OnSelectedNodesChanged(RadTreeNode)

Declaration

protected override void OnSelectedNodesChanged(RadTreeNode node)

Parameters

RadTreeNode node

Overrides

RadTreeViewElement.OnSelectedNodesChanged(RadTreeNode)

OnSelectedNodesCleared()

Declaration

protected override void OnSelectedNodesCleared()

Overrides

RadTreeViewElement.OnSelectedNodesCleared()

RemoveChildNode(RadTreeNode)

Removes the child node.

Declaration

public void RemoveChildNode(RadTreeNode nodeToRemove)

Parameters

RadTreeNode nodeToRemove The node to remove.

RemoveChildNode(RadTreeNode, RadTreeNode)

Removes the child node.

Declaration

public void RemoveChildNode(RadTreeNode node, RadTreeNode childNode)

Parameters

RadTreeNode node The parent node.
RadTreeNode childNode The child node.

SaveEditorValue(TreeNodeElement, Object)

Saves the editor value.

Declaration

protected override void SaveEditorValue(TreeNodeElement nodeElement, object newValue)

Parameters

TreeNodeElement nodeElement The node element.
System.Object newValue The new value.

Overrides

RadTreeViewElement.SaveEditorValue(TreeNodeElement, Object)

SelectAll()

Declaration

public override void SelectAll()

Overrides

RadTreeViewElement.SelectAll()

SetupDropDownList(DataFilterCriteriaNode, TreeViewDropDownListEditor)

Setups the drop down list.

Declaration

protected virtual object SetupDropDownList(DataFilterCriteriaNode criteriaNode, TreeViewDropDownListEditor editor)

Parameters

DataFilterCriteriaNode criteriaNode The criteria node.
TreeViewDropDownListEditor editor The editor.

Returns

System.Object The display value.

UpdateNodesFromDescriptors()

Updates the nodes collection by removing all the nodes that does not have corresponding property name in the Descriptors collection.

Declaration

public virtual void UpdateNodesFromDescriptors()

ValidateAddNewNode()

Validates if adding new node is allowed.

Declaration

public virtual bool ValidateAddNewNode()

Returns

System.Boolean

Events

NodeCheckedChanged

Declaration

public override event TreeNodeCheckedEventHandler NodeCheckedChanged

Event Type

TreeNodeCheckedEventHandler

Overrides

RadTreeViewElement.NodeCheckedChanged

NodeCheckedChanging

Declaration

public override event RadTreeView.RadTreeViewCancelEventHandler NodeCheckedChanging

Event Type

RadTreeView.RadTreeViewCancelEventHandler

Overrides

RadTreeViewElement.NodeCheckedChanging

PropertyDisplayNameNeeded

Occurs when a property text is about to be displayed on the screen. Allows the developer to substitute property names with user-friendly display strings.

Declaration

public event PropertyDisplayNameNeededEventHandler PropertyDisplayNameNeeded

Event Type

PropertyDisplayNameNeededEventHandler

SelectedNodeChanged

Declaration

public override event RadTreeView.RadTreeViewEventHandler SelectedNodeChanged

Event Type

RadTreeView.RadTreeViewEventHandler

Overrides

RadTreeViewElement.SelectedNodeChanged

SelectedNodeChanging

Declaration

public override event RadTreeView.RadTreeViewCancelEventHandler SelectedNodeChanging

Event Type

RadTreeView.RadTreeViewCancelEventHandler

Overrides

RadTreeViewElement.SelectedNodeChanging

SelectedNodesChanged

Declaration

public override event EventHandler<RadTreeViewEventArgs> SelectedNodesChanged

Event Type

System.EventHandler<RadTreeViewEventArgs>

Overrides

RadTreeViewElement.SelectedNodesChanged

SelectedNodesCleared

Declaration

public override event EventHandler SelectedNodesCleared

Event Type

System.EventHandler

Overrides

RadTreeViewElement.SelectedNodesCleared

Extension Methods

CommonExtensions.ClearIfNoBindingAndSet(RadObject, RadProperty)

DispatcherExtensions.CheckAccess(RadObject)

SerializationExtensions.DeserializePrimitives(RadItem, SerializationInfo)

CommonExtensions.SetIfDifferent(RadObject, RadProperty, Object)

CommonExtensions.ClearIfSet(RadObject, RadProperty)

CommonExtensions.IsLocalValueSet(RadObject, RadProperty)

DispatcherExtensions.CheckAccess(RadObject)

SvgExtentions.Traverse<T>(T, Func<T, IEnumerable<T>>)

SvgExtentions.TraverseDepthFirst<T>(T, Func<T, IEnumerable<T>>)