ClassSchedulerMonthViewElement
Represents the main visual element of RadScheduler when in SchedulerMonthView mode, providing a calendar-style grid layout for displaying and managing appointments across an entire month.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.Scheduler.dll
Syntax:
public class SchedulerMonthViewElement : SchedulerViewElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProviderInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementSchedulerVisualElementSchedulerViewElementSchedulerMonthViewElement
Implements:
Inherited Members
Constructors
SchedulerMonthViewElement(RadScheduler, SchedulerView)
Initializes a new instance of the SchedulerMonthViewElement class with the specified scheduler control and view configuration.
Declaration
public SchedulerMonthViewElement(RadScheduler scheduler, SchedulerView view)Parameters
scheduler
The RadScheduler control that owns this view element.
view
The SchedulerView configuration that this element represents.
Fields
AppointmentHeightProperty
Declaration
public static RadProperty AppointmentHeightPropertyField Value
AppointmentMarginProperty
Declaration
public static RadProperty AppointmentMarginPropertyField Value
VerticalNavigatorWidthProperty
Declaration
public static RadProperty VerticalNavigatorWidthPropertyField Value
Properties
AppointmentHeight
Gets or sets the default height in pixels for appointment elements displayed within the month view cells.
Declaration
[VsbBrowsable(true)]
public int AppointmentHeight { get; set; }Property Value
AppointmentMargin
Gets or sets the spacing margin applied around appointment elements to provide visual separation and improve readability within month view cells.
Declaration
[VsbBrowsable(true)]
public override Padding AppointmentMargin { get; set; }Property Value
Overrides
Header
Gets the header element that displays day names and column headers at the top of the month view grid.
MonthViewAreaElement
Gets the main content area element that contains the month calendar grid with individual day cells and their appointments.
Declaration
public MonthViewAreaElement MonthViewAreaElement { get; }Property Value
VerticalHeader
Gets the vertical header element that displays week numbers and provides row headers on the left side of the month view grid.
Declaration
public MonthViewVerticalHeader VerticalHeader { get; }Property Value
VerticalNavigatorWidth
Gets or sets the width in pixels of the vertical navigation scrollbar used for quick month-to-month navigation.
Declaration
[VsbBrowsable(true)]
public int VerticalNavigatorWidth { get; set; }Property Value
VerticalScrollbar
Gets the vertical scrollbar element used for navigating through different months when the view contains more content than can be displayed.
Declaration
public RadScrollBarElement VerticalScrollbar { get; }Property Value
Methods
ArrangeOverride(SizeF)
Arranges and positions the child elements within the specified final size, including headers, content area, navigation elements, and scrollbar.
GetCellAtPosition(int, int)
Gets the scheduler cell element at the specified row and column position in the month view grid.
Declaration
public override SchedulerCellElement GetCellAtPosition(int row, int column)Parameters
row
The row position in the grid.
column
The column position in the grid.
Returns
The SchedulerCellElement at the specified position, or null if no cell exists.
Overrides
GetCellContainers()
Gets a list of all cell containers that are part of this month view element, including the main area, vertical header, and header.
Declaration
public override List<SchedulerCellContainer> GetCellContainers()Returns
List<SchedulerCellContainer>
A list of SchedulerCellContainer objects representing all cell containers in the view.
Overrides
GetCellCoordinates(SchedulerCellElement)
Gets the table layout coordinates for the specified scheduler cell element within the month view structure.
Declaration
public override TableLayoutPanelCellPosition GetCellCoordinates(SchedulerCellElement cell)Parameters
cell
The SchedulerCellElement to get coordinates for.
Returns
The TableLayoutPanelCellPosition representing the cell's position in the layout.
Overrides
GetColumnHorizontalOffset(int, float)
Gets the horizontal offset in pixels of the column with a specified index relative to the left edge of the first column.
GetColumnWidth(int)
Gets the proportional width value for a column as set by the SetColumnWidth(int, float) method. The actual width of a column is calculated proportionally according to the values other columns have. The default value of each column is 1.0, meaning that setting a value of 2.0 for a given column will make it twice as large compared to other columns. To get the width of a column in pixels use the GetColumnWidth(int, float) overload.
GetColumnWidth(int, float)
Gets the calculated width in pixels of the column with a specified index based on the available space and column proportions.
GetColumnsWidth(int, int, float)
Gets the total combined width in pixels of a range of consecutive columns given their indices.
Declaration
public float GetColumnsWidth(int startColumn, int endColumn, float availableWidth)Parameters
startColumn
The index of the first column in the range.
endColumn
The index of the last column in the range (inclusive).
availableWidth
The total width available for all columns.
Returns
The combined width of the specified column range in pixels.
GetRowHeight(int)
Gets the proportional height value for a row as set by the SetRowHeight(int, float) method. The actual height of a row is calculated proportionally according to the values other rows have. The default value of each row is 1.0, meaning that setting a value of 2.0 for a given row will make it twice as large compared to other rows. To get the height of a row in pixels use the GetRowHeight(int, float) overload.
GetRowHeight(int, float)
Gets the calculated height in pixels of the row with a specified index based on the available space and row proportions.
GetRowVerticalOffset(int, float)
Gets the vertical offset in pixels of the row with a specified index relative to the top edge of the first row.
GetRowsHeight(int, int, float)
Gets the total combined height in pixels of a range of consecutive rows given their indices.
Declaration
public float GetRowsHeight(int startRow, int endRow, float availableHeight)Parameters
startRow
The index of the first row in the range.
endRow
The index of the last row in the range (inclusive).
availableHeight
The total height available for all rows.
Returns
The combined height of the specified row range in pixels.
GetScrollbarToolTipText()
Determines the tooltip text displayed for the vertical scrollbar based on the current scroll position and target date.
Declaration
protected virtual string GetScrollbarToolTipText()Returns
A formatted date string representing the target date for the current scroll position.
HideScrollToolTip()
Hides the tooltip that was displayed during scrollbar interaction.
Declaration
protected virtual void HideScrollToolTip()InitializeChildren()
Initializes and creates all child elements that comprise the month view layout, including headers, navigation controls, and content areas.
Declaration
protected virtual void InitializeChildren()InitializeFields()
Initializes the default field values and sets the CSS class for the month view element.
Declaration
protected override void InitializeFields()Overrides
InitializeVerticalScrollbar()
Initializes and configures the vertical scrollbar element with event handlers for month navigation.
Declaration
protected virtual RadScrollBarElement InitializeVerticalScrollbar()Returns
A configured RadScrollBarElement for vertical navigation.
MeasureOverride(SizeF)
Measures the size required by this element and its child elements based on the available size, including headers and scrollbar.
NavigateBackward()
Navigates backward to the previous time period, typically the previous month or week depending on the view configuration.
Declaration
public override void NavigateBackward()Overrides
NavigateForward()
Navigates forward to the next time period, typically the next month or week depending on the view configuration.
Declaration
public override void NavigateForward()Overrides
OnVerticalScroll(object, ScrollEventArgs)
Handles vertical scroll events for month navigation when the user interacts with the scrollbar buttons.
Declaration
protected virtual void OnVerticalScroll(object sender, ScrollEventArgs e)Parameters
sender
The object that raised the event.
e
The ScrollEventArgs containing scroll event information.
OnVerticalScrollBarValueChanged(object, EventArgs)
Handles the ValueChanged event of the vertical scrollbar and navigates to the corresponding date based on the new scroll position.
OnViewPropertyChanged(object, PropertyChangedEventArgs)
Handles property changes from the associated scheduler view and updates the visual elements accordingly.
Declaration
protected override void OnViewPropertyChanged(object sender, PropertyChangedEventArgs e)Parameters
sender
The object that raised the event.
e
The PropertyChangedEventArgs containing information about the changed property.
Overrides
Scroll(bool)
Scrolls the month view vertically in the specified direction by moving to the adjacent month or week range.
Declaration
public override void Scroll(bool up)Parameters
up
True to scroll up (previous period), false to scroll down (next period).
Overrides
SetColumnWidth(int, float)
Sets the proportional width value for a column. The actual width of a column is calculated proportionally according to the values other columns have. The default value of each column is 1.0. This means that setting a value of 2.0 for a given column will make it twice as large compared to other columns.
SetRowHeight(int, float)
Sets the proportional height value for a row. The actual height of a row is calculated proportionally according to the values other rows have. The default value of each row is 1.0. This means that setting a value of 2.0 for a given row will make it twice as large compared to other rows.
ShowScrollbarToolTip()
Displays a tooltip next to the vertical scrollbar showing the target date during scroll operations.
Declaration
protected virtual void ShowScrollbarToolTip()UpdateVerticalScrollbar()
Updates the vertical scrollbar's settings including range, value, and visibility based on the current view configuration. Called when the view's settings have changed to synchronize the scrollbar with the month view state.
Declaration
protected virtual void UpdateVerticalScrollbar()