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, ITextProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementSchedulerVisualElementSchedulerViewElementSchedulerMonthViewElement...
Implements:
Inherited Members
Constructors
Initializes a new instance of the SchedulerMonthViewElement class with the specified scheduler control and view configuration.
public SchedulerMonthViewElement(RadScheduler scheduler, SchedulerView view)
The RadScheduler control that owns this view element.
viewSchedulerViewThe SchedulerView configuration that this element represents.
Fields
public static RadProperty AppointmentHeightProperty
public static RadProperty AppointmentMarginProperty
public static RadProperty VerticalNavigatorWidthProperty
Properties
Gets or sets the default height in pixels for appointment elements displayed within the month view cells.
[VsbBrowsable(true)]
public int AppointmentHeight { get; set; }
Gets or sets the spacing margin applied around appointment elements to provide visual separation and improve readability within month view cells.
[VsbBrowsable(true)]
public override Padding AppointmentMargin { get; set; }
Overrides:
Gets the header element that displays day names and column headers at the top of the month view grid.
public MonthViewHeader Header { get; }
Gets the main content area element that contains the month calendar grid with individual day cells and their appointments.
public MonthViewAreaElement MonthViewAreaElement { get; }
Gets the vertical header element that displays week numbers and provides row headers on the left side of the month view grid.
public MonthViewVerticalHeader VerticalHeader { get; }
Gets or sets the width in pixels of the vertical navigation scrollbar used for quick month-to-month navigation.
[VsbBrowsable(true)]
public int VerticalNavigatorWidth { get; set; }
Gets the vertical scrollbar element used for navigating through different months when the view contains more content than can be displayed.
public RadScrollBarElement VerticalScrollbar { get; }
Methods
Arranges and positions the child elements within the specified final size, including headers, content area, navigation elements, and scrollbar.
Gets the scheduler cell element at the specified row and column position in the month view grid.
public override SchedulerCellElement GetCellAtPosition(int row, int column)
The row position in the grid.
columnintThe column position in the grid.
Returns:The SchedulerCellElement at the specified position, or null if no cell exists.
Overrides:
Gets a list of all cell containers that are part of this month view element, including the main area, vertical header, and header.
public override List<SchedulerCellContainer> GetCellContainers()
List<SchedulerCellContainer>
A list of SchedulerCellContainer objects representing all cell containers in the view.
Overrides:
Gets the table layout coordinates for the specified scheduler cell element within the month view structure.
public override TableLayoutPanelCellPosition GetCellCoordinates(SchedulerCellElement cell)
The SchedulerCellElement to get coordinates for.
Returns:The TableLayoutPanelCellPosition representing the cell's position in the layout.
Overrides:
Gets the horizontal offset in pixels of the column with a specified index relative to the left edge of the first column.
Gets the total combined width in pixels of a range of consecutive columns given their indices.
public float GetColumnsWidth(int startColumn, int endColumn, float availableWidth)
The index of the first column in the range.
endColumnintThe index of the last column in the range (inclusive).
availableWidthfloatThe total width available for all columns.
Returns:The combined width of the specified column range in pixels.
Gets the calculated width in pixels of the column with a specified index based on the available space and column proportions.
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.
Gets the calculated height in pixels of the row with a specified index based on the available space and row proportions.
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.
Gets the total combined height in pixels of a range of consecutive rows given their indices.
public float GetRowsHeight(int startRow, int endRow, float availableHeight)
The index of the first row in the range.
endRowintThe index of the last row in the range (inclusive).
availableHeightfloatThe total height available for all rows.
Returns:The combined height of the specified row range in pixels.
Gets the vertical offset in pixels of the row with a specified index relative to the top edge of the first row.
Determines the tooltip text displayed for the vertical scrollbar based on the current scroll position and target date.
protected virtual string GetScrollbarToolTipText()
A formatted date string representing the target date for the current scroll position.
Hides the tooltip that was displayed during scrollbar interaction.
protected virtual void HideScrollToolTip()
Initializes and creates all child elements that comprise the month view layout, including headers, navigation controls, and content areas.
protected virtual void InitializeChildren()
Initializes the default field values and sets the CSS class for the month view element.
protected override void InitializeFields()
Overrides:
Initializes and configures the vertical scrollbar element with event handlers for month navigation.
protected virtual RadScrollBarElement InitializeVerticalScrollbar()
A configured RadScrollBarElement for vertical navigation.
Measures the size required by this element and its child elements based on the available size, including headers and scrollbar.
Navigates backward to the previous time period, typically the previous month or week depending on the view configuration.
public override void NavigateBackward()
Overrides:
Navigates forward to the next time period, typically the next month or week depending on the view configuration.
public override void NavigateForward()
Overrides:
Handles vertical scroll events for month navigation when the user interacts with the scrollbar buttons.
protected virtual void OnVerticalScroll(object sender, ScrollEventArgs e)
The object that raised the event.
eScrollEventArgsThe ScrollEventArgs containing scroll event information.
Handles the ValueChanged event of the vertical scrollbar and navigates to the corresponding date based on the new scroll position.
Handles property changes from the associated scheduler view and updates the visual elements accordingly.
protected override void OnViewPropertyChanged(object sender, PropertyChangedEventArgs e)
The object that raised the event.
ePropertyChangedEventArgsThe PropertyChangedEventArgs containing information about the changed property.
Overrides:
Scrolls the month view vertically in the specified direction by moving to the adjacent month or week range.
public override void Scroll(bool up)
True to scroll up (previous period), false to scroll down (next period).
Overrides:
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.
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.
Displays a tooltip next to the vertical scrollbar showing the target date during scroll operations.
protected virtual void ShowScrollbarToolTip()
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.
protected virtual void UpdateVerticalScrollbar()