Class RadDataFilterElement

Represents a data filter element that provides a hierarchical tree view interface for building filter expressions.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
ScrollViewElement<VirtualizedStackContainer<RadTreeNode>>
VirtualizedScrollPanel<RadTreeNode, TreeNodeElement>
RadTreeViewElement
RadDataFilterElement
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 RadDataFilterElement : RadTreeViewElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IDataItemSource

Constructors

RadDataFilterElement()

Initializes a new instance of the RadDataFilterElement class.

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

AllowAlternatingRowColor

This property is not relevant for this class.

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

Overrides

AllowArbitraryItemHeight

This property is not relevant for this class.

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

Overrides

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

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

AlternatingRowColor

This property is not relevant for this class.

Declaration
public override Color AlternatingRowColor { get; set; }
Property Value
System.Drawing.Color

Overrides

AutoCheckChildNodes

This property is not relevant for this class.

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

Overrides

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

This property is not relevant for this class.

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

Overrides

CheckedMember

This property is not relevant for this class.

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

Overrides

CheckedNodes

This property is not relevant for this class.

Declaration
public override CheckedTreeNodeCollection CheckedNodes { get; }
Property Value
CheckedTreeNodeCollection

Overrides

ChildMember

This property is not relevant for this class.

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

Overrides

DataMember

This property is not relevant for this class.

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

Overrides

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

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

This property is not relevant for this class.

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

Overrides

EditMode

This property is not relevant for this class.

Declaration
public override TreeNodeEditMode EditMode { get; set; }
Property Value
TreeNodeEditMode

Overrides

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

This property is not relevant for this class.

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

Overrides

FilterDescriptors

This property is not relevant for this class.

Declaration
public override FilterDescriptorCollection FilterDescriptors { get; }
Property Value
FilterDescriptorCollection

Overrides

FilterPredicate

This property is not relevant for this class.

Declaration
public override Predicate<RadTreeNode> FilterPredicate { get; set; }
Property Value
System.Predicate<RadTreeNode>

Overrides

FindStringComparer

This property is not relevant for this class.

Declaration
public override IFindStringComparer FindStringComparer { get; set; }
Property Value
IFindStringComparer

Overrides

FullRowSelect

This property is not relevant for this class.

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

Overrides

HideSelection

This property is not relevant for this class.

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

Overrides

HotTracking

This property is not relevant for this class.

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

Overrides

ImageIndex

This property is not relevant for this class.

Declaration
public override int ImageIndex { get; set; }
Property Value
System.Int32

Overrides

ImageKey

This property is not relevant for this class.

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

Overrides

KeyboardSearchEnabled

This property is not relevant for this class.

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

Overrides

KeyboardSearchResetInterval

This property is not relevant for this class.

Declaration
public override int KeyboardSearchResetInterval { get; set; }
Property Value
System.Int32

Overrides

MultiSelect

This property is not relevant for this class.

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

Overrides

ParentMember

This property is not relevant for this class.

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

Overrides

PathSeparator

This property is not relevant for this class.

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

Overrides

Provider

Gets or sets the provider.

Declaration
public IDataFilterProvider Provider { get; set; }
Property Value
IDataFilterProvider

The provider.

SelectedNode

This property is not relevant for this class.

Declaration
public override RadTreeNode SelectedNode { get; set; }
Property Value
RadTreeNode

Overrides

SelectedNodes

This property is not relevant for this class.

Declaration
public override SelectedTreeNodeCollection SelectedNodes { get; }
Property Value
SelectedTreeNodeCollection

Overrides

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

This property is not relevant for this class.

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

Overrides

ValueMember

This property is not relevant for this class.

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

Overrides

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)

Adds child nodes based on the given filter descriptor, optionally updating descriptors.

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

The filter descriptor to add as a child node.
RadTreeNode node

The parent node for the new child nodes.
System.Boolean updateDescriptors

A value indicating whether to update the descriptors.

AddDescriptorsFromProvider()

Declaration
protected virtual void AddDescriptorsFromProvider()

AddNodeByPath(String)

Declaration
public override RadTreeNode AddNodeByPath(string path)
Parameters
System.String path

Returns
RadTreeNode

Overrides

AddNodeByPath(String, String)

Declaration
public override RadTreeNode AddNodeByPath(string path, string pathSeparator)
Parameters
System.String path

System.String pathSeparator

Returns
RadTreeNode

Overrides

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

true if editing was successfully started; otherwise, false.
Overrides

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

CreateAddNode()

Creates a new data filter add node that allows adding new filter conditions.

Declaration
protected virtual DataFilterAddNode CreateAddNode()
Returns
DataFilterAddNode

A new DataFilterAddNode instance.

CreateCriteriaNode()

Creates a new data filter criteria node that represents a single filter condition.

Declaration
protected virtual DataFilterCriteriaNode CreateCriteriaNode()
Returns
DataFilterCriteriaNode

A new DataFilterCriteriaNode instance.

CreateDragDropService()

Creates and returns a new instance of the drag drop service for data filter operations.

Declaration
protected override TreeViewDragDropService CreateDragDropService()
Returns
TreeViewDragDropService

A new DataFilterDragDropService instance.
Overrides

CreateElementProvider()

Creates and returns a new instance of the element provider for data filter tree nodes.

Declaration
protected override IVirtualizedElementProvider<RadTreeNode> CreateElementProvider()
Returns
IVirtualizedElementProvider<RadTreeNode>

A new DataFilterElementProvider instance.
Overrides

CreateGroupNode()

Creates a new data filter group node that represents a logical grouping of filter conditions.

Declaration
protected virtual DataFilterGroupNode CreateGroupNode()
Returns
DataFilterGroupNode

A new DataFilterGroupNode instance.

DisposeManagedResources()

Releases all managed resources used by the component.

Declaration
protected override void DisposeManagedResources()
Overrides

EndEditCore(Boolean)

Declaration
protected override bool EndEditCore(bool commitChanges)
Parameters
System.Boolean commitChanges

Returns
System.Boolean

Overrides

EndInit()

Completes the initialization of the component.

Declaration
public override void EndInit()
Overrides

EnsureNodeVisibleHorizontal(RadTreeNode, TreeNodeElement)

Declaration
protected override void EnsureNodeVisibleHorizontal(RadTreeNode node, TreeNodeElement nodeElement)
Parameters
RadTreeNode node

TreeNodeElement nodeElement

Overrides

Find(String)

Declaration
public override RadTreeNode Find(string text)
Parameters
System.String text

Returns
RadTreeNode

Overrides

FindNodes(String)

Declaration
public override RadTreeNode[] FindNodes(string text)
Parameters
System.String text

Returns
RadTreeNode[]

Overrides

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 an editor instance for the specified editor type.

Declaration
protected override IInputEditor GetEditor(Type editorType)
Parameters
System.Type editorType

The type of editor to create.
Returns
IInputEditor

An instance of the specified editor type.
Overrides

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

GetNodeByPath(String, String)

Declaration
public override RadTreeNode GetNodeByPath(string path, string pathSeparator)
Parameters
System.String path

System.String pathSeparator

Returns
RadTreeNode

Overrides

InitializeDefaultContextMenu(RadTreeNode)

Declaration
protected override RadContextMenu InitializeDefaultContextMenu(RadTreeNode node)
Parameters
RadTreeNode node

Returns
RadContextMenu

Overrides

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()

Initializes the fields of this instance to their default values.

Declaration
protected override void InitializeFields()
Overrides

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 a composite filter descriptor by reorganizing its child descriptors.

Declaration
protected virtual void NormalizeChildDescriptor(CompositeFilterDescriptor compositeDescriptor)
Parameters
CompositeFilterDescriptor compositeDescriptor

The composite descriptor to normalize.

NormalizeExpression()

Normalizes the expression by processing composite filter descriptors.

Declaration
protected virtual void NormalizeExpression()

OnDragEnded(RadTreeViewDragEventArgs)

Declaration
protected override void OnDragEnded(RadTreeViewDragEventArgs e)
Parameters
RadTreeViewDragEventArgs e

Overrides

OnEditing(Object, TreeNodeEditingEventArgs)

Raises the editing event for a tree node.

Declaration
protected override void OnEditing(object sender, TreeNodeEditingEventArgs e)
Parameters
System.Object sender

The sender of the event.
TreeNodeEditingEventArgs e

The TreeNodeEditingEventArgs instance containing the event data.
Overrides

OnEditorRequired(Object, TreeNodeEditorRequiredEventArgs)

Called when an editor is required for a tree node element.

Declaration
protected override void OnEditorRequired(object sender, TreeNodeEditorRequiredEventArgs e)
Parameters
System.Object sender

The sender of the event.
TreeNodeEditorRequiredEventArgs e

The TreeNodeEditorRequiredEventArgs instance containing the event data.
Overrides

OnLoaded()

Declaration
protected override void OnLoaded()
Overrides

OnNodeCheckedChanged(TreeNodeCheckedEventArgs)

This method is not relevant for this class.

Declaration
protected override void OnNodeCheckedChanged(TreeNodeCheckedEventArgs e)
Parameters
TreeNodeCheckedEventArgs e

Overrides

OnNodeCheckedChanging(RadTreeViewCancelEventArgs)

Declaration
protected override void OnNodeCheckedChanging(RadTreeViewCancelEventArgs e)
Parameters
RadTreeViewCancelEventArgs e

Overrides

OnNodeRemoving(RadTreeViewCancelEventArgs)

Declaration
protected override void OnNodeRemoving(RadTreeViewCancelEventArgs e)
Parameters
RadTreeViewCancelEventArgs e

Overrides

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

OnSelectedNodeChanging(RadTreeViewCancelEventArgs)

Declaration
protected override void OnSelectedNodeChanging(RadTreeViewCancelEventArgs args)
Parameters
RadTreeViewCancelEventArgs args

Overrides

OnSelectedNodesChanged(RadTreeNode)

Declaration
protected override void OnSelectedNodesChanged(RadTreeNode node)
Parameters
RadTreeNode node

Overrides

OnSelectedNodesCleared()

Declaration
protected override void OnSelectedNodesCleared()
Overrides

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

SelectAll()

Declaration
public override void SelectAll()
Overrides

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

This event is not relevant for this class.

Declaration
public override event TreeNodeCheckedEventHandler NodeCheckedChanged
Event Type
TreeNodeCheckedEventHandler

Overrides

NodeCheckedChanging

Declaration
public override event RadTreeView.RadTreeViewCancelEventHandler NodeCheckedChanging
Event Type
RadTreeView.RadTreeViewCancelEventHandler

Overrides

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

SelectedNodeChanging

Declaration
public override event RadTreeView.RadTreeViewCancelEventHandler SelectedNodeChanging
Event Type
RadTreeView.RadTreeViewCancelEventHandler

Overrides

SelectedNodesChanged

Declaration
public override event EventHandler<RadTreeViewEventArgs> SelectedNodesChanged
Event Type
System.EventHandler<RadTreeViewEventArgs>

Overrides

SelectedNodesCleared

Declaration
public override event EventHandler SelectedNodesCleared
Event Type
System.EventHandler

Overrides

Extension Methods