Class RadSchedulerNavigator

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.

Inheritance
System.Object
RadControl
RadSchedulerNavigator
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.Scheduler.dll

Syntax

[TelerikToolboxCategory("Scheduler")]
public class RadSchedulerNavigator : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

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
public RadButtonElement AgendaViewButton { get; }
Property Value
RadButtonElement

AgendaViewButtonVisible

Show/Hide Agenda View button.

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 hide when the scheduler is in timeline view

AssociatedScheduler

Gets or sets the RadScheduler control associated with this RadSchedulerNavigator.

Declaration
public RadScheduler AssociatedScheduler { get; set; }
Property Value
RadScheduler

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
public bool AutomaticNavigation { get; set; }
Property Value
System.Boolean

AutoSize

This property is not relevant for this class.

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

Overrides

BackColor

RadSchedulerNavigator consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

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
public string DateFormat { get; set; }
Property Value
System.String

DateLabelElement

Gets the DateLabelElement

Declaration
public RadLabelElement DateLabelElement { get; }
Property Value
RadLabelElement

DateSelectorButton

Gets the DateSelectorElement

Declaration
public RadToggleButtonElement DateSelectorButton { get; }
Property Value
RadToggleButtonElement

DateSelectorButtonVisible

Show/Hide the DateSelecotrButton.

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

true if the DateSelectorButton is visible; otherwise, false.

DayViewButton

Gets the DayViewButton element.

Declaration
public RadButtonElement DayViewButton { get; }
Property Value
RadButtonElement

DayViewButtonVisible

Show/Hide Day View button.

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 hide when the scheduler is in day view

DefaultSize

Gets the default size of the control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

A System.Drawing.Size representing the default size of the control.

ForeColor

RadSchedulerNavigator consists of multiple visual elements and separate settings are provided to customize their appearance. This property is not relevant for this class.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

MonthViewButton

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

Declaration
public RadButtonElement MonthViewButton { get; }
Property Value
RadButtonElement

MonthViewButtonVisible

Show/Hide Month View button.

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 hide when the scheduler is in month view

NavigateBackwardsButton

Gets the NavigateBackwardsButton element.

Declaration
public RadButtonElement NavigateBackwardsButton { get; }
Property Value
RadButtonElement

NavigateForwardsButton

Gets the NavigateForwardsButton element.

Declaration
public RadButtonElement NavigateForwardsButton { get; }
Property Value
RadButtonElement

NavigateTodayButton

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

Declaration
public RadButtonElement NavigateTodayButton { get; }
Property Value
RadButtonElement

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
public int NavigationStep { get; set; }
Property Value
System.Int32

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
public NavigationStepTypes NavigationStepType { get; set; }
Property Value
NavigationStepTypes

SchedulerNavigatorElement

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

Declaration
public SchedulerNavigatorElement SchedulerNavigatorElement { get; }
Property Value
SchedulerNavigatorElement

ShowWeekendCheckBox

Gets the ShowWeekendCheckBox element

Declaration
public RadCheckBoxElement ShowWeekendCheckBox { get; }
Property Value
RadCheckBoxElement

Text

This property is not relevant for this class.

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

Overrides

TimelineViewButton

Gets the TimelineViewButton element.

Declaration
public RadButtonElement TimelineViewButton { get; }
Property Value
RadButtonElement

TimelineViewButtonVisible

Show/Hide Timeline View button.

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 hide when the scheduler is in timeline view

WeekViewButton

Gets the WeekViewButton element.

Declaration
public RadButtonElement WeekViewButton { get; }
Property Value
RadButtonElement

WeekViewButtonVisible

Show/Hide Week View button.

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

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
RadElement element

The element to check.
Returns
System.Boolean

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
RadElement parent

The parent element to which child elements will be added.
Overrides

OnBindingContextChanged(EventArgs)

Raises the BindingContextChanged event.

Declaration
protected override void OnBindingContextChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnLoad(Size)

Called when the control is being loaded.

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size 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.

Declaration
protected override void OnParentBindingContextChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

ProcessAutoSizeChanged(Boolean)

Processes changes to the AutoSize property.

Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
System.Boolean value

The new AutoSize value.
Overrides

Events

AgendaViewClick

Fires when the user clicks on the Agenda View button.

Declaration
public event EventHandler AgendaViewClick
Event Type
System.EventHandler

DayViewClick

Fires when the user clicks on the Day View button.

Declaration
public event EventHandler DayViewClick
Event Type
System.EventHandler

MonthViewClick

Fires when the user clicks on the Month View button.

Declaration
public event EventHandler MonthViewClick
Event Type
System.EventHandler

NavigateBackwardsClick

Fires when the user clicks on the Navigate Backwards button.

Declaration
public event EventHandler NavigateBackwardsClick
Event Type
System.EventHandler

NavigateForwardsClick

Fires when the user clicks on the Navigate Forwards button.

Declaration
public event EventHandler NavigateForwardsClick
Event Type
System.EventHandler

SearchCompleted

Fires when the user perform search from search textbox

Declaration
public event EventHandler SearchCompleted
Event Type
System.EventHandler

ShowWeekendStateChanged

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

Declaration
public event StateChangedEventHandler ShowWeekendStateChanged
Event Type
StateChangedEventHandler

TimelineViewClick

Fires when the user clicks on the Timeline View button.

Declaration
public event EventHandler TimelineViewClick
Event Type
System.EventHandler

WeekViewClick

Fires when the user clicks of the Week View button.

Declaration
public event EventHandler WeekViewClick
Event Type
System.EventHandler

Extension Methods