Documentation

Class CustomViewDefinition

Represents a custom ViewDefinitionBase that overrides the GroupDescriptions and allows custom visible range formatting.

Inheritance
System.Object
ViewDefinitionBase
MultidayViewDefinition
CustomViewDefinition
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.ScheduleView.dll

Syntax

public class CustomViewDefinition : MultidayViewDefinition, INotifyPropertyChanged, ISlotConvertor

Constructors

CustomViewDefinition()

Initializes a new instance of the CustomViewDefinition class.

Declaration
public CustomViewDefinition()

Fields

CurrentVisibleRangeFormatProperty

Identifies the CurrentVisibleRangeFormat property.

Declaration
public static readonly DependencyProperty CurrentVisibleRangeFormatProperty
Field Value
System.Windows.DependencyProperty

The identifier for the CurrentVisibleRangeFormat property.

Properties

CurrentVisibleRangeFormat

Gets or sets the format to be used for displaying the current visible range.

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

Remarks

The format will be passed to String.Format to format the current visible range data, that is represented by the VisibleRangeStart, VisibleRangeEnd and CurrentDate properties of the ScheduleView in this order.

DateGroupDescription

Gets the date group description. This property return null so that GroupDescriptors are used to specify the grouping.

Declaration
protected override DateGroupDescription DateGroupDescription { get; }
Property Value
DateGroupDescription

Overrides

GroupDescriptions

Gets or sets a collection of GroupDescription objects that describes how the items in the collection are grouped in the view.

Declaration
public ObservableCollection<GroupDescription> GroupDescriptions { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<System.ComponentModel.GroupDescription>

Methods

CreateInstanceCore()

Creates a new instance of the CustomViewDefinition class.

Declaration
protected override Freezable CreateInstanceCore()
Returns
System.Windows.Freezable

The new instance.

FormatVisibleRangeText(IFormatProvider, DateTime, DateTime, DateTime)

When overridden in a derived class, this method formats the string that represents the current visible range.

Declaration
protected override string FormatVisibleRangeText(IFormatProvider formatInfo, DateTime rangeStart, DateTime rangeEnd, DateTime currentDate)
Parameters
System.IFormatProvider formatInfo

The format info provider to be used for formatting.
System.DateTime rangeStart

The start of the visible range.
System.DateTime rangeEnd

The end of the visible range.
System.DateTime currentDate

The current date.
Returns
System.String

The formatted string to be displayed as current visible range.
Overrides

GetGroupDescriptions()

Gets the group descriptions.

Declaration
protected override IEnumerable<GroupDescription> GetGroupDescriptions()
Returns
System.Collections.Generic.IEnumerable<System.ComponentModel.GroupDescription>

An enumerable set of GroupDescription objects that will be used for grouping.
Overrides

Extension Methods