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.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.Scheduler.dll
Syntax:
public class SchedulerNavigatorElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProviderInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementSchedulerNavigatorElement...
Implements:
Inherited Members
Constructors
public SchedulerNavigatorElement()Properties
Gets the agenda view button element that allows users to switch the scheduler to agenda view mode.
public RadButtonElement AgendaViewButton { get; }Gets or sets a value indicating whether the Agenda View button is visible in the navigation interface.
public bool AgendaViewButtonVisible { get; set; }true if Agenda View button is visible; otherwise, false.
The agenda view button will not be hidden when the scheduler is currently in agenda view.
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.
public bool AutomaticNavigation { get; set; }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.
public string DateFormat { get; set; }Gets the label element that displays the current date range being viewed in the scheduler.
public RadLabelElement DateLabel { get; }Gets the toggle button element that allows users to open the date selector calendar popup.
public RadToggleButtonElement DateSelectorButton { get; }Gets or sets a value indicating whether the date selector button is visible in the navigation interface.
public bool DateSelectorButtonVisible { get; set; }true if the date selector button is visible; otherwise, false.
Gets the calendar control used within the date selector popup for date selection and navigation.
public RadCalendar DateSelectorCalendar { get; }Gets the resizable popup control that contains the date selector calendar for quick date navigation.
public RadSizablePopupControl DateSelectorPopup { get; }Gets the day view button element that allows users to switch the scheduler to day view mode.
public RadButtonElement DayViewButton { get; }Gets or sets a value indicating whether the Day View button is visible in the navigation interface.
public bool DayViewButtonVisible { get; set; }true if Day View button is visible; otherwise, false.
The day view button will not be hidden when the scheduler is currently in day view.
Gets the month view button element that allows users to switch the scheduler to month view mode.
public RadButtonElement MonthViewButton { get; }Gets or sets a value indicating whether the Month View button is visible in the navigation interface.
public bool MonthViewButtonVisible { get; set; }true if Month View button is visible; otherwise, false.
The month view button will not be hidden when the scheduler is currently in month view.
Gets the navigation button element that allows users to navigate backwards in time (previous period).
public RadButtonElement NavigateBackwardsButton { get; }Gets the navigation button element that allows users to navigate forwards in time (next period).
public RadButtonElement NavigateForwardsButton { get; }Gets the navigate today button element that allows users to quickly navigate to the current date in the scheduler.
public RadButtonElement NavigateTodayButton { get; }Gets an instance of the StackLayoutPanel class that represents the container in which the navigation buttons of the RadSchedulerNavigator are layout.
[Browsable(false)]
public DockLayoutPanel NavigationPanel { get; }Gets an instance of the BorderPrimitive class that represents the border of the panel that holds the navigation buttons of the RadSchedulerNavigator.
[Browsable(false)]
public BorderPrimitive NavigationPanelBorder { get; }Gets an instance of the FillPrimitive class that represents the fill of the panel that holds the navigation buttons of the RadSchedulerNavigator.
[Browsable(false)]
public FillPrimitive NavigationPanelFill { get; }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.
public int NavigationStep { get; set; }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.
public NavigationStepTypes NavigationStepType { get; set; }Gets an instance of the BorderPrimitive class that represents the border of the RadSchedulerNavigator.
[Browsable(false)]
public BorderPrimitive NavigatorBorder { get; }Gets an instance of the FillPrimitive class that represents the background fill of the RadSchedulerNavigator.
[Browsable(false)]
public FillPrimitive NavigatorFill { get; }Gets the grid view control used for displaying search results within the navigator.
public RadGridView SearchGrid { get; }Gets or sets the search textbox control that allows users to search for appointments within the scheduler.
public SchedulerNavigatorSearchTextbox SearchTextBox { get; set; }Gets the checkbox element that allows users to toggle the display of weekend days in the scheduler views.
public RadCheckBoxElement ShowWeekendCheckBox { get; }Gets an instance of the StackLayoutPanel class that represents the container in which the show weekend checkbox of the RadSchedulerNavigator is layout.
[Browsable(false)]
public LightVisualElement ShowWeekendCheckBoxPanel { get; }Gets the timeline view button element that allows users to switch the scheduler to timeline view mode.
public RadButtonElement TimelineViewButton { get; }Gets or sets a value indicating whether the Timeline View button is visible in the navigation interface.
public bool TimelineViewButtonVisible { get; set; }true if Timeline View button is visible; otherwise, false.
The timeline view button will not be hidden when the scheduler is currently in timeline view.
Gets the time zone label element that displays information about the current time zone setting.
public RadLabelElement TimeZoneLabel { get; }Gets the time zones dropdown element that allows users to select and switch between different time zones for the scheduler display.
public RadDropDownListElement TimeZonesDropDown { get; }Gets the layout container element that houses the time zone selection controls and their associated visual elements.
public LightVisualElement TimeZonesElementLayout { get; }Gets the layout container element that houses the today button and its associated visual elements.
public LightVisualElement TodayButtonElementLayout { get; }Gets an instance of the StackLayoutPanel class that represents the container in which the view buttons of the RadSchedulerNavigator are layout.
[Browsable(false)]
public DockLayoutPanel ViewPanel { get; }Gets an instance of the BorderPrimitive class that represents the border of the panel that holds the view buttons of the RadSchedulerNavigator.
[Browsable(false)]
public BorderPrimitive ViewPanelBorder { get; }Gets an instance of the FillPrimitive class that represents the fill of the panel that holds the view buttons of the RadSchedulerNavigator.
[Browsable(false)]
public FillPrimitive ViewPanelFill { get; }Gets the week view button element that allows users to switch the scheduler to week view mode.
public RadButtonElement WeekViewButton { get; }Gets or sets a value indicating whether the Week View button is visible in the navigation interface.
public bool WeekViewButtonVisible { get; set; }true if Week View button is visible; otherwise, false.
The week view button will not be hidden when the scheduler is currently in week view.
Methods
Called by the element when constructed. Allows inheritors to build the element tree.
protected override void CreateChildElements()Overrides:
Creates the calendar control used within the date selector popup for date selection.
protected virtual RadCalendar CreateDateSelectorCalendar()A new instance of RadCalendar configured for date selection.
Creates the popup control that contains the date selector calendar.
protected virtual RadSizablePopupControl CreateDateSelectorPopup()A new instance of RadSizablePopupControl configured for date selection.
Disposes of managed resources including cached images and SVG images when the element is being disposed.
protected override void DisposeManagedResources()Overrides:
Handles the event when the calendar selection is changing and processes the date selection logic.
protected virtual void OnCalendarSelectionChanging(SelectionEventArgs e)The selection event arguments containing information about the changing selection.
Handles property change events by invalidating the fill cache and invoking the base class property change handler.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)Event arguments containing information about the property that changed.
Overrides:
Handles the event when the time zone dropdown selection changes and updates the associated scheduler's time zone.
protected virtual void OnTimeZoneDropDownSelectedValueChanged()Updates the time zone label and dropdown selection to reflect the current time zone from the associated scheduler.
public void UpdateTimeZoneElementsValues()Wires the event handlers for the time zones dropdown selection change events.
public void WireTimeZonesDropDownEvents()Events
Occurs when the agenda view button is clicked, allowing the user to switch to agenda view mode.
public event EventHandler AgendaViewClickOccurs when the day view button is clicked, allowing the user to switch to day view mode.
public event EventHandler DayViewClickOccurs when the month view button is clicked, allowing the user to switch to month view mode.
public event EventHandler MonthViewClickOccurs when the navigate backwards button is clicked, allowing the user to move to the previous time period.
public event EventHandler NavigateBackwardsClickOccurs when the navigate forwards button is clicked, allowing the user to move to the next time period.
public event EventHandler NavigateForwardsClickOccurs when the show weekend checkbox state changes, allowing control over weekend display in the scheduler.
public event StateChangedEventHandler ShowWeekendStateChangedOccurs when the timeline view button is clicked, allowing the user to switch to timeline view mode.
public event EventHandler TimelineViewClickOccurs when the week view button is clicked, allowing the user to switch to week view mode.
public event EventHandler WeekViewClick