Class RadCardView

RadCardView is control that layouts its items as cards based on CardLayout property.

Inheritance

System.Object

RadCardView

Namespace: Telerik.Windows.Controls

Assembly: Telerik.Windows.Controls.Data.dll

Syntax

[TelerikToolboxCategory("Data")]
public class RadCardView : Control, IThemable

Constructors

RadCardView()

Initializes a new instance of the Telerik.Windows.Controls.RadCardView class.

Declaration

public RadCardView()

Fields

AutoGenerateDataFieldDescriptorsProperty

Identifies the AutoGenerateDataFieldDescriptors dependency property.

Declaration

public static readonly DependencyProperty AutoGenerateDataFieldDescriptorsProperty

Field Value

System.Windows.DependencyProperty

CanUserSortDescriptorsProperty

Identifies the CanUserSortDescriptors dependency property.

Declaration

public static readonly DependencyProperty CanUserSortDescriptorsProperty

Field Value

System.Windows.DependencyProperty

CardDataFieldBeginningEditEvent

Identifies the CardDataFieldBeginningEdit routed event.

Declaration

public static readonly RoutedEvent CardDataFieldBeginningEditEvent

Field Value

System.Windows.RoutedEvent

CardDataFieldPreparedEditorEvent

Identifies the CardDataFieldPreparedEditor routed event.

Declaration

public static readonly RoutedEvent CardDataFieldPreparedEditorEvent

Field Value

System.Windows.RoutedEvent

DataFieldDescriptorsButtonVisibilityProperty

Identifies the DataFieldDescriptorsButtonVisibility dependency property.

Declaration

public static readonly DependencyProperty DataFieldDescriptorsButtonVisibilityProperty

Field Value

System.Windows.DependencyProperty

FilteringDropDownStaysOpenProperty

Identifies the FilteringDropDownStaysOpen dependency property.

Declaration

public static readonly DependencyProperty FilteringDropDownStaysOpenProperty

Field Value

System.Windows.DependencyProperty

IsSynchronizedWithCurrentItemProperty

Identifies the IsSynchronizedWithCurrentItem dependency property.

Declaration

public static readonly DependencyProperty IsSynchronizedWithCurrentItemProperty

Field Value

System.Windows.DependencyProperty

ShowCardDataFieldDescriptorSortIndexesProperty

Identifies the ShowCardDataFieldDescriptorSortIndexes dependency property.

Declaration

public static readonly DependencyProperty ShowCardDataFieldDescriptorSortIndexesProperty

Field Value

System.Windows.DependencyProperty

Properties

AutoGenerateDataFieldDescriptors

Gets or sets whether fields in the cards of the Telerik.Windows.Controls.RadCardView are generated automatically.

Declaration

public bool AutoGenerateDataFieldDescriptors { get; set; }

Property Value

System.Boolean

CanUserSelect

Gets or sets a value indicating whether the user can select card view items.

Declaration

public bool CanUserSelect { get; set; }

Property Value

System.Boolean

true if user can select; otherwise, false.

You can set this behavior for individual CardDataFieldDescriptor by setting the CardDataFieldDescriptor.AllowSorting property. If the CardDataFieldDescriptor.AllowSorting property and the RadCardView.CanUserSort property are both set, a value of false will take precedence over a value of true.

CanUserSortGroups

Gets or sets a value indicating whether this instance can user sort groups.

Declaration

public bool CanUserSortGroups { get; set; }

Property Value

System.Boolean

true if this instance can user sort groups; otherwise, false.

CardEditTemplate

Gets or sets the template that should be applied to cards when the card view is in edit mode.

Declaration

public DataTemplate CardEditTemplate { get; set; }

Property Value

System.Windows.DataTemplate

CardHeaderBinding

Gets or sets the data binding for the card header.

Declaration

public Binding CardHeaderBinding { get; set; }

Property Value

System.Windows.Data.Binding

CardHeaderTemplate

Gets or sets the DataTemplate that will be applied for the Header of the CardItem.

Declaration

public DataTemplate CardHeaderTemplate { get; set; }

Property Value

System.Windows.DataTemplate

CardLayout

Gets or sets whether cards are layout in rows or columns.

Declaration

public CardLayout CardLayout { get; set; }

Property Value

CardLayout

CardMargin

Gets or sets the margin around each card.

Declaration

public Thickness CardMargin { get; set; }

Property Value

System.Windows.Thickness

CardReadOnlyTemplate

Gets or sets the template that should be applied to cards when the card view is not in edit mode.

Declaration

public DataTemplate CardReadOnlyTemplate { get; set; }

Property Value

System.Windows.DataTemplate

CollapsedLength

Gets or sets the collapsed length of a card.

Declaration

public double CollapsedLength { get; set; }

Property Value

System.Double

ControlPanelItems

Gets or sets the control panel items.

Declaration

public ObservableCollection<IControlPanelItem> ControlPanelItems { get; set; }

Property Value

System.Collections.ObjectModel.ObservableCollection<IControlPanelItem>

DataFieldDescriptors

Gets the collection that contains all the data field descriptors.

Declaration

public CardDataFieldDescriptorCollection DataFieldDescriptors { get; }

Property Value

CardDataFieldDescriptorCollection

DataFieldDescriptorsButtonVisibility

Gets or sets a value that indicates whether the data field descriptors button is visible.

Declaration

public Visibility DataFieldDescriptorsButtonVisibility { get; set; }

Property Value

System.Windows.Visibility

CardDataFieldDescriptors button visibility.

FilteringDropDownStaysOpen

Gets or sets the property which controls whether the filtering dropdowns stay open when a click outside of the popups occurs. true if the popups will stay open, otherwise, false

Declaration

public bool FilteringDropDownStaysOpen { get; set; }

Property Value

System.Boolean

GroupItemIndentation

Gets or sets the indentation length for the nested group items.

Declaration

public double GroupItemIndentation { get; set; }

Property Value

System.Double

GroupPanelBackground

Gets or sets the color behind the content of the GroupPanel.

Declaration

public Brush GroupPanelBackground { get; set; }

Property Value

System.Windows.Media.Brush

The group panel background.

GroupPanelForeground

Gets or sets the foreground color of the GroupPanel.

Declaration

public Brush GroupPanelForeground { get; set; }

Property Value

System.Windows.Media.Brush

The group panel foreground.

GroupPanelItemStyle

Gets or sets the group panel cell style.

Declaration

public Style GroupPanelItemStyle { get; set; }

Property Value

System.Windows.Style

The group panel cell style.

GroupPanelStyle

Gets or sets the group panel style.

Declaration

public Style GroupPanelStyle { get; set; }

Property Value

System.Windows.Style

The group panel style.

IsEditing

Gets a value indicating whether the control is currently in edit mode.

Declaration

public bool IsEditing { get; }

Property Value

System.Boolean

IsFilteringAllowed

Gets or sets a value indicating whether the control can be filtered through the UI.

Declaration

public bool IsFilteringAllowed { get; set; }

Property Value

System.Boolean

true if the control can be filtered through the UI; otherwise, false.

IsReadOnly

Gets or sets whether fields in the cards of the Telerik.Windows.Controls.RadCardView can be edited.

Declaration

public bool IsReadOnly { get; set; }

Property Value

System.Boolean

IsSynchronizedWithCurrentItem

Gets or sets whether the current item is synchronized with the current item of the source collection.

Declaration

public bool IsSynchronizedWithCurrentItem { get; set; }

Property Value

System.Boolean

ItemsSource

Gets or sets a collection used to generate the cards of the Telerik.Windows.Controls.RadCardView.

Declaration

public IEnumerable ItemsSource { get; set; }

Property Value

System.Collections.IEnumerable

KeyboardCommandProvider

Gets the keyboard command provider.

Declaration

public IKeyboardCommandProvider KeyboardCommandProvider { get; set; }

Property Value

IKeyboardCommandProvider

The keyboard command provider. This class provides command key mappings.

MajorLength

Gets or sets the major dimension of a card. Major dimension is the dimension in which cards are scrolled. When CardLayout is Rows, MajorLength is card width, otherwise it is height.

Declaration

public double MajorLength { get; set; }

Property Value

System.Double

MinorLength

Gets or sets the minor dimension of a card. Minor dimension is the opposite dimension in which cards are scrolled. When CardLayout is Rows, MinorLength is card height, otherwise it is width.

Declaration

public double MinorLength { get; set; }

Property Value

System.Double

PendingCommands

Gets all pending commands.

Declaration

public List<ICommand> PendingCommands { get; }

Property Value

System.Collections.Generic.List<System.Windows.Input.ICommand>

The pending commands.

SelectedItem

Gets the selected card view item.

Declaration

public object SelectedItem { get; set; }

Property Value

System.Object

ShowCardDataFieldDescriptorSortIndexes

Gets or sets a value indicating whether dataFieldDescriptor sort indexes are displayed.

Declaration

public bool ShowCardDataFieldDescriptorSortIndexes { get; set; }

Property Value

System.Boolean

A value indicating whether dataFieldDescriptor sort indexes are displayed.

ShowGroupPanel

Gets or sets a value indicating whether to show a group panel.

Declaration

public bool ShowGroupPanel { get; set; }

Property Value

System.Boolean

Methods

Collapse(Object)

Collapse item or group.

Declaration

public void Collapse(object item)

Parameters

System.Object item

Item that will be collapsed.

ExecutePendingCommand()

Executes all pending commands in a sequence.

Declaration

public void ExecutePendingCommand()

Expand(Object)

Expands item or group.

Declaration

public void Expand(object item)

Parameters

System.Object item

Item that will be expanded.

GetDistinctValues(CardDataFieldDescriptor, Boolean)

Returns the first 1000 distinct values for the given cardDataFieldDescriptor.

Declaration

public IEnumerable GetDistinctValues(CardDataFieldDescriptor cardDataFieldDescriptor, bool filter)

Parameters

CardDataFieldDescriptor cardDataFieldDescriptor

The cardDataFieldDescriptor.

System.Boolean filter

A value indicating whether to filter the distinct values based on other cardDataFieldDescriptors' existing filters.

Returns

System.Collections.IEnumerable

An IEnumerable containing the distinct values.

Remarks

The 'filter' parameter specifies whether distinct values should be filtered according to other cardDataFieldDescriptors' active filters. For example, if we have countries and players and we have filtered by CountryX, when we request all distinct players, if 'filter' is true we will get players from CountryX only. If 'filter' is false we will get all distinct players.

GetDistinctValues(CardDataFieldDescriptor, Boolean, Nullable<Int32>)

Returns distinct values for a given cardDataFieldDescriptor.

Declaration

public IEnumerable GetDistinctValues(CardDataFieldDescriptor cardDataFieldDescriptor, bool filter, Nullable<int> maximumValueCount)

Parameters

CardDataFieldDescriptor cardDataFieldDescriptor

The cardDataFieldDescriptor.

System.Boolean filter

A value indicating whether to filter the distinct values base on other cardDataFieldDescriptors' existing filters.

System.Nullable<System.Int32> maximumValueCount

The maximum amount of distinct values to return. If you specify null for this parameter, then all distinct values will be returned.

Returns

System.Collections.IEnumerable

An IEnumerable containing the distinct values.

Remarks

OnApplyTemplate()

Invoked when ApplyTemplate is called.

Declaration

public override void OnApplyTemplate()

OnAutoGeneratingDataFieldDescriptor(CardViewAutoGeneratingDataFieldDescriptorEventArgs)

Fires the AutoGeneratingDataFieldDescriptor event.

Declaration

protected virtual void OnAutoGeneratingDataFieldDescriptor(CardViewAutoGeneratingDataFieldDescriptorEventArgs e)

Parameters

CardViewAutoGeneratingDataFieldDescriptorEventArgs e

OnCreateAutomationPeer()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnGroupPanelChanged(CardViewGroupPanel, CardViewGroupPanel)

Called when the CardViewGroupPanel is changed.

Declaration

protected virtual void OnGroupPanelChanged(CardViewGroupPanel oldPanel, CardViewGroupPanel newPanel)

Parameters

CardViewGroupPanel oldPanel

The old panel.

CardViewGroupPanel newPanel

The new panel.

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

System.EventArgs e

OnKeyDown(KeyEventArgs)

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

System.Windows.Input.KeyEventArgs e

OnMouseDown(MouseButtonEventArgs)

Declaration

protected override void OnMouseDown(MouseButtonEventArgs e)

Parameters

System.Windows.Input.MouseButtonEventArgs e

OnPreviewMouseWheel(MouseWheelEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.PreviewMouseWheel attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration

protected override void OnPreviewMouseWheel(MouseWheelEventArgs e)

Parameters

System.Windows.Input.MouseWheelEventArgs e

ScrollIntoView(Object)

Scrolls the card containing the data item into view.

Declaration

public void ScrollIntoView(object item)

Parameters

System.Object item

The data item to scroll into view.

Events

AutoGeneratingDataFieldDescriptor

Occurs before a data field descriptor is auto-generated and added to the DataFieldDescriptors collection.

Declaration

public event EventHandler<CardViewAutoGeneratingDataFieldDescriptorEventArgs> AutoGeneratingDataFieldDescriptor

Event Type

System.EventHandler<CardViewAutoGeneratingDataFieldDescriptorEventArgs>

CardBeginningEdit

Occurs before an edit operation is started.

Declaration

public event EventHandler<CardViewItemCancelEventArgs> CardBeginningEdit

Event Type

System.EventHandler<CardViewItemCancelEventArgs>

CardDataFieldBeginningEdit

Occurs before a card's data field is edited.

Declaration

public event EventHandler<CardDataFieldCancelEventArgs> CardDataFieldBeginningEdit

Event Type

System.EventHandler<CardDataFieldCancelEventArgs>

CardDataFieldEditEnded

Occurs after a card's data field is edited.

Declaration

public event EventHandler<CardDataFieldEditEndedEventArgs> CardDataFieldEditEnded

Event Type

System.EventHandler<CardDataFieldEditEndedEventArgs>

CardDataFieldPreparedEditor

Occurs when a card's data field editor is prepared for editing.

Declaration

public event EventHandler<CardDataFieldPreparedEditorEventArgs> CardDataFieldPreparedEditor

Event Type

System.EventHandler<CardDataFieldPreparedEditorEventArgs>

CardDataFieldValidated

Occurs after a card's data field is validated.

Declaration

public event EventHandler<CardDataFieldValidatedEventArgs> CardDataFieldValidated

Event Type

System.EventHandler<CardDataFieldValidatedEventArgs>

CardDataFieldValidating

Occurs before a card's data field is validated.

Declaration

public event EventHandler<CardDataFieldValidatingEventArgs> CardDataFieldValidating

Event Type

System.EventHandler<CardDataFieldValidatingEventArgs>

CardEditEnded

Occurs after an edit operation is finished.

Declaration

public event EventHandler<CardViewEditEndedEventArgs> CardEditEnded

Event Type

System.EventHandler<CardViewEditEndedEventArgs>

CardEditEnding

Occurs before an edit operation is finished.

Declaration

public event EventHandler<CardViewEditEndingEventArgs> CardEditEnding

Event Type

System.EventHandler<CardViewEditEndingEventArgs>

CardValidating

Occurs when a card is being validated.

Declaration

public event EventHandler<CardViewItemCancelEventArgs> CardValidating

Event Type

System.EventHandler<CardViewItemCancelEventArgs>

DistinctValuesLoading

Occurs when the CardDataFieldDescriptor distinct values is about to be loaded.

Declaration

public event EventHandler<CardViewDistinctValuesLoadingEventArgs> DistinctValuesLoading

Event Type

System.EventHandler<CardViewDistinctValuesLoadingEventArgs>

FieldFilterEditorCreated

Occurs when a field filter editor has been created. This event allows you to modify certain properties of the editor.

Declaration

public event EventHandler<CardViewFilterEditorCreatedEventArgs> FieldFilterEditorCreated

Event Type

System.EventHandler<CardViewFilterEditorCreatedEventArgs>

Filtered

Occurs after filter operation.

Declaration

public event EventHandler<CardViewFilteredEventArgs> Filtered

Event Type

System.EventHandler<CardViewFilteredEventArgs>

Filtering

Occurs before filter operation.

Declaration

public event EventHandler<CardViewFilteringEventArgs> Filtering

Event Type

System.EventHandler<CardViewFilteringEventArgs>

FilterOperatorsLoading

Occurs before the filter operators of the filtering control are loaded. Use this event if you want to remove one or more of the filter operators or if you want to change the one selected by default.

Declaration

public event EventHandler<FilterOperatorsLoadingEventArgs> FilterOperatorsLoading

Event Type

System.EventHandler<FilterOperatorsLoadingEventArgs>

Grouped

Occurs after grouping was performed.

Declaration

public event EventHandler<CardViewGroupedEventArgs> Grouped

Event Type

System.EventHandler<CardViewGroupedEventArgs>

Grouping

Occurs while grouping is performed. (Cancelable).

Declaration

public event EventHandler<CardViewGroupingEventArgs> Grouping

Event Type

System.EventHandler<CardViewGroupingEventArgs>

SelectionChanged

Occurs when the selected card view item has changed.

Declaration

public event SelectionChangedEventHandler SelectionChanged

Event Type

System.Windows.Controls.SelectionChangedEventHandler

Sorted

Occurs after sorted was performed.

Declaration

public event EventHandler<CardViewSortedEventArgs> Sorted

Event Type

System.EventHandler<CardViewSortedEventArgs>

Sorting

Occurs before RadCardView performs sorting.

Declaration

public event EventHandler<CardViewSortingEventArgs> Sorting

Event Type

System.EventHandler<CardViewSortingEventArgs>

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)