New to Telerik UI for WinFormsStart a free 30-day trial

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:

C#
[TelerikToolboxCategory("Scheduler")]
public class RadSchedulerNavigator : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadSchedulerNavigator...

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIDisposableIDropTargetILayoutHandlerINotifyPropertyChangedISupportInitializeISupportInitializeNotificationISynchronizeInvokeIWin32Window...

Inherited Members RadControl.isResizing2RadControl.isDisposing2RadControl.invalidResizeRectRadControl.isAccessibilityRequestedRadControl.Dispose(bool)RadControl.Construct()RadControl.CreateBehavior()RadControl.CreateRootElement()RadControl.InitializeRootElement(RootRadElement)RadControl.LoadElementTree()RadControl.LoadElementTree(Size)RadControl.SetBackColorThemeOverrides()RadControl.ResetBackColorThemeOverrides()RadControl.SetForeColorThemeOverrides()RadControl.ResetForeColorThemeOverrides()RadControl.OnKeyDown(KeyEventArgs)RadControl.OnKeyUp(KeyEventArgs)RadControl.OnPreviewKeyDown(PreviewKeyDownEventArgs)RadControl.OnKeyPress(KeyPressEventArgs)RadControl.OnClick(EventArgs)RadControl.OnDoubleClick(EventArgs)RadControl.OnMouseDown(MouseEventArgs)RadControl.OnMouseUp(MouseEventArgs)RadControl.OnMouseEnter(EventArgs)RadControl.OnMouseLeave(EventArgs)RadControl.OnMouseMove(MouseEventArgs)RadControl.OnMouseHover(EventArgs)RadControl.OnMouseWheel(MouseEventArgs)RadControl.OnMouseCaptureChanged(EventArgs)RadControl.OnGotFocus(EventArgs)RadControl.OnLostFocus(EventArgs)RadControl.OnCreateControl()RadControl.OnHandleDestroyed(EventArgs)RadControl.OnParentChanged(EventArgs)RadControl.OnVisibleChanged(EventArgs)RadControl.OnFontChanged(EventArgs)RadControl.OnForeColorChanged(EventArgs)RadControl.OnBackColorChanged(EventArgs)RadControl.OnEnabledChanged(EventArgs)RadControl.OnLocationChanged(EventArgs)RadControl.OnPaddingChanged(EventArgs)RadControl.OnRightToLeftChanged(EventArgs)RadControl.OnPaint(PaintEventArgs)RadControl.OnLayout(LayoutEventArgs)RadControl.OnAutoSizeChanged(EventArgs)RadControl.WndProc(ref Message)RadControl.OnInvalidated(RadElement)RadControl.OnCaptureLosing()RadControl.OnThemeChanged()RadControl.OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)RadControl.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)RadControl.OnThemeNameChanged(ThemeNameChangedEventArgs)RadControl.ProcessMnemonic(char)RadControl.ProcessFocusRequested(RadElement)RadControl.ProcessCaptureChangeRequested(RadElement, bool)RadControl.IsInputKey(Keys)RadControl.GetInputElement()RadControl.BeginInit()RadControl.EndInit()RadControl.OnNotifyPropertyChanged(string)RadControl.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadControl.GetPreferredSize(Size)RadControl.SetBoundsCore(int, int, int, int, BoundsSpecified)RadControl.GetRootElementDesiredSize(int, int, int, int)RadControl.OnZoomGesture(ZoomGestureEventArgs)RadControl.OnRotateGesture(RotateGestureEventArgs)RadControl.OnPanGesture(PanGestureEventArgs)RadControl.OnTwoFingerTapGesture(GestureEventArgs)RadControl.OnPressAndTapGesture(PressAndTapGestureEventArgs)RadControl.OnGesture(GestureEventArgs)RadControl.ProcessGesture(Message)RadControl.EnableGesture(GestureType)RadControl.DisableGesture(GestureType)RadControl.Refresh()RadControl.SuspendUpdate()RadControl.ResumeUpdate()RadControl.ResumeUpdate(bool)RadControl.InvokeLayoutCallback(LayoutCallback)RadControl.RegisterHostedControl(RadHostItem)RadControl.UnregisterHostedControl(RadHostItem, bool)RadControl.ResolveStyleGroupForElement(StyleGroup, RadObject)RadControl.GetPlainText()RadControl.ShouldSerializeProperty(RadProperty)RadControl.ShouldSerializeProperty(RadProperty, RadObject)RadControl.ResetProperty(RadProperty, RadObject)RadControl.CanEditElementAtDesignTime(RadElement)RadControl.ProcessCodedUIMessage(ref IPCMessage)RadControl.FindPropertyInChildren(RadControl, IPCMessage)RadControl.ScaleControl(SizeF, BoundsSpecified)RadControl.PerformRadAutoScale(BoundsSpecified?)RadControl.GetMonitorDpiScaleFactor(Control)RadControl.SetRadAutoScale(bool)RadControl.EnableDpiScalingRadControl.EnableRadAutoScaleRadControl.EnableRadFormInitialDpiScalingRadControl.EnableImageDpiScalingRadControl.EnableSvgImagesRadControl.IsLoadedRadControl.ElementTreeRadControl.UseCompatibleTextRenderingDefaultValueRadControl.BehaviorRadControl.RootElementRadControl.PaddingRadControl.ThemeNameRadControl.TextRadControl.EnableThemingRadControl.ThemeClassNameRadControl.ImageListRadControl.ImageScalingSizeRadControl.UseCompatibleTextRenderingRadControl.AutoSizeRadControl.MaximumSizeRadControl.MinimumSizeRadControl.FocusableRadControl.SiteRadControl.CausesValidationRadControl.IsInitializingRadControl.SmallImageListRadControl.SmallImageScalingSizeRadControl.IsDesignModeRadControl.IsDisplayedRadControl.FocusedElementRadControl.AllowShowFocusCuesRadControl.ShowItemToolTipsRadControl.CommandBindingsRadControl.EnableKeyMapRadControl.BackColorRadControl.ForeColorRadControl.FontRadControl.ValidationCancelRadControl.EnableAnalyticsRadControl.AnalyticsNameRadControl.EnableRadAccessibilityObjectsRadControl.EnableCodedUITestsRadControl.EnableCodedUITestsDefaultValueRadControl.EnableUIAutomationRadControl.EnableUIAutomationDefaultValueRadControl.ElementInvalidatedRadControl.ToolTipTextNeededRadControl.ScreenTipNeededRadControl.ThemeNameChangedRadControl.InitializedRadControl.PropertyChangedRadControl.ZoomGestureRadControl.RotateGestureRadControl.PanGestureRadControl.TwoFingerTapGestureRadControl.PressAndTapGesture...

Constructors

Initializes a new instance of the RadSchedulerNavigator class. Creates a navigator control with default settings and enables auto-sizing.

C#
public RadSchedulerNavigator()

Properties

Gets the AgendaViewButton element.

C#
[Browsable(false)]
public RadButtonElement AgendaViewButton { get; }

Show/Hide Agenda View button.

C#
[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

Gets or sets the RadScheduler control associated with this RadSchedulerNavigator.

C#
[Browsable(true)]
public RadScheduler AssociatedScheduler { get; set; }

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.

C#
[Browsable(true)]
public bool AutomaticNavigation { get; set; }

Gets or sets the format string used to display the date range in the navigator. The format follows the standard .NET date formatting patterns.

C#
[Browsable(true)]
public string DateFormat { get; set; }

Gets the DateLabelElement

C#
[Browsable(false)]
public RadLabelElement DateLabelElement { get; }

Gets the DateSelectorElement

C#
[Browsable(false)]
public RadToggleButtonElement DateSelectorButton { get; }

Show/Hide the DateSelecotrButton.

C#
[Browsable(true)]
public bool DateSelectorButtonVisible { get; set; }
Property Value:

true if the DateSelectorButton is visible; otherwise, false.

Gets the DayViewButton element.

C#
[Browsable(false)]
public RadButtonElement DayViewButton { get; }

Show/Hide Day View button.

C#
[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

Gets the default size of the control.

C#
protected override Size DefaultSize { get; }
Property Value:

A Size representing the default size of the control.

Overrides: Control.DefaultSize

Gets the button element that allows users to switch to the Month view in the scheduler.

C#
[Browsable(false)]
public RadButtonElement MonthViewButton { get; }

Show/Hide Month View button.

C#
[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

Gets the NavigateBackwardsButton element.

C#
[Browsable(false)]
public RadButtonElement NavigateBackwardsButton { get; }

Gets the NavigateForwardsButton element.

C#
[Browsable(false)]
public RadButtonElement NavigateForwardsButton { get; }

Gets the button element that allows users to quickly navigate to today's date.

C#
[Browsable(false)]
public RadButtonElement NavigateTodayButton { get; }

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.

C#
[Browsable(true)]
public int NavigationStep { get; set; }

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.

C#
[Browsable(true)]
public NavigationStepTypes NavigationStepType { get; set; }

Gets the root element that represents the visual structure of this navigator control.

C#
[Browsable(false)]
public SchedulerNavigatorElement SchedulerNavigatorElement { get; }

Gets the ShowWeekendCheckBox element

C#
[Browsable(false)]
public RadCheckBoxElement ShowWeekendCheckBox { get; }

Gets the TimelineViewButton element.

C#
[Browsable(false)]
public RadButtonElement TimelineViewButton { get; }

Show/Hide Timeline View button.

C#
[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

Gets the WeekViewButton element.

C#
[Browsable(false)]
public RadButtonElement WeekViewButton { get; }

Show/Hide Week View button.

C#
[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

Determines whether this control defines the theme for the specified element.

C#
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters:elementRadElement

The element to check.

Returns:

bool

True if this control defines the theme for the element; otherwise, false.

Overrides: RadControl.ControlDefinesThemeForElement(RadElement)

Creates the child elements that make up the control.

C#
protected override void CreateChildItems(RadElement parent)
Parameters:parentRadElement

The parent element to which child elements will be added.

Overrides: RadControl.CreateChildItems(RadElement)

Raises the BindingContextChanged event.

C#
protected override void OnBindingContextChanged(EventArgs e)
Parameters:eEventArgs

An EventArgs that contains the event data.

Overrides: RadControl.OnBindingContextChanged(EventArgs)

Called when the control is being loaded.

C#
protected override void OnLoad(Size desiredSize)
Parameters:desiredSizeSize

The desired size of the control.

Overrides: RadControl.OnLoad(Size)

Raised when the parent's binding context changes. Updates the time zone elements to reflect any changes.

C#
protected override void OnParentBindingContextChanged(EventArgs e)
Parameters:eEventArgs

An EventArgs that contains the event data.

Overrides: Control.OnParentBindingContextChanged(EventArgs)

Processes changes to the AutoSize property.

C#
protected override void ProcessAutoSizeChanged(bool value)
Parameters:valuebool

The new AutoSize value.

Overrides: RadControl.ProcessAutoSizeChanged(bool)

Events

Fires when the user clicks on the Agenda View button.

C#
public event EventHandler AgendaViewClick

Fires when the user clicks on the Day View button.

C#
public event EventHandler DayViewClick

Fires when the user clicks on the Month View button.

C#
public event EventHandler MonthViewClick

Fires when the user clicks on the Navigate Backwards button.

C#
public event EventHandler NavigateBackwardsClick

Fires when the user clicks on the Navigate Forwards button.

C#
public event EventHandler NavigateForwardsClick

Fires when the user perform search from search textbox

C#
public event EventHandler SearchCompleted

Fires when the user changes the state of the ShowWeekend checkbox.

C#
public event StateChangedEventHandler ShowWeekendStateChanged

Fires when the user clicks on the Timeline View button.

C#
public event EventHandler TimelineViewClick

Fires when the user clicks of the Week View button.

C#
public event EventHandler WeekViewClick