Back to all docs
API Reference / Telerik.Windows.Controls / MonthViewDefinition

Class
MonthViewDefinition

Represents definition of a view that shows 42 days in month view mode.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.ScheduleView.dll

Syntax:
cs-api-definition
public class MonthViewDefinition : ViewDefinitionBase, INotifyPropertyChanged, ISlotConvertor

Inheritance: objectViewDefinitionBaseMonthViewDefinition

Implements: INotifyPropertyChangedISlotConvertor

Inherited Members ViewDefinitionBase.CalendarWeekRulePropertyViewDefinitionBase.StretchGroupHeadersPropertyViewDefinitionBase.TitlePropertyViewDefinitionBase.LargeChangeIntervalPropertyViewDefinitionBase.SmallChangeIntervalPropertyViewDefinitionBase.DayEndTimePropertyViewDefinitionBase.DayStartTimePropertyViewDefinitionBase.VisibleDaysPropertyViewDefinitionBase.FirstDayOfWeekPropertyViewDefinitionBase.MinTimeRulerExtentPropertyViewDefinitionBase.MaxTimeRulerExtentPropertyViewDefinitionBase.SubGroupsFilterPropertyViewDefinitionBase.GroupFilterPropertyViewDefinitionBase.AppointmentFilterPropertyViewDefinitionBase.OccurrenceFilterPropertyViewDefinitionBase.TimerulerMajorTickStringFormatPropertyViewDefinitionBase.SlotGenarationBehaviorPropertyViewDefinitionBase.SnapBehaviorPropertyViewDefinitionBase.ToString()ViewDefinitionBase.FormatWeekGroupHeaderName(IFormatProvider, IList<DateTime>, int)ViewDefinitionBase.GetShowWeekGroupHeaders()ViewDefinitionBase.GetVisibleRangeEnd(DateTime, CultureInfo, DayOfWeek?)ViewDefinitionBase.GetGroupDescriptions()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

MonthViewDefinition()

Declaration

cs-api-definition
public MonthViewDefinition()

Fields

AllowCustomAppointmentSizeProperty

Identifies the AllowCustomAppointmentSize property.

Declaration

cs-api-definition
public static readonly DependencyProperty AllowCustomAppointmentSizeProperty

Field Value

DependencyProperty

The identifier for the AllowCustomAppointmentSize property.

GroupHeaderDateStringFormatProperty

Identifies the GroupHeaderDateStringFormat property.

Declaration

cs-api-definition
public static readonly DependencyProperty GroupHeaderDateStringFormatProperty

Field Value

DependencyProperty

The identifier for the GroupHeaderDateStringFormat property.

TimerulerGroupStringFormatProperty

Identifies the TimerulerGroupStringFormat property.

Declaration

cs-api-definition
public static readonly DependencyProperty TimerulerGroupStringFormatProperty

Field Value

DependencyProperty

The identifier for the TimerulerGroupStringFormat property.

Properties

AllowCustomAppointmentSize

Gets or sets boolean value to indicate if appointments can have different size.

Declaration

cs-api-definition
public bool AllowCustomAppointmentSize { get; set; }

Property Value

bool

DateGroupDescription

Gets the Date group descriptor for MonthViewDefinition.

Declaration

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

Property Value

DateGroupDescription

Overrides ViewDefinitionBase.DateGroupDescription

GroupHeaderDateStringFormat

Gets or sets the format that will be applied on GroupHeader control for date time.

Declaration

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

Property Value

string

TimerulerGroupStringFormat

Gets or sets the format that will be applied on the time ruler of each group.

Declaration

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

Property Value

string

Methods

CreateInstanceCore()

Creates a new instance of the MonthViewDefinition class.

Declaration

cs-api-definition
protected override Freezable CreateInstanceCore()

Returns

Freezable

The new instance.

CreateRecurringSlot(IDateSpan, IDateSpan, DayOfWeek)

Creates the recurring slot for MonthViewDefinition.

Declaration

cs-api-definition
protected override Slot CreateRecurringSlot(IDateSpan anchor, IDateSpan current, DayOfWeek firstDayOfWeek)

Parameters

anchor

IDateSpan

current

IDateSpan

firstDayOfWeek

DayOfWeek

The first day of week.

Returns

Slot

The recurring slot.

Overrides ViewDefinitionBase.CreateRecurringSlot(IDateSpan, IDateSpan, DayOfWeek)

FormatGroupHeaderName(IFormatProvider, object)

If group name is DateTime this method formats the group name using the GroupHeaderDateStringFormat.

Declaration

cs-api-definition
protected override string FormatGroupHeaderName(IFormatProvider formatInfo, object groupName)

Parameters

formatInfo

IFormatProvider

The format info provider to be used for formatting.

groupName

object

The group name to format.

Returns

string

The formatted group name.

Overrides ViewDefinitionBase.FormatGroupHeaderName(IFormatProvider, object)

FormatVisibleRangeText(IFormatProvider, DateTime, DateTime, DateTime)

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)

GetGroupTickLength()

Creates new instance of FixedTickProvider.

Declaration

cs-api-definition
protected ITickProvider GetGroupTickLength()

Returns

ITickProvider

GetMajorTickLength()

Gets the length of the major ticks. This value is a provider object that might be auto tick length provider, constant tick length provider or a custom tick length provider.

Declaration

cs-api-definition
protected override sealed ITickProvider GetMajorTickLength()

Returns

ITickProvider

The length of the major ticks.

Overrides ViewDefinitionBase.GetMajorTickLength()

GetMaxTimeRulerExtent(double)

Gets the maximum size of the time ruler in pixels.

Declaration

cs-api-definition
protected override double GetMaxTimeRulerExtent(double defaultValue)

Parameters

defaultValue

double

The default value, provided by the ScheduleView.

Returns

double

The minimum size of the time ruler in pixels.

Overrides ViewDefinitionBase.GetMaxTimeRulerExtent(double)

Remarks

The returned value determines the maximum size of the time ruler in pixels. MaxTimeRulerExtent of 1400 pixels means that the time ruler will be rendered with no more than 1400 pixels no matter how much time it represents. If there is less than 1400 pixels available, it will be squeezed as much as the value returned from the GetMinTimeRulerExtent method allows to.

GetMinTimeRulerExtent(double)

Gets the minimum size of the time ruler in pixels.

Declaration

cs-api-definition
protected override double GetMinTimeRulerExtent(double defaultValue)

Parameters

defaultValue

double

The default value, provided by the ScheduleView.

Returns

double

The minimum size of the time ruler in pixels.

Overrides ViewDefinitionBase.GetMinTimeRulerExtent(double)

Remarks

The returned value determines the minimum size of the time ruler in pixels. MinTimeRulerExtent of 1400 pixels means that the time ruler will be rendered with at least 1400 pixels no matter how much time it represents. If there is more than 1400 pixels available, it will be stretched as much as the value returned from the GetMaxTimeRulerExtent method allows to.

GetMinorTickLength()

Gets the length of the minor ticks. This value is a provider object that might be auto tick length provider, constant tick length provider or a custom tick length provider.

Declaration

cs-api-definition
protected override sealed ITickProvider GetMinorTickLength()

Returns

ITickProvider

The length of the minor ticks. The default value is 1 day.

Overrides ViewDefinitionBase.GetMinorTickLength()

GetOrientation()

Gets the Orientation of the ViewDefinition.

Declaration

cs-api-definition
public override Orientation GetOrientation()

Returns

Orientation

Horizontal Orientation only.

Overrides ViewDefinitionBase.GetOrientation()

GetVisibleRangeStart(DateTime, CultureInfo, DayOfWeek?)

Calculated the visible range start using the current date (passed as parameter), a culture and if provided, a specific first day of week.

Declaration

cs-api-definition
protected override DateTime GetVisibleRangeStart(DateTime dateTime, CultureInfo culture, DayOfWeek? firstDayOfWeek)

Parameters

dateTime

DateTime

The current date to be used to calculate the visible range start.

culture

CultureInfo

The culture to be used to calculate the visible range start.

firstDayOfWeek

DayOfWeek?

The first day of week that overrides the one, provided by the culture.

Returns

DateTime

The visible range start for the corresponding current date, culture and first day of week.

Overrides ViewDefinitionBase.GetVisibleRangeStart(DateTime, CultureInfo, DayOfWeek?)

Remarks

For example the WeekViewDefinition "snaps" to weeks. That means that it will always provide as visible range start a date, that is the first day of the week which contains the current date and this first day will be the same day of week as the provided one. If no firstDayOfWeek is provided, the value from the culture is used. Example: If the first day of week is Monday and the current date is 2010/10/29 the result will be 2010/10/25.

PrepareContainerForItemOverride(DependencyObject, object)

Prepares the specified element to display the specified item.

Declaration

cs-api-definition
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

Element used to display the specified item.

item

object

Specified item.

Overrides ViewDefinitionBase.PrepareContainerForItemOverride(DependencyObject, object)

In this article
DefinitionConstructorsMonthViewDefinition()FieldsAllowCustomAppointmentSizePropertyGroupHeaderDateStringFormatPropertyTimerulerGroupStringFormatPropertyPropertiesAllowCustomAppointmentSizeDateGroupDescriptionGroupHeaderDateStringFormatTimerulerGroupStringFormatMethodsCreateInstanceCore()CreateRecurringSlot(IDateSpan, IDateSpan, DayOfWeek)FormatGroupHeaderName(IFormatProvider, object)FormatVisibleRangeText(IFormatProvider, DateTime, DateTime, DateTime)GetGroupTickLength()GetMajorTickLength()GetMaxTimeRulerExtent(double)GetMinTimeRulerExtent(double)GetMinorTickLength()GetOrientation()GetVisibleRangeStart(DateTime, CultureInfo, DayOfWeek?)PrepareContainerForItemOverride(DependencyObject, object)
Not finding the help you need?
Contact Support