Class SchedulerNavigatorElement

Represents the main visual element for the scheduler navigator control, providing comprehensive navigation functionality including view switching, date navigation, time zone selection, and weekend display options for the RadScheduler component. Extends LightVisualElement to provide a rich user interface for scheduler interaction.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
SchedulerNavigatorElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.Scheduler.dll

Syntax

public class SchedulerNavigatorElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

SchedulerNavigatorElement()

Declaration
public SchedulerNavigatorElement()

Properties

AgendaViewButton

Gets the agenda view button element that allows users to switch the scheduler to agenda view mode.

Declaration
public RadButtonElement AgendaViewButton { get; }
Property Value
RadButtonElement

AgendaViewButtonVisible

Gets or sets a value indicating whether the Agenda View button is visible in the navigation interface.

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

true if Agenda View button is visible; otherwise, false.
Remarks

The agenda view button will not be hidden when the scheduler is currently in agenda view.

AutomaticNavigation

Gets or sets a value indicating whether automatic navigation mode is enabled. When enabled, navigation steps are automatically determined and the NavigationStep property is not used.

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

DateFormat

Gets or sets the date format string used to display the date range in the navigator. Changes to this property automatically trigger a refresh of the displayed date range.

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

DateLabel

Gets the label element that displays the current date range being viewed in the scheduler.

Declaration
public RadLabelElement DateLabel { get; }
Property Value
RadLabelElement

DateSelectorButton

Gets the toggle button element that allows users to open the date selector calendar popup.

Declaration
public RadToggleButtonElement DateSelectorButton { get; }
Property Value
RadToggleButtonElement

DateSelectorButtonVisible

Gets or sets a value indicating whether the date selector button is visible in the navigation interface.

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

true if the date selector button is visible; otherwise, false.

DateSelectorCalendar

Gets the calendar control used within the date selector popup for date selection and navigation.

Declaration
public RadCalendar DateSelectorCalendar { get; }
Property Value
RadCalendar

DateSelectorPopup

Gets the resizable popup control that contains the date selector calendar for quick date navigation.

Declaration
public RadSizablePopupControl DateSelectorPopup { get; }
Property Value
RadSizablePopupControl

DayViewButton

Gets the day view button element that allows users to switch the scheduler to day view mode.

Declaration
public RadButtonElement DayViewButton { get; }
Property Value
RadButtonElement

DayViewButtonVisible

Gets or sets a value indicating whether the Day View button is visible in the navigation interface.

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

true if Day View button is visible; otherwise, false.
Remarks

The day view button will not be hidden when the scheduler is currently in day view.

MonthViewButton

Gets the month view button element that allows users to switch the scheduler to month view mode.

Declaration
public RadButtonElement MonthViewButton { get; }
Property Value
RadButtonElement

MonthViewButtonVisible

Gets or sets a value indicating whether the Month View button is visible in the navigation interface.

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

true if Month View button is visible; otherwise, false.
Remarks

The month view button will not be hidden when the scheduler is currently in month view.

NavigateBackwardsButton

Gets the navigation button element that allows users to navigate backwards in time (previous period).

Declaration
public RadButtonElement NavigateBackwardsButton { get; }
Property Value
RadButtonElement

NavigateForwardsButton

Gets the navigation button element that allows users to navigate forwards in time (next period).

Declaration
public RadButtonElement NavigateForwardsButton { get; }
Property Value
RadButtonElement

NavigateTodayButton

Gets the navigate today button element that allows users to quickly navigate to the current date in the scheduler.

Declaration
public RadButtonElement NavigateTodayButton { get; }
Property Value
RadButtonElement

NavigationPanel

Gets an instance of the StackLayoutPanel class that represents the container in which the navigation buttons of the RadSchedulerNavigator are layout.

Declaration
public DockLayoutPanel NavigationPanel { get; }
Property Value
DockLayoutPanel

NavigationPanelBorder

Gets an instance of the BorderPrimitive class that represents the border of the panel that holds the navigation buttons of the RadSchedulerNavigator.

Declaration
public BorderPrimitive NavigationPanelBorder { get; }
Property Value
BorderPrimitive

NavigationPanelFill

Gets an instance of the FillPrimitive class that represents the fill of the panel that holds the navigation buttons of the RadSchedulerNavigator.

Declaration
public FillPrimitive NavigationPanelFill { get; }
Property Value
FillPrimitive

NavigationStep

Gets or sets the number of time units to navigate when using the forward and backward navigation buttons. Must be greater than or equal to 1. Only used when AutomaticNavigation is false.

Declaration
public int NavigationStep { get; set; }
Property Value
System.Int32

NavigationStepType

Gets or sets the type of time unit used for navigation steps, determining whether navigation moves by days, weeks, months, or years. Only used when AutomaticNavigation is false.

Declaration
public NavigationStepTypes NavigationStepType { get; set; }
Property Value
NavigationStepTypes

NavigatorBorder

Gets an instance of the BorderPrimitive class that represents the border of the RadSchedulerNavigator.

Declaration
public BorderPrimitive NavigatorBorder { get; }
Property Value
BorderPrimitive

NavigatorFill

Gets an instance of the FillPrimitive class that represents the background fill of the RadSchedulerNavigator.

Declaration
public FillPrimitive NavigatorFill { get; }
Property Value
FillPrimitive

SearchGrid

Gets the grid view control used for displaying search results within the navigator.

Declaration
public RadGridView SearchGrid { get; }
Property Value
RadGridView

SearchTextBox

Gets or sets the search textbox control that allows users to search for appointments within the scheduler.

Declaration
public SchedulerNavigatorSearchTextbox SearchTextBox { get; set; }
Property Value
SchedulerNavigatorSearchTextbox

ShowWeekendCheckBox

Gets the checkbox element that allows users to toggle the display of weekend days in the scheduler views.

Declaration
public RadCheckBoxElement ShowWeekendCheckBox { get; }
Property Value
RadCheckBoxElement

ShowWeekendCheckBoxPanel

Gets an instance of the StackLayoutPanel class that represents the container in which the show weekend checkbox of the RadSchedulerNavigator is layout.

Declaration
public LightVisualElement ShowWeekendCheckBoxPanel { get; }
Property Value
LightVisualElement

TimelineViewButton

Gets the timeline view button element that allows users to switch the scheduler to timeline view mode.

Declaration
public RadButtonElement TimelineViewButton { get; }
Property Value
RadButtonElement

TimelineViewButtonVisible

Gets or sets a value indicating whether the Timeline View button is visible in the navigation interface.

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

true if Timeline View button is visible; otherwise, false.
Remarks

The timeline view button will not be hidden when the scheduler is currently in timeline view.

TimeZoneLabel

Gets the time zone label element that displays information about the current time zone setting.

Declaration
public RadLabelElement TimeZoneLabel { get; }
Property Value
RadLabelElement

TimeZonesDropDown

Gets the time zones dropdown element that allows users to select and switch between different time zones for the scheduler display.

Declaration
public RadDropDownListElement TimeZonesDropDown { get; }
Property Value
RadDropDownListElement

TimeZonesElementLayout

Gets the layout container element that houses the time zone selection controls and their associated visual elements.

Declaration
public LightVisualElement TimeZonesElementLayout { get; }
Property Value
LightVisualElement

TodayButtonElementLayout

Gets the layout container element that houses the today button and its associated visual elements.

Declaration
public LightVisualElement TodayButtonElementLayout { get; }
Property Value
LightVisualElement

ViewPanel

Gets an instance of the StackLayoutPanel class that represents the container in which the view buttons of the RadSchedulerNavigator are layout.

Declaration
public DockLayoutPanel ViewPanel { get; }
Property Value
DockLayoutPanel

ViewPanelBorder

Gets an instance of the BorderPrimitive class that represents the border of the panel that holds the view buttons of the RadSchedulerNavigator.

Declaration
public BorderPrimitive ViewPanelBorder { get; }
Property Value
BorderPrimitive

ViewPanelFill

Gets an instance of the FillPrimitive class that represents the fill of the panel that holds the view buttons of the RadSchedulerNavigator.

Declaration
public FillPrimitive ViewPanelFill { get; }
Property Value
FillPrimitive

WeekViewButton

Gets the week view button element that allows users to switch the scheduler to week view mode.

Declaration
public RadButtonElement WeekViewButton { get; }
Property Value
RadButtonElement

WeekViewButtonVisible

Gets or sets a value indicating whether the Week View button is visible in the navigation interface.

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

true if Week View button is visible; otherwise, false.
Remarks

The week view button will not be hidden when the scheduler is currently in week view.

Methods

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateDateSelectorCalendar()

Creates the calendar control used within the date selector popup for date selection.

Declaration
protected virtual RadCalendar CreateDateSelectorCalendar()
Returns
RadCalendar

A new instance of RadCalendar configured for date selection.

CreateDateSelectorPopup()

Creates the popup control that contains the date selector calendar.

Declaration
protected virtual RadSizablePopupControl CreateDateSelectorPopup()
Returns
RadSizablePopupControl

A new instance of RadSizablePopupControl configured for date selection.

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

OnCalendarSelectionChanging(SelectionEventArgs)

Handles the event when the calendar selection is changing and processes the date selection logic.

Declaration
protected virtual void OnCalendarSelectionChanging(SelectionEventArgs e)
Parameters
SelectionEventArgs e

The selection event arguments containing information about the changing selection.

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnTimeZoneDropDownSelectedValueChanged()

Handles the event when the time zone dropdown selection changes and updates the associated scheduler's time zone.

Declaration
protected virtual void OnTimeZoneDropDownSelectedValueChanged()

UpdateTimeZoneElementsValues()

Updates the time zone label and dropdown selection to reflect the current time zone from the associated scheduler.

Declaration
public void UpdateTimeZoneElementsValues()

WireTimeZonesDropDownEvents()

Wires the event handlers for the time zones dropdown selection change events.

Declaration
public void WireTimeZonesDropDownEvents()

Events

AgendaViewClick

Occurs when the agenda view button is clicked, allowing the user to switch to agenda view mode.

Declaration
public event EventHandler AgendaViewClick
Event Type
System.EventHandler

DayViewClick

Occurs when the day view button is clicked, allowing the user to switch to day view mode.

Declaration
public event EventHandler DayViewClick
Event Type
System.EventHandler

MonthViewClick

Occurs when the month view button is clicked, allowing the user to switch to month view mode.

Declaration
public event EventHandler MonthViewClick
Event Type
System.EventHandler

NavigateBackwardsClick

Occurs when the navigate backwards button is clicked, allowing the user to move to the previous time period.

Declaration
public event EventHandler NavigateBackwardsClick
Event Type
System.EventHandler

NavigateForwardsClick

Occurs when the navigate forwards button is clicked, allowing the user to move to the next time period.

Declaration
public event EventHandler NavigateForwardsClick
Event Type
System.EventHandler

ShowWeekendStateChanged

Occurs when the show weekend checkbox state changes, allowing control over weekend display in the scheduler.

Declaration
public event StateChangedEventHandler ShowWeekendStateChanged
Event Type
StateChangedEventHandler

TimelineViewClick

Occurs when the timeline view button is clicked, allowing the user to switch to timeline view mode.

Declaration
public event EventHandler TimelineViewClick
Event Type
System.EventHandler

WeekViewClick

Occurs when the week view button is clicked, allowing the user to switch to week view mode.

Declaration
public event EventHandler WeekViewClick
Event Type
System.EventHandler

Extension Methods