Class CardDataFieldDescriptor

This is a class used to store the information for a single data field.

Inheritance

System.Object

CardDataFieldDescriptor

Namespace: Telerik.Windows.Controls

Assembly: Telerik.Windows.Controls.Data.dll

Syntax

public class CardDataFieldDescriptor : DependencyObject, INotifyPropertyChanged

Constructors

CardDataFieldDescriptor()

Declaration

public CardDataFieldDescriptor()

Fields

AllowFilteringProperty

Represents the AllowFiltering dependency property.

Declaration

public static readonly DependencyProperty AllowFilteringProperty

Field Value

System.Windows.DependencyProperty

AllowGroupingProperty

Represents the AllowGrouping dependency property.

Declaration

public static readonly DependencyProperty AllowGroupingProperty

Field Value

System.Windows.DependencyProperty

AllowSortingProperty

Represents the AllowSorting dependency property.

Declaration

public static readonly DependencyProperty AllowSortingProperty

Field Value

System.Windows.DependencyProperty

DisplayOrderProperty

Represents the DisplayOrder dependency property.

Declaration

public static readonly DependencyProperty DisplayOrderProperty

Field Value

System.Windows.DependencyProperty

EditorTemplateProperty

Represents the EditorTemplate dependency property.

Declaration

public static readonly DependencyProperty EditorTemplateProperty

Field Value

System.Windows.DependencyProperty

FilteringControlStyleProperty

Identifies the FilteringControlStyle dependency property.

Declaration

public static readonly DependencyProperty FilteringControlStyleProperty

Field Value

System.Windows.DependencyProperty

FilterMemberTypeProperty

Identifies the FilterMemberType dependency property.

Declaration

public static readonly DependencyProperty FilterMemberTypeProperty

Field Value

System.Windows.DependencyProperty

HeaderProperty

Represents the Header dependency property.

Declaration

public static readonly DependencyProperty HeaderProperty

Field Value

System.Windows.DependencyProperty

IsFilteringDeferredProperty

Identifies the IsFilteringDeferred dependency property.

Declaration

public static readonly DependencyProperty IsFilteringDeferredProperty

Field Value

System.Windows.DependencyProperty

IsReadOnlyProperty

Represents the IsReadOnly dependency property.

Declaration

public static readonly DependencyProperty IsReadOnlyProperty

Field Value

System.Windows.DependencyProperty

IsVisibleProperty

Represents the IsVisible dependency property.

Declaration

public static readonly DependencyProperty IsVisibleProperty

Field Value

System.Windows.DependencyProperty

OptimizeDistinctFilterQueryProperty

Identifies the OptimizeDistinctFilterQuery dependency property.

Declaration

public static readonly DependencyProperty OptimizeDistinctFilterQueryProperty

Field Value

System.Windows.DependencyProperty

ReadOnlyTemplateProperty

Represents the ReadOnlyTemplate dependency property.

Declaration

public static readonly DependencyProperty ReadOnlyTemplateProperty

Field Value

System.Windows.DependencyProperty

ShouldGenerateFieldFilterEditorsProperty

Identifies the ShouldGenerateFieldFilterEditors dependency property.

Declaration

public static readonly DependencyProperty ShouldGenerateFieldFilterEditorsProperty

Field Value

System.Windows.DependencyProperty

ShowDistinctFiltersProperty

Identifies the ShowDistinctFilters dependency property.

Declaration

public static readonly DependencyProperty ShowDistinctFiltersProperty

Field Value

System.Windows.DependencyProperty

ShowFieldFiltersProperty

Identifies the ShowFieldFilters dependency property.

Declaration

public static readonly DependencyProperty ShowFieldFiltersProperty

Field Value

System.Windows.DependencyProperty

ShowFilterButtonProperty

Identifies the ShowFilterButton dependency property.

Declaration

public static readonly DependencyProperty ShowFilterButtonProperty

Field Value

System.Windows.DependencyProperty

SortingIndexProperty

Identifies the SortingIndex readonly dependency property.

Declaration

public static readonly DependencyProperty SortingIndexProperty

Field Value

System.Windows.DependencyProperty

SortingStateProperty

Identifies the SortingState dependency property.

Declaration

public static readonly DependencyProperty SortingStateProperty

Field Value

System.Windows.DependencyProperty

Properties

AllowFiltering

Gets or sets a value that indicates whether the user can filter by the data in this data field.

Declaration

public bool AllowFiltering { get; set; }

Property Value

System.Boolean

AllowGrouping

Gets or sets a value that indicates whether the user can group by the data in this data field.

Declaration

public bool AllowGrouping { get; set; }

Property Value

System.Boolean

AllowSorting

Gets or sets a value that indicates whether the user can sort by the data in this data field.

Declaration

public bool AllowSorting { get; set; }

Property Value

System.Boolean

CardDataFieldFilterDescriptor

Gets the CardDataFieldFilterDescriptor.

Declaration

public ICardDataFieldFilterDescriptor CardDataFieldFilterDescriptor { get; }

Property Value

ICardDataFieldFilterDescriptor The CardDataFieldFilterDescriptor.

DataMemberBinding

Gets or sets the binding which points to the data member to display.

Declaration

public Binding DataMemberBinding { get; set; }

Property Value

System.Windows.Data.Binding

DisplayOrder

Gets or sets the order in which the data field should be displayed.

Declaration

public int DisplayOrder { get; set; }

Property Value

System.Int32

EditorTemplate

Gets or sets the editor template to be used for editing values of the data field.

Declaration

public DataTemplate EditorTemplate { get; set; }

Property Value

System.Windows.DataTemplate

FilteringControl

Gets or sets the control used for filtering.

Declaration

public IFilteringControl FilteringControl { get; set; }

Property Value

IFilteringControl

FilteringControlStyle

Gets or sets the style which will be applied on the filtering control.

Declaration

public Style FilteringControlStyle { get; set; }

Property Value

System.Windows.Style The editor style.

FilterMemberPath

Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to filter by.

Declaration

public string FilterMemberPath { get; set; }

Property Value

System.String

FilterMemberType

Gets or sets the filter member type of the CardDataFieldDescriptor. Set this property when the type cannot be automatically discovered from the FilterMemberPath.

Declaration

public Type FilterMemberType { get; set; }

Property Value

System.Type The filter member data type of the CardDataFieldDescriptor.

Header

Gets or sets the content of the data field header.

Declaration

public object Header { get; set; }

Property Value

System.Object

IsFilteringDeferred

Gets or sets a value indicating whether this CardDataFieldDescriptor will have deferred filtering.

Declaration

public bool IsFilteringDeferred { get; set; }

Property Value

System.Boolean

IsReadOnly

Gets or sets a value indicating whether this field can be edited.

Declaration

public bool IsReadOnly { get; set; }

Property Value

System.Boolean

IsVisible

Gets or sets whether this descriptor is visible .

Declaration

public bool IsVisible { get; set; }

Property Value

System.Boolean

OptimizeDistinctFilterQuery

Gets or sets a value indicating whether to optimize distinct filter query.

Declaration

public bool OptimizeDistinctFilterQuery { get; set; }

Property Value

System.Boolean A value indicating whether to optimize distinct filter query.

Remarks

By default, a condition of the form 'Member IsEqualTo Value' is generated for each distinct value selected and then all such conditions are combined with the OR operator. When the amount of distinct values checked grows, the query might become very slow. Setting OptimizeDistinctFilterQuery to true, will check the amount of distinct values checked. If this amount is less than or equal to half of all distinct values the original query will be generated. If, however, the amount of distinct values checked is more than half of all distinct values, an inverted statement like this be generated: (Member IsNotEqualTo uncheckedDistinctValue_0) ... AND ... (Member IsNotEqualTo uncheckedDistinctValue_N) If absolutely all distinct values are checked then no statement will be generated at all because this effectively means that there is no filter applied. Setting this property to true will try to generate the shortest possible LINQ Where clause.

ReadOnlyTemplate

Gets or sets the display template to be used when displaying values of the data field.

Declaration

public DataTemplate ReadOnlyTemplate { get; set; }

Property Value

System.Windows.DataTemplate

ShouldGenerateFieldFilterEditors

Gets or sets a value indicating whether field filter editors should be generated.

Declaration

public bool? ShouldGenerateFieldFilterEditors { get; set; }

Property Value

System.Nullable<System.Boolean>

ShowDistinctFilters

Gets or sets a value indicating whether this CardDataFieldDescriptor will show distinct filters.

Declaration

public bool ShowDistinctFilters { get; set; }

Property Value

System.Boolean

ShowFieldFilters

Gets or sets a value indicating whether this CardDataFieldDescriptor will show field filters.

Declaration

public bool ShowFieldFilters { get; set; }

Property Value

System.Boolean

ShowFilterButton

Gets or sets a value indicating whether this CardDataFieldDescriptor will show the filter button.

Declaration

public bool ShowFilterButton { get; set; }

Property Value

System.Boolean

SortingIndex

Gets the sorting index of the card data field descriptor when there is multiple sorting.

Declaration

public int SortingIndex { get; }

Property Value

System.Int32 The sorting index of the card data field descriptor when there is multiple sorting.

SortingState

Gets or sets a card data field descriptor sorting state depending on executed sorted command, it can take 3 possible values: Ascending, Descending and None.

Declaration

public SortingState SortingState { get; set; }

Property Value

SortingState

Methods

CanFilter()

Determines whether the data represented by the CardDataFieldDescriptor can be filtered by the RadCardView control.

Declaration

public bool CanFilter()

Returns

System.Boolean true if the data represented by the CardDataFieldDescriptor can be filtered automatically; otherwise, false.

CreateCardDataFieldFilterDescriptor()

Creates the CardDataFieldFilterDescriptor.

Declaration

public ICardDataFieldFilterDescriptor CreateCardDataFieldFilterDescriptor()

Returns

ICardDataFieldFilterDescriptor

CreateFieldFilterEditor()

Creates the field filter editor.

Declaration

public FrameworkElement CreateFieldFilterEditor()

Returns

System.Windows.FrameworkElement

OnPropertyChanged(String)

Declaration

protected virtual void OnPropertyChanged(string name)

Parameters

System.String name

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Declaration

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

System.Windows.DependencyPropertyChangedEventArgs e

Events

PropertyChanged

Occurs when a property value changes.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

System.ComponentModel.PropertyChangedEventHandler

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)