Class
CustomViewDefinition

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

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.ScheduleView.dll

Syntax:

cs-api-definition
public class CustomViewDefinition : MultidayViewDefinition, INotifyPropertyChanged, ISlotConvertor

Inheritance: objectViewDefinitionBaseMultidayViewDefinitionCustomViewDefinition

Implements: INotifyPropertyChangedISlotConvertor

Inherited Members MultidayViewDefinition.GroupHeaderDateStringFormatPropertyMultidayViewDefinition.OrientationPropertyMultidayViewDefinition.MinorTickLengthPropertyMultidayViewDefinition.MajorTickLengthPropertyMultidayViewDefinition.TimerulerMinorTickStringFormatPropertyMultidayViewDefinition.GetOrientation()MultidayViewDefinition.GetMinorTickLength()MultidayViewDefinition.GetMajorTickLength()MultidayViewDefinition.FormatGroupHeaderName(IFormatProvider, object)MultidayViewDefinition.GroupHeaderDateStringFormatMultidayViewDefinition.OrientationMultidayViewDefinition.MinorTickLengthMultidayViewDefinition.MajorTickLengthMultidayViewDefinition.TimerulerMinorTickStringFormatViewDefinitionBase.CalendarWeekRulePropertyViewDefinitionBase.StretchGroupHeadersPropertyViewDefinitionBase.TitlePropertyViewDefinitionBase.LargeChangeIntervalPropertyViewDefinitionBase.SmallChangeIntervalPropertyViewDefinitionBase.DayEndTimePropertyViewDefinitionBase.DayStartTimePropertyViewDefinitionBase.VisibleDaysPropertyViewDefinitionBase.FirstDayOfWeekPropertyViewDefinitionBase.MinTimeRulerExtentPropertyViewDefinitionBase.MaxTimeRulerExtentPropertyViewDefinitionBase.SubGroupsFilterPropertyViewDefinitionBase.GroupFilterPropertyViewDefinitionBase.AppointmentFilterPropertyViewDefinitionBase.OccurrenceFilterPropertyViewDefinitionBase.TimerulerMajorTickStringFormatPropertyViewDefinitionBase.SlotGenarationBehaviorPropertyViewDefinitionBase.SnapBehaviorPropertyViewDefinitionBase.ToString()ViewDefinitionBase.GetMinTimeRulerExtent(double)ViewDefinitionBase.GetMaxTimeRulerExtent(double)ViewDefinitionBase.FormatWeekGroupHeaderName(IFormatProvider, IList<DateTime>, int)ViewDefinitionBase.GetShowWeekGroupHeaders()ViewDefinitionBase.PrepareContainerForItemOverride(DependencyObject, object)ViewDefinitionBase.CreateRecurringSlot(IDateSpan, IDateSpan, DayOfWeek)ViewDefinitionBase.GetVisibleRangeStart(DateTime, CultureInfo, DayOfWeek?)ViewDefinitionBase.GetVisibleRangeEnd(DateTime, CultureInfo, DayOfWeek?)ViewDefinitionBase.OnPropertyChanged(string)ViewDefinitionBase.OnPropertyChanged<T>(Expression<Func<T>>)ViewDefinitionBase.OnPropertyChanged(PropertyChangedEventArgs)ViewDefinitionBase.CalendarWeekRuleViewDefinitionBase.StretchGroupHeadersViewDefinitionBase.TitleViewDefinitionBase.LargeChangeIntervalViewDefinitionBase.SmallChangeIntervalViewDefinitionBase.FirstDayOfWeekViewDefinitionBase.VisibleDaysViewDefinitionBase.DayEndTimeViewDefinitionBase.DayStartTimeViewDefinitionBase.MinTimeRulerExtentViewDefinitionBase.MaxTimeRulerExtentViewDefinitionBase.SubGroupsFilterViewDefinitionBase.GroupFilterViewDefinitionBase.AppointmentFilterViewDefinitionBase.OccurrenceFilterViewDefinitionBase.TimerulerMajorTickStringFormatViewDefinitionBase.SlotGenarationBehaviorViewDefinitionBase.SnapBehaviorViewDefinitionBase.ShowTimeRulerViewDefinitionBase.PropertyChanged

Constructors

CustomViewDefinition()

Initializes a new instance of the CustomViewDefinition class.

Declaration

cs-api-definition
public CustomViewDefinition()

Fields

CurrentVisibleRangeFormatProperty

Identifies the CurrentVisibleRangeFormat property.

Declaration

cs-api-definition
public static readonly DependencyProperty CurrentVisibleRangeFormatProperty

Field Value

DependencyProperty

The identifier for the CurrentVisibleRangeFormat property.

Properties

CurrentVisibleRangeFormat

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

Declaration

cs-api-definition
public string CurrentVisibleRangeFormat { get; set; }

Property Value

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

cs-api-definition
protected override DateGroupDescription DateGroupDescription { get; }

Property Value

DateGroupDescription

Overrides MultidayViewDefinition.DateGroupDescription

GroupDescriptions

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

Declaration

cs-api-definition
public ObservableCollection<GroupDescription> GroupDescriptions { get; }

Property Value

ObservableCollection<GroupDescription>

Methods

CreateInstanceCore()

Creates a new instance of the CustomViewDefinition class.

Declaration

cs-api-definition
protected override Freezable CreateInstanceCore()

Returns

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

cs-api-definition
protected override string FormatVisibleRangeText(IFormatProvider formatInfo, DateTime rangeStart, DateTime rangeEnd, DateTime currentDate)

Parameters

formatInfo

IFormatProvider

The format info provider to be used for formatting.

rangeStart

DateTime

The start of the visible range.

rangeEnd

DateTime

The end of the visible range.

currentDate

DateTime

The current date.

Returns

string

The formatted string to be displayed as current visible range.

Overrides ViewDefinitionBase.FormatVisibleRangeText(IFormatProvider, DateTime, DateTime, DateTime)

GetGroupDescriptions()

Gets the group descriptions.

Declaration

cs-api-definition
protected override IEnumerable<GroupDescription> GetGroupDescriptions()

Returns

IEnumerable<GroupDescription>

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

Overrides ViewDefinitionBase.GetGroupDescriptions()