ClassBaseFilterViewCategoryElement
A base class used to display grouped(categorized) values of the RadFilterView.
Definition
Namespace:Telerik.WinControls.UI.FilterView
Assembly:Telerik.WinControls.UI.dll
Syntax:
public abstract class BaseFilterViewCategoryElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IFilterViewCategory
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementBaseFilterViewCategoryElement
Derived Classes:
Implements:
Inherited Members
Constructors
BaseFilterViewCategoryElement(string, Type, string)
Initializes a new instance of the BaseFilterViewCategoryElement class.
Fields
ExpandedProperty
Declaration
public static readonly RadProperty ExpandedProperty
Field Value
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
Implements
Expanded
Gets or sets a value indicating, whether the category is expanded.
Header
Gets the header element.
Declaration
public FilterViewHeaderElement Header { get; }
Property Value
IsFilterChanged
Gets a value indicating, whether the filter is changed.
Declaration
public abstract bool IsFilterChanged { get; }
Property Value
Implements
ItemsHolder
Gets the element which holds the items.
Owner
Gets the owner of the category.
Declaration
public IFilterViewCategoriesOwner Owner { get; }
Property Value
Implements
PropertyName
Gets or sets the property name.
Declaration
public string PropertyName { get; set; }
Property Value
Implements
PropertyType
Gets or sets the property type.
Stack
Gets the stack panel which holds the Header and ItemsHolder elements.
Declaration
public StackLayoutPanel Stack { get; }
Property Value
Methods
ApplyFilter(FilterDescriptor)
Applies a FilterDescriptor to the category
Declaration
public abstract bool ApplyFilter(FilterDescriptor filterDescriptor)
Parameters
filterDescriptor
Returns
Implements
ClearFilter()
CLears the filter.
Declaration
public abstract void ClearFilter()
Implements
ClearItems()
Clears the items.
Declaration
public abstract void ClearItems()
Implements
CreateChildElements()
Called by the element when constructed. Allows inheritors to build the element tree.
Declaration
protected override void CreateChildElements()
Overrides
CreateHeaderElement()
Creates th e header element.
Declaration
protected virtual FilterViewHeaderElement CreateHeaderElement()
Returns
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
values
ICollection<object>
The values.
Implements
CreateItemsHolder()
Creates the items holder element.
CreateStack()
Creates the element stack.
Declaration
protected virtual StackLayoutPanel CreateStack()
Returns
GetFilter()
Gets the FilterDescriptor. Note that if the filter is not changed this method will return null.
Declaration
public abstract FilterDescriptor GetFilter()
Returns
Implements
InitializeFields()
Initializes the internal fields and components of the LightVisualElement. This method sets up text primitives, image primitives, and layout management components.
Declaration
protected override void InitializeFields()
Overrides
ItemFilterChanged(IFilterViewItem)
Called when the item filter is changed.
Declaration
public virtual void ItemFilterChanged(IFilterViewItem item)
Parameters
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
location
Implements
UpdateFilterIndicator()
Declaration
protected virtual void UpdateFilterIndicator()
Events
ExpandedChanged
An event that is fired when the expander is expanded or collapsed.