ClassRadSchedulerNavigator
A navigation control for the RadScheduler component that provides view switching, date navigation, and other scheduler-related UI operations. This control allows users to switch between different scheduler views, navigate between time periods, and toggle weekend display.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.Scheduler.dll
Syntax:
[TelerikToolboxCategory("Scheduler")]
public class RadSchedulerNavigator : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadSchedulerNavigator
Implements:
Inherited Members
Constructors
RadSchedulerNavigator()
Initializes a new instance of the RadSchedulerNavigator class. Creates a navigator control with default settings and enables auto-sizing.
Declaration
public RadSchedulerNavigator()
Properties
AgendaViewButton
Gets the AgendaViewButton element.
Declaration
[Browsable(false)]
public RadButtonElement AgendaViewButton { get; }
Property Value
AgendaViewButtonVisible
Show/Hide Agenda View button.
Declaration
[Browsable(false)]
public bool AgendaViewButtonVisible { get; set; }
Property Value
true if Agenda View button is visible; otherwise, false.
Remarks
the Agenda view button will not be hide when the scheduler is in timeline view
AssociatedScheduler
Gets or sets the RadScheduler control associated with this RadSchedulerNavigator.
Declaration
[Browsable(true)]
public RadScheduler AssociatedScheduler { get; set; }
Property Value
AutomaticNavigation
Gets or sets whether the navigator uses automatic navigation mode. When enabled, navigation will automatically adjust based on the active view type, ignoring the NavigationStep property.
Declaration
[Browsable(true)]
public bool AutomaticNavigation { get; set; }
Property Value
DateFormat
Gets or sets the format string used to display the date range in the navigator. The format follows the standard .NET date formatting patterns.
Declaration
[Browsable(true)]
public string DateFormat { get; set; }
Property Value
DateLabelElement
Gets the DateLabelElement
Declaration
[Browsable(false)]
public RadLabelElement DateLabelElement { get; }
Property Value
DateSelectorButton
Gets the DateSelectorElement
Declaration
[Browsable(false)]
public RadToggleButtonElement DateSelectorButton { get; }
Property Value
DateSelectorButtonVisible
Show/Hide the DateSelecotrButton.
Declaration
[Browsable(true)]
public bool DateSelectorButtonVisible { get; set; }
Property Value
true if the DateSelectorButton is visible; otherwise, false.
DayViewButton
Gets the DayViewButton element.
Declaration
[Browsable(false)]
public RadButtonElement DayViewButton { get; }
Property Value
DayViewButtonVisible
Show/Hide Day View button.
Declaration
[Browsable(false)]
public bool DayViewButtonVisible { get; set; }
Property Value
true if Day View button is visible; otherwise, false.
Remarks
the day view button will not be hide when the scheduler is in day view
DefaultSize
Gets the default size of the control.
MonthViewButton
Gets the button element that allows users to switch to the Month view in the scheduler.
Declaration
[Browsable(false)]
public RadButtonElement MonthViewButton { get; }
Property Value
MonthViewButtonVisible
Show/Hide Month View button.
Declaration
[Browsable(false)]
public bool MonthViewButtonVisible { get; set; }
Property Value
true if Month View button is visible; otherwise, false.
Remarks
the month view button will not be hide when the scheduler is in month view
NavigateBackwardsButton
Gets the NavigateBackwardsButton element.
Declaration
[Browsable(false)]
public RadButtonElement NavigateBackwardsButton { get; }
Property Value
NavigateForwardsButton
Gets the NavigateForwardsButton element.
Declaration
[Browsable(false)]
public RadButtonElement NavigateForwardsButton { get; }
Property Value
NavigateTodayButton
Gets the button element that allows users to quickly navigate to today's date.
Declaration
[Browsable(false)]
public RadButtonElement NavigateTodayButton { get; }
Property Value
NavigationStep
Gets or sets the number of units to move when navigating forward or backward. For example, if set to 2 and navigation type is days, clicking forward will advance by 2 days. The minimum value is 1.
Declaration
[Browsable(true)]
public int NavigationStep { get; set; }
Property Value
NavigationStepType
Gets or sets the unit type used for navigation steps (Day, Week, Month, etc.). This determines how the NavigationStep value is interpreted when navigating. Note: When in WeekView or MonthView with Day as the step type, navigation only works if NavigationStep is 7 or greater.
Declaration
[Browsable(true)]
public NavigationStepTypes NavigationStepType { get; set; }
Property Value
SchedulerNavigatorElement
Gets the root element that represents the visual structure of this navigator control.
Declaration
[Browsable(false)]
public SchedulerNavigatorElement SchedulerNavigatorElement { get; }
Property Value
ShowWeekendCheckBox
Gets the ShowWeekendCheckBox element
Declaration
[Browsable(false)]
public RadCheckBoxElement ShowWeekendCheckBox { get; }
Property Value
TimelineViewButton
Gets the TimelineViewButton element.
Declaration
[Browsable(false)]
public RadButtonElement TimelineViewButton { get; }
Property Value
TimelineViewButtonVisible
Show/Hide Timeline View button.
Declaration
[Browsable(false)]
public bool TimelineViewButtonVisible { get; set; }
Property Value
true if Timeline View button is visible; otherwise, false.
Remarks
the timeline view button will not be hide when the scheduler is in timeline view
WeekViewButton
Gets the WeekViewButton element.
Declaration
[Browsable(false)]
public RadButtonElement WeekViewButton { get; }
Property Value
WeekViewButtonVisible
Show/Hide Week View button.
Declaration
[Browsable(false)]
public bool WeekViewButtonVisible { get; set; }
Property Value
true if button Week View is visible; otherwise, false.
Remarks
the week view button will not be hide when the scheduler is in week view
Methods
ControlDefinesThemeForElement(RadElement)
Determines whether this control defines the theme for the specified element.
Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
element
The element to check.
Returns
True if this control defines the theme for the element; otherwise, false.
Overrides
CreateChildItems(RadElement)
Creates the child elements that make up the control.
Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
parent
The parent element to which child elements will be added.
Overrides
OnBindingContextChanged(EventArgs)
Raises the BindingContextChanged event.
OnLoad(Size)
Called when the control is being loaded.
Declaration
protected override void OnLoad(Size desiredSize)
Parameters
desiredSize
The desired size of the control.
Overrides
OnParentBindingContextChanged(EventArgs)
Raised when the parent's binding context changes. Updates the time zone elements to reflect any changes.
ProcessAutoSizeChanged(bool)
Processes changes to the AutoSize property.
Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
value
The new AutoSize value.
Overrides
Events
AgendaViewClick
Fires when the user clicks on the Agenda View button.
DayViewClick
Fires when the user clicks on the Day View button.
MonthViewClick
Fires when the user clicks on the Month View button.
NavigateBackwardsClick
Fires when the user clicks on the Navigate Backwards button.
Declaration
public event EventHandler NavigateBackwardsClick
Event Value
NavigateForwardsClick
Fires when the user clicks on the Navigate Forwards button.
Declaration
public event EventHandler NavigateForwardsClick
Event Value
SearchCompleted
Fires when the user perform search from search textbox
ShowWeekendStateChanged
Fires when the user changes the state of the ShowWeekend checkbox.
Declaration
public event StateChangedEventHandler ShowWeekendStateChanged
Event Value
TimelineViewClick
Fires when the user clicks on the Timeline View button.
WeekViewClick
Fires when the user clicks of the Week View button.