Class BaseFilterViewCategoryElement

A base class used to display grouped(categorized) values of the RadFilterView.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
BaseFilterViewCategoryElement
FilterViewCheckedDropDownCategoryElement
FilterViewDateTimeCategoryElement
FilterViewDropDownCategoryElement
FilterViewNumericCategoryElement
FilterViewTextCategoryElement
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.FilterView
Assembly: Telerik.WinControls.UI.dll

Syntax

public abstract class BaseFilterViewCategoryElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, IFilterViewCategory

Constructors

BaseFilterViewCategoryElement(String, Type, String)

Initializes a new instance of the BaseFilterViewCategoryElement class.

Declaration
public BaseFilterViewCategoryElement(string propertyName, Type propertyType, string displayName = "")
Parameters
System.String propertyName

The name of the property.
System.Type propertyType

The type of the property.
System.String displayName

The display name of the property.

Fields

ExpandedProperty

Declaration
public static readonly RadProperty ExpandedProperty
Field Value
RadProperty

Properties

DisplayName

Gets or sets the display name. Note that if this property is not set as a display name will be used the PropertyName.

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

Implements

Expanded

Gets or sets a value indicating, whether the category is expanded.

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

Header

Gets the header element.

Declaration
public FilterViewHeaderElement Header { get; }
Property Value
FilterViewHeaderElement

IsAutoGenerated

Gets or sets a value indicating, whether the filter is automatically generated.

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

IsFilterChanged

Gets a value indicating, whether the filter is changed.

Declaration
public abstract bool IsFilterChanged { get; }
Property Value
System.Boolean

Implements

ItemsHolder

Gets the element which holds the items.

Declaration
public RadElement ItemsHolder { get; }
Property Value
RadElement

Name

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

Overrides

Owner

Gets the owner of the category.

Declaration
public IFilterViewCategoriesOwner Owner { get; }
Property Value
IFilterViewCategoriesOwner

Implements

PropertyName

Gets or sets the property name.

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

Implements

PropertyType

Gets or sets the property type.

Declaration
public Type PropertyType { get; set; }
Property Value
System.Type

Implements

Stack

Gets the stack panel which holds the Header and ItemsHolder elements.

Declaration
public StackLayoutPanel Stack { get; }
Property Value
StackLayoutPanel

Text

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

Overrides

Values

Gets or sets a the values collection.

Declaration
protected IList<object> Values { get; set; }
Property Value
System.Collections.Generic.IList<System.Object>

Methods

ApplyFilter(FilterDescriptor)

Applies a FilterDescriptor to the category

Declaration
public abstract bool ApplyFilter(FilterDescriptor filterDescriptor)
Parameters
FilterDescriptor filterDescriptor

Returns
System.Boolean

Implements

ClearFilter()

CLears the filter.

Declaration
public abstract void ClearFilter()
Implements

ClearItems()

Clears the items.

Declaration
public abstract void ClearItems()
Implements

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateHeaderElement()

Creates th e header element.

Declaration
protected virtual FilterViewHeaderElement CreateHeaderElement()
Returns
FilterViewHeaderElement

CreateItems(ICollection<Object>)

A method used to create the items of the category based on a given collection of values.

Declaration
public abstract void CreateItems(ICollection<object> values)
Parameters
System.Collections.Generic.ICollection<System.Object> values

The values.
Implements

CreateItemsHolder()

Creates the items holder element.

Declaration
public abstract RadElement CreateItemsHolder()
Returns
RadElement

CreateStack()

Creates the element stack.

Declaration
protected virtual StackLayoutPanel CreateStack()
Returns
StackLayoutPanel

GetFilter()

Gets the FilterDescriptor. Note that if the filter is not changed this method will return null.

Declaration
public abstract FilterDescriptor GetFilter()
Returns
FilterDescriptor

Implements

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

ItemFilterChanged(IFilterViewItem)

Called when the item filter is changed.

Declaration
public virtual void ItemFilterChanged(IFilterViewItem item)
Parameters
IFilterViewItem item

Implements

OnExpandedChanged()

Fired when the expanded property is changed.

Declaration
protected virtual void OnExpandedChanged()

ShowContextMenu(Point)

Shows a context menu on a given location.

Declaration
public void ShowContextMenu(Point location)
Parameters
System.Drawing.Point location

Implements

UpdateFilterIndicator()

Declaration
protected virtual void UpdateFilterIndicator()

Events

ExpandedChanged

An event that is fired when the expander is expanded or collapsed.

Declaration
public event EventHandler ExpandedChanged
Event Type
System.EventHandler

Extension Methods