ClassRadCardView
RadCardView is control that layouts its items as cards based on CardLayout property.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.Data.dll
Syntax:
[TelerikToolboxCategory("Data")]
public class RadCardView : Control
Inheritance: objectRadCardView
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
DependencyProperty
CanUserSelectProperty
Identifies the CanUserSelect dependency property.
Declaration
public static readonly DependencyProperty CanUserSelectProperty
Field Value
DependencyProperty
CanUserSortDescriptorsProperty
Identifies the CanUserSortDescriptors dependency property.
Declaration
public static readonly DependencyProperty CanUserSortDescriptorsProperty
Field Value
DependencyProperty
CanUserSortGroupsProperty
Identifies the CanUserSortGroups dependency property.
Declaration
public static readonly DependencyProperty CanUserSortGroupsProperty
Field Value
DependencyProperty
CardBeginningEditEvent
Identifies the CardBeginningEdit routed event.
Declaration
public static readonly RoutedEvent CardBeginningEditEvent
Field Value
RoutedEvent
CardDataFieldBeginningEditEvent
Identifies the CardDataFieldBeginningEdit routed event.
Declaration
public static readonly RoutedEvent CardDataFieldBeginningEditEvent
Field Value
RoutedEvent
CardDataFieldEditEndedEvent
Identifies the CardDataFieldEditEnded routed event.
Declaration
public static readonly RoutedEvent CardDataFieldEditEndedEvent
Field Value
RoutedEvent
CardDataFieldPreparedEditorEvent
Identifies the CardDataFieldPreparedEditor routed event.
Declaration
public static readonly RoutedEvent CardDataFieldPreparedEditorEvent
Field Value
RoutedEvent
CardDataFieldValidatedEvent
Identifies the CardDataFieldValidated routed event.
Declaration
public static readonly RoutedEvent CardDataFieldValidatedEvent
Field Value
RoutedEvent
CardDataFieldValidatingEvent
Identifies the CardDataFieldValidating routed event.
Declaration
public static readonly RoutedEvent CardDataFieldValidatingEvent
Field Value
RoutedEvent
CardEditEndedEvent
Identifies the CardEditEnded routed event.
Declaration
public static readonly RoutedEvent CardEditEndedEvent
Field Value
RoutedEvent
CardEditEndingEvent
Identifies the CardEditEnding routed event.
Declaration
public static readonly RoutedEvent CardEditEndingEvent
Field Value
RoutedEvent
CardEditTemplateProperty
Identifies the CardEditTemplate dependency property.
Declaration
public static readonly DependencyProperty CardEditTemplateProperty
Field Value
DependencyProperty
CardHeaderTemplateProperty
Identifies the Telerik.Windows.Controls.RadCardView.CardHeaderTemplate dependency property.
Declaration
public static readonly DependencyProperty CardHeaderTemplateProperty
Field Value
DependencyProperty
CardLayoutProperty
Identifies the Telerik.Windows.Controls.RadCardView.CardLayout dependency property.
Declaration
public static readonly DependencyProperty CardLayoutProperty
Field Value
DependencyProperty
CardMarginProperty
Identifies the Telerik.Windows.Controls.RadCardView.CardMargin dependency property.
Declaration
public static readonly DependencyProperty CardMarginProperty
Field Value
DependencyProperty
CardReadOnlyTemplateProperty
Identifies the CardReadOnlyTemplate dependency property.
Declaration
public static readonly DependencyProperty CardReadOnlyTemplateProperty
Field Value
DependencyProperty
CardValidatingEvent
Identifies the CardValidating routed event.
Declaration
public static readonly RoutedEvent CardValidatingEvent
Field Value
RoutedEvent
CellLoadedEvent
Identifies the CellLoaded routed event.
Declaration
public static readonly RoutedEvent CellLoadedEvent
Field Value
RoutedEvent
CellUnloadedEvent
Identifies the CellUnloaded routed event.
Declaration
public static readonly RoutedEvent CellUnloadedEvent
Field Value
RoutedEvent
CollapsedLengthProperty
Identifies the Telerik.Windows.Controls.RadCardView.CollapsedLength dependency property.
Declaration
public static readonly DependencyProperty CollapsedLengthProperty
Field Value
DependencyProperty
ControlPanelItemsProperty
Identifies the ControlPanelItems dependency property.
Declaration
public static readonly DependencyProperty ControlPanelItemsProperty
Field Value
DependencyProperty
DataFieldDescriptorsButtonVisibilityProperty
Identifies the DataFieldDescriptorsButtonVisibility dependency property.
Declaration
public static readonly DependencyProperty DataFieldDescriptorsButtonVisibilityProperty
Field Value
DependencyProperty
DataFieldDescriptorsProperty
Identifies the DataFieldDescriptors dependency property.
Declaration
public static readonly DependencyProperty DataFieldDescriptorsProperty
Field Value
DependencyProperty
FilteredEvent
Occurs after filtering.
Declaration
public static readonly RoutedEvent FilteredEvent
Field Value
RoutedEvent
FilteringDropDownStaysOpenProperty
Identifies the FilteringDropDownStaysOpen dependency property.
Declaration
public static readonly DependencyProperty FilteringDropDownStaysOpenProperty
Field Value
DependencyProperty
FilteringEvent
Occurs before filtering.
Declaration
public static readonly RoutedEvent FilteringEvent
Field Value
RoutedEvent
GroupItemIndentationProperty
Identifies the GroupItemIndentation dependency property.
Declaration
public static readonly DependencyProperty GroupItemIndentationProperty
Field Value
DependencyProperty
GroupPanelBackgroundProperty
Identifies the GroupPanelBackground dependency property.
Declaration
public static readonly DependencyProperty GroupPanelBackgroundProperty
Field Value
DependencyProperty
GroupPanelForegroundProperty
Identifies the GroupPanelForeground dependency property.
Declaration
public static readonly DependencyProperty GroupPanelForegroundProperty
Field Value
DependencyProperty
GroupPanelItemStyleProperty
Identifies the GroupPanelItemStyle dependency property.
Declaration
public static readonly DependencyProperty GroupPanelItemStyleProperty
Field Value
DependencyProperty
GroupPanelStyleProperty
Identifies the GroupPanelStyle dependency property.
Declaration
public static readonly DependencyProperty GroupPanelStyleProperty
Field Value
DependencyProperty
GroupedEvent
Occurs after grouping was performed.
Declaration
public static readonly RoutedEvent GroupedEvent
Field Value
RoutedEvent
GroupingEvent
Occurs while grouping is being performed. (Cancelable).
Declaration
public static readonly RoutedEvent GroupingEvent
Field Value
RoutedEvent
IsFilteringAllowedProperty
Identifies the IsFilteringAllowedProperty dependency property.
Declaration
public static readonly DependencyProperty IsFilteringAllowedProperty
Field Value
DependencyProperty
IsReadOnlyProperty
Identifies the IsReadOnly dependency property.
Declaration
public static readonly DependencyProperty IsReadOnlyProperty
Field Value
DependencyProperty
IsSynchronizedWithCurrentItemProperty
Identifies the IsSynchronizedWithCurrentItem dependency property.
Declaration
public static readonly DependencyProperty IsSynchronizedWithCurrentItemProperty
Field Value
DependencyProperty
ItemsSourceProperty
Identifies the Telerik.Windows.Controls.RadCardView.ItemsSource dependency property.
Declaration
public static readonly DependencyProperty ItemsSourceProperty
Field Value
DependencyProperty
MajorLengthProperty
Identifies the Telerik.Windows.Controls.RadCardView.MajorLength dependency property.
Declaration
public static readonly DependencyProperty MajorLengthProperty
Field Value
DependencyProperty
MinorLengthProperty
Identifies the Telerik.Windows.Controls.RadCardView.MinorLength dependency property.
Declaration
public static readonly DependencyProperty MinorLengthProperty
Field Value
DependencyProperty
SelectedItemProperty
Represents the SelectedItem dependency property.
Declaration
public static readonly DependencyProperty SelectedItemProperty
Field Value
DependencyProperty
SelectionChangedEvent
Identifies the SelectionChanged routed event.
Declaration
public static readonly RoutedEvent SelectionChangedEvent
Field Value
RoutedEvent
ShowCardDataFieldDescriptorSortIndexesProperty
Identifies the ShowCardDataFieldDescriptorSortIndexes dependency property.
Declaration
public static readonly DependencyProperty ShowCardDataFieldDescriptorSortIndexesProperty
Field Value
DependencyProperty
ShowGroupPanelProperty
Identifies the ShowGroupPanel dependency property.
Declaration
public static readonly DependencyProperty ShowGroupPanelProperty
Field Value
DependencyProperty
SortedEvent
Occurs after sorting was performed.
Declaration
public static readonly RoutedEvent SortedEvent
Field Value
RoutedEvent
SortingEvent
Identifies the Sorting routed event.
Declaration
public static readonly RoutedEvent SortingEvent
Field Value
RoutedEvent
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
CanUserSelect
Gets or sets a value indicating whether the user can select card view items.
Declaration
public bool CanUserSelect { get; set; }
Property Value
true if user can select; otherwise, false.
CanUserSortDescriptors
Gets or sets a value that indicates whether the user can sort.
Declaration
public bool CanUserSortDescriptors { get; set; }
Property Value
Remarks
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
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
DataTemplate
CardHeaderBinding
Gets or sets the data binding for the card header.
Declaration
public Binding CardHeaderBinding { get; set; }
Property Value
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
DataTemplate
CardLayout
Gets or sets whether cards are layout in rows or columns.
CardMargin
Gets or sets the margin around each card.
Declaration
public Thickness CardMargin { get; set; }
Property Value
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
DataTemplate
CollapsedLength
Gets or sets the collapsed length of a card.
ControlPanelItems
Gets or sets the control panel items.
Declaration
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public ObservableCollection<IControlPanelItem> ControlPanelItems { get; set; }
Property Value
DataFieldDescriptors
Gets the collection that contains all the data field descriptors.
Declaration
public CardDataFieldDescriptorCollection DataFieldDescriptors { get; }
Property Value
DataFieldDescriptorsButtonVisibility
Gets or sets a value that indicates whether the data field descriptors button is visible.
Declaration
public Visibility DataFieldDescriptorsButtonVisibility { get; set; }
Property Value
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
GroupItemIndentation
Gets or sets the indentation length for the nested group items.
Declaration
public double GroupItemIndentation { get; set; }
Property Value
GroupPanelBackground
Gets or sets the color behind the content of the GroupPanel.
Declaration
public Brush GroupPanelBackground { get; set; }
Property Value
Brush
The group panel background.
GroupPanelForeground
Gets or sets the foreground color of the GroupPanel.
Declaration
public Brush GroupPanelForeground { get; set; }
Property Value
Brush
The group panel foreground.
GroupPanelItemStyle
Gets or sets the group panel cell style.
Declaration
public Style GroupPanelItemStyle { get; set; }
Property Value
Style
The group panel cell style.
GroupPanelStyle
Gets or sets the group panel style.
Declaration
public Style GroupPanelStyle { get; set; }
Property Value
Style
The group panel style.
IsEditing
Gets a value indicating whether the control is currently in edit mode.
IsFilteringAllowed
Gets or sets a value indicating whether the control can be filtered through the UI.
Declaration
public bool IsFilteringAllowed { get; set; }
Property Value
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.
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
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
KeyboardCommandProvider
Gets the keyboard command provider.
Declaration
public IKeyboardCommandProvider KeyboardCommandProvider { get; set; }
Property Value
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.
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.
PendingCommands
Gets all pending commands.
SelectedItem
Gets the selected card view item.
ShowCardDataFieldDescriptorSortIndexes
Gets or sets a value indicating whether dataFieldDescriptor sort indexes are displayed.
Declaration
public bool ShowCardDataFieldDescriptorSortIndexes { get; set; }
Property Value
A value indicating whether dataFieldDescriptor sort indexes are displayed.
ShowGroupPanel
Gets or sets a value indicating whether to show a group panel.
Methods
Collapse(object)
Collapse item or group.
Declaration
public void Collapse(object item)
Parameters
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
item
Item that will be expanded.
GetDistinctValues(CardDataFieldDescriptor, bool)
Returns the first 1000 distinct values for the given cardDataFieldDescriptor.
Declaration
public IEnumerable GetDistinctValues(CardDataFieldDescriptor cardDataFieldDescriptor, bool filter)
Parameters
cardDataFieldDescriptor
The cardDataFieldDescriptor.
filter
A value indicating whether to filter the distinct values based on other cardDataFieldDescriptors' existing filters.
Returns
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, bool, int?)
Returns distinct values for a given cardDataFieldDescriptor.
Declaration
public IEnumerable GetDistinctValues(CardDataFieldDescriptor cardDataFieldDescriptor, bool filter, int? maximumValueCount)
Parameters
cardDataFieldDescriptor
The cardDataFieldDescriptor.
filter
A value indicating whether to filter the distinct values base on other cardDataFieldDescriptors' existing filters.
maximumValueCount
int?
The maximum amount of distinct values to return. If you specify null for this parameter, then all distinct values will be returned.
Returns
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.
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
e
OnCreateAutomationPeer()
Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
AutomationPeer
The type-specific AutomationPeer implementation.
OnGroupPanelChanged(CardViewGroupPanel, CardViewGroupPanel)
Called when the CardViewGroupPanel is changed.
Declaration
protected virtual void OnGroupPanelChanged(CardViewGroupPanel oldPanel, CardViewGroupPanel newPanel)
Parameters
oldPanel
The old panel.
newPanel
The new panel.
OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)
Parameters
e
OnKeyDown(KeyEventArgs)
Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
e
KeyEventArgs
OnMouseDown(MouseButtonEventArgs)
Declaration
protected override void OnMouseDown(MouseButtonEventArgs e)
Parameters
e
MouseButtonEventArgs
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
e
MouseWheelEventArgs
ScrollIntoView(object)
Scrolls the card containing the data item into view.
Declaration
public void ScrollIntoView(object item)
Parameters
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 Value
EventHandler<CardViewAutoGeneratingDataFieldDescriptorEventArgs>
CardBeginningEdit
Occurs before an edit operation is started.
Declaration
public event EventHandler<CardViewItemCancelEventArgs> CardBeginningEdit
Event Value
CardDataFieldBeginningEdit
Occurs before a card's data field is edited.
Declaration
public event EventHandler<CardDataFieldCancelEventArgs> CardDataFieldBeginningEdit
Event Value
CardDataFieldEditEnded
Occurs after a card's data field is edited.
Declaration
public event EventHandler<CardDataFieldEditEndedEventArgs> CardDataFieldEditEnded
Event Value
CardDataFieldPreparedEditor
Occurs when a card's data field editor is prepared for editing.
Declaration
public event EventHandler<CardDataFieldPreparedEditorEventArgs> CardDataFieldPreparedEditor
Event Value
CardDataFieldValidated
Occurs after a card's data field is validated.
Declaration
public event EventHandler<CardDataFieldValidatedEventArgs> CardDataFieldValidated
Event Value
CardDataFieldValidating
Occurs before a card's data field is validated.
Declaration
public event EventHandler<CardDataFieldValidatingEventArgs> CardDataFieldValidating
Event Value
CardEditEnded
Occurs after an edit operation is finished.
Declaration
public event EventHandler<CardViewEditEndedEventArgs> CardEditEnded
Event Value
CardEditEnding
Occurs before an edit operation is finished.
Declaration
public event EventHandler<CardViewEditEndingEventArgs> CardEditEnding
Event Value
CardValidating
Occurs when a card is being validated.
Declaration
public event EventHandler<CardViewItemCancelEventArgs> CardValidating
Event Value
DistinctValuesLoading
Occurs when the CardDataFieldDescriptor distinct values is about to be loaded.
Declaration
public event EventHandler<CardViewDistinctValuesLoadingEventArgs> DistinctValuesLoading
Event Value
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 Value
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 Value
Filtered
Occurs after filter operation.
Declaration
public event EventHandler<CardViewFilteredEventArgs> Filtered
Event Value
Filtering
Occurs before filter operation.
Declaration
public event EventHandler<CardViewFilteringEventArgs> Filtering
Event Value
Grouped
Occurs after grouping was performed.
Declaration
public event EventHandler<CardViewGroupedEventArgs> Grouped
Event Value
Grouping
Occurs while grouping is performed. (Cancelable).
Declaration
public event EventHandler<CardViewGroupingEventArgs> Grouping
Event Value
SelectionChanged
Occurs when the selected card view item has changed.
Declaration
public event SelectionChangedEventHandler SelectionChanged
Event Value
SelectionChangedEventHandler
Sorted
Occurs after sorted was performed.
Declaration
public event EventHandler<CardViewSortedEventArgs> Sorted
Event Value
Sorting
Occurs before RadCardView performs sorting.
Declaration
public event EventHandler<CardViewSortingEventArgs> Sorting
Event Value