Class

RadDataFilterElement

Initializes a new instance of the RadDataFilterElement class.

Declaration

public RadDataFilterElement()

Declaration

protected Type currentNodeEditorType

Field Value

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

Declaration

public override bool AllowAdd { get; set; }

Property Value

Overrides RadTreeViewElement.AllowAdd

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

Declaration

public override bool AllowDragDrop { get; set; }

Property Value

Overrides RadTreeViewElement.AllowDragDrop

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

Declaration

public override bool AllowRemove { get; set; }

Property Value

Overrides RadTreeViewElement.AllowRemove

Gets or sets the auto generate descriptor items.

Declaration

public bool AutoGenerateDescriptorItems { get; set; }

Property Value

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

Declaration

public override object DataSource { get; set; }

Property Value

Overrides RadTreeViewElement.DataSource

Gets or sets the default custom date editor format.

Declaration

public string DefaultCustomDateEditorFormat { get; set; }

Property Value

Gets or sets the default date editor format.

Declaration

public DateTimePickerFormat DefaultDateEditorFormat { get; set; }

Property Value

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

Declaration

public DataFilterItemOwnerCollection Descriptors { get; }

Property Value

Gets or sets the expression.

Declaration

public virtual string Expression { get; set; }

Property Value

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

Declaration

public SortStyle FieldNamesSortStyle { get; set; }

Property Value

Gets or sets the provider.

Declaration

public IDataFilterProvider Provider { get; set; }

Property Value

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

Gets or sets the format of TimeSpan editor.

Declaration

public string TimeSpanEditorFormat { get; set; }

Property Value

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

Declaration

public void AddChildNodes(FilterDescriptor filter, RadTreeNode node)

Parameters

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

Declaration

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

Parameters

Declaration

protected virtual void AddDescriptorsFromProvider()

Applies the filter to the DataSource.

Declaration

public void ApplyFilter()

Puts the current node in edit mode.

Declaration

public override bool BeginEdit()

Returns

Overrides RadTreeViewElement.BeginEdit()

Builds the tree based on the collection of filter descriptors.

Declaration

protected virtual void BuildTree()

Clears the child nodes of given group node.

Declaration

public void ClearChildNodes(DataFilterGroupNode node)

Parameters

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

Declaration

protected virtual DataFilterAddNode CreateAddNode()

Returns

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

Declaration

protected virtual DataFilterCriteriaNode CreateCriteriaNode()

Returns

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

Declaration

protected override TreeViewDragDropService CreateDragDropService()

Returns

Overrides RadTreeViewElement.CreateDragDropService()

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

Declaration

protected override IVirtualizedElementProvider<RadTreeNode> CreateElementProvider()

Returns

Overrides RadTreeViewElement.CreateElementProvider()

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

Declaration

protected virtual DataFilterGroupNode CreateGroupNode()

Returns

Releases all managed resources used by the component.

Declaration

protected override void DisposeManagedResources()

Overrides RadTreeViewElement.DisposeManagedResources()

Declaration

protected override bool EndEditCore(bool commitChanges)

Parameters

Returns

Overrides RadTreeViewElement.EndEditCore(bool)

Completes the initialization of the component.

Declaration

public override void EndInit()

Overrides RadTreeViewElement.EndInit()

Declaration

protected override void EnsureNodeVisibleHorizontal(RadTreeNode node, TreeNodeElement nodeElement)

Parameters

Overrides RadTreeViewElement.EnsureNodeVisibleHorizontal(RadTreeNode, TreeNodeElement)

Gets the default name of field property.

Declaration

protected virtual string GetDefaultPropertyName()

Returns

Declaration

protected virtual DataFilterDescriptorItem GetDescriptorItemByName(string name)

Parameters

Returns

Gets an editor instance for the specified editor type.

Declaration

protected override IInputEditor GetEditor(Type editorType)

Parameters

Returns

Overrides RadTreeViewElement.GetEditor(Type)

Gets the type of the editor.

Declaration

public virtual Type GetEditorType(Type valueType)

Parameters

Returns

Gets the field names.

Declaration

public IEnumerable<string> GetFieldNames()

Returns

Gets the type of the field by given property name.

Declaration

public virtual Type GetFieldType(string propertyName)

Parameters

Returns

Declaration

protected override RadContextMenu InitializeDefaultContextMenu(RadTreeNode node)

Parameters

Returns

Overrides RadTreeViewElement.InitializeDefaultContextMenu(RadTreeNode)

Initializes the editor.

Declaration

protected virtual void InitializeEditor(Type valueType, IValueEditor editor)

Parameters

Declaration

protected virtual void InitializeFieldEditor(IInputEditor editor, DataFilterCriteriaElement editingElement)

Parameters

Initializes the fields of this instance to their default values.

Declaration

protected override void InitializeFields()

Overrides RadTreeViewElement.InitializeFields()

Declaration

protected virtual void InitializeOperatorEditor(IInputEditor editor, DataFilterCriteriaElement editingElement)

Parameters

Initializes the spin editor.

Declaration

protected virtual void InitializeSpinEditor(TreeViewSpinEditor spinEditor, Type valueType)

Parameters

Declaration

protected virtual void InitializeValueEditor(IInputEditor editor, DataFilterCriteriaElement editingElement)

Parameters

Normalizes a composite filter descriptor by reorganizing its child descriptors.

Declaration

protected virtual void NormalizeChildDescriptor(CompositeFilterDescriptor compositeDescriptor)

Parameters

Normalizes the expression by processing composite filter descriptors.

Declaration

protected virtual void NormalizeExpression()

Declaration

protected override void OnDragEnded(RadTreeViewDragEventArgs e)

Parameters

Overrides RadTreeViewElement.OnDragEnded(RadTreeViewDragEventArgs)

Raises the editing event for a tree node.

Declaration

protected override void OnEditing(object sender, TreeNodeEditingEventArgs e)

Parameters

Overrides RadTreeViewElement.OnEditing(object, TreeNodeEditingEventArgs)

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

Declaration

protected override void OnEditorRequired(object sender, TreeNodeEditorRequiredEventArgs e)

Parameters

Overrides RadTreeViewElement.OnEditorRequired(object, TreeNodeEditorRequiredEventArgs)

Called when the element has been successfully loaded. That includes loading of all its children as well.

Declaration

protected override void OnLoaded()

Overrides RadTreeViewElement.OnLoaded()

Declaration

protected override void OnNodeRemoving(RadTreeViewCancelEventArgs e)

Parameters

Overrides RadTreeViewElement.OnNodeRemoving(RadTreeViewCancelEventArgs)

Fires the event.

Declaration

protected virtual void OnPropertyDisplayNameNeeded(object sender, PropertyDisplayNameNeededEventArgs e)

Parameters

Removes the child node.

Declaration

public void RemoveChildNode(RadTreeNode nodeToRemove)

Parameters

Removes the child node.

Declaration

public void RemoveChildNode(RadTreeNode node, RadTreeNode childNode)

Parameters

Saves the editor value.

Declaration

protected override void SaveEditorValue(TreeNodeElement nodeElement, object newValue)

Parameters

Overrides RadTreeViewElement.SaveEditorValue(TreeNodeElement, object)

Setups the drop down list.

Declaration

protected virtual object SetupDropDownList(DataFilterCriteriaNode criteriaNode, TreeViewDropDownListEditor editor)

Parameters

Returns

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

Validates if adding new node is allowed.

Declaration

public virtual bool ValidateAddNewNode()

Returns

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 Value