Loading...

Class MonthViewDefinition

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

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

Syntax

public class MonthViewDefinition : ViewDefinitionBase, INotifyPropertyChanged, ISlotConvertor

Constructors

MonthViewDefinition()

Declaration
public MonthViewDefinition()

Fields

AllowCustomAppointmentSizeProperty

Identifies the AllowCustomAppointmentSize property.

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

The identifier for the AllowCustomAppointmentSize property.

GroupHeaderDateStringFormatProperty

Identifies the GroupHeaderDateStringFormat property.

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

The identifier for the GroupHeaderDateStringFormat property.

TimerulerGroupStringFormatProperty

Identifies the TimerulerGroupStringFormat property.

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

The identifier for the TimerulerGroupStringFormat property.

Properties

AllowCustomAppointmentSize

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

Declaration
public bool AllowCustomAppointmentSize { get; set; }
Property Value
System.Boolean

DateGroupDescription

Gets the Date group descriptor for MonthViewDefinition.

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

Overrides

GroupHeaderDateStringFormat

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

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

TimerulerGroupStringFormat

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

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

Methods

CreateInstanceCore()

Creates a new instance of the MonthViewDefinition class.

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

The new instance.

CreateRecurringSlot(IDateSpan, IDateSpan, DayOfWeek)

Creates the recurring slot for MonthViewDefinition.

Declaration
protected override Slot CreateRecurringSlot(IDateSpan anchor, IDateSpan current, DayOfWeek firstDayOfWeek)
Parameters
IDateSpan anchor

IDateSpan current

System.DayOfWeek firstDayOfWeek

The first day of week.
Returns
Slot

The recurring slot.
Overrides

FormatGroupHeaderName(IFormatProvider, Object)

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

Declaration
protected override string FormatGroupHeaderName(IFormatProvider formatInfo, object groupName)
Parameters
System.IFormatProvider formatInfo

The format info provider to be used for formatting.
System.Object groupName

The group name to format.
Returns
System.String

The formatted group name.
Overrides

FormatVisibleRangeText(IFormatProvider, DateTime, DateTime, DateTime)

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

GetGroupTickLength()

Creates new instance of FixedTickProvider.

Declaration
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
protected override sealed ITickProvider GetMajorTickLength()
Returns
ITickProvider

The length of the major ticks.
Overrides

GetMaxTimeRulerExtent(Double)

Gets the maximum size of the time ruler in pixels.

Declaration
protected override double GetMaxTimeRulerExtent(double defaultValue)
Parameters
System.Double defaultValue

The default value, provided by the ScheduleView.
Returns
System.Double

The minimum size of the time ruler in pixels.
Overrides
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.

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
protected override sealed ITickProvider GetMinorTickLength()
Returns
ITickProvider

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

GetMinTimeRulerExtent(Double)

Gets the minimum size of the time ruler in pixels.

Declaration
protected override double GetMinTimeRulerExtent(double defaultValue)
Parameters
System.Double defaultValue

The default value, provided by the ScheduleView.
Returns
System.Double

The minimum size of the time ruler in pixels.
Overrides
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.

GetOrientation()

Gets the Orientation of the ViewDefinition.

Declaration
public override Orientation GetOrientation()
Returns
System.Windows.Controls.Orientation

Horizontal Orientation only.
Overrides

GetVisibleRangeStart(DateTime, CultureInfo, Nullable<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
protected override DateTime GetVisibleRangeStart(DateTime dateTime, CultureInfo culture, Nullable<DayOfWeek> firstDayOfWeek)
Parameters
System.DateTime dateTime

The current date to be used to calculate the visible range start.
System.Globalization.CultureInfo culture

The culture to be used to calculate the visible range start.
System.Nullable<System.DayOfWeek> firstDayOfWeek

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

The visible range start for the corresponding current date, culture and first day of week.
Overrides
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
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

Element used to display the specified item.
System.Object item

Specified item.
Overrides

Extension Methods